QAN PHP 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

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

Documentation For Models

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

Acknowledgements

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