ergo-lib-wasm 0.22.0

WASM bindings for ergo-lib
Documentation
//! Ergo constant values

use crate::ast::js_conv::constant_from_js;
use crate::ast::js_conv::constant_to_js;
use crate::ergo_box::ErgoBox;
use crate::error_conversion::to_js;
use crate::utils::I64;
use ergo_lib::ergo_chain_types::Base16DecodedBytes;
use ergo_lib::ergo_chain_types::EcPoint;
use ergo_lib::ergotree_ir::base16_str::Base16Str;
use ergo_lib::ergotree_ir::mir::constant::{TryExtractFrom, TryExtractInto};
use ergo_lib::ergotree_ir::serialization::SigmaSerializable;
use ergo_lib::ergotree_ir::sigma_protocol::sigma_boolean::ProveDlog;
use gloo_utils::format::JsValueSerdeExt;
use js_sys::Uint8Array;
use std::convert::TryFrom;
use wasm_bindgen::prelude::*;

extern crate derive_more;
use derive_more::{From, Into};
use ergo_lib::ergotree_ir::bigint256::BigInt256;

pub mod js_conv;

/// Ergo constant(evaluated) values
#[wasm_bindgen]
#[derive(PartialEq, Eq, Debug, Clone, From, Into)]
pub struct Constant(ergo_lib::ergotree_ir::mir::constant::Constant);

#[wasm_bindgen]
impl Constant {
    /// Returns the debug representation of the type of the constant
    pub fn dbg_tpe(&self) -> String {
        format!("{:?}", self.0.tpe)
    }

    /// Returns the debug representation of the value of the constant
    pub fn dbg_inner(&self) -> String {
        format!("{:?}", self.0)
    }

    /// Decode from Base16-encoded ErgoTree serialized value
    pub fn decode_from_base16(base16_bytes_str: String) -> Result<Constant, JsValue> {
        let bytes = Base16DecodedBytes::try_from(base16_bytes_str.clone()).map_err(|_| {
            JsValue::from_str(&format!(
                "failed to decode base16 from: {}",
                base16_bytes_str.clone()
            ))
        })?;
        ergo_lib::ergotree_ir::mir::constant::Constant::try_from(bytes)
            .map_err(to_js)
            .map(Constant)
    }

    /// Encode as Base16-encoded ErgoTree serialized value or return an error if serialization
    /// failed
    pub fn encode_to_base16(&self) -> Result<String, JsValue> {
        self.0.base16_str().map_err(to_js)
    }

    /// Returns serialized bytes or fails with error if Constant cannot be serialized
    pub fn sigma_serialize_bytes(&self) -> Result<Vec<u8>, JsValue> {
        self.0
            .sigma_serialize_bytes()
            .map_err(|e| JsValue::from_str(&format! {"{:?}", e}))
    }

    /// Create from i32 value
    pub fn from_i32(v: i32) -> Constant {
        Constant(v.into())
    }

    /// Extract i32 value, returning error if wrong type
    pub fn to_i32(&self) -> Result<i32, JsValue> {
        i32::try_extract_from(self.0.clone()).map_err(to_js)
    }

    /// Create from i64
    pub fn from_i64(v: &I64) -> Constant {
        Constant(i64::from((*v).clone()).into())
    }

    /// Extract i64 value, returning error if wrong type
    pub fn to_i64(&self) -> Result<I64, JsValue> {
        i64::try_extract_from(self.0.clone())
            .map_err(to_js)
            .map(I64::from)
    }

    /// Create BigInt constant from byte array (signed bytes bit-endian)
    pub fn from_bigint_signed_bytes_be(num: &[u8]) -> Result<Constant, JsValue> {
        Ok(Constant(
            ergo_lib::ergotree_ir::mir::constant::Constant::from(BigInt256::try_from(num)?),
        ))
    }

    /// Create from byte array
    pub fn from_byte_array(v: &[u8]) -> Constant {
        Constant(v.to_vec().into())
    }

    /// Extract byte array, returning error if wrong type
    pub fn to_byte_array(&self) -> Result<Uint8Array, JsValue> {
        Vec::<u8>::try_extract_from(self.0.clone())
            .map(|v| Uint8Array::from(v.as_slice()))
            .map_err(to_js)
    }

    /// Create `Coll[Int]` from integer array
    #[allow(clippy::boxed_local)]
    pub fn from_i32_array(arr: Box<[i32]>) -> Result<Constant, JsValue> {
        arr.iter()
            .try_fold(vec![], |mut acc, l| {
                acc.push(*l);
                Ok(acc)
            })
            .map(|longs| longs.into())
            .map(Constant)
    }

    /// Extract `Coll[Int]` as integer array
    pub fn to_i32_array(&self) -> Result<Vec<i32>, JsValue> {
        self.0
            .clone()
            .try_extract_into::<Vec<i32>>()
            .map_err(|e| JsValue::from_str(&format!("Constant has wrong type: {:?}", e)))
    }

    /// Create `Coll[Long]` from string array
    #[allow(clippy::boxed_local)]
    pub fn from_i64_str_array(arr: Box<[JsValue]>) -> Result<Constant, JsValue> {
        arr.iter()
            .try_fold(vec![], |mut acc, l| {
                let b: i64 = if l.is_string() {
                    let l_str = l
                        .as_string()
                        .ok_or_else(|| JsValue::from_str("i64 as a string"))?;
                    serde_json::from_str(l_str.as_str())
                } else {
                    JsValueSerdeExt::into_serde(l)
                }
                .map_err(|e| {
                    JsValue::from_str(&format!(
                        "Failed to parse i64 from JSON string: {:?} \n with error: {:?}",
                        l, e
                    ))
                })?;
                acc.push(b);
                Ok(acc)
            })
            .map(|longs| longs.into())
            .map(Constant)
    }

    /// Extract `Coll[Long]` as string array
    #[allow(clippy::boxed_local)]
    pub fn to_i64_str_array(&self) -> Result<Box<[JsValue]>, JsValue> {
        let vec_i64 = self
            .0
            .clone()
            .try_extract_into::<Vec<i64>>()
            .map_err(|e| JsValue::from_str(&format!("Constant has wrong type: {:?}", e)))?;
        Ok(vec_i64
            .iter()
            .map(|it| JsValue::from_str(&it.to_string()))
            .collect())
    }

    /// Extract `Coll[Coll[Byte]]` as array of byte arrays
    pub fn to_coll_coll_byte(&self) -> Result<Vec<Uint8Array>, JsValue> {
        let vec_coll_byte = self
            .0
            .clone()
            .try_extract_into::<Vec<Vec<u8>>>()
            .map_err(to_js)?;
        Ok(vec_coll_byte
            .iter()
            .map(|it| Uint8Array::from(it.as_slice()))
            .collect())
    }

    /// Create `Coll[Coll[Byte]]` from array byte array
    pub fn from_coll_coll_byte(arr: Vec<Uint8Array>) -> Constant {
        let mut acc: Vec<Vec<u8>> = vec![];
        for bytes in arr.iter() {
            acc.push(bytes.to_vec());
        }
        let c = ergo_lib::ergotree_ir::mir::constant::Constant::from(acc);
        c.into()
    }

    /// Parse raw `EcPoint` value from bytes and make `ProveDlog` constant
    pub fn from_ecpoint_bytes(bytes: &[u8]) -> Result<Constant, JsValue> {
        let ecp = EcPoint::sigma_parse_bytes(bytes).map_err(to_js)?;
        let c: ergo_lib::ergotree_ir::mir::constant::Constant = ProveDlog::new(ecp).into();
        Ok(c.into())
    }

    /// Parse raw `EcPoint` value from bytes and make `GroupElement` constant
    pub fn from_ecpoint_bytes_group_element(bytes: &[u8]) -> Result<Constant, JsValue> {
        let ecp = EcPoint::sigma_parse_bytes(bytes).map_err(to_js)?;
        let c = ergo_lib::ergotree_ir::mir::constant::Constant::from(ecp);
        Ok(c.into())
    }

    /// Create `(Coll[Byte], Coll[Byte])` tuple Constant
    pub fn from_tuple_coll_bytes(bytes1: &[u8], bytes2: &[u8]) -> Constant {
        let t = (bytes1.to_vec(), bytes2.to_vec());
        let c: ergo_lib::ergotree_ir::mir::constant::Constant = t.into();
        c.into()
    }

    /// Extract `(Coll[Byte], Coll[Byte])` tuple from Constant as array of Uint8Array
    pub fn to_tuple_coll_bytes(&self) -> Result<Vec<Uint8Array>, JsValue> {
        let (bytes1, bytes2) = self
            .0
            .clone()
            .try_extract_into::<(Vec<u8>, Vec<u8>)>()
            .map_err(to_js)?;
        Ok(vec![
            Uint8Array::from(bytes1.as_slice()),
            Uint8Array::from(bytes2.as_slice()),
        ])
    }

    /// Create `(Int, Int)` tuple Constant
    pub fn to_tuple_i32(&self) -> Result<Vec<JsValue>, JsValue> {
        let (i1, i2) = self
            .0
            .clone()
            .try_extract_into::<(i32, i32)>()
            .map_err(to_js)?;
        Ok(vec![
            JsValue::from_str(&i1.to_string()),
            JsValue::from_str(&i2.to_string()),
        ])
    }

    /// Create `(Long, Long)` tuple Constant
    pub fn from_tuple_i64(l1: &I64, l2: &I64) -> Constant {
        let c: ergo_lib::ergotree_ir::mir::constant::Constant =
            (i64::from((*l1).clone()), i64::from((*l2).clone())).into();
        c.into()
    }

    /// Extract `(Long, Long)` tuple from Constant as array of strings
    pub fn to_tuple_i64(&self) -> Result<Vec<JsValue>, JsValue> {
        let (l1, l2) = self
            .0
            .clone()
            .try_extract_into::<(i64, i64)>()
            .map_err(to_js)?;
        Ok(vec![
            JsValue::from_str(&l1.to_string()),
            JsValue::from_str(&l2.to_string()),
        ])
    }

    /// Create from ErgoBox value
    pub fn from_ergo_box(v: &ErgoBox) -> Constant {
        let b: ergo_lib::ergotree_ir::chain::ergo_box::ErgoBox = v.clone().into();
        let c: ergo_lib::ergotree_ir::mir::constant::Constant = b.into();
        Constant(c)
    }

    /// Extract ErgoBox value, returning error if wrong type
    pub fn to_ergo_box(&self) -> Result<ErgoBox, JsValue> {
        self.0
            .clone()
            .try_extract_into::<ergo_lib::ergotree_ir::chain::ergo_box::ErgoBox>()
            .map(Into::into)
            .map_err(to_js)
    }

    /// Create Constant with Unit value
    pub fn unit() -> Constant {
        Constant(().into())
    }

    /// Returns true if constant value is Unit
    pub fn is_unit(&self) -> bool {
        self.0.tpe == ergo_lib::ergotree_ir::types::stype::SType::SUnit
    }

    /// Create a Constant from JS value
    /// JS types are converted to the following Ergo types:
    /// Number -> Int,
    /// String -> Long,
    /// BigInt -> BigInt,
    /// use array_as_tuple() to encode Ergo tuples
    pub fn from_js(value: &JsValue) -> Result<Constant, JsValue> {
        constant_from_js(value).map(Into::into).map_err(to_js)
    }

    /// Extract JS value from Constant
    /// Ergo types are converted to the following JS types:
    /// Byte -> Number,
    /// Short -> Number,
    /// Int -> Number,
    /// Long -> String,
    /// BigInt -> BigInt,
    /// Ergo tuples are encoded as arrays
    pub fn to_js(&self) -> Result<JsValue, JsValue> {
        constant_to_js(self.0.clone()).map_err(to_js)
    }
}