abidock_mvx 3.1.0

Full-Featured MultiversX blockchain SDK for Dart/Flutter.

example/README.md

---

id: examples title: Examples

Runnable code samples demonstrating the MultiversX SDK and the abidock code generator. Treat these as executable documentation—run every file directly with dart run.

Overview

The examples directory contains production-style code samples. Each sample demonstrates real-world usage patterns you can adapt for your applications.

Implementation Guides

Guide	Description
COOKBOOK.md	End-to-end manual SDK walkthroughs
CODEGEN_COOKBOOK.md	Generated controller workflows and best practices
ABI_COOKBOOK.md	Complete ABI types reference

Each guide links to exact Dart files so you can move from narrative explanations to runnable code without guesswork.

Directory Structure

Directory	Purpose
cookbook/manual/	Manual SDK examples: swaps, transfers, WebSocket listeners
cookbook/generated/	Generated controller examples
assets/	Wallet PEM files you supply; git-ignored

Every example resolves its file paths from the repository root, so run them from there — example/cookbook/pair.abi.json for the ABI and example/assets/alice.pem for the signing wallet.

Running Examples

Prerequisites

dart pub get
dart run example/assets/create_wallets.dart  # [1]

Where:

• [1] Creates example/assets/alice.pem and example/assets/bob.pem, then prints both addresses — fund them from the devnet faucet. See assets/README.md.

The three read-only listeners (websocket_events.dart, generated_polling_events.dart, generated_websocket_events.dart) need no wallet; the two WebSocket samples read their key from ABIDOCK_WS_API_KEY.

Manual SDK flows

dart run example/cookbook/manual/controller_swap.dart          # [1]
dart run example/cookbook/manual/controller_relayed_swap.dart  # [2]
dart run example/cookbook/manual/transfer.dart                 # [3]
dart run example/cookbook/manual/websocket_events.dart         # [4]

Where:

• [1] Smart contract interaction with manual ABI handling
• [2] Relayed transaction flow
• [3] Native EGLD transfers using TransfersController
• [4] WebSocket event streaming

Generated controllers

abidock example/cookbook/pair.abi.json example/cookbook/generated/pair Pair --full  # [1]
dart run example/cookbook/generated/generated_controller_swap.dart        # [2]
dart run example/cookbook/generated/generated_transfer.dart               # [3]
dart run example/cookbook/generated/generated_polling_events.dart         # [4]
dart run example/cookbook/generated/generated_websocket_events.dart       # [5]

Where:

• [1] Generate type-safe controller from ABI
• [2] DEX swap using generated methods
• [3] Token transfers with generated helpers
• [4] Polling event streams
• [5] WebSocket event streams

Additional Resources

Resource	Description
Documentation	Full online documentation
README.md	Root documentation
bin/README.md	CLI usage
API Reference	Generated API docs
MultiversX Docs	Protocol documentation

:::tip Check test/ for additional usage patterns and edge case handling. :::

Support

Questions or issues? Open a ticket at https://github.com/ABIdock/abidock_mvx/issues.