Struct rgb::prelude::Consignment

pub struct Consignment {
    pub genesis: Genesis,
    pub endpoints: ConsignmentEndpoints,
    pub state_transitions: TransitionData,
    pub state_extensions: ExtensionData,
    // some fields omitted
}

Fields

genesis: Genesis

endpoints: ConsignmentEndpoints

state_transitions: TransitionData

state_extensions: ExtensionData

Implementations

impl Consignment

pub fn with(
    genesis: Genesis,
    endpoints: ConsignmentEndpoints,
    state_transitions: TransitionData,
    state_extensions: ExtensionData
) -> Consignment

pub fn id(&self) -> ConsignmentId

pub fn version(&self) -> u16

pub fn txids(&self) -> BTreeSet<Txid>

pub fn node_ids(&self) -> BTreeSet<NodeId>

pub fn validate<R: TxResolver>(&self, schema: &Schema, resolver: R) -> Status

pub fn finalize(
    &mut self,
    expose: &BTreeSet<SealEndpoint>,
    contract_id: ContractId
) -> usize

pub fn reveal_seals<'a>(
    &mut self,
    known_seals: impl Iterator<Item = &'a OutpointReveal> + Clone
) -> usize

Reveals previously known seal information (replacing blind UTXOs with unblind ones). Function is used when a peer receives consignment containing concealed seals for the outputs owned by the peer

Trait Implementations

impl Clone for Consignment

fn clone(&self) -> Consignment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommitEncodeWithStrategy for Consignment

type Strategy = UsingStrict

impl ConsensusCommit for Consignment

type Commitment = ConsignmentId

pub fn consensus_commit(&self) -> Self::Commitment

pub fn consensus_verify(&self, commitment: &Self::Commitment) -> bool

impl Debug for Consignment

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

Formats the value using the given formatter.

impl Display for Consignment

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

Formats the value using the given formatter.

impl Eq for Consignment

impl FromStr for Consignment

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq<Consignment> for Consignment

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Strategy for Consignment

const HRP: &'static str

type Strategy = CompressedStrictEncoding

impl Strategy for Consignment

type Strategy = AsStrict

impl StrictDecode for Consignment

fn strict_decode<D: Read>(d: D) -> Result<Self, Error>

Decode with the given [std::io::Reader] instance; must either construct an instance or return implementation-specific error type.

pub fn strict_deserialize(data: impl AsRef<[u8]>) -> Result<Self, Error>

Tries to deserialize byte array into the current type using [strict_decode()]

impl StrictEncode for Consignment

fn strict_encode<E: Write>(&self, e: E) -> Result<usize, Error>

Encode with the given [std::io::Writer] instance; must return result with either amount of bytes encoded – or implementation-specific error type.

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

Serializes data as a byte array using [strict_encode()] function

impl StructuralEq for Consignment

impl StructuralPartialEq for Consignment