abidock_mvx 1.0.0-beta.2

abidock_mvx: ^1.0.0-beta.2 copied to clipboard

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 #

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

Directory Structure #

Running Examples #

Prerequisites #

dart pub get

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 #

:::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.