Module ckb_types::core

The essential rust types for CKB.

Packed bytes are not enough for all usage scenarios.

This module provides essential rust types.

Most of them is composed of those packed bytes or can convert between self and those bytes.

Re-exports

• pub use tx_pool::EntryCompleted;
• pub use tx_pool::TransactionWithStatus;

Modules

• cell
  TODO(doc): @quake
• error
  The error types to unexpected out-points.
• hardfork
  Hardfork-related configuration
• service
  Types for CKB services.
• tx_pool
  Tx-pool shared type define.

Macros

• capacity_bytes
  TODO(doc): @keroro520

Structs

• BlockBuilder
  An advanced builder for BlockView.
• BlockEconomicState
  Includes the rewards details for a block and when the block is finalized.
• BlockExt
  TODO(doc): @quake
• BlockIssuance
  Native token issuance.
• BlockReward
  Details of miner rewards issued by block cellbase transaction.
• BlockView
  A readonly and immutable struct which includes Block and its associated hashes.
• Capacity
  CKB capacity.
• EpochExt
  TODO(doc): @quake
• EpochNumberWithFraction
  Represents an epoch number with a fraction unit, it can be used to accurately represent the position for a block within an epoch.
• ExtraHashView
  A readonly and immutable struct which includes extra hash and the decoupled parts of it.
• FeeRate
  shannons per kilo-weight
• HeaderBuilder
  An advanced builder for HeaderView.
• HeaderView
  A readonly and immutable struct which includes Header and its hash.
• MinerReward
  Miner reward.
• Ratio
  Represents the ratio numerator / denominator, where numerator and denominator are both unsigned 64-bit integers.
• RationalU256
  Represents the ratio numerator / denominator, where numerator and denominator are both unsigned 256-bit integers.
• TransactionBuilder
  An advanced builder for TransactionView.
• TransactionInfo
  TODO(doc): @quake
• TransactionMeta
  TODO(doc): @quake
• TransactionMetaBuilder
  TODO(doc): @quake
• TransactionView
  A readonly and immutable struct which includes Transaction and its associated hashes.
• UncleBlockVecView
  A readonly and immutable struct which includes a vector of UncleBlocks and their hashes.
• UncleBlockView
  A readonly and immutable struct which includes UncleBlock and its hash.

Enums

• CapacityError
  Numeric errors.
• DepType
  The DepType enum represents different types of dependencies for cell_deps.
• ScriptHashType
  Specifies how the script code_hash is used to match the script code and how to run the code. The hash type is split into the high 7 bits and the low 1 bit, when the low 1 bit is 1, it indicates the type, when the low 1 bit is 0, it indicates the data, and then it relies on the high 7 bits to indicate that the data actually corresponds to the version.

Type Aliases

• BlockNumber
  Block number.
• CapacityResult
  Numeric operation result.
• Cycle
  Cycle number.
• EpochNumber
  Epoch number.
• PublicKey
  Public key. It’s a 512 bits fixed binary data.
• Version
  Version number.