Struct ergo_headless_dapp_framework::specified_boxes::ErgsBox

pub struct ErgsBox { /* fields omitted */ }

A specified box which is intended to be spent for the Ergs inside. The spec simply requires the box to simply have at least 1000000 nanoErgs inside.

Implementations

impl ErgsBox

pub fn new(b: &ErgoBox) -> Result<ErgsBox, HeadlessDappError>

impl ErgsBox

pub fn w_new(ergo_box: WErgoBox) -> Result<ErgsBox, JsValue>

pub fn w_box_spec(&self) -> BoxSpec

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

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

impl ErgsBox

Rust ErgsBox Methods

pub fn convert_from_ergo_boxes(ergo_boxes: &ErgoBoxes) -> Result<Vec<ErgsBox>>

Converts from the WASM wrapper ErgoBoxes into a vector of ErgsBoxes.

pub fn sum_ergs_boxes_value(boxes: &Vec<ErgsBox>) -> u64

Sums the nanoErg value of a list of ErgsBoxes

Trait Implementations

impl Clone for ErgsBox

pub fn clone(&self) -> ErgsBox

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ErgsBox

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

Formats the value using the given formatter.

impl Eq for ErgsBox

impl ExplorerFindable for ErgsBox

pub fn process_explorer_response(
    explorer_response_body: &str
) -> Result<Vec<ErgsBox>, HeadlessDappError>

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 default BoxSpec of the SpecifiedBox using the verify_box() method and creating new instances of your SpecifiedBox struct.

pub fn process_explorer_response_custom(
    explorer_response_body: &str,
    box_spec: BoxSpec
) -> Result<Vec<ErgsBox>, HeadlessDappError>

Using the response JSON (as a String) from the Ergo Explorer API endpoint generated by the explorer_endpoint() method, filter all returned ErgoBoxes against a custom BoxSpec using the verify_box() method and creating new instances of your SpecifiedBox struct.

impl From<ErgsBox> for JsValue

pub fn from(value: ErgsBox) -> Self

Performs the conversion.

impl FromWasmAbi for ErgsBox

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 ErgsBox

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 ErgsBox

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 ErgsBox

pub fn none() -> Self::Abi

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

impl PartialEq<ErgsBox> for ErgsBox

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

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

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

This method tests for !=.

impl RefFromWasmAbi for ErgsBox

type Abi = u32

The wasm ABI type references to Self are recovered from.

type Anchor = Ref<'static, ErgsBox>

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 ErgsBox

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RefMut<'static, ErgsBox>

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl SpecifiedBox for ErgsBox

SpecifiedBox impl

pub fn box_spec() -> BoxSpec

A simple BoxSpec that just checks the value of nanoErgs is above 1000000

pub fn get_utxo_scan_json_string() -> String

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

Verify that a provided ErgoBox matches the BoxSpec tied to your SpecifiedBox

pub fn explorer_endpoint(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()

impl StructuralEq for ErgsBox

impl StructuralPartialEq for ErgsBox

impl WasmDescribe for ErgsBox

pub fn describe()

impl WrappedBox for ErgsBox

pub fn get_box(&self) -> ErgoBox

pub fn as_data_input(&self) -> DataInput

Converts the WrappedBox into a DataInput

pub fn as_unsigned_input(&self) -> UnsignedInput

Converts the WrappedBox into an UnsignedInput

pub fn box_id(&self) -> String

Returns the Box ID of the wrapped ErgoBox as a base16 String

pub fn nano_ergs(&self) -> NanoErg

Returns the amount of nanoErgs held in the wrapped ErgoBox as u64

pub fn p2s_address(&self) -> P2SAddressString

pub fn registers(&self) -> Vec<Constant>

Returns the registers of the wrapped ErgoBox as an ordered Vector of Constants. First element is R4, second element is R5, etc.

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

Returns the Tokens inside of the wrapped ErgoBox

pub fn creation_height(&self) -> u64

Returns the creation height of the wrapped ErgoBox