examples

Avail typescript / javascript examples

Sample examples written in typescript using avail-js sdk that demonstrate interaction with Avail network. The following scripts have been tested with ts-node v10.9.2 node v20.11.1 (npm v10.2.4). Those examples are meant to show how to use the avail-js sdk. It's worth noting that when using this package, all polkadot-js features can be used as it's only a wrapper with additional types / rpc / helpers.

Avail node examples

To run some examples using node js, you can follow those instructions

• Go to the examples folder.

cd examples/node-examples

• Install dependencies.

npm install

• Install ts-node

npm i -g ts-node

• Make sure to populate basic configuration in config.ts or leave the default if you are running a local node. Take a look at the scripts for more details about the configuration.
• If you are using a local node, make sure you are running the node with this command : ./target/release/avail-node --dev

export default {
  seed: "bottom drive obey lake curtain smoke basket hold race lonely fit walk//Alice",
  endpoint: "ws://127.0.0.1:9944",
  appId: 0,
  amount: 1,
  recipient: "5FHneW46xGXgs5mUiveU4sbTyGBzmstUspZC92UhjJM694ty",
}

Run the examples

• Run the command related to the example you want to execute:

npm run connect
npm run transfer
npm run transfer-mortal-period
npm run data-submission
npm run create-app-id
npm run subscribe-blocks
npm run query-proof
npm run query-data-proof
npm run query-block-length
npm run query-rows
npm run submit-proposal
npm run staking-nominate
npm run staking validate
npm run estimate-transaction-fees
npm run validium

Avail web example (next js / typescript)

You can also use avail-js in the web with an extension (like polkadot.js, Nova wallet or subwallet)

• Go to the examples/next-example folder.

cd examples/next-example

• Install the project

npm install

• Run the project

npm run dev

• Send a transaction
  • Click on "detect extension"
  • The first account will be used
  • Click on send tx
  • Wait for it to get included and get blockhash