Struct Consignment

pub struct Consignment<const TRANSFER: bool> {
    pub version: ContainerVer,
    pub transfer: bool,
    pub terminals: SmallOrdMap<BundleId, SecretSeals>,
    pub genesis: Genesis,
    pub bundles: LargeVec<WitnessBundle>,
    pub schema: Schema,
    pub types: TypeSystem,
    pub scripts: Confined<BTreeSet<Lib>, 0, CONSIGNMENT_MAX_LIBS>,
}

Consignment represents contract-specific data, always starting with genesis, which must be valid under client-side-validation rules (i.e. internally consistent and properly committed into the commitment layer, like bitcoin blockchain or current state of the lightning channel).

All consignments-related procedures, including validation or merging consignments data into stash or schema-specific data storage, must start with endpoints and process up to the genesis.

Fields

version: ContainerVer

Version.

transfer: bool

Specifies whether the consignment contains information about state transfer (true), or it is just a consignment with an information about a contract.

terminals: SmallOrdMap<BundleId, SecretSeals>

Set of secret seals which are history terminals.

genesis: Genesis

Genesis data.

bundles: LargeVec<WitnessBundle>

All bundled state transitions contained in the consignment, together with their witness data.

schema: Schema

Schema (plus root schema, if any) under which contract is issued.

types: TypeSystem

Type system covering all types used in schema.

scripts: Confined<BTreeSet<Lib>, 0, CONSIGNMENT_MAX_LIBS>

Collection of scripts used across consignment.

Implementations

impl<const TRANSFER: bool> Consignment<TRANSFER>

pub fn consignment_id(&self) -> ConsignmentId

pub fn schema_id(&self) -> SchemaId

pub fn reveal_terminal_seals<E>( self, f: impl Fn(SecretSeal) -> Result<Option<GraphSeal>, E>, ) -> Result<Self, E>

pub fn into_contract(self) -> Contract

pub fn replace_transitions_input_ops(&self) -> BTreeSet<OpId>

pub fn validate( self, resolver: &impl ResolveWitness, chain_net: ChainNet, safe_height: Option<NonZeroU32>, trusted_typesystem: TypeSystem, ) -> Result<ValidConsignment<TRANSFER>, Status>

pub fn validate_with_opids( self, resolver: &impl ResolveWitness, chain_net: ChainNet, safe_height: Option<NonZeroU32>, trusted_typesystem: TypeSystem, trusted_op_seals: BTreeSet<OpId>, ) -> Result<ValidConsignment<TRANSFER>, Status>

pub fn modify_bundle<F>(&mut self, witness_id: Txid, modifier: F) -> bool

where F: Fn(&mut WitnessBundle),

Modify a bundle in the consignment if it exists

Trait Implementations

impl<const TRANSFER: bool> Clone for Consignment<TRANSFER>

fn clone(&self) -> Consignment<TRANSFER>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const TRANSFER: bool> CommitEncode for Consignment<TRANSFER>

type CommitmentId = ConsignmentId

Type of the resulting commitment.

fn commit_encode(&self, e: &mut CommitEngine)

Encodes the data for the commitment by writing them directly into a std::io::Write writer instance

impl<const TRANSFER: bool> ConsignmentExt for Consignment<TRANSFER>

fn contract_id(&self) -> ContractId

fn schema_id(&self) -> SchemaId

fn schema(&self) -> &Schema

fn genesis(&self) -> &Genesis

fn bundled_witnesses(&self) -> impl Iterator<Item = &WitnessBundle>

impl<const TRANSFER: bool> Debug for Consignment<TRANSFER>

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

Formats the value using the given formatter.

impl<'de, const TRANSFER: bool> Deserialize<'de> for Consignment<TRANSFER>

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<const TRANSFER: bool> Display for Consignment<TRANSFER>

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

Formats the value using the given formatter.

impl From<Consignment<false>> for UniversalFile

fn from(v: Contract) -> Self

Converts to this type from the input type.

impl From<Consignment<true>> for UniversalFile

fn from(v: Transfer) -> Self

Converts to this type from the input type.

impl<const TRANSFER: bool> FromStr for Consignment<TRANSFER>

type Err = ConsignmentParseError

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<const TRANSFER: bool> PartialEq for Consignment<TRANSFER>

fn eq(&self, other: &Consignment<TRANSFER>) -> 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<const TRANSFER: bool> Serialize for Consignment<TRANSFER>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<const TRANSFER: bool> StrictArmor for Consignment<TRANSFER>

const PLATE_TITLE: &'static str = "RGB CONSIGNMENT"

type Id = ConsignmentId

fn armor_id(&self) -> Self::Id

fn armor_headers(&self) -> Vec<ArmorHeader>

fn parse_armor_headers( &mut self, headers: Vec<ArmorHeader>, ) -> Result<(), StrictArmorError>

fn checksum_armor(&self) -> bool

impl<const TRANSFER: bool> StrictDecode for Consignment<TRANSFER>

fn strict_decode(reader: &mut impl TypedRead) -> Result<Self, DecodeError>

fn strict_read(reader: impl ReadRaw) -> Result<Self, DecodeError>

impl<const TRANSFER: bool> StrictDeserialize for Consignment<TRANSFER>

fn from_strict_serialized<const MAX: usize>( ast_data: Confined<Vec<u8>, 0, MAX>, ) -> Result<Self, DeserializeError>

fn strict_deserialize_from_file<const MAX: usize>( path: impl AsRef<Path>, ) -> Result<Self, DeserializeError>

impl<const TRANSFER: bool> StrictDumb for Consignment<TRANSFER>

fn strict_dumb() -> Self

impl<const TRANSFER: bool> StrictEncode for Consignment<TRANSFER>

fn strict_encode<W: TypedWrite>(&self, writer: W) -> Result<W>

fn strict_write(&self, writer: impl WriteRaw) -> Result<(), Error>

impl<const TRANSFER: bool> StrictSerialize for Consignment<TRANSFER>

fn strict_serialized_len<const MAX: usize>(&self) -> Result<usize, Error>

fn to_strict_serialized<const MAX: usize>( &self, ) -> Result<Confined<Vec<u8>, 0, MAX>, SerializeError>

fn strict_serialize_to_file<const MAX: usize>( &self, path: impl AsRef<Path>, ) -> Result<(), SerializeError>

impl<const TRANSFER: bool> StrictStruct for Consignment<TRANSFER>

const ALL_FIELDS: &'static [&'static str]

fn strict_check_fields()

fn strict_type_info() -> TypeInfo<Self>

impl<const TRANSFER: bool> StrictType for Consignment<TRANSFER>

const STRICT_LIB_NAME: &'static str = LIB_NAME_RGB_OPS

fn strict_name() -> Option<TypeName>

impl<const TRANSFER: bool> StrictProduct for Consignment<TRANSFER>

impl<const TRANSFER: bool> StructuralPartialEq for Consignment<TRANSFER>