Conflux
Last updated
Was this helpful?
Last updated
Was this helpful?
The Client class that provides an interface to the Conflux network.
: Object :
The Client class that provides an interface to the Conflux network.
Kind: global class
instance
: string
: BaseProvider | WechatProvider | HttpProvider | WebsocketProvider
: Wallet
: number | string
: number
: number
: PoS
: Trace
: TxPool
: CFX
: AdvancedRPCUtilities
⇒ Contract
⇒ Contract
⇒ Contract
⇒ BatchRequester
⇒ Promise.<string>
⇒ Promise.<SupplyInfo>
⇒ Promise.<ChainStatus>
⇒ Promise.<BigInt>
⇒ Promise.<BigInt>
⇒ Promise.<BigInt>
⇒ Promise.<Account>
⇒ Promise.<BigInt>
⇒ Promise.<BigInt>
⇒ Promise.<BigInt>
⇒ Promise.<string>
⇒ Promise.<Array.<Vote>>
⇒ Promise.<Array.<Deposit>>
⇒ Promise.<number>
⇒ Promise.<(Block|null)>
⇒ Promise.<(Block|null)>
⇒ Promise.<Array.<string>>
⇒ Promise.<Array.<RewardInfo>>
⇒ Promise.<string>
⇒ Promise.<(Block|null)>
⇒ Promise.<(Block|null)>
⇒ Promise.<(number|null)>
⇒ Promise.<(Transaction|null)>
⇒ Promise.<(TransactionReceipt|null)>
⇒ Promise.<PendingTransaction>
⇒ Promise.<PendingTransaction>
⇒ Promise.<string>
⇒ Promise.<(string|null)>
⇒ Promise.<object>
⇒ Promise.<SponsorInfo>
⇒ Promise.<AccountPendingInfo>
⇒ Promise.<AccountPendingTransactions>
⇒ Promise.<BigInt>
⇒ Promise.<string>
⇒ Promise.<EstimateResult>
⇒ Promise.<object>
⇒ Promise.<object>
⇒ Promise.<Array.<Log>>
⇒ Promise.<Array.<object>>
⇒ Promise.<Array.<Trace>>
⇒ Promise.<Array.<Trace>>
⇒ Promise.<Array.<Array.<TransactionReceipt>>>
⇒ Promise.<Array.<Array.<TransactionReceipt>>>
⇒ Promise.<PoSEconomics>
⇒ Promise.<string>
⇒ Promise.<Subscription>
⇒ Promise.<Subscription>
⇒ Promise.<Subscription>
⇒ Promise.<boolean>
static
⇒
[options]
Conflux and Provider constructor options.
Example
Example
stringBaseProvider | WechatProvider | HttpProvider | WebsocketProviderProvider for rpc call
WalletWallet for sendTransaction to get Account by from field
numberstringDeprecated
Default gas price for following methods:
Conflux.sendTransaction
numberIf transaction.gas is undefined, gas will be set by estimate, cause gas used might be change during estimateGasAndCollateral and sendTransaction, estimate value need to multiply by defaultGasRatio (>1.0) in case of gas not enough.
transaction.gas = estimate.gasUsed * defaultGasRatio
Default gas price for following methods:
Conflux.sendTransaction
numberIf transaction.storageLimit is undefined, storageLimit will be set by estimate, cause storage limit might be change during estimateGasAndCollateral and sendTransaction, estimate value need to multiply by defaultStorageRatio (>1.0) in case of storageLimit not enough.
transaction.storageLimit = estimate.storageCollateralized * defaultStorageRatio
Default gas price for following methods:
Conflux.sendTransaction
PoSpos RPC methods
Tracetrace RPC methods
TxPooltxpool RPC methods
CFXcfx RPC methods
AdvancedRPCUtilitiesAdvanced RPC compose methods
Different kind provider API wrapper
ContractA shout cut for new Contract(options, conflux);
options
object
ContractCreate internal contract by default abi and address
name
"AdminControl" | "SponsorWhitelistControl" | "Staking" | "PoSRegister" | "CrossSpaceCall"
Internal contract name
Example
ContractCreate an token CRC20 contract with standard CRC20 abi
address
string
BatchRequesterReturn a BatchRequester instance which can used to build batch request and decode response data
close connection.
Update conflux networkId from RPC
Promise.<string>Get node client version
Promise.<SupplyInfo>Get supply info
totalIssued BigInt: Total issued balance in Drip
totalStaking BigInt: Total staking balance in Drip
totalCollateral BigInt: Total collateral balance in Drip
[epochNumber]
string | number
"'latest_state'"
Example
Promise.<ChainStatus>Get status
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
Example
Promise.<BigInt>Returns the current price per gas in Drip.
Promise.<BigInt>Returns the interest rate of given parameter.
[epochNumber]
string | number
"'latest_state'"
Example
Promise.<BigInt>Returns the accumulate interest rate of given parameter.
[epochNumber]
string | number
"'latest_state'"
Example
Promise.<Account>Return account related 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.
address
string
address to get account.
[epochNumber]
string | number
"'latest_state'"
Example
Promise.<BigInt>Returns the balance of the account of given address.
address
string
The address to get the balance of.
[epochNumber]
string | number
"'latest_state'"
Example
Promise.<BigInt>Returns the balance of the staking account of given address.
address
string
Address to check for staking balance.
[epochNumber]
string | number
"'latest_state'"
Example
Promise.<BigInt>Returns the next nonce should be used by given address.
address
string
The address to get the numbers of transactions from.
[epochNumber]
string | number
Example
Promise.<string>Returns the admin of given contract.
address
string
Address to contract.
[epochNumber]
string | number
"'latest_state'"
Example
Promise.<Array.<Vote>>Returns vote list of the given account.
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.
address
string
Address to contract.
[epochNumber]
string | number
"'latest_state'"
Promise.<Array.<Deposit>>Returns deposit list of the given account.
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
address
string
Address to contract.
[epochNumber]
string | number
"'latest_state'"
Promise.<number>Returns the epoch number of given parameter.
[epochNumber]
string | number
"'latest_state'"
Example
Promise.<(Block|null)>Returns information about a block by epoch number.
epochNumber
string | number
[detail]
boolean
false
If true it returns the full transaction objects, if false only the hashes of the transactions.
Example
Promise.<(Block|null)>Returns information about a block by block number.
blockNumber
string | number
[detail]
boolean
false
If true it returns the full transaction objects, if false only the hashes of the transactions.
Example
Promise.<Array.<string>>Returns hashes of blocks located in some epoch.
epochNumber
string | number
Example
Promise.<Array.<RewardInfo>>Get epoch blocks reward info
blockHash string: Hash of the block.
author string: The address of the beneficiary to whom the mining rewards were given.
baseReward BigInt: Block base reward in Drip
totalReward BigInt: Block total reward in Drip
txFee BigInt: Total gas fee of block transaction
epochNumber
string | number
Example
Promise.<string>Returns the hash of best block.
Promise.<(Block|null)>Returns information about a block by hash.
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.
blockHash
string
hash of a block.
[detail]
boolean
false
If true it returns the full transaction objects, if false only the hashes of the transactions.
Example
Promise.<(Block|null)>Get block by blockHash if pivot block of epochNumber is pivotBlockHash.
blockHash
string
Block hash which epochNumber expect to be epochNumber.
pivotBlockHash
string
Block hash which expect to be the pivot block of epochNumber.
epochNumber
number
Epoch number
Promise.<(number|null)>Get the risk of the block could be reverted. All block in one same epoch returned same risk number
blockHash
string
Hash of a block
Example
Promise.<(Transaction|null)>Returns the information about a transaction requested by transaction hash.
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.
transactionHash
string
hash of a transaction
Example
Promise.<(TransactionReceipt|null)>Returns the information about a transaction receipt requested by transaction hash.
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
transactionHash
string
Hash of a transaction
Example
Promise.<PendingTransaction>Creates new message call transaction or a contract creation for signed transactions.
hex
string | Buffer
The signed transaction data.
Example
Promise.<PendingTransaction>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
options
[password]
string
Password for remote node.
Example
Example
Example
Example
Example
Promise.<string>Returns the code of given contract.
address
string
Address to contract.
[epochNumber]
string | number
"'latest_state'"
Example
Promise.<(string|null)>Returns storage entries from a given contract.
address
string
Address to contract.
position
string
The given position.
[epochNumber]
string | number
"'latest_state'"
Example
Promise.<object>Returns the storage root of a given contract.
delta string: storage root in the delta trie.
intermediate string: storage root in the intermediate trie.
snapshot string: storage root in the snapshot.
address
string
Address to contract.
[epochNumber]
string | number
"'latest_state'"
Example
Promise.<SponsorInfo>Returns the sponsor info of given contract.
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.
address
string
Address to contract.
[epochNumber]
string | number
"'latest_state'"
Example
Promise.<AccountPendingInfo>Return pending info of an account
localNonce BigInt: then next nonce can use in the transaction pool
nextPendingTx string: the hash of next pending transaction
pendingCount BigInt: the count of pending transactions
pendingNonce BigInt: the nonce of pending transaction
address
string
Address to account
Promise.<AccountPendingTransactions>Return pending transactions of one account
pendingTransactions Array: pending transactions
firstTxStatus Object: the status of first pending tx
pendingCount BigInt: the count of pending transactions
address
string
base32 address
Promise.<BigInt>Returns the size of the collateral storage of given address, in Byte.
address
string
Address to check for collateral storage.
[epochNumber]
'latest_state'
Example
Promise.<string>Virtually call a contract, return the output data.
options
[epochNumber]
string | number
"'latest_state'"
Promise.<EstimateResult>Virtually call a contract, return the estimate gas used and storage collateralized.
BigInt gasUsed: The gas used.
BigInt gasLimit: The gas limit.
BigInt storageCollateralized: The storage collateralized in Byte.
options
[epochNumber]
string | number
"'latest_state'"
Promise.<object>Estimate a transaction's gas and storageCollateralize, check whether user's balance is enough for fee and value
BigInt gasUsed: The gas used.
BigInt gasLimit: The gas limit.
BigInt storageCollateralized: The storage collateralized in Byte.
BigInt balance: The balance of the options.from.
Boolean isBalanceEnough: indicate balance is enough for gas and storage fee
Boolean isBalanceEnoughForValueAndFee: indicate balance is enough for gas and storage fee plus value
Boolean willPayCollateral: false if the transaction is eligible for storage collateral sponsorship, true otherwise
Boolean willPayTxFee: false if the transaction is eligible for gas sponsorship, true otherwise
options
[epochNumber]
string | number
"'latest_state'"
Promise.<object>Check whether transaction sender's balance is enough for gas and storage fee
Boolean isBalanceEnough: indicate balance is enough for gas and storage fee
Boolean willPayCollateral: false if the transaction is eligible for storage collateral sponsorship, true otherwise
Boolean willPayTxFee: false if the transaction is eligible for gas sponsorship, true otherwise
from
string
sender address
to
string
target address
gas
string | number
gas limit (in drip)
gasPrice
string | number
gas price (in drip)
storageLimit
string | number
storage limit (in byte)
[epochNumber]
string | number
optional epoch number
Promise.<Array.<Log>>Returns 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.
[options]
LogFilter
Example
Promise.<Array.<object>>Return block's execution trace.
Note: need RPC server open trace_block method
blockHash
string
block hash
Example
Promise.<Array.<Trace>>Return transaction's trace
txHash
string
transaction hash
Example
Promise.<Array.<Trace>>Return traces that satisfy an filter
filter
TraceFilter
trace filters
Example
Promise.<Array.<Array.<TransactionReceipt>>>Return one epoch's all receipts
epochNumber
number | string
epoch number
Example
Promise.<Array.<Array.<TransactionReceipt>>>Return one epoch's all receipts by pivot block hash
pivotBlockHash
string
epoch pivot block hash
Example
Promise.<PoSEconomics>Return PoS summary info
distributablePosInterest number: Currently total distributable PoS interest (Drip)
lastDistributeBlock number: Last distribute block number
totalPosStakingTokens number: Total token amount (Drip) staked in PoS
Promise.<string>Subscribe event by name and got id, and provider will emit event by id
Note: suggest use
conflux.subscribeXXXto subscribe
name
string
Subscription name
...args
array
Subscription arguments
Example
Promise.<Subscription>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.
'data':
epochNumber number: epoch number
epochHashesOrdered array: epoch block hash in order
string: block hash
[sub_epoch]
string
Available values are latest_mined(default value) and latest_state
Example
Promise.<Subscription>The newHeads topic streams all new block headers participating in the consensus.
'data': see getBlockByHash
Example
Promise.<Subscription>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.
'data': see getLogs
'revert':
revertTo 'number': epoch number
[options]
object
[options.address]
string | Array.<string>
Search contract addresses. If null, match all. If specified, log must be produced by one of these addresses.
[options.topics]
array
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.
Example
Example
Promise.<boolean>Unsubscribe subscription.
id
string | Subscription
Subscription id
Example
Example
Create a Conflux instance with networdId set up
options
ObjectKind: global typedef Properties
[options.defaultGasPrice]
string | number
The default gas price in drip to use for transactions.
[options.defaultGasRatio]
number
1.1
The ratio to multiply by gas.
[options.defaultStorageRatio]
number
1.1
The ratio to multiply by storageLimit.
[options.url]
string
Url of Conflux node to connect.
[options.retry]
number
Retry times if request error occurs.
[options.timeout]
number
Request time out in ms
[options.logger]
Object
Logger object with 'info' and 'error' method.
[options.networkId]
number
Connected RPC's networkId
[options.useWechatProvider]
boolean
Use wechat provider
[options.useHexAddressInParameter]
boolean
Use hex address in parameter
[options.useVerboseAddress]
boolean
Use verbose address
Kind: global typedef
Kind: instance property of
Kind: instance property of
Kind: instance property of
Kind: instance property of
Kind: instance property of
Kind: instance property of
Kind: instance property of
Kind: instance property of
Kind: instance property of
Kind: instance property of
Kind: instance property of
Kind: instance method of
Kind: instance method of
See
Kind: instance method of
Kind: instance method of
Returns: Contract - A token contract instance
Kind: instance method of
Returns: BatchRequester - - A BatchRequester instance
Kind: instance method of Example
Kind: instance method of
Kind: instance method of
Kind: instance method of
Returns: Promise.<SupplyInfo> - Return supply info
See
Kind: instance method of
Returns: Promise.<ChainStatus> - Status information object
Kind: instance method of
Returns: Promise.<BigInt> - Gas price in drip.
Example
Kind: instance method of
Returns: Promise.<BigInt> - The interest rate of given parameter.
See
Kind: instance method of
Returns: Promise.<BigInt> - The accumulate interest rate of given parameter.
See
Kind: instance method of
Returns: Promise.<Account> - Return the states of the given account:
See
Kind: instance method of
Returns: Promise.<BigInt> - The balance in Drip.
See
Kind: instance method of
Returns: Promise.<BigInt> - The staking balance in Drip.
See
Kind: instance method of
Returns: Promise.<BigInt> - The next nonce should be used by given address.
See
Kind: instance method of
Returns: Promise.<string> - Address to admin, or null if the contract does not exist.
See
Kind: instance method of
Returns: Promise.<Array.<Vote>> - Vote list
See
Kind: instance method of
Returns: Promise.<Array.<Deposit>> - Deposit list
See
Kind: instance method of
Returns: Promise.<number> - integer of the current epoch number of given parameter.
See
Kind: instance method of
Returns: Promise.<(Block|null)> - See getBlockByHash
See
Kind: instance method of
Returns: Promise.<(Block|null)> - See getBlockByHash
Kind: instance method of
Returns: Promise.<Array.<string>> - Array of block hashes, sorted by execution(topological) order.
See
Kind: instance method of
Returns: Promise.<Array.<RewardInfo>> - List of block reward info
See
Kind: instance method of
Returns: Promise.<string> - hash of the best block.
Example
Kind: instance method of
Returns: Promise.<(Block|null)> - A block object, or null when no block was found:
Kind: instance method of
Returns: Promise.<(Block|null)> - See getBlockByHash
Kind: instance method of
Returns: Promise.<(number|null)> - Number >0 and <1
Kind: instance method of
Returns: Promise.<(Transaction|null)> - transaction object, or null when no transaction was found:
Kind: instance method of
Returns: Promise.<(TransactionReceipt|null)> - A transaction receipt object, or null when no transaction was found or the transaction was not executed yet:
Kind: instance method of
Returns: Promise.<PendingTransaction> - The transaction hash, or the zero hash if the transaction is not yet available.
Kind: instance method of
Returns: Promise.<PendingTransaction> - The PendingTransaction object.
See
Kind: instance method of
Returns: Promise.<string> - Byte code of contract, or 0x if the contract does not exist.
See
Kind: instance method of
Returns: Promise.<(string|null)> - Storage entry of given query, or null if the it does not exist.
See
Kind: instance method of
Returns: Promise.<object> - A storage root object, or null if the contract does not exist
See
Kind: instance method of
Returns: Promise.<SponsorInfo> - A sponsor info object, if the contract doesn't have a sponsor, then the all fields in returned object will be 0:
See
Kind: instance method of
Returns: Promise.<AccountPendingInfo> - An account pending info object.
Kind: instance method of
Returns: Promise.<AccountPendingTransactions> - An account's pending transactions and info.
Kind: instance method of
Returns: Promise.<BigInt> - - The collateral storage in Byte.
See
Kind: instance method of
Returns: Promise.<string> - The output data.
See
See
Kind: instance method of
Returns: Promise.<EstimateResult> - A estimate result object:
See
See
Kind: instance method of
Returns: Promise.<object> - A estimate result with advance info object:
See
See
Kind: instance method of
Returns: Promise.<object> - A check result object:
Kind: instance method of
Returns: Promise.<Array.<Log>> - Array of log, that the logs matching the filter provided:
Kind: instance method of
Returns: Promise.<Array.<object>> - Array of transaction traces.
Kind: instance method of
Returns: Promise.<Array.<Trace>> - Array of traces.
Kind: instance method of
Returns: Promise.<Array.<Trace>> - Array of traces.
Kind: instance method of
Returns: Promise.<Array.<Array.<TransactionReceipt>>> - Array of array receipts.
Kind: instance method of
Returns: Promise.<Array.<Array.<TransactionReceipt>>> - Array of array receipts.
Kind: instance method of
Returns: Promise.<PoSEconomics> - PoS summary info
Kind: instance method of
Returns: Promise.<string> - Id of subscription
Kind: instance method of
Returns: Promise.<Subscription> - EventEmitter instance with the follow events:
Kind: instance method of
Returns: Promise.<Subscription> - EventEmitter instance with the follow events:
Kind: instance method of
Returns: Promise.<Subscription> - EventEmitter instance with the follow events:
Kind: instance method of
Returns: Promise.<boolean> - Is success
Kind: static method of