Skip to main content

Consignment

Struct Consignment 

Source
pub struct Consignment {
    pub version: u8,
    pub genesis: Genesis,
    pub transitions: Vec<Transition>,
    pub seal_assignments: Vec<SealAssignment>,
    pub anchors: Vec<Anchor>,
    pub schema_id: Hash,
}
Expand description

Complete contract consignment

This is the wire format for transferring CSV contract state between peers. A valid consignment contains a complete, verifiable chain from genesis to the current state.

Fields§

§version: u8

Consignment version

§genesis: Genesis

Contract genesis

§transitions: Vec<Transition>

State transitions in topological order

§seal_assignments: Vec<SealAssignment>

Seal assignments (indexed by transition output)

§anchors: Vec<Anchor>

Anchor proofs (on-chain commitment locations)

§schema_id: Hash

Schema ID (for validation against contract rules)

Implementations§

Source§

impl Consignment

Source

pub fn new( genesis: Genesis, transitions: Vec<Transition>, seal_assignments: Vec<SealAssignment>, anchors: Vec<Anchor>, schema_id: Hash, ) -> Self

Create a new consignment

Source

pub fn state_root(&self) -> Hash

Compute the consignment state root hash

This hash represents the current state of the contract after all transitions have been applied.

Source

pub fn contract_id(&self) -> Hash

Get the contract ID (from genesis)

Source

pub fn transition_count(&self) -> usize

Get the number of transitions

Source

pub fn assignment_count(&self) -> usize

Get the number of seal assignments

Source

pub fn anchor_count(&self) -> usize

Get the number of anchors

Source

pub fn latest_state_for_seal(&self, seal: &SealRef) -> Option<&StateAssignment>

Get the latest state for a given seal

Walks transitions in order to find the most recent assignment to the given seal.

Source

pub fn current_seals(&self) -> BTreeSet<Vec<u8>>

Get all current seal owners

Returns the set of seals that have received state but haven’t been consumed by any transition.

Source

pub fn validate_structure(&self) -> Result<(), ConsignmentError>

Validate basic consignment structure

Source

pub fn to_bytes(&self) -> Result<Vec<u8>, Error>

Serialize consignment to bytes

Source

pub fn from_bytes(bytes: &[u8]) -> Result<Self, Error>

Deserialize consignment from bytes with size limit (50MB max)

Source

pub fn from_genesis(genesis: Genesis) -> Self

Create a consignment with only genesis (no transitions yet)

Trait Implementations§

Source§

impl Clone for Consignment

Source§

fn clone(&self) -> Consignment

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Consignment

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Consignment

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for Consignment

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for Consignment

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for Consignment

Source§

impl StructuralPartialEq for Consignment

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,