AvalancheJS is a JavaScript library for interfacing with the Avalanche platform. It is built using TypeScript and intended to support both browser and Node.js. The AvalancheJS library allows one to issue commands to the Avalanche node APIs.

The APIs currently supported by default are:

  • Admin API

  • Auth API

  • AVM API (X-Chain)

  • EVM API (C-Chain)

  • Health API

  • Index API

  • Info API

  • Keystore API

  • Metrics API

  • PlatformVM API

  • Socket API

We built AvalancheJS with ease of use in mind. With this library, any Javascript developer is able to interact with a node on the Avalanche Platform that has enabled their API endpoints for the developer’s consumption. We keep the library up-to-date with the latest changes in the Avalanche Platform Specification found in the Platform Chain Specification, Exchange Chain (X-Chain) Specification, and Contract Chain (C-Chain) Specification.

Using AvalancheJS, developers can:

  • Locally manage private keys

  • Retrieve balances on addresses

  • Get UTXOs for addresses

  • Build and sign transactions

  • Issue signed transactions to the X-Chain, P-Chain, and C-Chain on the Primary network

  • Create a Subnetwork

  • Swap AVAX and assets between the X-Chain, P-Chain, and C-Chain

  • Add a Validator to the Primary network

  • Add a Delegator to the Primary network

  • Administer a local node

  • Retrieve Avalanche network information from a node

Requirements​

AvalancheJS requires Node.js version 14.18.0 or higher to compile.

To learn more about how to use these tools, please visit docs.avax.network.

Chat with Ava Labs | Use Apps on Avalanche | Validate on Avalanche

Build on Avalanche

Did this answer your question?