Crypto.com Chain library for Node.js

This repository contains the Node.js library for interacting with Crypto.com Chain.

Warning

Crypto.com Chain and this library is currently in the alpha development phase and subjects to changes. Before proceeding, please be aware of the following:

• This library is not production-ready, do not use in production systems.

• Do not transfer any ERC20 tokens to addresses generated by this sample code as it can cause loss of funds.

• Crypto.com is not liable for any potential damage, loss of data/files arising from the use of the library.

Installation

Install via NPM

npm install @crypto-com/chain-nodelib

Depending on your Node.js languages:

1. TypeScript

   import * as cro from "@crypto-com/chain-nodelib";

2. JavaScript:

   const cro = require("@crypto-com/chain-nodelib");

Build manually

1. Clone this repository to your project

   git clone https://github.com/crypto-com/chain-nodelib 

2. Install and build chain-nodelib

   cd chain-node-lib
   npm install
   npm build

3. Add chain-nodelib to your package.json

   {
       ...
       "dependencies": {
           "@cryptocom/chain-nodelib": "file:./chain-nodelib",
       }
   }

Examples

An example is worth a thousand words, we provide code examples of different use cases below.

If you couldn't find an example for your use case, please open an issue and tell us.

Address

• Generate random transfer address
• Create transfer address from private/public key
• Generate random staking address
• Create staking address from private/public key

View Key

• Generate random view key

Transaction

• Create transfer transaction

Staking and Council Node

• Create deposit transaction
• Create unbond transaction
• Create withdraw staked transaction
• Create node-join transaction
• Create unjail transaction

HD Wallet

• Generate mnemonic words
• Restore from mnemonic words and create addresses and view key at bip39 path
• Create addresses and view key at Crypto.com chain default bip44 path
• create at particular path with format argument
• Spend UTXO of transfer address generated with HD wallet

Documentation

You can generate API documentation by running

npm run docs:generate

Generated documentation is available at docs/dist

Browser support

Right now the library does not support Browser.

License

Apache 2.0