Struct ergo_headless_dapp_framework::specified_boxes::ErgUsdOraclePoolBox

pub struct ErgUsdOraclePoolBox { /* fields omitted */ }

A specified box which is an Oracle Pool box that stores a Long integer datapoint inside of R4 that represents how many nanoErgs can be bought for 1 USD.

Implementations

impl ErgUsdOraclePoolBox

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

impl ErgUsdOraclePoolBox

WASM-compatible ErgUsdOraclePoolBox Methods

pub fn w_new(wb: WErgoBox) -> Result<ErgUsdOraclePoolBox, JsValue>

pub fn datapoint(&self) -> u64

Extracts the Long datapoint out of register R4.

pub fn datapoint_in_cents(&self) -> u64

Extracts the Long datapoint out of register R4.

Trait Implementations

impl Clone for ErgUsdOraclePoolBox

pub fn clone(&self) -> ErgUsdOraclePoolBox

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ErgUsdOraclePoolBox

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

Formats the value using the given formatter.

impl ExplorerFindable for ErgUsdOraclePoolBox

pub fn process_explorer_response(
    explorer_response_body: &str
) -> Result<Vec<ErgUsdOraclePoolBox>, 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<ErgUsdOraclePoolBox>, 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<ErgUsdOraclePoolBox> for JsValue

pub fn from(value: ErgUsdOraclePoolBox) -> Self

Performs the conversion.

impl FromWasmAbi for ErgUsdOraclePoolBox

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 ErgUsdOraclePoolBox

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 ErgUsdOraclePoolBox

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 ErgUsdOraclePoolBox

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 ErgUsdOraclePoolBox

type Abi = u32

The wasm ABI type references to Self are recovered from.

type Anchor = Ref<'static, ErgUsdOraclePoolBox>

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 ErgUsdOraclePoolBox

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RefMut<'static, ErgUsdOraclePoolBox>

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 ErgUsdOraclePoolBox

SpecifiedBox impl

pub fn box_spec() -> BoxSpec

A box spec for an Oracle Pool Box with the correct NFT + a Long value in R4

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 WasmDescribe for ErgUsdOraclePoolBox

pub fn describe()

impl WrappedBox for ErgUsdOraclePoolBox

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