@geekberry/js-conflux-sdk

JavaScript Conflux Software Development Kit

Usage no npm install needed!

<script type="module">
  import geekberryJsConfluxSdk from 'https://cdn.skypack.dev/@geekberry/js-conflux-sdk';
</script>

README

@geekberry/js-conflux-sdk

ChecksumAddress

Checksum address by CIP-37

ChecksumAddress.fromObject

From object to CIP-37 address

  • Parameters
Name Type Required Default Description
options object true
options.netName string true Net name
options.addressType string true Address Type
options.payload string true Base32 address payload
options.checksum string true Base32 address checksum
  • Returns

ChecksumAddress

  • Examples
> ChecksumAddress.fromObject({
     netName: 'CFX',
     addressType: 'USER',
     payload: 'ACC7UAWF5UBTNMEZVHU9DHC6SGHEA0403Y',
     checksum: '2DGPYFJP',
   })
   "CFX:TYPE.CONTRACT:ACC7UAWF5UBTNMEZVHU9DHC6SGHEA0403Y2DGPYFJP"

ChecksumAddress.fromSimple

From simple address string to complete CIP-37 address

  • Parameters
Name Type Required Default Description
string string true
  • Returns

ChecksumAddress

  • Examples
> ChecksumAddress.fromSimple('cfx:acc7uawf5ubtnmezvhu9dhc6sghea0403y2dgpyfjp')
   "CFX:TYPE.CONTRACT:ACC7UAWF5UBTNMEZVHU9DHC6SGHEA0403Y2DGPYFJP"

ChecksumAddress.fromBuffer

From bytes20 address buffer to CIP-37 address

  • Parameters
Name Type Required Default Description
buffer Buffer true
netName string false 'CFX'
  • Returns

ChecksumAddress

  • Examples
> ChecksumAddress.fromBuffer(Buffer.alloc(20))
   'CFX:TYPE.NULL:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA0SFBNJM2'

ChecksumAddress.fromHex

From hex40 address to CIP-37 address

  • Parameters
Name Type Required Default Description
hex string true Hex 40 address
netName string false Net name
  • Returns

ChecksumAddress

  • Examples
> ChecksumAddress.fromHex('0x0000000000000000000000000000000000000000')
   'CFX:TYPE.NULL:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA0SFBNJM2'
> ChecksumAddress.fromHex('0x0000000000000000000000000000000000000000', 'CFXTEST')
   'CFXTEST:TYPE.NULL:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA6F0VRCSW'
> ChecksumAddress.fromHex('0x0000000000000000000000000000000000000000', 'NET8')
   'NET8:TYPE.NULL:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABM73N8R6'

ChecksumAddress.prototype.constructor

Checksum address by CIP-37

  • Parameters
Name Type Required Default Description
string string true CIP-37 address
  • Examples
> new ChecksumAddress('CFX:TYPE.USER:AARC9ABYCUE0HHZGYRR53M6CXEDGCCRMMYYBJGH4XG')
   'CFX:TYPE.USER:AARC9ABYCUE0HHZGYRR53M6CXEDGCCRMMYYBJGH4XG'
> ChecksumAddress('CFX:TYPE.CONTRACT:ACC7UAWF5UBTNMEZVHU9DHC6SGHEA0403Y2DGPYFJP') // without `new`
   'CFX:TYPE.CONTRACT:ACC7UAWF5UBTNMEZVHU9DHC6SGHEA0403Y2DGPYFJP'

ChecksumAddress.prototype.isValid

Return address checksum is valid

  • Returns

boolean

  • Examples
> ChecksumAddress('CFX:TYPE.NULL:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA0SFBNJM2').isValid()
   true
> ChecksumAddress('CFX:TYPE.NULL:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA0SFBNJM3').isValid()
   false

ChecksumAddress.prototype.toObject

Inverse operation of ChecksumAddress.fromObject

  • Returns

object

  • Examples
> ChecksumAddress('CFX:TYPE.NULL:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA0SFBNJM2').toObject()
   {
      netName: 'CFX',
      addressType: 'NULL',
      payload: 'AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA',
      checksum: '0SFBNJM2',
   }

ChecksumAddress.prototype.toSimple

Inverse operation of ChecksumAddress.fromSimple

  • Returns

string

  • Examples
> ChecksumAddress('CFX:TYPE.NULL:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA0SFBNJM2').toSimple()
   'cfx:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0sfbnjm2'

ChecksumAddress.prototype.toBuffer

Inverse operation of ChecksumAddress.fromBuffer

  • Returns

Buffer

  • Examples
> ChecksumAddress('CFX:TYPE.NULL:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA0SFBNJM2').toBuffer()
   <Buffer 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00>

ChecksumAddress.prototype.toHex

Inverse operation of ChecksumAddress.fromHex

  • Returns

string

  • Examples
> ChecksumAddress('CFX:TYPE.BUILTIN:AAEJUAAAAAAAAAAAAAAAAAAAAAAAAAAAAJRWUC9JNB').toHex()
   '0x0888000000000000000000000000000000000002'

Conflux

A sdk of conflux.

Conflux.prototype.constructor

  • Parameters
Name Type Required Default Description
options object false Conflux and Provider constructor options.
options.defaultGasPrice string,number false The default gas price in drip to use for transactions.
options.url string false Url of Conflux node to connect.
options.timeout number false Request time out in ms
options.logger Object false Logger object with 'info' and 'error' method.
  • Examples
> const { Conflux } = require('js-conflux-sdk');
> const conflux = new Conflux({url:'http://test.confluxrpc.org'});

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

Conflux.prototype.provider

WebsocketProvider,HttpProvider,BaseProvider

Provider for rpc call

Conflux.prototype.wallet

Wallet

Wallet for sendTransaction to get Account by from field

Conflux.prototype.netName

string

Default net name

Conflux.prototype.defaultGasPrice

number,string

Default gas price for following methods:

  • Conflux.sendTransaction

Conflux.prototype.Contract

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

  • Parameters
Name Type Required Default Description
options object true See Contract.constructor
  • Returns

Contract - A Contract instance

Conflux.prototype.InternalContract

Create internal contract by default abi and address

  • Parameters
Name Type Required Default Description
name "AdminControl","SponsorWhitelistControl","Staking" true Internal contract name
  • Returns

Contract

  • Examples
> conflux.InternalContract('AdminControl')
   {
    constructor: [Function: bound call],
    abi: ContractABI { * },
    address: '0x0888000000000000000000000000000000000000',
    destroy: [Function: bound call],
    getAdmin: [Function: bound call],
    setAdmin: [Function: bound call],
    'destroy(address)': [Function: bound call],
    '0x00f55d9d': [Function: bound call],
    'getAdmin(address)': [Function: bound call],
    '0x64efb22b': [Function: bound call],
    'setAdmin(address,address)': [Function: bound call],
    '0xc55b6bb7': [Function: bound call]
  }

Conflux.prototype.ChecksumAddress

A shout cut for ChecksumAddress(string), ChecksumAddress.fromSimple(string) or ChecksumAddress.fromHex(string, conflux.netName)

  • Parameters
Name Type Required Default Description
string string true Hex, checksum address or simple checksum address
  • Returns

ChecksumAddress

  • Examples
> conflux.ChecksumAddress('0x0000000000000000000000000000000000000000');
   [String (ChecksumAddress): 'CFX:TYPE.NULL:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA0SFBNJM2']

   > conflux.ChecksumAddress('cfx:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa0sfbnjm2');
   [String (ChecksumAddress): 'CFX:TYPE.NULL:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA0SFBNJM2']

   > conflux.ChecksumAddress('CFX:TYPE.NULL:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA0SFBNJM2');
   [String (ChecksumAddress): 'CFX:TYPE.NULL:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA0SFBNJM2']

Conflux.prototype.close

close connection.

  • Examples
> conflux.close();

Conflux.prototype.getStatus

Get status

  • Returns

Promise.<object> Status information object

  • chainId number: Chain id
  • epochNumber number: Epoch number
  • blockNumber number: Block number
  • pendingTxNumber number: Pending transaction number
  • bestHash string: The block hash of best pivot block
  • Examples
> await conflux.getStatus()
   {
      chainId: 1029,
      epochNumber: 1117476,
      blockNumber: 2230973,
      pendingTxNumber: 4531,
      bestHash: '0x8d581f13fa0548f2751450a7dabd871777875c9ccdf0d8bd629e07a7a5a7917a'
   }

Conflux.prototype.getGasPrice

Returns the current price per gas in Drip.

  • Returns

Promise.<BigInt> Gas price in drip.

  • Examples
> await conflux.getGasPrice();
   1n

Conflux.prototype.getSupplyInfo

Get CFX total supply info

  • Parameters
Name Type Required Default Description
epochNumber string,number false 'latest_state' See format.epochNumber
  • Returns

Promise.<object> Supply info

  • Examples
> await conflux.getSupplyInfo();
   {
    totalCirculating: 10000000061346204857053386048036690n,
    totalCollateral: 109158125000000000000000n,
    totalIssued: 10000005061346154857053386048036690n,
    totalStaking: 41923206238928855616779914n
  }

Conflux.prototype.getInterestRate

Returns the interest rate of given parameter.

  • Parameters
Name Type Required Default Description
epochNumber string,number false 'latest_state' See format.epochNumber
  • Returns

Promise.<BigInt> The interest rate of given parameter.

  • Examples
> await conflux.getInterestRate();
   2522880000000n

Conflux.prototype.getAccumulateInterestRate

Returns the accumulate interest rate of given parameter.

  • Parameters
Name Type Required Default Description
epochNumber string,number false 'latest_state' See format.epochNumber
  • Returns

Promise.<BigInt> The accumulate interest rate of given parameter.

  • Examples
> await conflux.getAccumulateInterestRate()
   76357297457647044505744908994993n

Conflux.prototype.getAccount

Return account related states of the given account

  • Parameters
Name Type Required Default Description
address string true address to get account.
epochNumber string,number false 'latest_state' See format.epochNumber
  • Returns

Promise.<object> Return the states of the given account:

  • balance BigInt: the balance of the account.
  • nonce BigInt: the nonce of the account's next transaction.
  • codeHash string: the code hash of the account.
  • stakingBalance BigInt: the staking balance of the account.
  • collateralForStorage BigInt: the collateral storage of the account.
  • accumulatedInterestReturn BigInt: accumulated unterest return of the account.
  • admin string: admin of the account.
  • Examples
> await conflux.getAccount('0x1c1e72f0c37968557b3d85a3f32747792798bbde');
   {
      accumulatedInterestReturn: 0n,
      balance: 824812401057514588670n,
      collateralForStorage: 174187500000000000000n,
      nonce: 1449n,
      stakingBalance: 0n,
      admin: 'NET1921:TYPE.NULL:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAE1FWAT0M',
      codeHash: '0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470'
   }

Conflux.prototype.getBalance

Returns the balance of the account of given address.

  • Parameters
Name Type Required Default Description
address string true The address to get the balance of.
epochNumber string,number false 'latest_state' See format.epochNumber
  • Returns

Promise.<BigInt> The balance in Drip.

  • Examples
> await conflux.getBalance("0x1c1e72f0c37968557b3d85a3f32747792798bbde");
   824812401057514588670n

Conflux.prototype.getStakingBalance

Returns the balance of the staking account of given address.

  • Parameters
Name Type Required Default Description
address string true Address to check for staking balance.
epochNumber string,number false 'latest_state' See format.epochNumber
  • Returns

Promise.<BigInt> The staking balance in Drip.

  • Examples
> await conflux.getStakingBalance('0x1c1e72f0c37968557b3d85a3f32747792798bbde', 'latest_state');
   0n

Conflux.prototype.getNextNonce

Returns the next nonce should be used by given address.

  • Parameters
Name Type Required Default Description
address string true The address to get the numbers of transactions from.
epochNumber string,number false See format.epochNumber
  • Returns

Promise.<BigInt> The next nonce should be used by given address.

  • Examples
> await conflux.getNextNonce("0x1c1e72f0c37968557b3d85a3f32747792798bbde");
   1449n

Conflux.prototype.getAdmin

Returns the admin of given contract.

  • Parameters
Name Type Required Default Description
address string true Address to contract.
epochNumber string,number false 'latest_state' See format.epochNumber
  • Returns

Promise.<string> Address to admin, or null if the contract does not exist.

  • Examples
> conflux.getAdmin('0x8e2f2e68eb75bb8b18caafe9607242d4748f8d98')
   'NET1921:TYPE.NULL:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAE1FWAT0M'

Conflux.prototype.getVoteList

Returns vote list of the given account.

  • Parameters
Name Type Required Default Description
address string true Address to contract.
epochNumber string,number false 'latest_state' See format.epochNumber
  • Returns

Promise.<Array.<object>> Vote list

  • array:
    • amount BigInt: This is the number of tokens should be locked before
    • unlockBlockNumber number: This is the timestamp when the vote right will be invalid, measured in, the number of past blocks.

Conflux.prototype.getDepositList

Returns deposit list of the given account.

  • Parameters
Name Type Required Default Description
address string true Address to contract.
epochNumber string,number false 'latest_state' See format.epochNumber
  • Returns

Promise.<Array.<object>> Deposit list

  • array:
    • amount BigInt: the number of tokens deposited
    • accumulatedInterestRate: BigInt: the accumulated interest rate at the time of the deposit
    • depositTime number: the time of the deposit

Conflux.prototype.getEpochNumber

Returns the epoch number of given parameter.

  • Parameters
Name Type Required Default Description
epochNumber string,number false 'latest_state' See format.epochNumber
  • Returns

Promise.<number> integer of the current epoch number of given parameter.

  • Examples
> await conflux.getEpochNumber();
   443

Conflux.prototype.getBlockByEpochNumber

Returns information about a block by epoch number.

  • Parameters
Name Type Required Default Description
epochNumber string,number true See format.epochNumber
detail boolean false false If true it returns the full transaction objects, if false only the hashes of the transactions.
  • Returns

Promise.<(object|null)> See getBlockByHash

  • Examples
> await conflux.getBlockByEpochNumber('latest_mined', true);
   {...}

Conflux.prototype.getBlocksByEpochNumber

Returns hashes of blocks located in some epoch.

  • Parameters
Name Type Required Default Description
epochNumber string,number true See format.epochNumber
  • Returns

Promise.<Array.<string>> Array of block hashes, sorted by execution(topological) order.

  • Examples
> await conflux.getBlocksByEpochNumber(0);
   ['0xe677ae5206a5d67d9efa183d867b4b986ed82a3e62174a1488cf8364d58534ec']

Conflux.prototype.getBestBlockHash

Returns the hash of best block.

  • Returns

Promise.<string> hash of the best block.

  • Examples
> await conflux.getBestBlockHash();
   "0xb8bb355bfeaf055a032d5b7df719917c090ee4fb6fee42383004dfe8911d7daf"

Conflux.prototype.getBlockByHash

Returns information about a block by hash.

  • Parameters
Name Type Required Default Description
blockHash string true hash of a block.
detail boolean false false If true it returns the full transaction objects, if false only the hashes of the transactions.
  • Returns

Promise.<(object|null)> A block object, or null when no block was found:

  • adaptive boolean: If true the weight of the block is adaptive under GHAST rule, if false otherwise.
  • blame number: If 0, then no blocks are blamed on its parent path, If greater than 0, then the nearest blamed block on the parent path is blame steps away.
  • deferredLogsBloomHash string: The bloom hash of deferred logs.
  • deferredReceiptsRoot string: The hash of the receipts of the block after deferred execution.
  • deferredStateRoot string: The root of the final state trie of the block after deferred execution.
  • difficulty string: Integer string of the difficulty for this block.
  • epochNumber number|null: The current block epoch number in the client's view. null when it's not in best block's past set and the epoch number is not determined.
  • gasLimit BigInt: The maximum gas allowed in this block.
  • hash string|null: Hash of the block. null when its pending block.
  • height number: The block heights. null when its pending block.
  • miner string: The address of the beneficiary to whom the mining rewards were given.
  • nonce string: Hash of the generated proof-of-work. null when its pending block.
  • parentHash string: Hash of the parent block.
  • powQuality string:Hash of the generated proof-of-work. null when its pending block.
  • refereeHashes string[]: Array of referee hashes.
  • size number: Integer the size of this block in bytes.
  • timestamp number: The unix timestamp for when the block was collated.
  • transactions string[]|object[]: Array of transaction objects, or 32 Bytes transaction hashes depending on the last given parameter.
  • transactionsRoot string: The hash of the transactions of the block.
  • Examples
> await conflux.getBlockByHash('0xaf4136d04e9e2cc470703251ec46f5913ab7955d526feed43771705e89c77390');
   {
      epochNumber: 6,
      blame: 0,
      height: 6,
      size: 352,
      timestamp: 1603901780,
      gasLimit: 30000000n,
      gasUsed: 61118n,
      difficulty: 20000000000n,
      transactions: [
        '0xaad69c8c814aec3e418b68f60917c607920a531e7082dd2c642323b43ecadb94',
        '0xbf7110474779ba2404433ef39a24cb5b277186ef1e6cb199b0b60907b029a1ce'
      ],
      adaptive: false,
      deferredLogsBloomHash: '0xd397b3b043d87fcd6fad1291ff0bfd16401c274896d8c63a923727f077b8e0b5',
      deferredReceiptsRoot: '0x09f8709ea9f344a810811a373b30861568f5686e649d6177fd92ea2db7477508',
      deferredStateRoot: '0x50c0fcbc5bafa7d1dba7b19c87629830106a6be8d0adf505cdc656bb43535d69',
      hash: '0xaf4136d04e9e2cc470703251ec46f5913ab7955d526feed43771705e89c77390',
      miner: 'NET1921:TYPE.USER:AATXETSP0KDARPDB5STDYEX11DR3X6SB0JABGHCD8E',
      nonce: '0x17d86f2f6',
      parentHash: '0xc8a412b4b77b48d61f694975f032d109f26bb0f9fc02e4b221d67a382fab386b',
      powQuality: '0x5a0f86a6f4',
      refereeHashes: [
        '0x73cd891aea310e2c0b8644de91746c7353cebfffb780126bc06101b20689c893'
      ],
      transactionsRoot: '0xd2f08676484ba2a3738194f44542eb29fb290b8ed74bf007f132fe51d89b2e7c'
    }

Conflux.prototype.getConfirmationRiskByHash

Get the risk of the block could be reverted. All block in one same epoch returned same risk number

  • Parameters
Name Type Required Default Description
blockHash string true Hash of a block
  • Returns

Promise.<(number|null)> Number >0 and <1

  • Examples
> await conflux.getConfirmationRiskByHash('0xaf4136d04e9e2cc470703251ec46f5913ab7955d526feed43771705e89c77390')
   1e-8

Conflux.prototype.traceBlock

Get block trace

  • Parameters
Name Type Required Default Description
blockHash string true Hash of a block
  • Returns

Promise.<object>,null

Conflux.prototype.getTransactionByHash

Returns the information about a transaction requested by transaction hash.

  • Parameters
Name Type Required Default Description
transactionHash string true hash of a transaction
  • Returns

Promise.<(object|null)> transaction object, or null when no transaction was found:

  • blockHash string: hash of the block where this transaction was in and got executed. null when its pending.
  • contractCreated string|null: address of created contract. null when it's not a contract creating transaction
  • data string: the data send along with the transaction.
  • epochHeight number: epoch height
  • from string: address of the sender.
  • gas BigInt: gas provided by the sender.
  • gasPrice number: gas price provided by the sender in Drip.
  • hash string: hash of the transaction.
  • nonce BigInt: the number of transactions made by the sender prior to this one.
  • r string: ECDSA signature r
  • s string: ECDSA signature s
  • status number: 0 for success, 1 for error occured, null when the transaction is skipped or not packed.
  • storageLimit BigInt: storage limit in bytes
  • chainId number: chain id
  • to string: address of the receiver. null when its a contract creation transaction.
  • transactionIndex number: integer of the transactions's index position in the block. null when its pending.
  • v string: ECDSA recovery id
  • value BigInt: value transferred in Drip.
  • Examples
> await conflux.getTransactionByHash('0xbf7110474779ba2404433ef39a24cb5b277186ef1e6cb199b0b60907b029a1ce');
   {
      nonce: 0n,
      gasPrice: 10n,
      gas: 200000n,
      value: 0n,
      storageLimit: 1024n,
      epochHeight: 0,
      chainId: 1029,
      v: 1,
      status: 0,
      transactionIndex: 1,
      blockHash: '0xaf4136d04e9e2cc470703251ec46f5913ab7955d526feed43771705e89c77390',
      contractCreated: null,
      data: '0xfebe49090000000000000000000000000000000000000000000000000000000000000000000000000000000000000000162788589c8e386863f217faef78840919fb2854',
      from: 'NET1921:TYPE.USER:AAP9KTHVCTUNVF030RBKK9K7ZBZYZ12DAJYFD4DBC8',
      hash: '0xbf7110474779ba2404433ef39a24cb5b277186ef1e6cb199b0b60907b029a1ce',
      r: '0x495da01ae9f445847022a8bc7df0198577ba75f88b26699f61afb435bb9c50bc',
      s: '0x2291051b1c53db1d6bfe2fb29be1bf512d063e726dc6b98aaf0f2259b7456be0',
      to: 'NET1921:TYPE.CONTRACT:ACB59FK6VRYH8DJ5VYVEHJ9APZHPD72RDPA1CTUUZH'
    }

Conflux.prototype.getTransactionReceipt

Returns the information about a transaction receipt requested by transaction hash.

  • Parameters
Name Type Required Default Description
transactionHash string true Hash of a transaction
  • Returns

Promise.<(object|null)> A transaction receipt object, or null when no transaction was found or the transaction was not executed yet:

  • transactionHash string: Hash of the given transaction.
  • index number: Transaction index within the block.
  • blockHash string: Hash of the block where this transaction was in and got executed.
  • epochNumber number: Epoch number of the block where this transaction was in and got executed.
  • from string: Address of the sender.
  • to string: Address of the receiver. null when its a contract creation transaction.
  • gasUsed number: Gas used the transaction.
  • contractCreated string|null: Address of created contract. null when it's not a contract creating transaction.
  • stateRoot string: Hash of the state root.
  • outcomeStatus number: the outcome status code, 0 was successful, 1 for an error occurred in the execution.
  • logsBloom string: Bloom filter for light clients to quickly retrieve related logs.
  • logs object[]: Array of log objects, which this transaction generated.
  • gasCoveredBySponsor boolean: true if this transaction's gas fee was covered by the sponsor.
  • storageCoveredBySponsor boolean: true if this transaction's storage collateral was covered by the sponsor.
  • storageCollateralized BigInt: the amount of storage collateral this transaction required.
  • storageReleased array: array of storage change objects, each specifying an address and the corresponding amount of storage collateral released
    • address string: address released
    • collaterals BigInt: corresponding amount of storage collateral released
  • Examples
> await conflux.getTransactionReceipt('0xbf7110474779ba2404433ef39a24cb5b277186ef1e6cb199b0b60907b029a1ce');
   {
      index: 1,
      epochNumber: 6,
      outcomeStatus: 0,
      gasUsed: 30559n,
      gasFee: 1500000n,
      blockHash: '0xaf4136d04e9e2cc470703251ec46f5913ab7955d526feed43771705e89c77390',
      contractCreated: null,
      from: 'NET1921:TYPE.USER:AAP9KTHVCTUNVF030RBKK9K7ZBZYZ12DAJYFD4DBC8',
      logs: [],
      logsBloom: '0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000',
      stateRoot: '0xd6a7c2c14cb0d1233010acca98e114db5a10e0b94803d23b01a6777b7fd3b2fd',
      to: 'NET1921:TYPE.CONTRACT:ACB59FK6VRYH8DJ5VYVEHJ9APZHPD72RDPA1CTUUZH'
      transactionHash: '0xbf7110474779ba2404433ef39a24cb5b277186ef1e6cb199b0b60907b029a1ce',
      txExecErrorMsg: null,
      gasCoveredBySponsor: false,
      storageCoveredBySponsor: false,
      storageCollateralized: 0n,
      storageReleased: [
        address: 'NET1921:TYPE.BUILTIN:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAE45419DJS',
        collaterals: 640n,
      ],
    }

Conflux.prototype.sendRawTransaction

Creates new message call transaction or a contract creation for signed transactions.

  • Parameters
Name Type Required Default Description
hex string,Buffer true The signed transaction data.
  • Returns

Promise.<PendingTransaction> The transaction hash, or the zero hash if the transaction is not yet available.

  • Examples
> await conflux.sendRawTransaction('0xf85f800382520894bbd9e9b...');
   "0xbe007c3eca92d01f3917f33ae983f40681182cf618defe75f490a65aac016914"

Conflux.prototype.sendTransaction

Sign and send transaction if from field in conflux.wallet, sign by local account and send raw transaction, else call cfx_sendTransaction and sign by remote wallet

  • Parameters
Name Type Required Default Description
options object true See Transaction
password string false Password for remote node.
  • Returns

Promise.<PendingTransaction> The PendingTransaction object.

  • Examples
> txHash = await conflux.sendTransaction({from:account, to:address, value:0}); // send and get transaction hash
   "0xb2ba6cca35f0af99a9601d09ee19c1949d8130312550e3f5413c520c6d828f88"

> packedTx = await conflux.sendTransaction({from:account, to:address, value:0}).get(); // await till transaction packed
   {
    "nonce": 8n,
    "value": 0n,
    "gasPrice": 1000000000n,
    "gas": 21000n,
    "v": 0,
    "transactionIndex": null,
    "status": null,
    "storageLimit": 0n,
    "chainId": 1,
    "epochHeight": 791394,
    "blockHash": null,
    "contractCreated": null,
    "data": "0x",
    "from": "0x1bd9e9be525ab967e633bcdaeac8bd5723ed4d6b",
    "hash": "0xb2ba6cca35f0af99a9601d09ee19c1949d8130312550e3f5413c520c6d828f88",
    "r": "0x245a1a86ae405eb72c1eaf98f5e22baa326fcf8262abad2c4a3e5bdcf2e912b5",
    "s": "0x4df8058887a4dd8aaf60208accb3e57292a50ff06a117df6e54f7f56176248c0",
    "to": "0x1bd9e9be525ab967e633bcdaeac8bd5723ed4d6b"
   }

> minedTx = await conflux.sendTransaction({from:account, to:address, value:0}).mined(); // await till transaction mined
   {
    "nonce": 8n,
    "value": 0n,
    "gasPrice": 1000000000n,
    "gas": 21000n,
    "v": 0,
    "transactionIndex": 0,
    "status": 0,
    "storageLimit": 0n,
    "chainId": 1,
    "epochHeight": 791394,
    "blockHash": "0xdb2d2d438dcdee8d61c6f495bd363b1afb68cb0fdff16582c08450a9ca487852",
    "contractCreated": null,
    "data": "0x",
    "from": "0x1bd9e9be525ab967e633bcdaeac8bd5723ed4d6b",
    "hash": "0xb2ba6cca35f0af99a9601d09ee19c1949d8130312550e3f5413c520c6d828f88",
    "r": "0x245a1a86ae405eb72c1eaf98f5e22baa326fcf8262abad2c4a3e5bdcf2e912b5",
    "s": "0x4df8058887a4dd8aaf60208accb3e57292a50ff06a117df6e54f7f56176248c0",
    "to": "0x1bd9e9be525ab967e633bcdaeac8bd5723ed4d6b"
   }

> executedReceipt = await conflux.sendTransaction({from:account, to:address, value:0}).executed(); // await till transaction executed
   {
    "index": 0,
    "epochNumber": 791402,
    "outcomeStatus": 0,
    "gasUsed": 21000n,
    "gasFee": 21000000000000n,
    "blockHash": "0xdb2d2d438dcdee8d61c6f495bd363b1afb68cb0fdff16582c08450a9ca487852",
    "contractCreated": null,
    "from": "0x1bd9e9be525ab967e633bcdaeac8bd5723ed4d6b",
    "logs": [],
    "logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
    "stateRoot": "0x510d680cdbf60d34bcd987b3bf9925449c0839a7381dc8fd8222d2c7ee96122d",
    "to": "0x1bd9e9be525ab967e633bcdaeac8bd5723ed4d6b",
    "transactionHash": "0xb2ba6cca35f0af99a9601d09ee19c1949d8130312550e3f5413c520c6d828f88"
   }

> confirmedReceipt = await conflux.sendTransaction({from:account, to:address, value:0}).confirmed(); // await till risk coefficient < threshold (default 1e-8)
   {
    "index": 0,
    "epochNumber": 791402,
    "outcomeStatus": 0,
    "gasUsed": 21000n,
    "gasFee": 21000000000000n,
    "blockHash": "0xdb2d2d438dcdee8d61c6f495bd363b1afb68cb0fdff16582c08450a9ca487852",
    "contractCreated": null,
    "from": "0x1bd9e9be525ab967e633bcdaeac8bd5723ed4d6b",
    "logs": [],
    "logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
    "stateRoot": "0x510d680cdbf60d34bcd987b3bf9925449c0839a7381dc8fd8222d2c7ee96122d",
    "to": "0x1bd9e9be525ab967e633bcdaeac8bd5723ed4d6b",
    "transactionHash": "0xb2ba6cca35f0af99a9601d09ee19c1949d8130312550e3f5413c520c6d828f88"
   }

Conflux.prototype.getCode

Returns the code of given contract.

  • Parameters
Name Type Required Default Description
address string true Address to contract.
epochNumber string,number false 'latest_state' See format.epochNumber
  • Returns

Promise.<string> Byte code of contract, or 0x if the contract does not exist.

  • Examples
> await conflux.getCode('0xb385b84f08161f92a195953b980c8939679e906a');
   "0x6080604052348015600f57600080fd5b506004361060325760003560e01c806306661abd1460375780638..."

Conflux.prototype.getStorageAt

Returns storage entries from a given contract.

  • Parameters
Name Type Required Default Description
address string true Address to contract.
position string true The given position.
epochNumber string,number false 'latest_state' See format.epochNumber
  • Returns

Promise.<(string|null)> Storage entry of given query, or null if the it does not exist.

  • Examples
> await conflux.getStorageAt('0x866aca87ff33a0ae05d2164b3d999a804f583222', '0x6661e9d6d8b923d5bbaab1b96e1dd51ff6ea2a93520fdc9eb75d059238b8c5e9')
   "0x000000000000000000000000000000000000000000000000000000000000162e"

Conflux.prototype.getStorageRoot

Returns the storage root of a given contract.

  • Parameters
Name Type Required Default Description
address string true Address to contract.
epochNumber string,number false 'latest_state' See format.epochNumber
  • Returns

Promise.<object> A storage root object, or null if the contract does not exist

  • delta string: storage root in the delta trie.
  • intermediate string: storage root in the intermediate trie.
  • snapshot string: storage root in the snapshot.
  • Examples
> await conflux.getStorageRoot('0x866aca87ff33a0ae05d2164b3d999a804f583222')
   {
      "delta": "0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470",
      "intermediate": "0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470",
      "snapshot": "0x7bb7d43152e56f529fbef709aab7371b0672f2332ae0fb4786da350f664df5b4"
   }

Conflux.prototype.getSponsorInfo

Returns the sponsor info of given contract.

  • Parameters
Name Type Required Default Description
address string true Address to contract.
epochNumber string,number false 'latest_state' See format.epochNumber
  • Returns

Promise.<object> A sponsor info object, if the contract doesn't have a sponsor, then the all fields in returned object will be 0:

  • sponsorBalanceForCollateral BigInt: the sponsored balance for storage.
  • sponsorBalanceForGas BigInt: the sponsored balance for gas.
  • sponsorGasBound BigInt: the max gas could be sponsored for one transaction.
  • sponsorForCollateral string: the address of the storage sponsor.
  • sponsorForGas string: the address of the gas sponsor.
  • Examples
> await conflux.getSponsorInfo('0x8e2f2e68eb75bb8b18caafe9607242d4748f8d98')
   {
      sponsorBalanceForCollateral: 410625000000000000000n,
      sponsorBalanceForGas: 9999999993626232440n,
      sponsorGasBound: 10000000000n,
      sponsorForCollateral: '0x8d5adbcaf5714924830591586f05302bf87f74bd',
      sponsorForGas: '0x8d5adbcaf5714924830591586f05302bf87f74bd'
   }

Conflux.prototype.getCollateralForStorage

Returns the size of the collateral storage of given address, in Byte.

  • Parameters
Name Type Required Default Description
address string true Address to check for collateral storage.
epochNumber false 'latest_state' See format.epochNumber
  • Returns

Promise.<BigInt> - The collateral storage in Byte.

  • Examples
> await conflux.getCollateralForStorage('0x8e2f2e68eb75bb8b18caafe9607242d4748f8d98')
   89375000000000000000n

Conflux.prototype.call

Virtually call a contract, return the output data.

  • Parameters
Name Type Required Default Description
options object true See Transaction
epochNumber string,number false 'latest_state' See format.epochNumber
  • Returns

Promise.<string> The output data.

Conflux.prototype.estimateGasAndCollateral

Virtually call a contract, return the estimate gas used and storage collateralized.

  • Parameters
Name Type Required Default Description
options object true See Transaction
epochNumber string,number false 'latest_state' See format.epochNumber
  • Returns

Promise.<object> A estimate result object:

  • BigInt gasUsed: The gas used.
  • BigInt gasLimit: The gas limit.
  • BigInt storageCollateralized: The storage collateralized in Byte.

Conflux.prototype.getLogs

Returns logs matching the filter provided.

  • Parameters
Name Type Required Default Description
options object false
options.fromEpoch string,number false 'latest_checkpoint' See format.epochNumber. Search will be applied from this epoch number.
options.toEpoch string,number false 'latest_state' See format.epochNumber. Search will be applied up until (and including) this epoch number.
options.blockHashes Array.<string> false Array of up to 128 block hashes that the search will be applied to. This will override from/to epoch fields if it's not null
options.address string,Array.<string> false Search contract addresses. If null, match all. If specified, log must be produced by one of these addresses.
options.topics array false Search topics. Logs can have 4 topics: the function signature and up to 3 indexed event arguments. The elements of topics match the corresponding log topics. Example: ["0xA", null, ["0xB", "0xC"], null] matches logs with "0xA" as the 1st topic AND ("0xB" OR "0xC") as the 3rd topic. If null, match all.
options.limit number false Return the last limit logs
  • Returns

Promise.<Array.<object>> Array of log, that the logs matching the filter provided:

  • address string: Address this event originated from.
  • topics string[]: Array of topics.
  • data string: The data containing non-indexed log parameter.
  • blockHash string: Hash of the block where the log in.
  • epochNumber number: Epoch number of the block where the log in.
  • transactionHash string: Hash of the transaction where the log in.
  • transactionIndex string: Transaction index in the block.
  • logIndex number: Log index in block.
  • transactionLogIndex number: Log index in transaction.
  • Examples
> await conflux.getLogs({
      address: '0x8e2f2e68eb75bb8b18caafe9607242d4748f8d98',
      fromEpoch: 39802,
      toEpoch: 39802,
      limit: 1,
      topics: ['0x2f8788117e7eff1d82e926ec794901d17c78024a50270940304540a733656f0d'],
    });
   [
   {
      epochNumber: 39802,
      logIndex: 2,
      transactionIndex: 0,
      transactionLogIndex: 2,
      address: '0x8e2f2e68eb75bb8b18caafe9607242d4748f8d98',
      blockHash: '0xca00158a2a508170278d5bdc5ca258b6698306dd8c30fdba32266222c79e57e6',
      data: '0x',
      topics: [
        '0x2f8788117e7eff1d82e926ec794901d17c78024a50270940304540a733656f0d',
        '0x0000000000000000000000000000000000000000000000000000000000000000',
        '0x0000000000000000000000001c1e72f0c37968557b3d85a3f32747792798bbde',
        '0x0000000000000000000000001c1e72f0c37968557b3d85a3f32747792798bbde'
      ],
      transactionHash: '0xeb75f47002720311f1709e36d7f7e9a91ee4aaa469a1de892839cb1ef66a9939'
    }
   ]

Conflux.prototype.subscribe

Subscribe event by name and got id, and provider will emit event by id

Note: suggest use conflux.subscribeXXX to subscribe

  • Parameters
Name Type Required Default Description
name string true Subscription name
...args array true Subscription arguments
  • Returns

Promise.<string> Id of subscription

  • Examples
> conflux = new Conflux({url:'ws://127.0.0.1:12535'})
> id = await conflux.subscribe('epochs');
   "0x8fe7879a1681e9b9"
> conflux.provider.on(id, data=>console.log(data));
   {
     epochHashesOrdered: [
       '0x0eff33578346b8e8347af3bae948eb7f4f5c27add9dbcfeb55eaf7cb3640088f',
       '0xb0cedac34a06ebcb42c3446a6bb2df1f0dcd9d83061f550460e387d19a4d8e91'
     ],
     epochNumber: '0x8cb32'
   }

Conflux.prototype.subscribeEpochs

The epochs topic streams consensus results: the total order of blocks, as expressed by a sequence of epochs. The returned series of epoch numbers is monotonically increasing with an increment of one. If you see the same epoch twice, this suggests a pivot chain reorg has happened (this might happen for recent epochs). For each epoch, the last hash in epochHashesOrdered is the hash of the pivot block.

  • Returns

Promise.<Subscription> EventEmitter instance with the follow events:

  • 'data':
    • epochNumber number: epoch number
    • epochHashesOrdered array: epoch block hash in order
      • string: block hash
  • Examples
> subscription = await conflux.subscribeEpochs()
> subscription.on('data', data=>console.log(data))
   {
     epochNumber: 566031,
     epochHashesOrdered: [
       '0x2820dbb5c4126455ad37bc88c635ae1f35e0d4f85c74300c01828f57ea1e5969',
       '0xd66b801335ba01e2448df52e59da584b54fc7ee7c2f8160943c097e1ebd23038'
     ]
    }
   {
     epochNumber: 566032,
     epochHashesOrdered: [
       '0x899606b462f0141d672aaea8497c82aebbd7b16d266fad71e9d5093b5c6d392e',
       '0xf6093d19c4df3645cd972e9f791fe0db3a1ab70881023a8aee63f64e0c3ca152'
     ]
   }

Conflux.prototype.subscribeNewHeads

The newHeads topic streams all new block headers participating in the consensus.

  • Returns

Promise.<Subscription> EventEmitter instance with the follow events:

  • 'data': see getBlockByHash
  • Examples
> subscription = await conflux.subscribeNewHeads()
> subscription.on('data', data=>console.log(data))
   {
      difficulty: 368178587115n,
      epochNumber: null,
      gasLimit: 30000000n,
      height: 1118247,
      timestamp: 1605005752,
      adaptive: false,
      blame: 0,
      deferredLogsBloomHash: '0xd397b3b043d87fcd6fad1291ff0bfd16401c274896d8c63a923727f077b8e0b5',
      deferredReceiptsRoot: '0x7ae0d5716513206755b6f7c95272b79dbc225759b6e17727e19c2f15c3166bda',
      deferredStateRoot: '0x3cf5deba77c8aa9072f1e972d6a97db487a0ce88455f371eb8ac8fa77321cb9d',
      hash: '0x194675173abbc5aab50326136008774eea1a289e6722c973dfed12b703ee5f2a',
      miner: '0x189121b8f0cdfef0b56eb22d9cb76c97b9c7cfbc',
      nonce: '0x799d35f695950fd6',
      parentHash: '0x4af3cf8cb358e75acad282ffa4b578b6211ea9eeb7cf87c282f120d8a1c809df',
      powQuality: '0xe7ac17feab',
      refereeHashes: [],
      transactionsRoot: '0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470'
    }

Conflux.prototype.subscribeLogs

The logs topic streams all logs matching a certain filter, in order. In case of a pivot chain reorg (which might affect recent logs), a special revert message is sent. All logs received previously that belong to epochs larger than the one in this message should be considered invalid.

  • Parameters
Name Type Required Default Description
options object false
options.address string,Array.<string> false Search contract addresses. If null, match all. If specified, log must be produced by one of these addresses.
options.topics array false Search topics. Logs can have 4 topics: the function signature and up to 3 indexed event arguments. The elements of topics match the corresponding log topics. Example: ["0xA", null, ["0xB", "0xC"], null] matches logs with "0xA" as the 1st topic AND ("0xB" OR "0xC") as the 3rd topic. If null, match all.
  • Returns

Promise.<Subscription> EventEmitter instance with the follow events:

  • 'data': see getLogs
  • 'revert':
    • revertTo 'number': epoch number
  • Examples
> subscription = await conflux.subscribeLogs()
> subscription.on('data', data=>console.log(data))
   {
     epochNumber: 568224,
     logIndex: 0,
     transactionIndex: 0,
     transactionLogIndex: 0,
     address: '0x84ed30d7ddc5ff82ac271ae4e7add5a8b22a8d71',
     blockHash: '0xc02689eea6a507250838463c13e6b633479e2757dfb7e9b2593d5c31b54adb63',
     data: '0x0000000000000000000000000000000000000000000000000000000000000001',
     topics: [
       '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef',
       '0x0000000000000000000000001bd9e9be525ab967e633bcdaeac8bd5723ed4d6b',
       '0x0000000000000000000000001bd9e9be525ab967e633bcdaeac8bd5723ed4d6b'
     ],
     transactionHash: '0x950ddec9ce3b42c4d8ca120722fa318ae64dc2e24553201f55f68c00bfd9cc4c'
   }

> subscription.on('revert', data=>console.log(data))
   { revertTo: 568230 }
   { revertTo: 568231 }

Conflux.prototype.unsubscribe

Unsubscribe subscription.

  • Parameters
Name Type Required Default Description
id string,Subscription true Subscription id
  • Returns

Promise.<boolean> Is success

  • Examples
> id = await conflux.subscribe('epochs');
> await conflux.unsubscribe(id);
   true
> await conflux.unsubscribe(id);
   false

> subscription = await conflux.subscribeLogs();
> await conflux.unsubscribe(subscription);
   true

NET_NAME

Conflux net name

others named NET${chainId}

  • CFXTEST 'CFX': conflux main-net
  • CFXTEST 'CFXTEST': conflux test-net

ADDRESS_TYPE

address type

  • null 'NULL': full zero address
  • builtin 'BUILTIN': starts with 0x0
  • user 'USER': starts with 0x1
  • contract 'CONTRACT': sta