miden-client-web 0.14.0

Web Client library that facilitates interaction with the Miden network
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140

//!# Module Overview
//!
//! This module provides a set of structs and functionality that are exposed to JavaScript via
//! `wasm_bindgen`. These structs serve as wrappers around native objects from the acrss the miden
//! repositories. The goal is to provide a way to interact with these objects in a web context with
//! JavaScript, mimicking the same level of functionality and usability as when working with them in
//! Rust.
//!
//! ## Purpose
//!
//! This module is designed to enable developers to work with core objects and data structures used
//! in the miden client, directly from JavaScript in a browser environment. By exposing Rust-native
//! functionality via `wasm_bindgen`, it ensures that the web-based use of the miden client is as
//! close as possible to the Rust-native experience. These bindings allow the creation and
//! manipulation of important client structures, such as accounts, transactions, notes, and assets,
//! providing access to core methods and properties.
//!
//! ## Usage
//!
//! Each module provides Rust structs and methods that are exposed to JavaScript via `wasm_bindgen`.
//! These bindings allow developers to create and manipulate miden client objects in JavaScript,
//! while maintaining the same functionality and control as would be available in a pure Rust
//! environment.
//!
//! This makes it easy to build web-based applications that interact with the miden client, enabling
//! rich interaction with accounts, assets, and transactions directly from the browser.

#![allow(clippy::return_self_not_must_use)]

pub mod account;
pub mod account_builder;
pub mod account_code;
pub mod account_component;
pub mod account_component_code;
pub mod account_delta;
pub mod account_file;
pub mod account_header;
pub mod account_id;
pub mod account_proof;
pub mod account_reader;
pub mod account_status;
pub mod account_storage;
pub mod account_storage_mode;
pub mod account_storage_requirements;
pub mod account_type;
pub mod address;
pub mod advice_inputs;
pub mod advice_map;
pub mod asset_vault;
pub mod auth;
pub mod auth_scheme;
pub mod auth_secret_key;
pub mod basic_fungible_faucet_component;
pub mod block_header;
pub mod code_builder;
pub mod committed_note;
pub mod components;
pub mod consumable_note_record;
pub mod endpoint;
pub mod executed_transaction;
pub mod felt;
pub mod fetched_account;
pub mod foreign_account;
pub mod fungible_asset;
pub mod input_note;
pub mod input_note_record;
pub mod input_note_state;
pub mod input_notes;
pub mod library;
pub mod merkle_path;
pub mod note;
pub mod note_assets;
pub mod note_attachment;
pub mod note_attachment_kind;
pub mod note_details;
pub mod note_execution_hint;
pub mod note_export_format;
pub mod note_file;
pub mod note_filter;
pub mod note_header;
pub mod note_id;
pub mod note_inclusion_proof;
pub mod note_location;
pub mod note_metadata;
pub mod note_recipient;
pub mod note_script;
pub mod note_storage;
pub mod note_sync_info;
pub mod note_tag;
pub mod note_type;
pub mod output_note;
pub mod output_note_record;
pub mod output_note_state;
pub mod output_notes;
pub mod package;
pub mod partial_note;
pub mod poseidon2;
pub mod program;
pub mod proven_transaction;
pub mod provers;
pub mod public_key;
pub mod rpo256;
pub mod signature;
pub mod signing_inputs;
pub mod sparse_merkle_path;
pub mod storage_map;
pub mod storage_map_info;
pub mod storage_slot;
pub mod sync_summary;
pub mod token_symbol;
pub mod transaction_args;
pub mod transaction_filter;
pub mod transaction_id;
pub mod transaction_record;
pub mod transaction_request;
pub mod transaction_result;
pub mod transaction_script;
pub mod transaction_script_inputs;
pub mod transaction_status;
pub mod transaction_store_update;
pub mod transaction_summary;
pub mod word;

pub use crate::models::note_tag::NoteTag;
pub use crate::models::note_type::NoteType;

declare_js_miden_arrays! {
    (crate::models::account::Account) -> AccountArray,
    (crate::models::account_id::AccountId) -> AccountIdArray,
    (crate::models::foreign_account::ForeignAccount) -> ForeignAccountArray,
    (crate::models::note_recipient::NoteRecipient) -> NoteRecipientArray,
    (crate::models::note::Note) -> NoteArray,
    (crate::models::output_note::OutputNote) -> OutputNoteArray,
    (crate::models::storage_slot::StorageSlot) -> StorageSlotArray,
    (crate::models::transaction_script_inputs::TransactionScriptInputPair) -> TransactionScriptInputPairArray,
    (crate::models::felt::Felt) -> FeltArray,
    (crate::models::transaction_request::note_and_args::NoteAndArgs) -> NoteAndArgsArray,
    (crate::models::transaction_request::note_details_and_tag::NoteDetailsAndTag) -> NoteDetailsAndTagArray,
    (crate::models::transaction_request::note_id_and_args::NoteIdAndArgs) -> NoteIdAndArgsArray
}