@chromia/ft4

FT4 Library: Asset and Account Management for Chromia's Rell and TypeScript Environments

Introduction

The FT4 library is a toolkit to help dApp developers build real world applications within the Chromia ecosystem by providing out of the box support for things such as account creation and access management and interaction with external signature solutions already familiar to the user. It also provides asset management. Allowing issuance, allocation and transfers and tracing of asset activities, both within a chain as well as across other chains within the Chromia ecosystem.

Features

• Asset Management: Facilitate the creation, allocation, and management of assets.
• Asset Allocation and Transfers: Perform secure and efficient asset transfers.
• Cross-Chain Transfers: Enable the movement of assets between distinct blockchains.
• Account Registration and Management: Create and oversee user accounts independently of asset activities.

A full documentation on how to use the various features of the library can be found on the official docs page.

Repository Overview

This repository contains the FT4 library and a comprehensive suite of tests written in Node.js and Jest. The current testing setup serves as a temporary measure, as a Rell-based testing suite is in development.

Getting Started

Prerequisites

• Node.js
• Chromia CLI
• Docker
• [Optional] PostgreSQL for database sessions

Installation

Clone the repository and install the dependencies:

git clone [e-mail]:chromaway/ft4-lib.git
cd ft4-lib
npm install
chr install

Build

Build TypeScript library into dist/:

npm run build

How to Run Tests

Comprehensive Test Suite

Run the complete set of Rell and TypeScript tests:

npm run test

Run only Rell or TypeScript tests:

npm run test:rell
npm run test:js

The TypeScript tests can be run with even more granularity:

npm run test:js-unit # does not make any calls to a real blockchain
npm run test:js-integration # stars a single blockchain which it interacts with
npm run test:js-multichain # Stars a cluster of chains which it interacts with

Running Specific Rell Tests

To execute particular tests in Rell, use the --tests or -t option:

npm run test:rell -- --tests=test1,test2
npm run test:rell -- -t=test1,test2

Running Specific Jest Tests

Execute specific Jest tests by string matching:

npm run test:js 'string matching test(s)'

Examples:

npm run test:js 'user'
npm run test:js 'rate|sso'

Running End-to-End Tests with Cypress

Interactive Mode

Run e2e tests interactively:

npm run test:e2e

Headless Mode

Run e2e tests in headless mode:

npm run test:e2e:headless

Changelog

Update changelog in doc/release-notes/, then run ./scripts/compile-changelog.sh script to assemble changelog.md and rell-changelog.md. Do not update changelog.md or rell-changelog.md directly.

License

This project is licensed under the Apache License, Version 2.0. For more details, see the LICENSE file in the repository or visit Apache License, Version 2.0.

Changelog

[2.0.0] - 2025-05-07

Breaking 💔

• Removed the constant MERKLE_HASH_VERSIONS as the same constants is now exported from postchain-client and can be reused

Changed 🪙

• The deriveNonce function has been updated to accept an additional input parameter merkleHashVersion that defaults to 1 if not provided
• The TransactionBuilder event type of buildAndSend from Web3CustomPromiEvent to Web3PromiEvent
• The TransactionBuilder event type of buildAndSendWithAnchoring from Web3CustomPromiEvent to Web3PromiEvent
• The return types of for the functions buildAndSend and buildAndSendWithAnchoring of transactionBuilder from Web3CustomPromiEvent to Web3PromiEvent
• The return type of the function registerAccount from Web3CustomPromiEvent to Web3PromiEvent
• The return type of the function transferHistoryFromHeight from TransferHistoryEntryResponse[] to PagedResponse<TransferHistoryEntryResponse>
• The return type of the function addAuthDescriptor from Web3CustomPromiEvent to Web3PromiEvent
• The return type of the function updateMainAuthDescriptor from Web3CustomPromiEvent to Web3PromiEvent
• The return type of the function deleteAuthDescriptor from Web3CustomPromiEvent to Web3PromiEvent
• The return type of the function deleteAllAuthDescriptorsExceptMain from Web3CustomPromiEvent to Web3PromiEvent
• The return type of the function transfer from Web3CustomPromiEvent to Web3PromiEvent
• The return type of the function recallUnclaimedTransfer from Web3CustomPromiEvent to Web3PromiEvent
• The return type of the function burn from Web3CustomPromiEvent to Web3PromiEvent
• The return type of the function crosschainTransfer from Web3CustomPromiEvent to Web3PromiEvent
• The return type of the function resumeCrosschainTransfer from Web3CustomPromiEvent to Web3PromiEvent
• The return type of the function recallUnclaimedCrosschainTransfer from Web3CustomPromiEvent to Web3PromiEvent
• The return type of Session.call from Web3CustomPromiEvent to Web3PromiEvent
• The return type of Session.callWithoutNop from Web3CustomPromiEvent to Web3PromiEvent
• The return type of AuthenticatedAccount.addAuthDescriptor from Web3CustomPromiEvent to Web3PromiEvent
• The return type of AuthenticatedAccount.updateMainAuthDescriptor from Web3CustomPromiEvent to Web3PromiEvent
• The return type of AuthenticatedAccount.deleteAuthDescriptor from Web3CustomPromiEvent to Web3PromiEvent
• The return type of AuthenticatedAccount.deleteAllAuthDescriptorsExceptMain from Web3CustomPromiEvent to Web3PromiEvent
• The return type of AuthenticatedAccount.transfer from Web3CustomPromiEvent to Web3PromiEvent
• The return type of AuthenticatedAccount.recallUnclaimedTransfer from Web3CustomPromiEvent to Web3PromiEvent
• The return type of AuthenticatedAccount.crosschainTransfer from Web3CustomPromiEvent to Web3PromiEvent
• The return type of AuthenticatedAccount.resumeCrosschainTransfer from Web3CustomPromiEvent to Web3PromiEvent
• The return type of AuthenticatedAccount.revertCrosschainTransfer from Web3CustomPromiEvent to Web3PromiEvent
• The return type of AuthenticatedAccount.recallUnclaimedCrosschainTransfer from Web3CustomPromiEvent to Web3PromiEvent
• The return type of AuthenticatedAccount.burn from Web3CustomPromiEvent to Web3PromiEvent

Removed 🗑️

• The implementations of Web3CustomPromiEvent, Web3CustomEventMap, PromiseExecutor, Web3EventCallback and Web3EventKey as postchain-client's was refactored to generic and can be reused