The End to End Guide For Staking VOW on the VL

This guide will walk you through successfully installing the API to staking your VOW on the VL and verifying the state of the transaction.

The first thing we need to do is ensure that you have npm installed. You'll find instructions on how to do this here. You'll also find instructions on how to install the avn-api library. Once that'S done, the next step is to set up your Substrate uri (SURI) as an environmental variable here. Setting your environment variable makes things easier going forward.

Note, all transactions on the VL must be paid for using VOW, so going forward it's important for you to have some VOW in your account. There are multiple ways to purchase VOW and this page provides instructions on how to get some. Note: You need 1 VOW in your account to use the API. The VOW needs to be lifted (moved) to the Voucher Ledger, and there are also instructions for that too here

Once you have some VOW in your account, of which you can check your account balance here, let's get to the exciting bit, staking your VOW on the VL by submitting a transaction to the VL. For this guide, we'll show a simple transaction staking 100 VOW.

important

First time stakers must stake a minimum of 100 VOW.

This operation uses a relayer account that the sender authorizes to submit the transfer transaction. You can learn more about relayers HERE.

You can get the VL_GATEWAY_URL and VL_RELAYER here.

const { AvnApi, SetupMode, SigningMode } = require("avn-api");
const VL_GATEWAY_URL = "gateway url of your chosen network";
const options = {
	suri: "suri of your account",
	setupMode: SetupMode.SingleUser,
	signingMode: SigningMode.SuriBased,
	hasPayer: true,
};

// Amount to Stake in 18 decimals (wei value). Decimal values (e.g. 1.3) are not supported.
AMOUNT_TO_STAKE = "100000000000000000000";

async function main() {
	const avnSdk = new AvnApi(VL_GATEWAY_URL, options);
	await avnSdk.init();
	const api = await avnSdk.apis();

	let result = await api.send.stake(AMOUNT_TO_STAKE);
	// returns a request id
	console.log(result);
}

(async () => {
	await main();
})();

Expected Transaction Submission Output

f1710fe7-141f-43c1-b1bb-6ec33d9b3e9a

Congratulations! You've now successfully submitted a transaction to the VL to stake 10 VOW.

State of the Transaction

To query the VL on the state of the staking transaction:

let status = await api.poll.requestState(requestId);
console.log(status);

Expected State Output

{
    "txHash": "0x37b5aa6...ae1c773c0acbc63dc90",
    "status": "Processed",
    "blockNumber": "125412",
    "transactionIndex": "2"
}