Struct ergo_lib::chain::ergo_box::box_builder::ErgoBoxCandidateBuilder

pub struct ErgoBoxCandidateBuilder { /* fields omitted */ }

ErgoBoxCandidate builder

Implementations

impl ErgoBoxCandidateBuilder

pub fn new(value: BoxValue, ergo_tree: ErgoTree, creation_height: u32) -> Self

Create builder with required box parameters: value - box value in nanoErgs, ergo_tree - ErgoTree to guard this box, current_height - chain height that will be set in the built box

pub fn set_min_box_value_per_byte(&mut self, new_min_value_per_byte: u32)

Set minimal value (per byte of the serialized box size)

pub fn min_box_value_per_byte(&self) -> u32

Get minimal value (per byte of the serialized box size)

pub fn set_value(&mut self, new_value: BoxValue)

Set new box value

pub fn value(&self) -> &BoxValue

Get box value

pub fn calc_box_size_bytes(&self) -> Result<usize, ErgoBoxCandidateBuilderError>

Calculate serialized box size(in bytes)

pub fn calc_min_box_value(
    &self
) -> Result<BoxValue, ErgoBoxCandidateBuilderError>

Calculate minimal box value for the current box serialized size(in bytes)

pub fn set_register_value(
    &mut self,
    register_id: NonMandatoryRegisterId,
    value: Constant
)

Set register with a given id (R4-R9) to the given value

pub fn register_value(
    &self,
    register_id: &NonMandatoryRegisterId
) -> Option<&Constant>

Returns register value for the given register id (R4-R9), or None if the register is empty

pub fn delete_register_value(&mut self, register_id: &NonMandatoryRegisterId)

Delete register value(make register empty) for the given register id (R4-R9)

pub fn mint_token(
    &mut self,
    token: Token,
    token_name: String,
    token_desc: String,
    num_decimals: usize
)

Mint token, as defined in https://github.com/ergoplatform/eips/blob/master/eip-0004.md token - token id(box id of the first input box in transaction) and token amount, token_name - token name (will be encoded in R4), token_desc - token description (will be encoded in R5), num_decimals - number of decimals (will be encoded in R6)

pub fn add_token(&mut self, token: Token)

Add given token id and token amount

pub fn build(self) -> Result<ErgoBoxCandidate, ErgoBoxCandidateBuilderError>

Build the box candidate

Trait Implementations

impl Clone for ErgoBoxCandidateBuilder

pub fn clone(&self) -> ErgoBoxCandidateBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ErgoBoxCandidateBuilder

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

Formats the value using the given formatter.