Aurox Wallet is an innovative web3 browser extension that provides industry-leading security measures, a simple user experience, and full data analytics to help users safely store and use their crypto and NFTs.
📹 Aurox Wallet Video Tutorials
🐂 Visit Aurox's Website | 🐦 Follow us on Twitter | 👾 Join our Discord
There's multiple ways you can contribute to help us improve the Aurox Wallet.
- Install Node v19.7.0. Preferably using NVM.
- Double check to make sure NPM is installed by running the following command in terminal.
npm -v
- Clone or download this repository.
- Copy the .env.example file to .env
- Edit the new .env based on instructions below.
- Run the following commands in the project directory to install dependencies:
npm i --force
- After all dependencies are installed you can:
- Run it locally:
npm run watch - Build for production:
npm run build
- Run it locally:
Once you have built the extension, it will output the extension files in the ./dist/ directory. To install it, go to your Chromium based browser's extension settings.
- Enable developer mode.
- Click the "load unpacked" button.
- Select the
./dist/folder when prompted to select folder.
The .env file contains API keys for variety of endpoints that are required to make the Aurox Wallet fully operational.
You can acquire free or free trial version of API keys from the following services by visiting their respective websites:
- Blockchain explorer API keys, such as Etherscan, and BSCScan are necessary for certain security features like smart contract validation.
- Sentry API key is necessary to help you find and detect errors.
- RPC Providers, such as Alchemy and Infura, are utilized when interacting with the blockchain. For example, estimating gas or submitting transactions.
The only API key that is not available publicly is the GRAPHQL_LEECHER_X_API_KEY. This API key is for the Aurox Backend API. Our backend serves as a layer above the blockchain to provide data and analytics to the wallet. This includes portfolio charts, token USD prices, auto token importing and a variety of other functions that improve the user experience of the Aurox Wallet.
Our company will provide our backend API key on a per-request basis. If you would like a personal API key, please contact [email protected].
To build the project without the GRAPHQL_LEECHER_X_API_KEY, simply set the value to 0:
GRAPHQL_LEECHER_X_API_KEY=0
Although the project will still build and install, some of the functionalities will not be available without the API key.
There are two ways you can contribute to the codebase:
Bugs, fixes, and other small items
- Fork the repository.
- Create a pull request.
- Our team will review and merge.
Larger implementations such as fulfilling feature requests
If you are looking to implement larger functionalities or fulfill feature requests made by other users, Aurox will soon open up bounties for certain features on Gitcoin.
Please read the following two files before writing any code or creating a pull request.