@chromia/ft4

FT4 Library

FT4 Library is a library for Rell modules (Chromia smart contract language). It can be imported and used as a token provider and manager. It allows several operations, among them: creation of different assets (type of tokens), allocation of tokens, and transfer. It also have some basic data structure for users (account) that can be used independently from the use of the tokens.

The repository

This repository provides the TypeScript (client) and Rell (blockchain) libraries and tests.

How to run tests

npm run test will take care of everything, launching the blockchain and running bot typescript and rell tests.

npm run test:js and npm run test:rell will only run one kind of test

If you want to run just certain jest tests, use: npm run test[:js] 'string matching test(s)' Example: npm run test 'user' will only run js tests with user in their name, and all rell tests npm run test:js 'rate|sso' will only run js tests with either rate or sso in their name, and no rell tests

How to run the blockchain

"postchain:test": "docker-compose -f dockers/rell-test.yml up -d", "postchain:demo": "docker-compose -f dockers/demo.yml up -d", "stop-postchain:jest": "docker-compose -f dockers/jest-test.yml down", "stop-postchain:rell": "docker-compose -f dockers/rell-test.yml down", "stop-postchain:demo": "docker-compose -f dockers/demo.yml down",

Changelog

[0.1.5] - 2023-09-12

Added

• createGenericEvmKeyStore: it receives an address and a sign function, to allow for custom implementations with any web3 library. Metamask is still supported through ethers for ease of setup.
• fixed examples
• Custom Event Emitter for handling various events like Metamask address change, crosschain transfer notifications.
• Auth messages now includes rid of the blockchain to which the tx is being submitted.

Changed

• Transfer history's asset properties are now of the Asset type
• Auth messages now include rid of the blockchain to which the tx is being submitted.

Fixed

• Asset queries now return Asset type with iconUrl, not icon_url
• Balance queries now return frozen objects
• Exports of admin functions.
• authenticate() function will now try to match operation name exactly when searching for auth handlers and throw an error if none is found. The old behaviour where scope path was traversed to the root can be aquired again by calling authenticate(strict = false)
• Connection interface is now exported and part of the public interface