Skip to content

Latest commit

 

History

History
50 lines (31 loc) · 1.19 KB

README.md

File metadata and controls

50 lines (31 loc) · 1.19 KB

🔴WARNING: Beta Release🔴

  • This library is under development and there might be frequent breaking changes.
  • Audit pending.

Avalanche Wallet SDK (Beta)

Avalanche Wallet SDK is a Typescript library for creating and managing decentralized wallets.

It provides high level methods to transact on Avalanche's primary networks: X, P and C chain.

Wallet types supported:

  • Singleton Wallets
  • Ledger Wallets
  • Mnemonic Wallets
  • Public Mnemonic Wallets (XPUB)

Using the avalanche-wallet-sdk developers can:

  • Receive and send tokens and NFTs.
  • Cross chain transfer
  • Validation & Delegation
  • Create keystore files from wallet instances
  • Get transaction history of wallets
  • Mint NFTs on the X chain

Installation

With npm

npm install --save @avalabs/avalanche-wallet-sdk

or yarn

yarn add @avalabs/avalanche-wallet-sdk

Local build

  1. Clone the repository.
  2. Install dependencies yarn install
  3. Run for development yarn start

Webpack

For Webpack version 5 and above you must use this plugin with it. https://www.npmjs.com/package/node-polyfill-webpack-plugin

Docs

Can generate documentation with yarn docs and open docs/index.html in a browser.