@geekberry/js-conflux-sdk

Nodejs Conflux Software Development Kit

Note: This module does not work in the browser, cause: BigInt required, CommonJS style, "ws" lib, Function eval.

• Account.js
  • Account
• Conflux.js
  • Conflux
• contract
  • Contract.js
    • Contract
• Message.js
  • Message
• provider
  • BaseProvider.js
    • BaseProvider
  • HttpProvider.js
    • HttpProvider
  • WebsocketProvider.js
    • WebsocketProvider
• Transaction.js
  • Transaction
• util
  • sign.js
    • sha3
    • checksumAddress
    • randomBuffer
    • randomPrivateKey
    • privateKeyToPublicKey
    • publicKeyToAddress
    • privateKeyToAddress
    • ecdsaSign
    • ecdsaRecover
  • unit.js
    • unit

Account

no description

Account.random

Create a new Account with random privateKey.

• Parameters

• Returns

Account

• Examples

> Account.random()
   Account {
      privateKey: '0xd28edbdb7bbe75787b84c5f525f47666a3274bb06561581f00839645f3c26f66',
      publicKey: '0xc42b53ae2ef95fee489948d33df391c4a9da31b7a3e29cf772c24eb42f74e94ab3bfe00bf29a239c17786a5b921853b7c5344d36694db43aa849e401f91566a5',
      address: '0xbcecb4a2922b7007e236daf0c797de6e55496e84'
    }
> Account.random() // gen a different account from above
   Account {
      privateKey: '0x1b67150f56f49556ef7e3899024d83c125d84990d311ec08fa98aa1433bc0f53',
      publicKey: '0xd442207828ffd4dad918fea0d75d42dbea1fe5e3789c00a82e18ce8229714eae3f70b12f2f1abd795ad3e5c52a5a597289eb5096548438c233431f498b47b9a6',
      address: '0xb6c25691aadc3363f5862d264072584f3ebf4613'
    }
> Account.random('0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff');
   Account {
      privateKey: '0x1d41e006afd28ea339922d8ab4be93154a14d4f1b6d0ad4e7aabf807e7536a5f',
      publicKey: '0x4c07c75d3fdc5b1d6afef6ec374b0eaac86bcaa771a1d536bc4ce6f111b1c60e414b370e4cf31bf7770ae6818a3518c485398a43857d9053153f6eb4f5644a90',
      address: '0x613d49784c80d6f8fdbc0bef5a5ab0d9c9fee520'
    }
> Account.random('0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff');
// gen a different account from above, even use same entropy
   Account {
      privateKey: '0x5a34ff3318674c33209ce856218890e9a6ee3811e8a51e3094ed1e6a94bf58ef',
      publicKey: '0xe530d77c3ed6115cb46ba79821085bf67d2a7a8c808c1d52dec03fd7a82e569c2136dba84b21d40f46d90484722b21a9d5a8038495adf93f2eed564ababa2422',
      address: '0x8f63fcef4aaa88c03cbb5c9fb34be69dee65d0a8'
    }

Account.prototype.constructor

Create a account by privateKey.

• Parameters

• Returns

Account

Account.prototype.signTransaction

Sign a transaction.

• Parameters

• Returns

Transaction

Account.prototype.signMessage

Sign a string.

• Parameters

• Returns

Message

• Examples

> const account = new Account('0x0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef')
> const msg = account.signMessage('Hello World!')
> console.log(msg);
   Message {
      message: 'Hello World',
      hash: '0xa1de988600a42c4b4ab089b619297c17d53cffae5d5120d82d8a92d0bb3b78f2',
      r: '0xe6bfbd768a421b9051fe86310f0f1eef9d5df65288b53f54d663f887a5b4bcd6',
      s: '0x32efb64ccc67d7245545175953e811bc237fd83ab8722d8be0a66e92ec39da81',
      v: 1
    }

> const msg = new Message({
      hash: '0xa1de988600a42c4b4ab089b619297c17d53cffae5d5120d82d8a92d0bb3b78f2',
      r: '0xe6bfbd768a421b9051fe86310f0f1eef9d5df65288b53f54d663f887a5b4bcd6',
      s: '0x32efb64ccc67d7245545175953e811bc237fd83ab8722d8be0a66e92ec39da81',
      v: 1
    });
> console.log(msg.form); // getter to recover address
   "0xfcad0b19bb29d4674531d6f115237e16afce377c"

Account.prototype.toString

no description

• Returns

string Account address as string.

Conflux

A sdk of conflux.

Conflux.prototype.constructor

no description

• Parameters

• Examples

> const Conflux = require('js-conflux-sdk');
> const cfx = new Conflux({url:'http://testnet-jsonrpc.conflux-chain.org:12537'});

> const cfx = new Conflux({
     url: 'http://localhost:8000',
     logger: console,
   });

Conflux.prototype.setProvider

Create and set provider.

• Parameters

• Returns

Object

• Examples

> cfx.provider;
   HttpProvider {
     url: 'http://testnet-jsonrpc.conflux-chain.org:12537',
     timeout: 60000,
     ...
   }
> cfx.setProvider('http://localhost:8000');
> cfx.provider;
   HttpProvider {
     url: 'http://localhost:8000',
     timeout: 60000,
     ...
   }

Conflux.prototype.Account

A shout cut for new Account(privateKey);

• Parameters

• Returns

Account

Conflux.prototype.Contract

A shout cut for new Contract(cfx, options);

• Parameters

• Returns

Contract

Conflux.prototype.close

close connection.

• Examples

> cfx.close();

Conflux.prototype.getGasPrice

Returns the current gas price oracle. The gas price is determined by the last few blocks median gas price.

• Returns

Promise.<BigInt> Gas price in drip.

• Examples

> await cfx.getGasPrice();
   "0"

Conflux.prototype.getEpochNumber

Returns the current epochNumber the client is on.

• Parameters

• Returns

Promise.<number> EpochNumber

• Examples

> await cfx.getEpochNumber();
   200109

Conflux.prototype.getLogs

Gets past logs, matching the given options.

• Parameters

• Returns

Promise.<LogIterator> Array of log objects.

• string address: Address this event originated from.
• string[] topics: An array with max 4 32 Byte topics, topic 1-3 contains indexed parameters of the event.
• string data: The data containing non-indexed log parameter.
• string type: TODO
• boolean removed: TODO
• number epochNumber: The epochNumber this log was created in. null when still pending.
• string blockHash: Hash of the block this event was created in. null when it’s still pending.
• string transactionHash: Hash of the transaction this event was created in.
• string transactionIndex: Integer of the transaction’s index position the event was created in.
• number logIndex: Integer of the event index position in the block.
• number transactionLogIndex: Integer of the event index position in the transaction.

• Examples

> await cfx.getLogs({
      address: '0xbd72de06cd4a94ad31ed9303cf32a2bccb82c404',
      fromEpoch: 0,
      toEpoch: 'latest_mined',
      limit: 1,
      topics: [
        '0xb818399ffd68e821c34de8d5fbc5aeda8456fdb9296fc1b02bf6245ade7ebbd4',
        '0x0000000000000000000000001ead8630345121d19ee3604128e5dc54b36e8ea6'
      ]
    });

   [
   {
      address: '0xbd72de06cd4a94ad31ed9303cf32a2bccb82c404',
      blockHash: '0x701afee0ffc49aaebadf0e6618b6ec1715d31e7aa639e2e00dc8df10994e0283',
      data: '0x',
      epochNumber: 542556,
      logIndex: 0,
      removed: false,
      topics: [
        '0xb818399ffd68e821c34de8d5fbc5aeda8456fdb9296fc1b02bf6245ade7ebbd4',
        '0x0000000000000000000000001ead8630345121d19ee3604128e5dc54b36e8ea6'
      ],
      transactionHash: '0x5a301d2c342709d7de9da24bd096ab3754ea328b016d85ab3410d375616f5d0d',
      transactionIndex: 0,
      transactionLogIndex: 0,
      type: 'mined'
     },
   ]

> logIter = cfx.getLogs({
      address: '0xbd72de06cd4a94ad31ed9303cf32a2bccb82c404',
      fromEpoch: 'latest_mined',
      limit: 2,
      })
> await logIter.next({threshold: 0.01, delta: 1000});
   {
      address: '0xbd72de06cd4a94ad31ed9303cf32a2bccb82c404',
      ...
   }
> await logIter.next();
   {
      address: '0xbd72de06cd4a94ad31ed9303cf32a2bccb82c404',
      ...
   }
> await logIter.next();
   undefined

> logIter = cfx.getLogs({
      address: '0xbd72de06cd4a94ad31ed9303cf32a2bccb82c404',
      fromEpoch: 'latest_mined',
      limit: 2,
      })
> for await (const log of iter) {
       console.log(log);
     }
   {
      address: '0xbd72de06cd4a94ad31ed9303cf32a2bccb82c404',
      ...
   }
   ...

Conflux.prototype.getBalance

Get the balance of an address at a given epochNumber.

• Parameters

• Returns

Promise.<BigInt> Address balance number in drip.

• Examples

> let balance = await cfx.getBalance("0xbbd9e9be525ab967e633bcdaeac8bd5723ed4d6b");
> balance;
   1793636034970586632n
> balance = await cfx.getBalance("0xbbd9e9be525ab967e633bcdaeac8bd5723ed4d6b", 0);
> balance.toString(10);
   "0"

Conflux.prototype.getTransactionCount

Get the numbers of transactions sent from this address.

• Parameters

• Returns

Promise.<number>

• Examples

> await cfx.getTransactionCount("0xbbd9e9be525ab967e633bcdaeac8bd5723ed4d6b");
   61
> await cfx.getTransactionCount("0xbbd9e9be525ab967e633bcdaeac8bd5723ed4d6b", 0);
   0

Conflux.prototype.getBlockByEpochNumber

Get the epochNumber pivot block info.

• Parameters

• Returns

Promise.<(object|null)> The block info (same as getBlockByHash).

• Examples

> await cfx.getBlockByEpochNumber(449);
   {
     hash: '0x59339ff28bc235cceac9fa588ebafcbf61316e6a8c86c7a1d7239b9445d98e40',
     ...
   }

Conflux.prototype.getBlocksByEpochNumber

Get block hash array of a epochNumber.

• Parameters

• Returns

Promise.<Array.<string>> Block hash array, last one is the pivot block hash of this epochNumber.

• Examples

> await cfx.getBlocksByEpochNumber(0);
   ['0x2da120ad267319c181b12136f9e36be9fba59e0d818f6cc789f04ee937b4f593']
> await cfx.getBlocksByEpochNumber(449);
   [
   '0x3d8b71208f81fb823f4eec5eaf2b0ec6b1457d381615eff2fbe24605ea333c39',
   '0x59339ff28bc235cceac9fa588ebafcbf61316e6a8c86c7a1d7239b9445d98e40'
   ]

Conflux.prototype.getBestBlockHash

TODO

• Returns

Promise.<string>

• Examples

> await cfx.getBestBlockHash();
   "0x43ddda130fff8539b9f3c431aa1b48e021b3744aacd224cbd4bcdb64373f3dd5"

Conflux.prototype.getBlockByHash

Returns a block matching the block hash.

• Parameters

• Returns

Promise.<(object|null)> Block info object.

• string miner: The address of the beneficiary to whom the mining rewards were given.
• string|null hash: Hash of the block. null when its pending block.
• string parentHash: Hash of the parent block.
• string[] refereeHashes: Array of referee hashes.
• number|null epochNumber: The current block epochNumber in the client's view. null when it's not in best block's past set.
• boolean|null stable: If the block stable or not. null for pending stable.
• string nonce: Hash of the generated proof-of-work. null when its pending block.
• number gas: The maximum gas allowed in this block.
• string difficulty: Integer string of the difficulty for this block.
• number height: The block heights. null when its pending block.
• number size: Integer the size of this block in bytes.
• number blame: 0 if there's nothing to blame; k if the block is blaming on the state info of its k-th ancestor.
• boolean adaptive: If the block's weight adaptive or not.
• number timestamp: The unix timestamp for when the block was collated.
• string transactionsRoot: The hash of the transactions of the block.
• string[] transactions: Array of transaction objects, or 32 Bytes transaction hashes depending on the last given parameter.
• string deferredLogsBloomHash: The hash of the deferred block's log bloom filter
• string deferredReceiptsRoot: The hash of the receipts of the block after deferred execution.
• string deferredStateRoot: The root of the final state trie of the block after deferred execution.
• object deferredStateRootWithAux: Information of deferred state root

• Examples

> await cfx.getBlockByHash('0xc6fd0c924b1bb2a828d622b46bad4c3806bc1b778f545adb457c5de0aedd0e80');
   {
      epochNumber: 231939,
      height: 231939,
      size: 384,
      timestamp: 1578972801,
      gasLimit: 3000000000n,
      difficulty: 29649377n,
      transactions: [
        '0x62c94c660f6ae9191bd3ff5e6c078015f84a3ad3f22e14c97f3b1117549b8530'
      ],
      stable: true,
      adaptive: false,
      blame: 0,
      deferredLogsBloomHash: '0xd397b3b043d87fcd6fad1291ff0bfd16401c274896d8c63a923727f077b8e0b5',
      deferredReceiptsRoot: '0x959684cc863003d5ac5cb31bcf5baf7e1b4fc60963fcc36fbc1bf4394a0e2e3c',
      deferredStateRoot: '0xa930f70fc49e1ab5441031775138817ff951421fad1298b69cda26a10f1fe2b9',
      hash: '0xc6fd0c924b1bb2a828d622b46bad4c3806bc1b778f545adb457c5de0aedd0e80',
      miner: '0x0000000000000000000000000000000000000014',
      nonce: '0xd7adc50635950329',
      parentHash: '0xd601491dc9e0f80ceccbf0142490fcb47a4e1801d6fcea34119ffc338b59712c',
      refereeHashes: [
        '0x6826206c6eaa60a6950182f90d2a608c07c7af6802131204f7365c1e96b1f85c'
      ],
      transactionsRoot: '0xe26c8940951305914fa69b0a8e431255962cfe95f2481283ec08437eceec03e2'
    }

> await cfx.getBlockByHash('0x59339ff28bc235cceac9fa588ebafcbf61316e6a8c86c7a1d7239b9445d98e40', true);
   {
    hash: '0xc6fd0c924b1bb2a828d622b46bad4c3806bc1b778f545adb457c5de0aedd0e80',
    transactions: [
      {
        nonce: 1,
        value: 0n,
        gasPrice: 10n,
        gas: 10000000n,
        v: 1,
        transactionIndex: 0,
        status: 0,
        blockHash: '0xc6fd0c924b1bb2a828d622b46bad4c3806bc1b778f545adb457c5de0aedd0e80',
        contractCreated: null,
        data: '0x47e7ef2400000000000000000000000099b52de54f2f922fbd6e46d99654d2063bd7f0dc00000000000000000000000000000000000000000000000000000000000003e8',
        from: '0x99b52de54f2f922fbd6e46d99654d2063bd7f0dc',
        hash: '0x62c94c660f6ae9191bd3ff5e6c078015f84a3ad3f22e14c97f3b1117549b8530',
        r: '0xdc383e4afb5b389e4074e6d4acbb847fd0908bbca60602d66e60169f1340630',
        s: '0x14efbc60c095b507609639b219d233418a7fc7ee835902e69e1735897b45fb38',
        to: '0x28d995f3818426dbbe8e357cc1cdb67be043b0df'
      }
    ],
    ...
   }

Conflux.prototype.getBlockByHashWithPivotAssumption

Get block by blockHash if pivot block of epochNumber is pivotBlockHash.

• Parameters

• Returns

Promise.<object> The block info (same as getBlockByHash).

• Examples

> await cfx.getBlockByHashWithPivotAssumption(
   '0x3d8b71208f81fb823f4eec5eaf2b0ec6b1457d381615eff2fbe24605ea333c39',
   '0x59339ff28bc235cceac9fa588ebafcbf61316e6a8c86c7a1d7239b9445d98e40'
   449,
   );
   {
     hash: '0x3d8b71208f81fb823f4eec5eaf2b0ec6b1457d381615eff2fbe24605ea333c39',
     ...
   }

Conflux.prototype.getTransactionByHash

Returns a transaction matching the given transaction hash.

• Parameters

• Returns

Promise.<(object|null)> Transaction info object

• string blockHash: Hash of the block where this transaction was in and got executed. null when its pending.
• number transactionIndex: Integer of the transactions index position in the block.
• string hash: Hash of the transaction.
• number nonce: The number of transactions made by the sender prior to this one.
• string from: Address of the sender.
• string to: Address of the receiver. null when its a contract creation transaction.
• string value: Value transferred in Drip.
• string data: The data send along with the transaction.
• number gas: Gas provided by the sender.
• number gasPrice: Gas price provided by the sender in Drip.
• string status: '0x0' successful execution; '0x1' exception happened but nonce still increased; '0x2' exception happened and nonce didn't increase.
• string|null contractCreated: The contract address created, if the transaction was a contract creation, otherwise null.
• string r: ECDSA signature r
• string s: ECDSA signature s
• string v: ECDSA recovery id

• Examples

> await cfx.getTransactionByHash('0xbe007c3eca92d01f3917f33ae983f40681182cf618defe75f490a65aac016914');
   {
      "blockHash": "0x59339ff28bc235cceac9fa588ebafcbf61316e6a8c86c7a1d7239b9445d98e40",
      "transactionIndex": 0,
      "hash": "0xbe007c3eca92d01f3917f33ae983f40681182cf618defe75f490a65aac016914",
      "nonce": 0,
      "from": "0xa70ddf9b9750c575db453eea6a041f4c8536785a",
      "to": "0x63f0a574987f6893e068a08a3fb0e63aec3785e6",
      "value": "1000000000000000000"
      "data": "0x",
      "gas": 21000,
      "gasPrice": "819",
      "status": 0,
      "contractCreated": null,
      "r": "0x88e43a02a653d5895ffa5495718a5bd772cb157776108c5c22cee9beff890650",
      "s": "0x24e3ba1bb0d11c8b1da8d969ecd0c5e2372326a3de71ba1231c876c0efb2c0a8",
      "v": 0,
    }

Conflux.prototype.getTransactionReceipt

Returns the receipt of a transaction by transaction hash.

Note: The receipt is not available for pending transactions and returns null.

• Parameters

• Returns

Promise.<(object|null)> - number outcomeStatus: 0: the transaction was successful, 1: EVM reverted the transaction.

• string stateRoot: The state root of transaction execution.
• number epochNumber: EpochNumber where this transaction was in.
• string blockHash: Hash of the block where this transaction was in.
• string transactionHash: Hash of the transaction.
• number index: Integer of the transactions index position in the block.
• string from: Address of the sender.
• string to: Address of the receiver. null when its a contract creation transaction.
• string|null contractCreated: The contract address created, if the transaction was a contract creation, otherwise null.
• number gasUsed: The amount of gas used by this specific transaction alone.
• [object] logs: Array of log objects, which this transaction generated.
• [string] logs[].address: The address of the contract executing at the point of the LOG operation.
• [string] logs[].topics: The topics associated with the LOG operation.
• [string] logs[].data: The data associated with the LOG operation.
• string logsBloom: Log bloom.

• Examples

> await cfx.getTransactionReceipt('0xbe007c3eca92d01f3917f33ae983f40681182cf618defe75f490a65aac016914');
   {
    "outcomeStatus": 0,
    "stateRoot": "0x3854f64be6c124dffd0ddca57270846f0f43a119ea681b4e5d022ade537d9f07",
    "epochNumber": 449,
    "blockHash": "0x59339ff28bc235cceac9fa588ebafcbf61316e6a8c86c7a1d7239b9445d98e40",
    "transactionHash": "0xbe007c3eca92d01f3917f33ae983f40681182cf618defe75f490a65aac016914"
    "index": 0,
    "from": "0xa70ddf9b9750c575db453eea6a041f4c8536785a",
    "to": "0x63f0a574987f6893e068a08a3fb0e63aec3785e6",
    "contractCreated": null,
    "gasUsed": 21000,
    "logs": [],
    "logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
   }

Conflux.prototype.sendTransaction

Creates new message call transaction or a contract creation, if the data field contains code.

FIXME: rpc cfx_sendTransaction not implement yet.

NOTE: if from options is a instance of Account, this methods will sign by account local and send by cfx_sendRawTransaction, else send by cfx_sendTransaction

• Parameters

• Returns

Promise.<PendingTransaction> The PendingTransaction object.

• Examples

> // TODO call with address, need `cfx_sendTransaction`

> const account = cfx.Account(KEY);
> await cfx.sendTransaction({
      from: account, // from account instance will sign by local.
      to: ADDRESS,
      value: Drip.fromCFX(0.023),
    });
   "0x459473cb019bb59b935abf5d6e76d66564aafa313efd3e337b4e1fa6bd022cc9"

> await cfx.sendTransaction({
      from: account,
      to: account, // to account instance
      value: Drip.fromCFX(0.03),
    }).get(); // send then get transaction by hash.
   {
    "blockHash": null,
    "transactionIndex": null,
    "hash": "0xf2b258b49d33dd22419526e168ebb79b822889cf8317ce1796e816cce79e49a2",
    "contractCreated": null,
    "data": "0x",
    "from": "0xbbd9e9be525ab967e633bcdaeac8bd5723ed4d6b",
    "nonce": 111,
    "status": null,
    "to": "0xbbd9e9be525ab967e633bcdaeac8bd5723ed4d6b",
    "value": "30000000000000000",
    ...
   }

> const promise = cfx.sendTransaction({ // Not await here, just get promise
      from: account1,
      to: ADDRESS1,
      value: Drip.fromCFX(0.007),
    });
> await promise; // transaction
   "0x91fbdfb33f3a585f932c627abbe268c7e3aedffc1633f9338f9779c64702c688"
> await promise.get(); // get transaction
   {
    "blockHash": null,
    "transactionIndex": null,
    "hash": "0x91fbdfb33f3a585f932c627abbe268c7e3aedffc1633f9338f9779c64702c688",
    ...
   }
> await promise.mined(); // wait till transaction mined
   {
    "blockHash": "0xe9b22ce311003e26c7330ac54eea9f8afea0ffcd4905828f27c9e2c02f3a00f7",
    "transactionIndex": 0,
    "hash": "0x91fbdfb33f3a585f932c627abbe268c7e3aedffc1633f9338f9779c64702c688",
    ...
   }
> await promise.executed(); // wait till transaction executed in right status. and return it's receipt.
   {
    "blockHash": "0xe9b22ce311003e26c7330ac54eea9f8afea0ffcd4905828f27c9e2c02f3a00f7",
    "index": 0,
    "transactionHash": "0x91fbdfb33f3a585f932c627abbe268c7e3aedffc1633f9338f9779c64702c688",
    "outcomeStatus": 0,
    ...
   }
> await promise.confirmed(); // wait till transaction risk coefficient '<' threshold.
   {
    "blockHash": "0xe9b22ce311003e26c7330ac54eea9f8afea0ffcd4905828f27c9e2c02f3a00f7",
    "index": 0,
    "transactionHash": "0x91fbdfb33f3a585f932c627abbe268c7e3aedffc1633f9338f9779c64702c688",
    "outcomeStatus": 0,
    ...
   }

Conflux.prototype.sendRawTransaction

Signs a transaction. This account needs to be unlocked.

• Parameters

• Returns

Promise.<PendingTransaction> The PendingTransaction object. See sendTransaction

• Examples

> await cfx.sendRawTransaction('0xf85f800382520894bbd9e9b...');
   "0xbe007c3eca92d01f3917f33ae983f40681182cf618defe75f490a65aac016914"

Conflux.prototype.getCode

Get the code at a specific address.

• Parameters

• Returns

Promise.<string> Code hex string

• Examples

> await cfx.getCode('0xb385b84f08161f92a195953b980c8939679e906a');
   "0x6080604052348015600f57600080fd5b506004361060325760003560e01c806306661abd1460375780638..."

Conflux.prototype.call

Executes a message call transaction, which is directly executed in the VM of the node, but never mined into the block chain.

• Parameters

• Returns

Promise.<string> Hex bytes the contract method return.

Conflux.prototype.estimateGas

Executes a message call or transaction and returns the amount of the gas used.

• Parameters

• Returns

Promise.<BigInt> The used gas for the simulated call/transaction.

Contract

Contract with all its methods and events defined in its abi.

Contract.prototype.constructor

no description

• Parameters

• Returns

object

• Examples

> const contract = cfx.Contract({ abi, code });
> contract instanceof Contract;
   true
> contract.abi; // input abi
   [{type:'constructor', inputs:[...]}, ...]
> contract.constructor.code; // input code
   "0x6080604052600080..."

> const contract = cfx.Contract({ abi, address });
> contract.address
   "0xc3ed1a06471be1d3bcd014051fbe078387ec0ad8"
> await contract.count(); // call a method without parameter, get decoded return value.
   100n
> await contract.inc(1); // call a method with parameters, get decoded return value.
   101n
> await contract.count().call({ from: account }); // call a method from a account.
   100n
> await contract.count().estimateGas();
   21655n
> await contract.count().estimateGas({ from: ADDRESS, nonce: 68 }); // if from is a address string, nonce is required
   21655n
// send transaction from account instance, then wait till confirmed, and get receipt.
> await contract.inc(1)
   .sendTransaction({ from: account1 })
   .confirmed({ threshold: 0.01, timeout: 30 * 1000 });
   {
     "blockHash": "0xba948c8925f6d7f14faf540c3b9e6d24d33c78168b2dd81a6021a50949d9f0d7",
     "index": 0,
     "transactionHash": "0x8a5f48c2de0f1bdacfe90443810ad650e4b327a0d19ce49a53faffb224883e42",
     "outcomeStatus": 0,
     ...
   }
> tx = await cfx.getTransactionByHash('0x8a5f48c2de0f1bdacfe90443810ad650e4b327a0d19ce49a53faffb224883e42');
> await contract.abi.decodeData(tx.data)
   {
     name: 'inc',
     params: NamedTuple(num) [ 100n ]
   }
> await contract.count(); // data in block chain changed by transaction.
   101n
> logs = await contract.SelfEvent(account1.address).getLogs()
   [
   {
      address: '0xc3ed1a06471be1d3bcd014051fbe078387ec0ad8',
      blockHash: '0xc8cb678891d4914aa66670e3ebd7a977bb3e38d2cdb1e2df4c0556cb2c4715a4',
      data: '0x000000000000000000000000000000000000000000000000000000000000000a',
      epochNumber: 545896,
      logIndex: 0,
      removed: false,
      topics: [
        '0xc4c01f6de493c58245fb681341f3a76bba9551ce81b11cbbb5d6d297844594df',
        '0x000000000000000000000000bbd9e9be525ab967e633bcdaeac8bd5723ed4d6b'
      ],
      transactionHash: '0x9100f4f84f711aa358e140197e9d2e5aab1f99751bc26a660d324a8282fc54d0',
      transactionIndex: 0,
      transactionLogIndex: 0,
      type: 'mined',
      params: [ '0xbbd9e9be525ab967e633bcdaeac8bd5723ed4d6b', '10' ]
     }
   ]
> contract.abi.decodeLog(logs[0]);
   {
      name: "SelfEvent",
      params: NamedTuple(sender,current) [
        '0xbbd9e9be525ab967e633bcdaeac8bd5723ed4d6b',
        100n
      ]
    }

Message

no description

Message.prototype.constructor

no description

• Parameters

• Returns

Message

• Examples

> msg = new Message({ message: 'Hello World' });
   Message {
      message: 'Hello World',
      hash: '0x592fa743889fc7f92ac2a37bb1f5ba1daf2a5c84741ca0e0061d243a2e6707ba',
      r: undefined,
      s: undefined,
      v: undefined
    }
> msg.sign('0x0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef');
   Message {
      message: 'Hello World',
      hash: '0x592fa743889fc7f92ac2a37bb1f5ba1daf2a5c84741ca0e0061d243a2e6707ba',
      r: '0x6e913e2b76459f19ebd269b82b51a70e912e909b2f5c002312efc27bcc280f3c',
      s: '0x29134d382aad0dbd3f0ccc9f0eb8f1dbe3f90141d81574ebb6504156b0d7b95f',
      v: 1,
    }
> msg.signature
   "0x6e913e2b76459f19ebd269b82b51a70e912e909b2f5c002312efc27bcc280f3c29134d382aad0dbd3f0ccc9f0eb8f1dbe3f90141d81574ebb6504156b0d7b95f01"
> msg.from
   "0xfcad0b19bb29d4674531d6f115237e16afce377c"

Message.prototype.from (getter)

Getter of sender address.

Note: calculate every time.

• Returns

string,undefined If ECDSA recover success return address, else return undefined.

Message.prototype.signature (getter)

Getter signature of message r,s,v.

• Returns

string

Message.prototype.sign

Sign message and set 'r','s','v' and 'hash'.

• Parameters

• Returns

Message

Message.prototype.recover

Recover public key from signed Transaction.

• Returns

string

BaseProvider

no description

BaseProvider.prototype.constructor

no description

• Parameters

• Returns

BaseProvider

BaseProvider.prototype.requestId

Gen a random json rpc id. It is used in call method, overwrite it to gen your own id.

• Returns

string

BaseProvider.prototype.call

Call a json rpc method with params

• Parameters

• Returns

Promise.<*> Json rpc method return value.

• Examples

> await provider.call('cfx_epochNumber');
> await provider.call('cfx_getBlockByHash', blockHash);

BaseProvider.prototype.close

Disconnect

HttpProvider

Http protocol json rpc provider.

HttpProvider.prototype.constructor

no description

• Parameters

• Returns

HttpProvider

• Examples

> const provider = new HttpProvider('http://testnet-jsonrpc.conflux-chain.org:12537', {logger: console});

WebsocketProvider

Web socket protocol json rpc provider.

WebsocketProvider.prototype.constructor

no description

• Parameters

• Returns

WebsocketProvider

• Examples

> const provider = new WebsocketProvider('ws://testnet-jsonrpc.conflux-chain.org:8080', {logger: console});

Transaction

no description

Transaction.prototype.constructor

Create a transaction.

• Parameters

• Returns

Transaction

Transaction.prototype.hash (getter)

Getter of transaction hash include signature.

Note: calculate every time.

• Returns

string,undefined If transaction has r,s,v return hex string, else return undefined.

Transaction.prototype.from (getter)

Getter of sender address.

Note: calculate every time.

• Returns

string,undefined If ECDSA recover success return address, else return undefined.

Transaction.prototype.sign

Sign transaction and set 'r','s','v'.

• Parameters

• Returns

Transaction

Transaction.prototype.recover

Recover public key from signed Transaction.

• Returns

string

Transaction.prototype.encode

Encode rlp.

• Parameters

• Returns

Buffer

Transaction.prototype.serialize

Get the raw tx hex string.

• Returns

string Hex string

format.any (setter)

no description

• Parameters

• Returns

any arg

• Examples

> format.any(1)
 1

format.hex (setter)

When encoding UNFORMATTED DATA (byte arrays, account addresses, hashes, bytecode arrays): encode as hex, prefix with "0x", two hex digits per byte.

• Parameters

• Returns

string Hex string

• Examples

> format.hex(null)
 '0x'
> format.hex(1)
 "0x01"
> format.hex(256)
 "0x0100"
> format.hex(true)
 "0x01"
> format.hex(Buffer.from([1,10,255]))
 "0x010aff"
> format.hex("0x0a")
 "0x0a"

format.bigUInt (setter)

no description

• Parameters

• Returns

BigInt

• Examples

> format.uint(-3.14)
 Error("not match uint")
> format.uint('0')
 0n
> format.uint(1)
 1n
> format.uint(BigInt(100))
 100n
> format.uint('0x10')
 16n
> format.uint(Number.MAX_SAFE_INTEGER + 1) // unsafe integer
 Error("not match uint")

format.uint (setter)

no description

• Parameters

• Returns

Number

• Examples

> format.uint(-3.14)
 Error("cannot be converted to a BigInt")
> format.uint(null)
 Error("Cannot convert null to a BigInt")
> format.uint('0')
 0
> format.uint(1)
 1
> format.uint(BigInt(100))
 100
> format.uint('0x10')
 16
> format.uint('')
 0
> format.uint(true)
 1
> format.uint(false)
 0
> format.uint(Number.MAX_SAFE_INTEGER + 1) // unsafe integer
 Error("not match uint")

format.numberHex (setter)

When encoding QUANTITIES (integers, numbers): encode as hex, prefix with "0x", the most compact representation (slight exception: zero should be represented as "0x0")

• Parameters

• Returns

string Hex string

• Examples

> format.numberHex(100)
 "0x64"
> format.numberHex(10)
 "0xa"
> format.numberHex(3.50)
 "0x4"
> format.numberHex(3.49)
 "0x3"
> format.numberHex(-1))
 Error("not match uintHex")

format.epochNumber (setter)

no description

• Parameters

• Returns

string

• Examples

> format.epochNumber(10)
 "0xa"
> format.epochNumber('latest_state')
 "latest_state"
> format.epochNumber('latest_mined')
 "latest_state"

format.address (setter)

no description

• Parameters

• Returns

string Hex string

• Examples

> format.address('0x0123456789012345678901234567890123456789')
 "0x0123456789012345678901234567890123456789"
> format.address('0x0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef')
 Error("not match address")

format.publicKey (setter)

no description

• Parameters

• Returns

string Hex string

• Examples

> format.publicKey('0x0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef')
 "0x0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"
> format.publicKey('0x0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef')
 Error("not match publicKey")

format.privateKey (setter)

no description

• Parameters

• Returns

string Hex string

• Examples

> format.privateKey('0x0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef')
 "0x0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"
> format.privateKey('0x0123456789012345678901234567890123456789')
 Error("not match hex64")

format.signature (setter)

no description

• Parameters

• Returns

string Hex string

format.blockHash (setter)

no description

• Parameters

• Returns

string Hex string

• Examples

> format.privateKey('0x0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef')
 "0x0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"
> format.privateKey('0x0123456789012345678901234567890123456789')
 Error("not match hex64")

format.txHash (setter)

no description

• Parameters

• Returns

string Hex string

• Examples

> format.privateKey('0x0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef')
 "0x0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"
> format.privateKey('0x0123456789012345678901234567890123456789')
 Error("not match hex64")

format.buffer (setter)

no description

• Parameters

• Returns

Buffer

• Examples

> format.buffer(Buffer.from([0, 1]))
 <Buffer 00 01>
> format.buffer(null)
 <Buffer >
> format.buffer(1024)
 <Buffer 04 00>
> format.buffer('0x0a')
 <Buffer 0a>
> format.buffer(true)
 <Buffer 01>
> format.buffer(3.14)
 Error("not match hex")

format.boolean (setter)

no description

• Parameters

• Returns

boolean

• Examples

> format.boolean(true)
 true
> format.boolean(false)
 false

sha3

sha3

• Parameters

• Returns

Buffer

• Examples

> sha3(Buffer.from(''))
 <Buffer c5 d2 46 01 86 f7 23 3c 92 7e 7d b2 dc c7 03 c0 e5 00 b6 53 ca 82 27 3b 7b fa d8 04 5d 85 a4 70>

checksumAddress

Makes a checksum address

• Parameters

• Returns

string

• Examples

> checksumAddress('0xfb6916095ca1df60bb79ce92ce3ea74c37c5d359')
 "0xfB6916095ca1df60bB79Ce92cE3Ea74c37c5d359"

randomBuffer

gen a random buffer with size bytes.

Note: call crypto.randomBytes

• Parameters

• Returns

Buffer

• Examples

> randomBuffer(0)
 <Buffer >
> randomBuffer(1)
 <Buffer 33>
> randomBuffer(1)
 <Buffer 5a>

randomPrivateKey

Gen a random PrivateKey buffer.

• Parameters

• Returns

Buffer

• Examples

> randomPrivateKey()
 <Buffer 23 fb 3b 2b 1f c9 36 8c a4 8e 5b dc c7 a9 e2 bd 67 81 43 3b f2 3a cc da da ff a9 dd dd b6 08 d4>
> randomPrivateKey()
 <Buffer e7 5b 68 fb f9 50 19 94 07 80 d5 13 2e 40 a7 f9 a1 b0 5d 72 c8 86 ca d1 c6 59 cd a6 bf 37 cb 73>

> entropy = randomBuffer(32)
> randomPrivateKey(entropy)
 <Buffer 57 90 e8 3d 16 10 02 b9 a4 33 87 e1 6b cd 40 7e f7 22 b1 d8 94 ae 98 bf 76 a4 56 fb b6 0c 4b 4a>
> randomPrivateKey(entropy) // same `entropy`
 <Buffer 89 44 ef 31 d4 9c d0 25 9f b0 de 61 99 12 4a 21 57 43 d4 4b af ae ef ae e1 3a ba 05 c3 e6 ad 21>

privateKeyToPublicKey

no description

• Parameters

• Returns

Buffer

publicKeyToAddress

Get address by public key.

• Parameters

• Returns

Buffer

• Examples

> privateKeyToAddress(Buffer.from([0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 1]))
 <Buffer 4c 6f a3 22 12 5f a3 1a 42 cb dd a8 73 0d 4c f0 20 0d 72 db>

privateKeyToAddress

Get address by private key.

• Parameters

• Returns

Buffer

• Examples

> privateKeyToAddress(Buffer.from([0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 1]))
 <Buffer 0d b9 e0 02 85 67 52 28 8b ef 47 60 fa 67 94 ec 83 a8 53 b9>

ecdsaSign

Sign ecdsa

• Parameters

• Returns

object ECDSA signature object.

• r {Buffer}
• s {Buffer}
• v {number}

• Examples

> privateKey = Buffer.from([0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 1]);
> buffer32 = Buffer.from([0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31])
> ecdsaSign(buffer32, privateKey)
 {
  r: <Buffer 21 ab b4 c3 fd 51 75 81 e6 c7 e7 e0 7f 40 4f a2 2c ba 8d 8f 71 27 0b 29 58 42 b8 3c 44 b5 a4 c6>,
  s: <Buffer 08 59 7b 69 8f 8f 3c c2 ba 0b 45 ee a7 7f 55 29 ad f9 5c a5 51 41 e7 9b 56 53 77 3d 00 5d 18 58>,
  v: 0
 }

ecdsaRecover

Recover ecdsa

• Parameters

• Returns

Buffer publicKey

• Examples

> privateKey = Buffer.from([0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 1])
> buffer32 = Buffer.from([0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31])
> privateKeyToAddress(privateKey)
 <Buffer 0d b9 e0 02 85 67 52 28 8b ef 47 60 fa 67 94 ec 83 a8 53 b9>
> publicKeyToAddress(ecdsaRecover(buffer32, ecdsaSign(buffer32, privateKey)))
 <Buffer 0d b9 e0 02 85 67 52 28 8b ef 47 60 fa 67 94 ec 83 a8 53 b9>

unit

Unit converter factory

• Parameters

• Returns

function

• Examples

> unit('cfx', 'drip')(1)
 1000000000000000000n
> unit('drip', 'cfx')(1000000000000000000)
 1n