Expand description
Wrappers for JSON serialization.
Structs§
- Alert
- An alert is a message about critical problems to be broadcast to all nodes via the p2p network.
- Alert
Message - An alert sent by RPC
send_alert. - Ancestors
Score Sort Key - A struct as a sorted key for tx-pool
- Banned
Addr - A banned P2P address.
- Block
- The JSON view of a Block used as a parameter in the RPC.
- Block
Economic State - Block Economic State.
- Block
Filter - Block filter data and hash.
- Block
Issuance - Block base rewards.
- Block
Template - A block template for miners.
- Block
View - The JSON view of a Block including header and body.
- Block
With Cycles Response - BlockResponse with cycles format wrapper
- Byte32
- Fixed-length 32 bytes binary encoded as a 0x-prefixed hex string in JSON.
- Cell
Data - The cell data content and hash.
- CellDep
- The cell dependency of a transaction.
- Cell
Info - The JSON view of a cell combining the fields in cell output and cell data.
- Cell
Input - The input cell of a transaction.
- Cell
Output - The fields of an output cell except the cell data.
- Cell
With Status - The JSON view of a cell with its status information.
- Cellbase
Template - The cellbase transaction template of the new block for miners.
- Chain
Info - Chain information.
- Consensus
- Consensus defines various parameters that influence chain consensus
- Deployment
- RFC0043 deployment params
- Deployment
Info - An object containing various state info regarding deployments of consensus changes
- Deployments
Info - Chain information.
- Entry
Completed - Transaction’s verify result by test_tx_pool_accept
- Epoch
View - JSON view of an epoch.
- Estimate
Cycles - Response result of the RPC method
estimate_cycles. - Extra
Logger Config - Runtime logger config for extra loggers.
- FeeRate
Def - Serialize and Deserialize implementations for FeeRate
- FeeRate
Statistics - The fee_rate statistics information, includes mean and median, unit: shannons per kilo-weight
- Hard
Fork Feature - The information about one hardfork feature.
- Hard
Forks - Hardfork information
- Header
- The block header.
- Header
View - The JSON view of a Header.
- Indexer
Cell - Live cell
- Indexer
Cells Capacity - Cells capacity
- Indexer
Pagination - IndexerPagination wraps objects array and last_cursor to provide paging
- Indexer
Range - A array represent (half-open) range bounded inclusively below and exclusively above [start, end).
- Indexer
Search Key - SearchKey represent indexer support params
- Indexer
Search KeyFilter - IndexerSearchKeyFilter represent indexer params
filter - Indexer
Tip - Indexer tip information
- Indexer
TxWith Cell - Ungrouped Tx inner type
- Indexer
TxWith Cells - Grouped Tx inner type
- Json
Bytes - Variable-length binary encoded as a 0x-prefixed hex string in JSON.
- Local
Node - The information of the node itself.
- Local
Node Protocol - The information of a P2P protocol that is supported by the local node.
- Main
Logger Config - Runtime logger config.
- Merkle
Proof - Proof of CKB Merkle Tree.
- Miner
Reward - Block rewards for miners.
- Node
Address - Node P2P address and score.
- OutPoint
- Reference to a cell via transaction hash and output index.
- Peer
Sync State - The chain synchronization state between the local node and a remote node.
- Pool
Transaction Entry - The transaction entry in the pool.
- Pool
TxDetail Info - A Tx details info in tx-pool.
- Proposal
Short Id - The 10-byte fixed-length binary encoded as a 0x-prefixed hex string in JSON.
- Proposal
Window - Two protocol parameters
closestandfarthestdefine the closest and farthest on-chain distance between a transaction’s proposal and commitment. - Ratio
- Represents the ratio
numerator / denominator, wherenumeratoranddenominatorare both unsigned 64-bit integers. - Rational
U256 - Represents the ratio
numerator / denominator, wherenumeratoranddenominatorare both unsigned 256-bit integers. - Remote
Node - Information of a remote node.
- Remote
Node Protocol - The information about an active running protocol.
- Response
Format - This is a wrapper for JSON serialization to select the format between Json and Hex.
- Script
- Describes the lock script and type script for a cell.
- Sync
State - The overall chain synchronization state of this local node.
- Transaction
- The transaction.
- Transaction
AndWitness Proof - Merkle proof for transactions’ witnesses in a block.
- Transaction
Proof - Merkle proof for transactions in a block.
- Transaction
Template - Transaction template which is ready to be committed in the new block.
- Transaction
View - The JSON view of a Transaction.
- Transaction
With Status Response - The JSON view of a transaction as well as its status.
- TxPool
Entries - Tx-pool entries object
- TxPool
Entry - Transaction entry info
- TxPool
Ids - Array of transaction ids
- TxPool
Info - Transaction pool information.
- TxStatus
- Transaction status and the block hash if it is committed.
- Uncle
Block - The uncle block used as a parameter in the RPC.
- Uncle
Block View - The uncle block.
- Uncle
Template - The uncle block template of the new block for miners.
Enums§
- Block
Response - The wrapper represent response of
get_block|get_block_by_number, return a Block with cycles. - DaoWithdrawing
Calculation Kind - An enum to represent the two kinds of dao withdrawal amount calculation option.
DaoWithdrawingCalculationKindis equivalent toH256|OutPoint. - DepType
- The dep cell type. Allowed values: “code” and “dep_group”.
- Deployment
Pos - Deployment name
- Deployment
State - The possible softfork deployment state
- Either
- The enum
Eitherwith variantsLeftandRightis a general purpose sum type with two cases. - Estimate
Mode - The fee estimate mode.
- Indexer
Cell Type - Cell type
- Indexer
Order - Order Desc | Asc
- Indexer
Script Type - ScriptType
Lock|Type - Indexer
Search Mode - IndexerSearchMode represent search mode, default is prefix search
- Indexer
Tx - Indexer Transaction Object
- Outputs
Validator - Transaction output validators that prevent common mistakes.
- Pool
Transaction Reject - TX reject message,
PoolTransactionRejectis a JSON object with following fields. - RawTx
Pool - All transactions in tx-pool.
- Response
Format Inner Type - The enum
ResponseFormatInnerTypewith variantsJsonandHexis used to supply a format choice for the format ofResponseFormatResponse.transaction - Script
Hash Type - Specifies how the script
code_hashis used to match the script code and how to run the code. - Soft
Fork - SoftFork information
- Status
- Status for transaction
- Topic
- Specifies the topic which to be added as active subscription.
Traits§
- AsEpoch
Number With Fraction - This trait is a restriction for type
Uint64, so we can only get epoch_number, epoch_index and epoch_length from the typeEpochNumberWithFractioninstead of allUint64 - Deserialize
- A data structure that can be deserialized from any data format supported by Serde.
- Serialize
- A data structure that can be serialized into any data format supported by Serde.
Type Aliases§
- AlertId
- The alert identifier that is used to filter duplicated alerts.
- Alert
Priority - Alerts are sorted by priority. Greater integers mean higher priorities.
- Block
Number - Consecutive block number starting from 0.
- Capacity
- The capacity of a cell is the value of the cell in Shannons. It is also the upper limit of the cell occupied storage size where every 100,000,000 Shannons give 1-byte storage.
- Cycle
- Count of cycles consumed by CKB VM to run scripts.
- Epoch
Number - Consecutive epoch number starting from 0.
- Epoch
Number With Fraction - The epoch indicator of a block. It shows which epoch the block is in, and the elapsed epoch fraction after adding this block.
- Timestamp
- The Unix timestamp in milliseconds (1 second is 1000 milliseconds).
- Uint32
- The 32-bit unsigned integer type encoded as the 0x-prefixed hex string in JSON.
- Uint64
- The 64-bit unsigned integer type encoded as the 0x-prefixed hex string in JSON.
- Uint128
- The 128-bit unsigned integer type encoded as the 0x-prefixed hex string in JSON.
- Version
- The simple increasing integer version.