Starcoin SDK

starcoin.js is a full featured sdk for developing dapp on Starcoin blockchain network.

Type Architecture Diagram

Docs

Starcoin Javascript SDK

Usage

First, start a Starcoin node with websocket and http APIs opened.

./starcoin -n dev --miner-thread 4 --websocket-apis all --http-apis all

or

./starcoin -n barnard --miner-thread 4 --websocket-apis all --http-apis all

let provider = new JsonRpcProvider("http://localhost:9850");

/// Get txn data.
const txnData = await provider.getTransaction(txnHash);
const txnInfoData = await provider.getTransactionInfo(txnHash);

/// Send Transaction

let signer = provider.getSigner();
await signer.unlock(""); // put password into the quotes
// starcoin node should enable account jsonrpc api.
const txnRequest = {
    script: {
      code: '0x1::TransferScripts::peer_to_peer',
      type_args: ['0x1::STC::STC'],
      args: ['0xc13b50bdb12e3fdd03c4e3b05e34926a', 'x"29b6012aee31a216af67c3d05e21a092c13b50bdb12e3fdd03c4e3b05e34926a"', '100000u128'],
    }
};
let txn = await signer.sendTransaction(txnRequest);
// wait for 7 confirmations.
const txnInfo = await txn.wait(7);
console.log(txnInfo);

Utils

Decode Events

TransactionEvents returned from node are encoded in BCS format. client sdk should decode the data to see the detailed information.

import encoding from 'starcoin';
import 'starcoin';

let provider = new JsonRpcProvider("http://localhost:9850");

// Get txn info.
const txnEvents = await provider.getEventsOfTransaction(txnHash);
// get a txn event.
const txnEvent = txnEvents.pop();
// then decode with pre-determined event type in onchain_event_types.
console.log(encoding.bcsDecode(DepositEvent, txnEvent.data).toJS());

You can also see the spec in src/index.spec.ts.

Develop

> cd <project>
> yarn
> yarn dev

Publish to npm

1. change version in package.json

2. npm run build

3. npm login

4. npm config set registry https://registry.npmjs.org/ # use npm config ls to confirm

5. npm publish --access public --tag latest --dry-run # test locally before actually publishing to the registry

6. npm publish --access public --tag latest

Welcome for your PRs!