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
- Clone the repo
git clone https://github.com/ava-labs/avalanche-wallet.git
- Go to root of the project
cd avalanche-wallet
- 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.
- If you want to connect to a local network, make sure you have installed and able to run a Gecko node properly.
- 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
- Compile and minify to have a production ready application with
yarn build
. - Serve from the
/dist
directory.
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.
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.
Keystore File Spec
v1.0.0 (initial)
interface IKeystoreFile{
salt
pass_hash
keys: [
{
key,
nonce,
address
}
]
}
v2.0.0
interface IKeystoreFile{
version
salt
pass_hash
warnings
keys: [
{
key
iv
address
}
]
}
v3.0.0
Underlying encryption changed.
interface IKeystoreFile{
version
salt
pass_hash
warnings
keys: [
{
key
iv
address
}
]
}
v4.0.0
Avalanche uses bech32 addresses. Removed address field from keys and the warning message.
interface IKeystoreFile{
version
salt
pass_hash
keys: [
{
key
iv
}
]
}
v5.0.0
Encodes mnemonic phrase as the key.
interface IKeystoreFile{
version
salt
pass_hash
keys: [
{
key
iv
}
]
}
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"