Struct ergo_headless_dapp_framework::box_spec::BoxSpec

pub struct BoxSpec { /* fields omitted */ }

A specification which specifies parameters of an ErgoBox. This spec is used as a "source of truth" to both verify and find ErgoBoxes which match the spec. This is often used for defining Stages in multi-stage smart contract protocols, but can also be used to define input boxes for Actions. All fields are wrapped in Options to allow ignoring specifying the field.

Implementations

impl BoxSpec

Method definitions for BoxSpec that are WASM-compatible by default and/or are wrapper functions for Rust methods so that they are made WASM-compatible.

pub fn utxo_scan_json(&self) -> String

pub fn modified_address(&self, address: Option<ErgoAddressString>) -> BoxSpec

Returns a new BoxSpec with all fields exactly the same except the address is set to the String provided as input. This method is generally used to hone down a more generic BoxSpec definition into a more specific one for your given use case. Ie. Add a user's P2PK address to find boxes matching the BoxSpec in their wallet.

pub fn w_verify_box(&self, wrapped_ergo_box: WErgoBox) -> bool

pub fn w_explorer_endpoint(
    &self,
    explorer_api_url: &str
) -> Result<String, JsValue>

pub fn w_process_explorer_response(
    &self,
    explorer_response_body: &str
) -> Result<ErgoBoxes, JsValue>

impl BoxSpec

Method definitions for BoxSpec that are intended to be used in Rust.

pub fn new(
    address: Option<ErgoAddressString>,
    value_range: Option<Range<NanoErg>>,
    registers: Vec<RegisterSpec>,
    tokens: Vec<Option<TokenSpec>>
) -> BoxSpec

Create a new basic BoxSpec with no predicate.

pub fn new_predicated(
    address: Option<ErgoAddressString>,
    value_range: Option<Range<NanoErg>>,
    registers: Vec<RegisterSpec>,
    tokens: Vec<Option<TokenSpec>>,
    predicate: Option<fn(_: &ErgoBox) -> bool>
) -> BoxSpec

Create a new BoxSpec with a custom predicate defined.

pub fn ergo_tree(&self) -> Result<ErgoTree>

Acquire the ErgoTree of the address in the BoxSpec

pub fn verify_box(&self, ergo_box: &ErgoBox) -> Result<()>

Verify that a provided ErgoBox matches the spec

pub fn explorer_endpoint(&self, explorer_api_url: &str) -> Result<String>

Generates a URL for the Ergo Explorer Backend API to find boxes which may match your BoxSpec. This method uses the explorer_api_url you provide as input which must be formatted as such: https://api.ergoplatform.com/api This method is intended to be used in tandem with process_explorer_response()

pub fn process_explorer_response(
    &self,
    explorer_response_body: &str
) -> Result<Vec<ErgoBox>>

Using the response JSON (as a String) from the Ergo Explorer API endpoint generated by the explorer_endpoint() method, filter all returned ErgoBoxes against the BoxSpec using the verify_box() method.

impl BoxSpec

Methods related to modifying fields (which aren't WASM-compatible)

pub fn modified_value_range(&self, value_range: Option<Range<u64>>) -> BoxSpec

Returns a new BoxSpec with all fields exactly the same except the value_range is set to the range provided as input.

pub fn modified_registers(&self, registers: Vec<RegisterSpec>) -> BoxSpec

Returns a new BoxSpec with all fields exactly the same except the registers are set to the registers provided as input.

pub fn modified_tokens(&self, tokens: Vec<Option<TokenSpec>>) -> BoxSpec

Returns a new BoxSpec with all fields exactly the same except the tokens are set to the TokenSpecs provided as input.

pub fn modified_predicate(
    &self,
    predicate: Option<fn(_: &ErgoBox) -> bool>
) -> BoxSpec

Returns a new BoxSpec with all fields exactly the same except the predicate is set to the one provided as input.

Trait Implementations

impl Clone for BoxSpec

pub fn clone(&self) -> BoxSpec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<BoxSpec> for JsValue

pub fn from(value: BoxSpec) -> Self

Performs the conversion.

impl FromWasmAbi for BoxSpec

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 BoxSpec

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 BoxSpec

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 BoxSpec

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 BoxSpec

type Abi = u32

The wasm ABI type references to Self are recovered from.

type Anchor = Ref<'static, BoxSpec>

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 BoxSpec

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RefMut<'static, BoxSpec>

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 BoxSpec

pub fn describe()