Martian aptos-web3 dart Docs

Introduction

Web3 library for Aptos

Supported functions

1. createWallet: create a new wallet
2. importWallet: import an existing wallet
3. airdrop: airdrop test coins into an account
4. getBalance: get the balance of an account
5. transfer: transfer coins from one account to another
6. getSentEvents: get Sent events of an account
7. getReceivedEvents: get Received events of an account
8. createNFTCollection: create an NFT collection
9. createNFT: create an NFT
10. offerNFT: offer an NFT to a receiver
11. claimNFT: claim an NFT offered by a sender
12. cancelNFTOffer: cancel an outgoing NFT offer

Functions and their args, return values and description

Name	Argument: [name: type]	Returns	Description
createWallet	None	"code": string "address key": string	This method is used to create new wallet. It returns “code” which is a secret phrase and “address key” which is public address of the wallet
importWallet	code: string	"address key": string	This method is used to import wallet from mnemonic/secret phrase. It returns “address key” which is public address of the wallet
airdrop	code: string amount: number	None	This method is used to add coins in the wallet.
getBalance	address: string	balance: Integer	This method is used to get available balance of any address. It returns integer
transfer	code: string recipient_address: string amount: number	None	This method is used to transfer fund from one account to another. It returns Nothing
getSentEvents	address: string	Click Here	This method is used to fetch sent events done by the wallet. Please hit the url given in the returns field to see what it return
getReceivedEvents	address: string	Click Here	This method is used to fetch received events to the wallet. Please hit the url given in the returns field to see what it return
createNFTCollection	code: string name: string description: string uri: string	hash: string	This method is used to create collection inside the wallet/account. It returns submission hash
createNFT	code: string collection_name: string name: string description: string supply: number uri: string	hash: string	This method is used to create nft inside collection. It returns submission hash
offerNFT	code: string receiver_address: string creator_address: string collection_name: string token_name: string amount: number	hash: string	This method is used to offer nft to another address.
claimNFT	code: string sender_address: string creator_address: string collection_name: string token_name: string	hash: string	This method is used to claim nft offered

Usage Example Wallet

import 'package:martiandao_aptos_web3/martiandao_aptos_web3.dart';
// import 'package:martiandao_aptos_web3/src/account_client.dart';

void main() async {
  var wal = WalletClient();

  print("Creating wallet for Alice");  
  final alice = await wal.createWallet();
  
  print("Wallet Created $alice");  
  print("Current balance ${await wal.getBalance(alice['accounts'][0]['address'])}");

  print("\nCreating wallet for bob");  
  final bob = await wal.createWallet();
  
  print("Wallet Created $bob");  
  print("Current balance ${await wal.getBalance(bob['accounts'][0]['address'])}");


  dynamic aliceAccount = wal.getAccountFromMetaData(alice['code'], alice['accounts'][0]);
  dynamic bobAccount = wal.getAccountFromMetaData(bob['code'], bob['accounts'][0]);

  var aliceAddress = alice['accounts'][0]['address'];
  var bobAddress = bob['accounts'][0]['address'];


  print("\nAirdropping 12000 coins to alice");
  await wal.airdrop(aliceAccount, 12000);
  print("Updated balance alice ${await wal.getBalance(aliceAddress)}");

  print("\nAirdropping 12000 coins to bob");
  await wal.airdrop(bobAccount, 12000);
  print("Updated balance bob ${await wal.getBalance(bobAddress)}");

  print("\nTransferring 1000 from $aliceAddress (alice) -> $bobAddress (bob)");
  print("=========================================================================");
  await wal.transfer(aliceAccount, bobAddress, 1000);

  print("Wallet balance of alice account -> $aliceAddress");
  print("=========================================================================");
  print("${await wal.getBalance(aliceAddress)}");

  print("Wallet balance of bob account -> $bobAddress");
  print("=========================================================================");
  print("${await wal.getBalance(bobAddress)}");

  print("\nGetting Sent Events of account (alice) -> $aliceAddress");
  print("=========================================================================");
  print(await wal.getSentEvents(aliceAddress));

  print("\nGetting Received Events of account (bob) -> $bobAddress");
  print("=========================================================================");
  print(await wal.getReceivedEvents(bobAddress));

  print("\Importing wallet test");  
  final temp =  await wal.importWallet(alice['code']);
  print(temp);

  print("\n\nNFT Examples");
  const description = "Alice's simple collection";
  const collectionName = "AliceCollection";
  const tokenName = "AliceToken";
  const uri = "https://aptos.dev";
  const img = "https://aptos.dev/img/nyan.jpeg";

  print("\nCreating Collection: \nDescription -> $description \nName -> $collectionName \nURI -> $uri");
  print(await wal.createNFTCollection(aliceAccount, collectionName, description, uri));

  print("\nCreating NFT Token: image url -> $img, TokenName -> $tokenName");
  print(await wal.createNFT(aliceAccount, collectionName, tokenName, description, 1, img));

  print("\n\nGetting all NFTs");
  print(await wal.getTokens(aliceAddress));

  print("\n\nGetting single NFT");
  print(await wal.getToken(aliceAddress, collectionName, tokenName));

  print("\n\nTransfer NFT");
  await wal.offerNFT(aliceAccount, bobAddress, aliceAddress, collectionName, tokenName, 1);
  await wal.claimNFT(aliceAccount,aliceAddress, aliceAddress, collectionName, tokenName);
  print("Transfer Completed");

  print("\nTesting cache");
  dynamic cacheAliceAccount = wal.getAccountFromMetaData(alice['code'], alice['accounts'][0]);
  print("\nAirdropping 12000 coins to alice using cached account");
  await wal.airdrop(cacheAliceAccount, 12000);
  print("Updated balance alice ${await wal.getBalance(aliceAddress)}");


  print("\nRotating auth key of alice");
  print("=========================================================================");
  print(await wal.rotateAuthKey(alice['code'], alice['accounts'][0]));

  print("Getting JSON payload");
  print("=========================================================================");
  // String recipientAddress, String amount, String contractAddress
  // NOTE: Here contract address is not correct it is just for testing
  print(await wal.getJsonPayload(aliceAccount, "1000", aliceAccount));

  print("\nTransferring 1000 from $aliceAddress (alice) -> $bobAddress (bob) SHOULD THROW EXCEPTION: INVALID_AUTH_KEY");
  print("=========================================================================");
  await wal.transfer(aliceAccount, bobAddress, 1000);
}

To install dependencies and run example

dart pub install
dart run example/martian_aptos_web3_example.dart

Features and bugs

Please file feature requests and bugs at the issue tracker.