Skip to Content
API ReferenceAvail node API referenceCreate a new nomination pool

Create a new nomination pool

On-chain name of method: nominationPools_create

Parameters

parametertypeoptionaldescription
amountBNfalseThe amount of funds to delegate to the pool
rootstringfalseThe account to set as [PoolRoles::root]
nominatorstringfalseThe account to set as the [PoolRoles::nominator]
bouncerstringfalseThe account to set as the [PoolRoles::bouncer]
waitForWaitForfalsewait for block inclusion or finalization
accountKeyringPairfalseaccount that will send and sign the transaction
optionsSignerOptionstrueused to overwrite existing signer options

Returns

On failure, a reason for the failure is returned. On success, the function will return a object of type PoolCreateTxSuccess. This object contains the details of the transaction and your newly created nomination pool.

Minimal example

  1. You will need to set up the dev environment required to run this example. For instructions, check out our docs here.

  2. If you’re sending an extrinsic (i.e conducting a transaction) you will need to replace the demo seed phrase with your own seed phrase. The rest of the code should work as is.

⚠️
  1. The minimum amount of AVAIL required to create a nomination pool is 10_000 AVAIL.
  2. You need to allocate privileges to some accounts while creating the pool.

Different roles within a nomination pool

A pool consists of 4 roles, each of which having different responsibilities in managing the running of the pool.

  1. Root: Can change the nominator, bouncer, or itself. Further, it can perform any of the actions the nominator or bouncer can.
  2. Depositor: Creates the pool and is the initial member. The depositor can only leave the pool once all other members have left. Once they leave by withdrawing, the pool is fully removed from the system.
  3. Nominator: Can select the validators the pool nominates.
  4. Bouncer: Can change the pool’s state and kick (permissionlessly unbond/withdraw) members if the pool is blocked.
  1. Inside your-file-name.ts, add the following code:
avail-js
import * as dotenv from 'dotenv'; import { Account, SDK, BN, Pallets } from 'avail-js-sdk'; dotenv.config(); export async function nominationPoolsCreate() { // Initialize SDK with Turing endpoint const sdk = await SDK.New('wss://turing-rpc.avail.so/ws'); // Create account from seed in .env file const seed = process.env.SEED; if (!seed) { throw new Error("SEED environment variable is not set"); } // Create account from seed const account = Account.new(seed); console.log("Account Address: ", account.address); // Initial deposit amount: 10,000 AVAIL const amount = new BN(10).pow(new BN(18)).mul(new BN(10000)); // 10,000 AVAIL console.log("Initial Deposit: 10,000 AVAIL"); // Pool roles - using Alice's address for all roles const root = "5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY"; // Alice const nominator = "5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY"; // Alice const bouncer = "5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY"; // Alice console.log("Pool Roles:"); console.log(`Root: ${root}`); console.log(`Nominator: ${nominator}`); console.log(`Bouncer: ${bouncer}`); // Create pool transaction const tx = sdk.tx.nominationPools.create(amount, root, nominator, bouncer); console.log("Submitting create pool transaction..."); // Execute and wait for inclusion const res = await tx.executeWaitForInclusion(account, {}); // Check if transaction was successful const isOk = res.isSuccessful(); if (isOk === undefined) { throw new Error("Cannot check if transaction was successful"); } else if (!isOk) { throw new Error("Transaction failed"); } console.log("\nPool creation completed successfully"); // Log all transaction details console.log("\nTransaction Details:"); console.log(`Transaction Hash: ${res.txHash}`); console.log(`Block Hash: ${res.blockHash}`); console.log(`Block Number: ${res.blockNumber}`); process.exit(0); } // Execute the function nominationPoolsCreate();
  1. Run the code using:
terminal
ts-node your-file-name.ts

Sample Response:

{ "isErr": false, "event": { "depositor": "5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY", "poolId": "1" }, "event2": { "member": "5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY", "poolId": "1", "bonded": "10000", "joined": "true" }, "event": { "key": "0x4d79417765736f6d654b6579", "owner": "5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY", "id": "10" }, "events": [...], "txHash": "0x5ae9edbd2a2da96eeffc14cf9050d711082890fa6bfb8749ad2c4947565f3bd2", "txIndex": 1, "blockHash": "0x152338c1b0696d12664cf3d4c159af3d54beca151ba1ea8b00989a66dc8050b0", "blockNumber": 1 }
Last updated on