Struct JsNote

pub struct JsNote {

    pub scheme: String,
    pub protocol: NoteProtocol,
    pub version: NoteVersion,
    pub source_chain_id: String,
    pub target_chain_id: String,
    pub source_identifying_data: String,
    pub target_identifying_data: String,
    pub secrets: Vec<Vec<u8>>,
    pub curve: Option<Curve>,
    pub exponentiation: Option<i8>,
    pub width: Option<usize>,
    pub token_symbol: Option<String>,
    pub amount: Option<String>,
    pub denomination: Option<u8>,
    pub backend: Option<Backend>,
    pub hash_function: Option<HashFunction>,
    pub index: Option<u64>,
}

Fields

scheme: String

protocol: NoteProtocol

version: NoteVersion

source_chain_id: String

target_chain_id: String

source_identifying_data: String

target_identifying_data: String

secrets: Vec<Vec<u8>>

mixer related items

curve: Option<Curve>

Misc - zkp related items

exponentiation: Option<i8>

width: Option<usize>

token_symbol: Option<String>

amount: Option<String>

denomination: Option<u8>

backend: Option<Backend>

hash_function: Option<HashFunction>

index: Option<u64>

Implementations

impl JsNote

pub fn deserialize(note: &str) -> Result<Self, OperationError>

Deseralize note from a string

pub fn mutate_index(&mut self, index: u64) -> Result<(), OperationError>

pub fn get_leaf_and_nullifier(&self) -> Result<JsLeaf, OperationError>

pub fn get_js_utxo(&self) -> Result<JsUtxo, OperationError>

impl JsNote

pub fn new(builder: JsNoteBuilder) -> Result<JsNote, JsValue>

pub fn js_deserialize(note: JsString) -> Result<JsNote, JsValue>

pub fn get_leaf_commitment(&self) -> Result<Uint8Array, JsValue>

pub fn serialize(&self) -> JsString

pub fn protocol(&self) -> Protocol

pub fn version(&self) -> Version

pub fn target_chain_id(&self) -> JsString

pub fn source_chain_id(&self) -> JsString

pub fn target_identifying_data(&self) -> JsString

pub fn source_identifying_data(&self) -> JsString

pub fn backend(&self) -> BE

pub fn hash_function(&self) -> JsString

pub fn curve(&self) -> WasmCurve

pub fn secrets(&self) -> JsString

pub fn token_symbol(&self) -> JsString

pub fn amount(&self) -> JsString

pub fn denomination(&self) -> JsString

pub fn width(&self) -> JsString

pub fn exponentiation(&self) -> JsString

pub fn js_mutate_index(&mut self, index: JsString) -> Result<(), JsValue>

pub fn default_utxo_note(note: &JsNote) -> Result<JsNote, OperationError>

pub fn get_utxo(&self) -> Result<JsUtxo, OperationError>

pub fn update_vanchor_utxo( &mut self, utxo: JsUtxo, ) -> Result<(), OperationError>

pub fn index(&self) -> JsString

Trait Implementations

impl Clone for JsNote

fn clone(&self) -> JsNote

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JsNote

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

Formats the value using the given formatter.

impl Display for JsNote

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

Formats the value using the given formatter.

impl From<JsNote> for JsValue

fn from(value: JsNote) -> Self

Converts to this type from the input type.

impl FromStr for JsNote

type Err = OperationError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl FromWasmAbi for JsNote

type Abi = u32

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for JsNote

type Abi = u32

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl LongRefFromWasmAbi for JsNote

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<JsNote>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for JsNote

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 JsNote

fn none() -> Self::Abi

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

impl PartialEq for JsNote

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefFromWasmAbi for JsNote

type Abi = u32

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<JsNote>

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.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for JsNote

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<JsNote>

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl TryFromJsValue for JsNote

type Error = JsValue

The type returned in the event of a conversion error.

fn try_from_js_value(value: JsValue) -> Result<Self, Self::Error>

Performs the conversion.

impl VectorFromWasmAbi for JsNote

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[JsNote]>

impl VectorIntoJsValue for JsNote

fn vector_into_jsvalue(vector: Box<[JsNote]>) -> JsValue

impl VectorIntoWasmAbi for JsNote

type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi

fn vector_into_abi(vector: Box<[JsNote]>) -> Self::Abi

impl WasmDescribe for JsNote

fn describe()

impl WasmDescribeVector for JsNote

fn describe_vector()

impl Eq for JsNote

impl StructuralPartialEq for JsNote

impl SupportsConstructor for JsNote

impl SupportsInstanceProperty for JsNote

impl SupportsStaticProperty for JsNote