Overview

Overview for XChainJS

Interface

The interface is defined here.

Common Interface

The interface supports as a minimum the following functions for each blockchain:

1. Initialise with a valid BIP39 phrase and specified network ('testnet'/'mainnet')
2. Get the address, with support for BIP44 path derivations (default is Index 0)
3. Get the balance (UTXO or account-based)
4. Get transaction history for that address
5. Get transaction data for the transaction ID/hash
6. Make a simple transfer
7. Get blockchain fee information (standard, fast, fastest)

Extended Interface

Some blockchains have different functions. More advanced logic can be built by extending the interface, such as for Binance Chain and Cosmos chains.

Return the Client

For wallets that need even more flexibility (smart contract blockchains) the client can be retrieved and the wallet is then free to handle directly.

XChainJS uses following libraries, frameworks and more:

• BitcoinJS
• @binance-chain/javascript-sdk
• @ethersproject
• cosmos-client

Tests

unit

yarn test

Development

lerna bootstrap

Releasing

See RELEASE.md

Contributing

Please see the Contributing Guidelines here (coming soon).

Bug Reports

Please see the Bug Report Process here (coming soon).