Skip to content

Latest commit

 

History

History

avail-js

readme.md

Avail-js

npm stable

Library to connect to Avail

Introduction

The simplest ways to interact with the avail network.

Installation

Pre-requisites: Node.js

Install the latest stable version of the avail-js library by running this command:

npm install avail-js-sdk

Structure

This SDK is split into two main parts:

  1. Polkadot JS Wrapper: This allows you to use all the Polkadot JS functions and types to interact with the chain. For more information and documentation, please refer to the Polkadot JS Documentation.

  2. Opinionated SDK: A simpler, more streamlined way to interact with the chain. It offers less customization but provides an easier interface. This SDK will be continuously improved to include everything needed for seamless chain interaction.

Folder Structure

  • src/chain/: Contains the basics to initialize an API with the chain, serving as the Polkadot JS wrapper.
  • src/helpers/: Includes basic helper functions that facilitate various tasks.
  • src/spec/: All types, RPC, and signed extensions related to Avail. These are crucial for interacting with the chain, including decoding chain data, transactions, and initiating transactions.
  • src/sdk/: Contains all classes related to the SDK, representing the opinionated part of Avail-JS-SDK.

Additional Information

  • ./examples/README.md: Refer to this for examples utilizing the Polkadot JS wrapper.
  • ./docs/README.md: This contains documentation, interfaces, and examples using the opinionated SDK.

Documentation and examples

Error Reporting

In case you encounter a bug, don't hesitate to open an issue with the maximum amount of detail and we will deal with it as soon as possible.