# avail-js-sdk

> Avail library of functions to interact with blockchain and manipulate transactions

Latest version **0.4.2** (published 2025-03-27) · ISC license · 0 weekly downloads

## Install

```sh
npm install avail-js-sdk
pnpm add avail-js-sdk
yarn add avail-js-sdk
bun add avail-js-sdk
```

## Health

**Score 30/100 (F)** — status: maintenance-mode.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.2 |
| Published | 2025-03-27 |
| First published | 2023-06-16 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 245.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Ghali Leouarz |
| Maintainers | leouarz, markopoloparadox, devops-avail, rishabhagrawalzra |
| Keywords | avail, data, blockchain, substrate, sdk, typescript |

## Links

- npm: https://www.npmjs.com/package/avail-js-sdk
- Homepage: https://github.com/availproject/avail-js
- Issues: https://github.com/availproject/avail-js/issues/new/choose
- npm.io page: https://npm.io/package/avail-js-sdk

## Dependencies (2)

- [neverthrow](https://npm.io/package/neverthrow.md) ^8.1.1
- [@polkadot/api](https://npm.io/package/@polkadot/api.md) ^15.7.1

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 0.4.2 (latest) — 2025-03-27
- 0.5.0-8 (beta) — 2025-10-06
- 0.5.0-7 — 2025-10-05
- 0.5.0-6 — 2025-10-04
- 0.5.0-5 — 2025-10-04
- 0.5.0-4 — 2025-10-03
- 0.5.0-3 — 2025-10-03
- 0.5.0-2 — 2025-10-03
- 0.5.0-1 — 2025-10-03
- 0.5.0-0 — 2025-10-03
- 0.4.1 — 2025-03-19
- 0.4.0 — 2025-02-28
- 0.3.0 — 2024-10-25
- 0.2.18 — 2024-09-30
- 0.2.17 — 2024-09-27
- … 45 more at https://npm.io/package/avail-js-sdk/versions

## README

# Avail-js

[![npm stable](https://img.shields.io/npm/v/avail-js-sdk?logo=npm&style=flat-square)](https://www.npmjs.com/package/avail-js-sdk)

Library to connect to Avail

## Introduction

The simplest ways to interact with the avail network.

# Documentation

[Examples](https://availproject.github.io/avail-js/)

[User Documentation](https://docs.availproject.org/api-reference/avail-node-api)

# Github Page

[Link](https://github.com/availproject/avail-js) to github page

## Installation

Pre-requisites:
[Node.js](https://nodejs.org/en/download/)

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

```bash
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](https://polkadot.js.org/docs/).

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/`](https://github.com/availproject/avail-js/tree/main/src/chain)**: Contains the basics to initialize an API with the chain, serving as the Polkadot JS wrapper.
- **[`src/helpers/`](https://github.com/availproject/avail-js/tree/main/src/helpers)**: Includes basic helper functions that facilitate various tasks.
- **[`src/spec/`](https://github.com/availproject/avail-js/tree/main/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/`](https://github.com/availproject/avail-js/tree/main/src/sdk)**: Contains all classes related to the SDK, representing the opinionated part of Avail-JS-SDK.

## Error Reporting

In case you encounter a bug, don't hesitate to [open an issue](https://github.com/availproject/avail-js/issues/new/choose) with the maximum amount of detail and we will deal with it as soon as possible.

---
_Source: https://npm.io/package/avail-js-sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._