Struct Payload

pub struct Payload {
    pub(crate) raw_payload: Vec<u8>,
    pub(crate) ns_table: NsTable,
}

Raw payload data for an entire block.

A block consists of two sequences of arbitrary bytes:

• ns_table: namespace table
• ns_payloads: namespace payloads

Any sequence of bytes is a valid ns_table. Any sequence of bytes is a valid ns_payloads. The contents of ns_table determine how to interpret ns_payload.

Namespace table

See NsTable for the format of a namespace table.

Namespace payloads

A concatenation of payload bytes for multiple individual namespaces. Namespace boundaries are dictated by ns_table. See NsPayload for the format of a namespace payload.

Fields

raw_payload: Vec<u8>

ns_table: NsTable

Implementations

impl Payload

pub fn ns_table(&self) -> &NsTable

pub fn transaction(&self, index: &Index) -> Option<Transaction>

Like [QueryablePayload::transaction_with_proof] except without the proof.

pub(crate) fn read_ns_payload(&self, range: &NsPayloadRange) -> &NsPayload

pub(crate) fn ns_payload(&self, index: &NsIndex) -> &NsPayload

Convenience wrapper for Self::read_ns_payload.

index is not checked. Use self.ns_table().in_bounds() as needed.

pub fn byte_len(&self) -> PayloadByteLen

fn from_transactions_sync( transactions: impl IntoIterator<Item = <Self as BlockPayload<SeqTypes>>::Transaction> + Send, chain_config: ChainConfig, ) -> Result<(Self, <Self as BlockPayload<SeqTypes>>::Metadata), <Self as BlockPayload<SeqTypes>>::Error>

Need a sync version of BlockPayload::from_transactions in order to impl BlockPayload::empty.

Trait Implementations

impl BlockPayload<SeqTypes> for Payload

type Error = BlockBuildingError

The error type for this type of block

type Transaction = Transaction

The type of the transitions we are applying

type Instance = NodeState

The type of the instance-level state this state is associated with

type Metadata = NsTable

Data created during block building which feeds into the block header

type ValidatedState = ValidatedState

Validated State

fn from_transactions<'life0, 'life1, 'async_trait>( transactions: impl 'async_trait + IntoIterator<Item = Self::Transaction> + Send, validated_state: &'life0 Self::ValidatedState, instance_state: &'life1 Self::Instance, ) -> Pin<Box<dyn Future<Output = Result<(Self, Self::Metadata), Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Build a payload and associated metadata with the transactions. This function is asynchronous because it may need to request updated state from the peers via GET requests.

fn from_bytes(block_payload_bytes: &[u8], ns_table: &Self::Metadata) -> Self

Build a payload with the encoded transaction bytes, metadata, and the associated number of VID storage nodes

fn empty() -> (Self, Self::Metadata)

Build the payload and metadata for genesis/null block.

fn builder_commitment(&self, metadata: &Self::Metadata) -> BuilderCommitment

Generate commitment that builders use to sign block options.

fn transactions<'a>( &'a self, metadata: &'a Self::Metadata, ) -> impl 'a + Iterator<Item = Self::Transaction>

Get the transactions in the payload.

fn transaction_commitments( &self, metadata: &Self::Metadata, ) -> Vec<Commitment<Self::Transaction>>

List of transaction commitments.

fn num_transactions(&self, metadata: &Self::Metadata) -> usize

Number of transactions in the block.

impl Clone for Payload

fn clone(&self) -> Payload

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Payload

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Payload

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Payload

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl EncodeBytes for Payload

fn encode(&self) -> Arc<[u8]>

Encode &self

impl Hash for Payload

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Payload

fn eq(&self, other: &Payload) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl QueryablePayload<SeqTypes> for Payload

type TransactionIndex = Index

An index which can be used to efficiently retrieve a transaction for the block.

type Iter<'a> = Iter<'a>

Enumerate the transactions in this block.

type InclusionProof = TxProof

A proof that a certain transaction exists in the block.

fn len(&self, _meta: &Self::Metadata) -> usize

The number of transactions in the block.

fn iter<'a>(&'a self, _meta: &'a Self::Metadata) -> Self::Iter<'a>

List the transaction indices in the block.

fn transaction_with_proof( &self, _meta: &Self::Metadata, index: &Self::TransactionIndex, ) -> Option<(Self::Transaction, Self::InclusionProof)>

Get a transaction by its block-specific index, along with an inclusion proof.

fn transaction( &self, _meta: &Self::Metadata, index: &Self::TransactionIndex, ) -> Option<Self::Transaction>

Get a transaction by its block-specific index.

fn is_empty(&self, meta: &Self::Metadata) -> bool

Whether this block is empty of transactions.

fn enumerate<'a>( &'a self, meta: &'a Self::Metadata, ) -> Box<dyn Iterator<Item = (Self::TransactionIndex, Self::Transaction)> + 'a>

Enumerate the transactions in the block with their indices.

fn proof( &self, meta: &Self::Metadata, index: &Self::TransactionIndex, ) -> Option<Self::InclusionProof>

Get an inclusion proof for a transaction with a given index.

fn nth(&self, meta: &Self::Metadata, n: usize) -> Option<Self::TransactionIndex>

Get the index of the nth transaction.

fn nth_transaction( &self, meta: &Self::Metadata, n: usize, ) -> Option<Self::Transaction>

Get the nth transaction.

fn nth_transaction_with_proof( &self, meta: &Self::Metadata, n: usize, ) -> Option<(Self::Transaction, Self::InclusionProof)>

Get the nth transaction, along with an inclusion proof.

fn by_hash( &self, meta: &Self::Metadata, hash: Commitment<Self::Transaction>, ) -> Option<Self::TransactionIndex>

Get the index of the transaction with a given hash, if it is in the block.

fn transaction_by_hash( &self, meta: &Self::Metadata, hash: Commitment<Self::Transaction>, ) -> Option<Self::Transaction>

Get the transaction with a given hash, if it is in the block.

fn transaction_by_hash_with_proof( &self, meta: &Self::Metadata, hash: Commitment<Self::Transaction>, ) -> Option<(Self::Transaction, Self::InclusionProof)>

Get the transaction with a given hash, if it is in the block, along with an inclusion proof.

impl Serialize for Payload

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Payload

impl StructuralPartialEq for Payload