QAN JavaScript SDK

This repository is guaranteed up-to-date with the upstream QAN API definitions, and leverages OpenAPI technology to stay consistent.

Versioning is based on SEMVER, meaning:

• Stable releases guarantee backwards compatibility for the same major versions.
• Minor releases will not contain breaking changes.
• Patch releases only focus on fixing issues.

Documentation for API Endpoints

All URIs are relative to https://rpc-testnet.qanplatform.com

Method	HTTP request	Description
qanBlockNumber	GET /blockNumber/	Returns the latest block number of the blockchain.
qanCall	POST /call/	Executes a new message call immediately without creating a transaction on the block chain.
qanChainId	GET /chainId/	Returns the current network/chain ID, used to sign replay-protected transaction introduced in EIP-155.
qanEstimateGas	POST /estimateGas/	Returns an estimation of gas for a given transaction.
qanFeeHistory	POST /feeHistory/	Returns the collection of historical gas information.
qanGasPrice	GET /gasPrice/	Returns the current gas price on the network in wei.
qanGetBalance	GET /getBalance/{Address}/	Returns the balance of the account of given address.
qanGetBlockByHash	GET /getBlockByHash/{Hash}/{TransactionDetailFlag}/	Returns information of the block matching the given block hash.
qanGetBlockByNumber	GET /getBlockByNumber/{BlockNumber}/{TransactionDetailFlag}/	Returns information of the block matching the given block number.
qanGetBlockReceipts	GET /getBlockReceipts/{BlockNumber}/	Returns all transaction receipts for a given block.
qanGetBlockTransactionCountByHash	GET /getBlockTransactionCountByHash/{Hash}/	Returns the number of transactions for the block matching the given block hash.
qanGetBlockTransactionCountByNumber	GET /getBlockTransactionCountByNumber/{BlockNumber}/	Returns the number of transactions for the block matching the given block number.
qanGetCode	GET /getCode/{Address}/	Returns the compiled bytecode of a smart contract.
qanGetFilterChanges	GET /getFilterChanges/{FilterId}/	Polling method for a filter, which returns an array of events that have occurred since the last poll.
qanGetFilterLogs	GET /getFilterLogs/{Id}/	Returns an array of all logs matching filter with given id.
qanGetLogs	POST /getLogs/	Returns an array of all logs matching a given filter object.
qanGetProof	POST /getProof/	Returns the account and storage values of the specified account including the Merkle-proof.
qanGetStorageAt	POST /getStorageAt/	Returns the value from a storage position at a given address.
qanGetTransactionByBlockHashAndIndex	GET /getTransactionByBlockHashAndIndex/{blockHash}/{index}/	Returns information about a transaction given a blockhash and transaction index position.
qanGetTransactionByBlockNumberAndIndex	GET /getTransactionByBlockNumberAndIndex/{blockNumber}/{index}/	Returns information about a transaction given a block number and transaction index position.
qanGetTransactionByHash	GET /getTransactionByHash/{hash}/	Returns the information about a transaction from a transaction hash.
qanGetTransactionCount	GET /getTransactionCount/{Address}/{BlockNumber}/	Returns the number of transactions sent from an address.
qanGetTransactionReceipt	GET /getTransactionReceipt/{Hash}/	Returns the receipt of a transaction by transaction hash.
qanMaxPriorityFeePerGas	GET /maxPriorityFeePerGas/	Get the priority fee needed to be included in a block.
qanNewBlockFilter	GET /newBlockFilter/	Creates a filter in the node, to notify when a new block arrives.
qanNewFilter	POST /newFilter/	Creates a filter object, based on filter options, to notify when the state changes (logs).
qanNewPendingTransactionFilter	GET /newPendingTransactionFilter/	Creates a filter in the node to notify when new pending transactions arrive.
qanSendRawTransaction	POST /sendRawTransaction/	Creates new message call transaction or a contract creation for signed transactions.
qanSyncing	GET /syncing/	Returns an object with the sync status of the node if the node is out-of-sync and is syncing. Returns null when the node is already in sync.
qanUninstallFilter	GET /uninstallFilter/{FilterId}/	Uninstalls a filter with the given filter id.
qanXlinkValid	GET /xlinkValid/{Address}/	Returns the xlink validity time of the account of given address.

Documentation for Models

• QanAutoApi.ErrorDetail
• QanAutoApi.ErrorModel
• QanAutoApi.EstimateGasObject
• QanAutoApi.FilterObject
• QanAutoApi.InputCall
• QanAutoApi.InputEstimateGas
• QanAutoApi.InputFeeHistory
• QanAutoApi.InputGetLogs
• QanAutoApi.InputGetProof
• QanAutoApi.InputGetStorageAt
• QanAutoApi.InputNewFilter
• QanAutoApi.InputSendRawTransaction
• QanAutoApi.InputSubscribe
• QanAutoApi.OutputAccounts
• QanAutoApi.OutputBlobBaseFee
• QanAutoApi.OutputBlockNumber
• QanAutoApi.OutputCall
• QanAutoApi.OutputChainId
• QanAutoApi.OutputEstimateGas
• QanAutoApi.OutputFeeHistory
• QanAutoApi.OutputGasPrice
• QanAutoApi.OutputGetAccount
• QanAutoApi.OutputGetBalance
• QanAutoApi.OutputGetBlockByHash
• QanAutoApi.OutputGetBlockByNumber
• QanAutoApi.OutputGetBlockReceipts
• QanAutoApi.OutputGetBlockTransactionCountByHash
• QanAutoApi.OutputGetBlockTransactionCountByNumber
• QanAutoApi.OutputGetCode
• QanAutoApi.OutputGetFilterChanges
• QanAutoApi.OutputGetFilterLogs
• QanAutoApi.OutputGetLogs
• QanAutoApi.OutputGetProof
• QanAutoApi.OutputGetStorageAt
• QanAutoApi.OutputGetTransactionByBlockHashAndIndex
• QanAutoApi.OutputGetTransactionByBlockNumberAndIndex
• QanAutoApi.OutputGetTransactionByHash
• QanAutoApi.OutputGetTransactionCount
• QanAutoApi.OutputGetTransactionReceipt
• QanAutoApi.OutputGetUncleCountByBlockHash
• QanAutoApi.OutputGetUncleCountByBlockNumber
• QanAutoApi.OutputMaxPriorityFeePerGas
• QanAutoApi.OutputNewBlockFilter
• QanAutoApi.OutputNewFilter
• QanAutoApi.OutputNewPendingTransactionFilter
• QanAutoApi.OutputSendRawTransaction
• QanAutoApi.OutputSubscribe
• QanAutoApi.OutputSyncing
• QanAutoApi.OutputUninstallFilter
• QanAutoApi.OutputUnsubscribe
• QanAutoApi.ParamsTransaction
• QanAutoApi.QanXlinkValidResponse
• QanAutoApi.ResponseBlock
• QanAutoApi.ResponseLog
• QanAutoApi.ResponseStorageEntry
• QanAutoApi.ResponseTransaction
• QanAutoApi.ResponseTransactionReceipt
• QanAutoApi.ResponseWithdrawals
• QanAutoApi.SyncStatus

Acknowledgements

We would like to thank Smartbear and OpenAPITools tech for making building declarative APIs possible. A huge benefit for the whole industry!