avail

Interact with the chain

The following software development kits (SDKs) are available:

• avail-js
• avail-rust
• avail-go

Verifying Avail Node Binary Signatures

Our release binaries are GPG signed for security. To verify a download:

1. Import our public key. Make sure you change the version to the correct version: curl -s https://github.com/availproject/avail/releases/download/vX.Y.Z/gpg-public-key.asc | gpg --import
2. Verify the binary's signature: gpg --verify DOWNLOADED_BINARY.tar.gz.sig DOWNLOADED_BINARY.tar.gz
3. Verify the checksum file: gpg --verify YOUR_DOWNLOADED_FILE.tar.gz.sha256.sig YOUR_DOWNLOADED_FILE.tar.gz.sha256
4. Verify the checksum: sha256sum -c YOUR_DOWNLOADED_FILE.tar.gz.sha256

A successful verification will display: "Good signature from 'Your Project Release Key key's email address'"

You have now verified that the binary is signed by Avail and that its checksum is correct.

Running Avail Node

Manually

To manually run the Avail Node, you'll need to have the following dependencies installed:

• Rust
• Substrate dependencies

After ensuring you have the dependencies installed, you can run the Avail Node using the following command:

mkdir -p output
cargo run --locked --release -- --chain mainnet -d ./output

This command compiles and runs the Avail Node connected to the Mainnet Network.

…

Supported Chains

Development

A development chain is typically used for testing and development purposes.

cargo run --locked --release -- --dev

Testnet Turing

cargo run --locked --release -- --chain turing

Mainnet

cargo run --locked --release -- --chain mainnet

Docker/Podman

To run the Avail Node using Docker (Podman works as well), follow these steps:

# Build the Docker image for the Avail Node:
docker build -t availnode -f ./dockerfiles/avail-node.Dockerfile .

# Create an output directory. Here the node's data will be stored.
mkdir output

# Run the Avail Node container:
docker run --rm -p 30333:30333 -p 9944:9944 -v ./output:/output availnode
# For SELinux
docker run --rm -p 30333:30333 -p 9944:9944 -v ./output:/output:z availnode

Running Dev Chain

The following instructions describe how to run a development chain using Docker (Podman works as well). A development chain is typically used for testing and development purposes.

# Build the Docker image for the Avail Node:
docker build -t availnode -f ./dockerfiles/avail-node.Dockerfile .

# Create an output directory. Here the node's data will be stored.
mkdir output

# Run the Avail Node container:
docker run --rm -p 30333:30333 -p 9944:9944 -v ./output:/output availnode --dev --rpc-methods=unsafe --unsafe-rpc-external --rpc-cors=all
# For SELinux
docker run --rm -p 30333:30333 -p 9944:9944 -v ./output:/output:z availnode --dev --rpc-methods=unsafe --unsafe-rpc-external --rpc-cors=all

RPCs and Custom Flags

Kate RPC

To enable Kate RPC you need to pass --enable-kate-rpc flag when executing the binary. --dev implies --enable-kate-rpc.

./avail-node --enable-kate-rpc

All Custom Flags

--enable-kate-rpc
    Enable Kate RPC

--kate-max-cells-size 
    The maximum number of cells that can be requested in one go.
    
    Max size cannot exceed 10_000
    
    [default: 64]

Run Benchmarks

Kate RPC

./avail-node --dev
deno run -A ./examples/deno/benchmarks/query_proof.ts && deno run -A ./examples/deno/benchmarks/query_rows.ts && deno run -A ./examples/deno/benchmarks/query_block_length.ts && deno run -A ./examples/deno/benchmarks/query_data_proof.ts

Header Builder

# Option 1: for time measurement 
cargo bench --bench header_kate_commitment_cri
# Option 2: for time measurement 
cargo bench --bench header_kate_commitment_divan
# Option 1: for instructions, cache and main memory hits
cargo bench --bench header_kate_commitment_iai_callgrind
# Option 2: for instructions, cache and main memory hits
cargo bench --bench header_kate_commitment_iai

Additional Documentation

For additional documentation check our wiki page. There you can learn how to:

• Run Avail Node together with Avail Light Clients
• Build Avail Node for different Linux flavours
• Find out what node synchronization options are available
• Running Avail Benchmarks

Governance

Avail governance and reference material is maintained in the Avail governance repository.

License

This project contains source files under multiple open source licenses.

• Most of the code is licensed under the Apache License 2.0.
• Some files that derive from Substrate may be under the GNU General Public License v3.0.

See the LICENSE-APACHE2 and LICENSE-GPL3 files in the repository root for full text. For license details on specific files, check the license header at the top of each source file.