QAN C# 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

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

Acknowledgements

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