Struct ergo_lib_wasm::ergo_box::box_builder::ErgoBoxCandidateBuilder

pub struct ErgoBoxCandidateBuilder(_);

ErgoBoxCandidate builder

Implementations

impl ErgoBoxCandidateBuilder

pub fn new(value: &BoxValue, contract: &Contract, creation_height: u32) -> Self

Create builder with required box parameters: value - amount of money associated with the box contract - guarding contract(Contract), which should be evaluated to true in order to open(spend) this box creation_height - height when a transaction containing the box is created. It should not exceed height of the block, containing the transaction with this 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, JsValue>

Calculate serialized box size(in bytes)

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

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_id: &TokenId, amount: &TokenAmount)

Add given token id and token amount

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

Build the box candidate

Trait Implementations

impl FromWasmAbi for ErgoBoxCandidateBuilder

type Abi = u32

The wasm ABI type that this converts from when coming back out from the ABI boundary.

pub unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for ErgoBoxCandidateBuilder

type Abi = u32

The wasm ABI type that this converts into when crossing the ABI boundary.

pub fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl OptionFromWasmAbi for ErgoBoxCandidateBuilder

pub fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a "none" instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for ErgoBoxCandidateBuilder

pub fn none() -> Self::Abi

Returns an ABI instance indicating "none", which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for ErgoBoxCandidateBuilder

type Abi = u32

The wasm ABI type references to Self are recovered from.

type Anchor = Ref<'static, ErgoBoxCandidateBuilder>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don't persist beyond one function call, and so that they remain anonymous.

pub unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for ErgoBoxCandidateBuilder

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RefMut<'static, ErgoBoxCandidateBuilder>

Same as RefFromWasmAbi::Anchor

pub unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl WasmDescribe for ErgoBoxCandidateBuilder

pub fn describe()