Skip to content
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,8 @@ try {

For more detailed information about the classes and methods used in these examples, refer to the following API documentation:

- [WebClient](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/WebClient.md) - Main client class for interacting with the Miden network
- [Account](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/Account.md) - Account class and its properties
- [AccountId](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/AccountId.md) - Account identifier class and utilities
- [WebClient](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/WebClient.md) - Main client class for interacting with the Miden network
- [Account](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/Account.md) - Account class and its properties
- [AccountId](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/AccountId.md) - Account identifier class and utilities

For a complete list of available classes and utilities, see the [SDK API Reference](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/README.md).
For a complete list of available classes and utilities, see the [SDK API Reference](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/README.md).
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The examples in this section showcase various capabilities of the Miden SDK, inc
- Working with consumable notes
- Send and fetch private notes using the note transport network

For installation instructions, prerequisites, and setup details, please refer to the [SDK README](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/README.md).
For installation instructions, prerequisites, and setup details, please refer to the [SDK README](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/README.md).

Each example is self-contained and includes:

Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-0.12/miden-client/web-client/export.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,6 @@ The store export contains all the data managed by the client, which can be usefu

For more detailed information about the export functionality, refer to the following API documentation:

- [WebClient](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/WebClient.md) - Main client class for interacting with the Miden network
- [WebClient](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/WebClient.md) - Main client class for interacting with the Miden network

For a complete list of available classes and utilities, see the [SDK API Reference](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/README.md).
For a complete list of available classes and utilities, see the [SDK API Reference](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/README.md).
6 changes: 3 additions & 3 deletions versioned_docs/version-0.12/miden-client/web-client/import.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ The `forceImportStore` method is a destructive operation that will completely ov

For more detailed information about the import functionality, refer to the following API documentation:

- [WebClient](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/WebClient.md) - Main client class for interacting with the Miden network
- [Account](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/Account.md) - Account class returned by importPublicAccountFromSeed
- [WebClient](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/WebClient.md) - Main client class for interacting with the Miden network
- [Account](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/Account.md) - Account class returned by importPublicAccountFromSeed

For a complete list of available classes and utilities, see the [SDK API Reference](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/README.md).
For a complete list of available classes and utilities, see the [SDK API Reference](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/README.md).
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ npm install @demox-labs/miden-sdk
yarn add @demox-labs/miden-sdk
```

See the [README](https://github.com/0xMiden/miden-client/blob/main/crates/web-client/README) for full installation instructions and some usage instructions, including code examples for wallet creation, transaction execution, and syncing state.
See the [README](https://github.com/0xMiden/miden-client/blob/main/crates/web-client/README.md) for full installation instructions and some usage instructions, including code examples for wallet creation, transaction execution, and syncing state.
Original file line number Diff line number Diff line change
Expand Up @@ -81,10 +81,10 @@ try {
For more detailed information about the classes and methods used in these examples, refer to the following API documentation:

- [WebClient](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/WebClient.md) - Main client class for interacting with the Miden network
- [Account](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/Account.md) - Account class and its properties
- [AccountStorageMode](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/AccountStorageMode.md) - Storage mode options and methods
- [AccountId](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/AccountId.md) - Account identifier class and utilities
- [AccountCode](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/AccountCode.md) - Account code management
- [AccountStorage](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/AccountStorage.md) - Account storage operations
- [Account](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/Account.md) - Account class and its properties
- [AccountStorageMode](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/AccountStorageMode.md) - Storage mode options and methods
- [AccountId](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/AccountId.md) - Account identifier class and utilities
- [AccountCode](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/AccountCode.md) - Account code management
- [AccountStorage](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/AccountStorage.md) - Account storage operations

For a complete list of available classes and utilities, see the [SDK API Reference](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/README.md).
For a complete list of available classes and utilities, see the [SDK API Reference](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/README.md).
Original file line number Diff line number Diff line change
Expand Up @@ -269,22 +269,22 @@ Custom transactions require a good understanding of the Miden VM and its instruc

For more detailed information about transaction functionality, refer to the following API documentation:

- [WebClient](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/WebClient.md) - Main client class for transaction operations
- [TransactionRequest](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/TransactionRequest.md) - Class representing transaction requests
- [TransactionRequestBuilder](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/TransactionRequestBuilder.md) - Builder class for creating transaction requests
- [TransactionResult](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/TransactionResult.md) - Class representing transaction execution results
- [TransactionProver](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/TransactionProver.md) - Class for transaction proving
- [TransactionScript](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/TransactionScript.md) - Class for defining transaction scripts
- [NoteType](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/enumerations/NoteType.md) - Enumeration for note types (Private/Public)
- [NoteAssets](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/NoteAssets.md) - Class for defining note assets
- [NoteMetadata](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/NoteMetadata.md) - Class for defining note metadata
- [FungibleAsset](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/FungibleAsset.md) - Class for defining fungible assets
- [Felt](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/Felt.md) - Class for working with field elements
- [FeltArray](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/FeltArray.md) - Class for working with arrays of field elements
- [NoteTag](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/NoteTag.md) - Class for defining note tags
- [NoteExecutionMode](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/NoteExecutionMode.md) - Class for defining note execution modes
- [NoteExecutionHint](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/NoteExecutionHint.md) - Class for defining note execution hints
- [OutputNotesArray](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/OutputNotesArray.md) - Class for working with arrays of output notes
- [NotesArray](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/NotesArray.md) - Class for working with arrays of notes

For a complete list of available classes and utilities, see the [SDK API Reference](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/README.md).
- [WebClient](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/WebClient.md) - Main client class for transaction operations
- [TransactionRequest](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/TransactionRequest.md) - Class representing transaction requests
- [TransactionRequestBuilder](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/TransactionRequestBuilder.md) - Builder class for creating transaction requests
- [TransactionResult](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/TransactionResult.md) - Class representing transaction execution results
- [TransactionProver](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/TransactionProver.md) - Class for transaction proving
- [TransactionScript](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/TransactionScript.md) - Class for defining transaction scripts
- [NoteType](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/enumerations/NoteType.md) - Enumeration for note types (Private/Public)
- [NoteAssets](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/NoteAssets.md) - Class for defining note assets
- [NoteMetadata](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/NoteMetadata.md) - Class for defining note metadata
- [FungibleAsset](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/FungibleAsset.md) - Class for defining fungible assets
- [Felt](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/Felt.md) - Class for working with field elements
- [FeltArray](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/FeltArray.md) - Class for working with arrays of field elements
- [NoteTag](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/NoteTag.md) - Class for defining note tags
- [NoteExecutionMode](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/NoteExecutionMode.md) - Class for defining note execution modes
- [NoteExecutionHint](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/NoteExecutionHint.md) - Class for defining note execution hints
- [OutputNotesArray](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/OutputNotesArray.md) - Class for working with arrays of output notes
- [NotesArray](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/NotesArray.md) - Class for working with arrays of notes

For a complete list of available classes and utilities, see the [SDK API Reference](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/README.md).
Original file line number Diff line number Diff line change
Expand Up @@ -83,11 +83,11 @@ try {

For more detailed information about note transport functionality, refer to the following API documentation:

- [WebClient](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/WebClient.md) - Main client class for note transport operations
- [Note](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/Note.md) - Class for working with notes
- [Address](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/Address.md) - Class for working with addresses
- [NoteFilter](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/NoteFilter.md) - Class for filtering notes
- [NoteFilterTypes](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/enumerations/NoteFilterTypes.md) - Enumeration for note filter types
- [WebClient](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/WebClient.md) - Main client class for note transport operations
- [Note](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/Note.md) - Class for working with notes
- [Address](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/Address.md) - Class for working with addresses
- [NoteFilter](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/NoteFilter.md) - Class for filtering notes
- [NoteFilterTypes](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/enumerations/NoteFilterTypes.md) - Enumeration for note filter types

For a complete list of available classes and utilities, see the [SDK API Reference](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/README.md).
For a complete list of available classes and utilities, see the [SDK API Reference](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/README.md).

17 changes: 9 additions & 8 deletions versioned_docs/version-0.12/miden-client/web-client/notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,15 +123,15 @@ try {

For more detailed information about note functionality, refer to the following API documentation:

- [WebClient](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/WebClient.md) - Main client class for note operations
- [NoteFilter](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/NoteFilter.md) - Class for filtering notes
- [NoteFilterTypes](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/enumerations/NoteFilterTypes.md) - Enumeration for note filter types
- [AccountId](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/AccountId.md) - Class for working with account IDs
- [InputNoteRecord](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/InputNoteRecord.md) - Class representing input notes
- [ConsumableNoteRecord](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/ConsumableNoteRecord.md) - Class representing consumable notes
- [NoteScript](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/NoteScript.md) - Class for working with note scripts
- [WebClient](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/WebClient.md) - Main client class for note operations
- [NoteFilter](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/NoteFilter.md) - Class for filtering notes
- [NoteFilterTypes](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/enumerations/NoteFilterTypes.md) - Enumeration for note filter types
- [AccountId](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/AccountId.md) - Class for working with account IDs
- [InputNoteRecord](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/InputNoteRecord.md) - Class representing input notes
- [ConsumableNoteRecord](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/ConsumableNoteRecord.md) - Class representing consumable notes
- [NoteScript](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/NoteScript.md) - Class for working with note scripts

For a complete list of available classes and utilities, see the [SDK API Reference](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/README.md).
For a complete list of available classes and utilities, see the [SDK API Reference](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/README.md).

### Available Note Filter Types

Expand Down Expand Up @@ -159,3 +159,4 @@ const noteIds = [noteId1, noteId2];
const listFilter = new NoteFilter(NoteFilterTypes.List, noteIds);
const specificNotes = await webClient.getInputNotes(listFilter);
```

13 changes: 7 additions & 6 deletions versioned_docs/version-0.12/miden-client/web-client/sync.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,11 @@ The `SyncSummary` object returned by `syncState()` contains the following inform

For more detailed information about sync functionality, refer to the following API documentation:

- [WebClient](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/WebClient.md) - Main client class for sync operations
- [SyncSummary](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/SyncSummary.md) - Class representing sync state
- [NoteId](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/NoteId.md) - Class for working with note IDs
- [AccountId](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/AccountId.md) - Class for working with account IDs
- [TransactionId](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/TransactionId.md) - Class for working with transaction IDs
- [WebClient](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/WebClient.md) - Main client class for sync operations
- [SyncSummary](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/SyncSummary.md) - Class representing sync state
- [NoteId](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/NoteId.md) - Class for working with note IDs
- [AccountId](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/AccountId.md) - Class for working with account IDs
- [TransactionId](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/TransactionId.md) - Class for working with transaction IDs

For a complete list of available classes and utilities, see the [SDK API Reference](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/README.md).

For a complete list of available classes and utilities, see the [SDK API Reference](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/README.md).
Loading