abidock_mvx 1.0.0-beta.2

abidock_mvx: ^1.0.0-beta.2 copied to clipboard

id: overview title: abidock_mvx #

MultiversX SDK for Dart/Flutter that provides wallets, smart-contract controllers, ABI codecs, and a CLI for generating type-safe Dart code from contract ABIs.

Overview #

abidock_mvx is a Dart/Flutter SDK for the MultiversX blockchain:

Installation #

Step 1: Add the dependency #

Add abidock_mvx to your pubspec.yaml:

dependencies:
  abidock_mvx: ^1.0.0-beta.1

Step 2: Install packages #

dart pub get

Step 3: Install the CLI (optional) #

dart pub global activate abidock_mvx

:::important Ensure ~/.pub-cache/bin (Linux/macOS) or %LOCALAPPDATA%\Pub\Cache\bin (Windows) is on your PATH so the abidock command resolves globally. :::

Quick Start #

Creating an account #

import 'package:abidock_mvx/abidock_mvx.dart';

final mnemonic = Mnemonic.generate();                      // [1]
final words = mnemonic.getWords().join(' ');               // [2]
final account = await Account.fromMnemonic(words);         // [3]
print('Address: ${account.address.bech32}');               // [4]

Where:

• [1] Generate a new 24-word mnemonic phrase
• [2] Get the mnemonic as a space-separated string
• [3] Derive the first account (index 0) from the mnemonic
• [4] Print the bech32 address (e.g., erd1...)

Calling a smart contract #

final provider = ApiNetworkProvider.devnet();              // [1]
final abiJson = await File('example/cookbook/pair.abi.json').readAsString();
final controller = SmartContractController(
  contractAddress: SmartContractAddress.fromBech32('erd1...'),  // [2]
  abi: SmartContractAbi.fromJson(abiJson),                 // [3]
  networkProvider: provider,
);

final accountOnNetwork = await provider.getAccount(account.address);
final tx = await controller.call(                          // [4]
  account: account,
  nonce: accountOnNetwork.nonce,
  endpointName: 'swapTokensFixedInput',
  arguments: [TokenIdentifierValue('MEX-a659d0'), BigInt.from(1000000)],
  tokenTransfers: [
    TokenTransferValue.fromPrimitives(
      tokenIdentifier: 'WEGLD-a28c59',
      amount: BigInt.from(10).pow(17),
    ),
  ],
  options: BaseControllerInput(gasLimit: GasLimit(25000000)),
);
final hash = await provider.sendTransaction(tx);           // [5]
print('Submitted: $hash');

Where:

• [1] Connect to the devnet API
• [2] Specify the contract address
• [3] Parse the ABI JSON
• [4] Build and sign a transaction
• [5] Broadcast the signed transaction to the network

Generating type-safe controllers #

abidock example/cookbook/pair.abi.json lib/generated/pair Pair --full

:::tip Generated controllers expose typed queries, calls, event streams, and dedicated transfer helpers. See example/cookbook/generated/ for complete runnable samples. :::

CLI Commands #

Common flags: --full, --logger, --transfers, --autogas, --interactive, --config <path>.

:::important Relayer and guardian parameters are always available in generated code. :::

Repository Structure #

lib/                 Core SDK (abi, core, infrastructure, utils, wallet)
bin/abidock.dart     CLI entrypoint (config + legacy modes)
example/             Manual & generated cookbook scenarios with reference ABIs
test/                900+ unit, integration, and regression tests
scripts/             Release and automation scripts

Documentation #

Contributing #

We welcome issues, feature requests, and pull requests. Please read CONTRIBUTING.md for workflow expectations, coding standards, and how to run tests locally before opening a PR.

License #

abidock_mvx is available under the MIT License.