Struct ergo_headless_dapp_framework::output_builders::TokensChangeBox

pub struct TokensChangeBox {}

A struct used while constructing txs to build a ErgoBoxCandidate that holds various tokens from the input boxes which are not relevant to the protocol at hand. In other words a "Tokens Change Box".

Implementations

impl TokensChangeBox

pub fn output_candidate(
    input_boxes: &Vec<ErgoBox>,
    value: NanoErg,
    user_address: &P2PKAddressString,
    current_height: u64
) -> Result<ErgoBoxCandidate>

Creates an ErgoBoxCandidate which holds all of the tokens from the the provided inputs. In other words creates a "TokensChange" box for the tokens inside of the inputs. Holds number of nanoErgs value as provided to method.

pub fn output_candidate_filtered(
    filter_tokens: &Vec<Token>,
    input_boxes: &Vec<ErgoBox>,
    value: NanoErg,
    user_address: &P2PKAddressString,
    current_height: u64
) -> Result<ErgoBoxCandidate>

Creates an ErgoBoxCandidate which holds tokens from the the provided inputs excluding the tokens provided in the filter list. Holds number of nanoErgs value as provided to method.

pub fn output_candidate_with_registers_filtered(
    filter_tokens: &Vec<Token>,
    input_boxes: &Vec<ErgoBox>,
    value: NanoErg,
    registers: &Vec<Constant>,
    user_address: &P2PKAddressString,
    current_height: u64
) -> Result<ErgoBoxCandidate>

Creates an ErgoBoxCandidate which holds tokens from the the provided inputs excluding the tokens provided in the filter list. Holds number of nanoErgs value as provided to method and uses the customized registers provided.