Avail node API reference

avail-js

1. Make sure Node-js is installed on your system by running the following command in your terminal:

node --version

If not installed, you can refer to Node-js docs  for the same.

2. Create a new Node-js project by running the following command in a directory of your choice:

pnpm init

3. To install the avail-js-sdk run the following command:

pnpm add avail-js-sdk@0.4.0

4. Make sure to install the ts-node package if you haven’t already:

pnpm add -g ts-node

5. Create a tsconfig.json file in the root of your project by running:

touch tsconfig.json

6. Populate your tsconfig.json with the following configuration:

{
    "compilerOptions": {
      "target": "es2016",
      "module": "commonjs",
      "outDir": "build",
      "declaration": true,
      "esModuleInterop": true,
      "forceConsistentCasingInFileNames": true,
      "strict": true,
      "skipLibCheck": true,
      "noUnusedParameters": true
    },
    "include": ["**/*.ts", "**/*.js"],
    "exclude": ["node_modules", "build"]
} 

7. Create a .env file in the root of your project by running:

pnpm add dotenv && touch .env

8. Put in the Seed Phrase of the account you want to use into the .env file:

SEED="This is a random seed phrase please replace with your own"

avail-deno

1. Make sure avail-deno is installed on your system. You can refer to Deno’s docs  for the same.

2. Create a new Deno JS project by running deno init in a directory of your choice, and create a new file named your-file-name.ts in the project.

3. The examples in this reference will interact with the Turing testnet of Avail DA, and will use the correspponding endpoint. You can use the networks page to find endpoints for mainnet if you need to.

avail-rust

1. Make sure rust and cargo are installed on your system. You can refer to Rustlang’s docs  for the same.

2. Create a new Rust project by running cargo init your-project-name.

3. Paste the following into your Cargo.toml file:

[workspace]
 
[package]
name = "your-project-name"
edition = "2021"
 
[dependencies]
# Use avail-rust v0.1.1 from the `avail-rust` repo
avail-rust = { git = "https://github.com/availproject/avail-rust", tag = "v0.1.1" }
# Tokio
tokio = { version = "1.38.0", features = ["full"] }
# dotenvy
dotenvy = "0.15.7"

4. Create a .env file in the root of your project by running the following command:

touch .env

5. Put in the Seed Phrase of the account you want to use into the .env file:

SEED="This is a random seed phrase please replace with your own"

avail-go

1. Make sure go is installed on your system by running the following command in your terminal:

go version

If not installed, you can refer to Go’s docs  for the same.

2. Create a new Go project by initializing a Go module in a directory of your choice. Run the following command:

go mod init your-project-name

3. To install the avail-go-sdk, use the following command to add it to your project:

go get github.com/availproject/avail-go-sdk@v0.2.3

4. To install the godotenv package, use the following command:

go get github.com/joho/godotenv

5. Create a .env file in the root of your project by running the following command:

touch .env

6. Put in the Seed Phrase of the account you want to use into the .env file:

SEED="This is a random seed phrase please replace with your own"