https://github.com/ava-labs/avalanche-wallet-sdk

A Typescript library to create and manage wallets on the Avalanche network.
https://github.com/ava-labs/avalanche-wallet-sdk

Last synced: 13 days ago
JSON representation

A Typescript library to create and manage wallets on the Avalanche network.

• Host: GitHub
• URL: https://github.com/ava-labs/avalanche-wallet-sdk
• Owner: ava-labs
• License: bsd-3-clause
• Created: 2021-06-29T13:52:14.000Z (over 3 years ago)
• Default Branch: dev
• Last Pushed: 2024-03-29T06:57:28.000Z (7 months ago)
• Last Synced: 2024-10-15T22:00:06.526Z (24 days ago)
• Language: TypeScript
• Size: 4.06 MB
• Stars: 40
• Watchers: 25
• Forks: 26
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Audit: audits/Avalanche_Wallet_SDK_Pentesting_Report_Halborn_v1_1.pdf

Awesome Lists containing this project

• awesome-web3 - Avalanche Wallet SDK - Typescript library to create and manage wallets on the Avalanche network. (Software Development / JavaScript)

README

        
# 🔴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.