Struct ergo_lib::chain::ergo_box::ErgoBoxCandidate

pub struct ErgoBoxCandidate {
    pub value: BoxValue,
    pub ergo_tree: ErgoTree,
    pub tokens: Vec<Token>,
    pub additional_registers: NonMandatoryRegisters,
    pub creation_height: u32,
}

Contains the same fields as ErgoBox, except if transaction id and index, that will be calculated after full transaction formation. Use box_builder::ErgoBoxCandidateBuilder to create an instance.

Fields

value: BoxValue

amount of money associated with the box

ergo_tree: ErgoTree

guarding script, which should be evaluated to true in order to open this box

tokens: Vec<Token>

secondary tokens the box contains

additional_registers: NonMandatoryRegisters

additional registers the box can carry over

creation_height: u32

height when a transaction containing the box was created. This height is declared by user and should not exceed height of the block, containing the transaction with this box.

Implementations

impl ErgoBoxCandidate

pub fn serialize_body_with_indexed_digests<W: SigmaByteWrite>(
    &self,
    token_ids_in_tx: Option<&IndexSet<TokenId>>,
    w: &mut W
) -> Result<(), Error>

Box serialization with token ids optionally saved in transaction (in this case only token index is saved)

pub fn parse_body_with_indexed_digests<R: SigmaByteRead>(
    digests_in_tx: Option<&IndexSet<TokenId>>,
    r: &mut R
) -> Result<ErgoBoxCandidate, SerializationError>

Box deserialization with token ids optionally parsed in transaction

Trait Implementations

impl Clone for ErgoBoxCandidate

pub fn clone(&self) -> ErgoBoxCandidate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ErgoBoxCandidate

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

Formats the value using the given formatter.

impl Eq for ErgoBoxCandidate

impl ErgoBoxAssets for ErgoBoxCandidate

pub fn value(&self) -> BoxValue

Box value

pub fn tokens(&self) -> Vec<Token>

Tokens (ids and amounts)

impl From<ErgoBox> for ErgoBoxCandidate

pub fn from(b: ErgoBox) -> Self

Performs the conversion.

impl PartialEq<ErgoBoxCandidate> for ErgoBoxCandidate

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

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

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

This method tests for !=.

impl SigmaSerializable for ErgoBoxCandidate

pub fn sigma_serialize<W: SigmaByteWrite>(&self, w: &mut W) -> Result<(), Error>

Write self to the given writer. This function has a sigma_ prefix to alert the reader that the serialization in use is consensus-critical serialization
Notice that the error type is std::io::Error; this indicates that serialization MUST be infallible up to errors in the underlying writer. In other words, any type implementing SigmaSerializable must make illegal states unrepresentable.

pub fn sigma_parse<R: SigmaByteRead>(
    r: &mut R
) -> Result<Self, SerializationError>

Try to read self from the given reader. sigma- prefix to alert the reader that the serialization in use is consensus-critical

pub fn sigma_serialize_bytes(&self) -> Vec<u8>

Serialize any SigmaSerializable value into bytes

pub fn sigma_parse_bytes(mut bytes: Vec<u8>) -> Result<Self, SerializationError>

Parse self from the bytes

impl StructuralEq for ErgoBoxCandidate

impl StructuralPartialEq for ErgoBoxCandidate