corpetty / avalanche-wallet

The Avalanche web wallet

Avalanche (AVAX) Wallet

This is the frontend Vue.js application for the Avalanche (AVAX) Wallet.

Prerequisites

• Yarn (https://classic.yarnpkg.com/en/docs/install/)
• Recent version of npm (6.13.4)
• Node v12.14.1
• Gecko, Avalanche client in Golang (https://github.com/ava-labs/gecko)

Installation

1. Clone the repo git clone https://github.com/ava-labs/avalanche-wallet.git
2. Go to root of the project cd avalanche-wallet
3. Install javascript dependencies with yarn install.

Running The Project

In order for the wallet to work, it needs the Avalanche network to operate on. By default the wallet will connect to the Avalanche test network.

1. If you want to connect to a local network, make sure you have installed and able to run a Gecko node properly.
2. Run the project with hot reloading yarn serve

When you go to the website on your browser, you might get a warning saying "Site is not secure". This is because we are signing our own SSL Certificates. Please ignore and continue to the website.

Deployment

1. Compile and minify to have a production ready application with yarn build.
2. Serve from the /dist directory.

Releases

1. Generate a personal access token
2. Save it in your local env as RELEASE_IT_GITHUB_TOKEN
3. Run yarn release

Changing the Network

By default the wallet will connect to the Avalanche test network. You can change to another network by clicking the button labeled TestNet on the navigation bar and selecting another network, or add a custom network.

Explorer API

The wallet uses the Avalanche Explorer API to display wallet transaction history.

The wallet uses the Avalanche Explorer API to display wallet transaction history.

WARNING: This history might be out of order and incomplete.

Browser Support

We suggest using Google Chrome to view the Avalanche Wallet website.

Firefox and https

Firefox does not allow https requests to localhost. But the Avalanche Wallet uses https by default, so we will need to change this to http. Make this switch by editing the vue.config.js file in the root directory and change

devServer: {
    https: true
},

to

devServer: {
    https: false
},

and run yarn serve to reflect the change.

Local Storage Remember Wallet Spec

Basically same as storing the keystore file in the browser localstorage.

If there is a remembered wallet it will be the Keystore JSON format.

{
    "w": IKeystoreFile | undefined
}

Language Setting

Saved into local storage as a 2 letter code.

"lang": "en"

Dependencies

Avalanche Node (https://github.com/ava-labs/avalanchego)

To get utxos and to send transactions.

Explorer API Node (https://github.com/ava-labs/ortelius)

To check if an address was used before, and to get activity history.

Default Connections

The wallet needs to connect to an Avalanche node, and an explorer node to operate properly.

By default, there are two network options to connect to: Mainnet and Fuji.

Mainnet

• Avalanche API: https://api.avax.network:443
• Explorer API: https://explorerapi.avax.network

Fuji (Testnet)

• Avalanche API: https://api.avax-test.network:443
• Explorer API: https://explorerapi.avax-test.network