Struct ADVZNsProof

pub struct ADVZNsProof {
    pub(crate) ns_index: NsIndex,
    pub(crate) ns_payload: NsPayloadOwned,
    pub(crate) ns_proof: Option<LargeRangeProofType>,
}

Proof of correctness for namespace payload bytes in a block.

Fields

ns_index: NsIndex

ns_payload: NsPayloadOwned

ns_proof: Option<LargeRangeProofType>

Implementations

impl ADVZNsProof

pub fn new( payload: &Payload, index: &NsIndex, common: &ADVZCommon, ) -> Option<ADVZNsProof>

Returns the payload bytes for the indexth namespace, along with a proof of correctness for those bytes. Returns None on error.

The namespace payload [NsPayloadOwned] is included as a hidden field in the returned [NsProof]. A conventional API would instead return (NsPayload, NsProof) and [NsProof] would not contain the namespace payload. (TxProof::new conforms to this convention.) In the future we should change this API to conform to convention. But that would require a change to our RPC endpoint API at endpoints, which is a hassle.

pub fn verify( &self, ns_table: &NsTable, commit: &VidCommitment, common: &ADVZCommon, ) -> Option<(Vec<Transaction>, NamespaceId)>

Verify a [NsProof] against a payload commitment. Returns None on error or if verification fails.

There is no NsPayload arg because this data is already included in the [NsProof]. See [NsProof::new] for discussion.

If verification is successful then return (Vec<Transaction>, NamespaceId) obtained by post-processing the underlying NsPayload. Why? This method might be run by a client in a WASM environment who might be running non-Rust code, in which case the client is unable to perform this post-processing himself.

pub fn export_all_txs(&self, ns_id: &NamespaceId) -> Vec<Transaction>

Return all transactions in the namespace whose payload is proven by self. The namespace ID for each returned Transaction is set to ns_id.

Design warning

This method relies on a promise that a [NsProof] stores the entire namespace payload. If in the future we wish to remove the payload from a [NsProof] then this method can no longer be supported.

In that case, use the following a workaround:

• Given a NamespaceId, get a NsIndex i via NsTable::find_ns_id.
• Use i to get a NsPayload p via Payload::ns_payload.
• Use p to get the desired Vec<Transaction> via NsPayload::export_all_txs.

This workaround duplicates the work done in [NsProof::new]. If you don’t like that then you could instead hack [NsProof::new] to return a pair (NsProof, Vec<Transaction>).

Trait Implementations

impl Clone for ADVZNsProof

fn clone(&self) -> ADVZNsProof

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ADVZNsProof

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ADVZNsProof

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ADVZNsProof

fn eq(&self, other: &ADVZNsProof) -> 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 Serialize for ADVZNsProof

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 ADVZNsProof

impl StructuralPartialEq for ADVZNsProof