libra-sdk-mol v0.3.1

Javascript SDK for Libra Network and Move Smart Contract powered by MoveOnLibra OpenAPI.

Introduction

The MoveOnLibra/mol open API is used to develop Libra applications and smart contracts, aiming to make life as a Libra developer easier. The API is built using RESTful endpoints and standard HTTP verbs.

• Http status codes are used to indicate the status of the API call.
• JSON is returned on all our API responses, including errors, with a consistent structure for all messages.
• Text fields support UTF-8.

Installation

Using npm:

$ npm install libra-sdk-mol

Using bower:

$ bower install libra-sdk-mol

Using yarn:

$ yarn add libra-sdk-mol

Using cdn:

<script src="https://unpkg.com/libra-sdk-mol/dist/moveonlibra.browser.js"></script>

Usage

In nodejs:

const LibraClient = require('libra-sdk-mol');
var client = new LibraClient("testnet");
try{
	address = "000000000000000000000000000000000000000000000000000000000a550c18";
	data = await client.addressAPI.getAccountBalance(address);
    console.log(data.balance);
} catch (error) {
    console.log(error);
}

In browser:

<script src="https://unpkg.com/libra-sdk-mol/dist/moveonlibra.browser.js"></script>
<script>
	var client = new LibraClient("testnet");
	try{
		address = "000000000000000000000000000000000000000000000000000000000a550c18";
		data = await client.addressAPI.getAccountBalance(address);
		console.log(data.balance);
	} catch (error) {
		console.log(error);
	}
</script>

Mint some coins to address

// mint 123 micro-libra to address, the call is blocked until the mint is finished or failed.
tx = await client.transactionAPI.mint(address, 123);
assert 123 == tx.raw_txn.payload.Script.args[1].U64;
// get the transaction status
console.log(tx.transaction_info.major_status)

Query the income and expenditure of an address

For example, get the latest 5 incomes of an address：

events = await client.eventAPI.getAccountEventsLatestReceived(address, 5);
for(var i in events) {
	console.log(events[i].type_tag.Struct.name);//"ReceivedPaymentEvent";
	console.log(events[i].event_data_decode.amount) //received amount in micro-libra
}

Get the latest 5 expenditure of an address：

events = await client.eventAPI.getAccountEventsLatestSent(address, 5);
for(var i in events) {
	console.log(events[i].type_tag.Struct.name);//"SentPaymentEvent"
	console.log(events[i].event_data_decode.amount); //sent amount in micro-libra
}

Get the latest 5 income and expenditure in one call of an address：

events = await client.eventAPI.getAccountEventsLatest(address, 5);
console.log(events["sent"])
console.log(events["received"])

About API Authorization

You can access the MoveOnLibra public API without any prerequisites, there are 3 groups of public API:

• Address, all address API is public available.
• Event, all events API is public available.
• Transaction, all GET method API under Transaction group is public available.

Following API need a token to access:

• Wallet, all wallet API need API token to access.
• Move, (TODO) all move API need API token to access, currently not available.
• Transaction, all POST method API under Transaction group need API token to access except mint.

Access to MoveOnLibra's protected API requires authorization. You need to sign up to get your appkey.

For example, using appkey to create wallet and account:

var client = new LibraClient("testnet", appkey);
wallet = await client.walletAPI.createWallet(name)
account = await client.walletAPI.createWalletAccount(wallet)

Example Project

We wrote an Libra wallet demo using libra-sdk-mol package, the source code is here libra-wallet-demo.

The online access url of the wallet is https://www.moveonlibra.com/wallet.html.

API List

AddressAPI

AuthkeyAPI

EventAPI

LibraAPI

TransactionAPI

WalletAPI