|
1 |
| -# avax-wallet |
2 |
| -A maintenance fork of the original AVAX wallet by Ava Labs |
| 1 | +# Avalanche (AVAX) Wallet Fork |
| 2 | + |
| 3 | +This is a fork of the original frontend Vue.js application for the Avalanche (AVAX) Wallet. |
| 4 | + |
| 5 | +It's a maintenance fork meant for local use and not meant for production. |
| 6 | + |
| 7 | +## Prerequisites |
| 8 | + |
| 9 | +- Yarn (https://classic.yarnpkg.com/en/docs/install/) |
| 10 | +- Recent version of npm (7.4.0) |
| 11 | +- Node v16 |
| 12 | +- Gecko, Avalanche client in Golang (https://github.com/ava-labs/avalanchego) |
| 13 | + |
| 14 | +## Installation |
| 15 | + |
| 16 | +1. Clone the repo `git clone https://github.com/ava-labs/avalanche-wallet.git` |
| 17 | +2. Go to root of the project `cd avalanche-wallet` |
| 18 | +3. Install javascript dependencies with `yarn install`. |
| 19 | + |
| 20 | +## Running The Project |
| 21 | + |
| 22 | +In order for the wallet to work, it needs the Avalanche network to operate on. By default the wallet will connect to the Avalanche mainnet. |
| 23 | + |
| 24 | +1. If you want to connect to a local network, make sure you have installed and able to run a AvlaancheGo node properly. |
| 25 | +2. Run the project with hot reloading `yarn serve` |
| 26 | + |
| 27 | +When you go to the website on your browser, you might get a warning saying |
| 28 | +"Site is not secure". This is because we are signing our own SSL Certificates. Please ignore and continue to the website. |
| 29 | + |
| 30 | +## Deployment |
| 31 | + |
| 32 | +1. Compile and minify to have a production ready application with `yarn build`. |
| 33 | +2. Serve from the `/dist` directory. |
| 34 | + |
| 35 | +## Changing the Network |
| 36 | + |
| 37 | +By default the wallet will connect to the Avalanche tmainnet. 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. |
| 38 | + |
| 39 | +## Explorer API |
| 40 | + |
| 41 | +A valid explorer API is required to correctly display balances for Mnemonic and Ledger type wallets. |
| 42 | +The wallet uses the Avalanche Explorer API to display wallet transaction history. |
| 43 | + |
| 44 | +WARNING: This history might be out of order and incomplete. |
| 45 | + |
| 46 | +## Browser Support |
| 47 | + |
| 48 | +We suggest using Google Chrome to view the Avalanche Wallet website. |
| 49 | + |
| 50 | +### Firefox and https |
| 51 | + |
| 52 | +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 |
| 53 | + |
| 54 | +``` |
| 55 | +devServer: { |
| 56 | + https: true |
| 57 | +}, |
| 58 | +``` |
| 59 | + |
| 60 | +to |
| 61 | + |
| 62 | +``` |
| 63 | +devServer: { |
| 64 | + https: false |
| 65 | +}, |
| 66 | +``` |
| 67 | + |
| 68 | +and run `yarn serve` to reflect the change. |
| 69 | + |
| 70 | +# Accounts |
| 71 | + |
| 72 | +The wallet can encrypt your private keys into a secure file encrypted by a password. |
| 73 | + |
| 74 | +```json |
| 75 | +{ |
| 76 | + "accounts": iUserAccountEncrypted[] |
| 77 | +} |
| 78 | +``` |
| 79 | + |
| 80 | +# Language Setting |
| 81 | + |
| 82 | +Saved into local storage as a 2 letter code. |
| 83 | + |
| 84 | +``` |
| 85 | +"lang": "en" |
| 86 | +``` |
| 87 | + |
| 88 | +# Dependencies |
| 89 | + |
| 90 | +##### Avalanche Node (https://github.com/ava-labs/avalanchego) |
| 91 | + |
| 92 | +To get utxos and to send transactions. |
| 93 | + |
| 94 | +#### Explorer API Node (https://github.com/ava-labs/ortelius) |
| 95 | + |
| 96 | +To check if an address was used before, and to get activity history. |
| 97 | + |
| 98 | +# Default Connections |
| 99 | + |
| 100 | +The wallet needs to connect to an Avalanche node, and an explorer node to operate properly. |
| 101 | + |
| 102 | +By default, there are two network options to connect to: `Mainnet` and `Fuji`. |
| 103 | + |
| 104 | +##### Mainnet |
| 105 | + |
| 106 | +- Avalanche API: `https://api.avax.network:443` |
| 107 | +- Explorer API: `https://explorerapi.avax.network` |
| 108 | + |
| 109 | +##### Fuji (Testnet) |
| 110 | + |
| 111 | +- Avalanche API: `https://api.avax-test.network:443` |
| 112 | +- Explorer API: `https://explorerapi.avax-test.network` |
| 113 | + |
0 commit comments