Miden SDK Examples

This directory contains practical examples demonstrating how to use the @demox-labs/miden-sdk in your web applications. These examples cover core functionality and common use cases for interacting with the Miden blockchain and virtual machine.

Overview

The examples in this section showcase various capabilities of the Miden SDK, including:

• Account Operations

  • Creating new wallets
  • Creating new faucets
  • Importing existing accounts
  • Exporting account data
  • Retrieving account data

• Transaction Operations

  • Creating standard mint, consume, and send transaction requests
  • Creating custom transaction requests
  • Executing transactions
  • Submitting transactions to the network
  • Retrieving transaction history

• Note Operations

  • Retrieve input and output notes
  • Import and export notes
  • Working with consumable notes

For installation instructions, prerequisites, and setup details, please refer to the SDK README.

Each example is self-contained and includes:

• Complete source code
• Step-by-step explanations
• Expected outputs
• Common pitfalls and troubleshooting tips

Client Initialization

Most if not all examples require you to initialize the Miden Web Client. You can do this via:

import { WebClient } from "@demox-labs/miden-sdk";

// Initialize the web client
const webClient = await WebClient.createClient();