Skip to content

smart-dag/sdag.js

Repository files navigation

SDAG.js

A Javascript SDAG library for Web broswers and Node.js.

Installing

npm install sdag.js

API Documentation

Almost all network APIs are promise-style, await/async is recommended.

HubClient

The core class of SDAG.js.

import { HubClient } from 'sdag.js';

let client = new HubClient();
Method Description Return
connect Connect to a hub boolean
getJoint Get a joint from hub PropertyJoint
getNetworkInfo Get the latest net info NetworkInfo
getBalance Query the balance of specified address Balance
getTxsByAddress Query history txs of specified address Transaction[]
getJointsByMci Query joints by mci Joint[]
getJointsByLevel Query joints between levels JointLevel[][]
getFreeJoints Query free joints Joint[]
transfer Transfer assets string

Keyman

SDAG keys manager. You should use this class to manage users' addresses and private keys.

import { Keyman , HubClient } from 'sdag.js';

let client = new HubClient();
let man = new Keyman(mnemnoic, passphrase);

// Sign a transaction when transferring assets

await client.transfer({ to: 'To', from: 'From', amount: 2, ecdsaPubkey: man.mainEcdsaPubKey }, (hash) => man.sign(hash));


// Sign and verify text messages

let signed = man.signMessage('hello sdag');
let ok = man.verifyMessage('hello sdag', signed);
let ok2 = man.verifyMessage('other message' ,otherSignedMessage, otherPubkey);
Method Description Return
constructor The mnemonic code is required
genAddress Generate a address by index string
sign Sign unit hash when you transfer assets string
verify Verify a signed string boolean
ecdsaPubkey Gen a ecdsa pub key by index string
signMessage Sign a text message string
verifyMessage Verify a text message boolean

License

GPL-3.0

About

No description, website, or topics provided.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors