https://github.com/aave/aave-sandbox
Sandbox of Aave Markets that replicates a forked production environment. The environment is envisioned for testing liquidations or other integrations.
https://github.com/aave/aave-sandbox
Last synced: 8 months ago
JSON representation
Sandbox of Aave Markets that replicates a forked production environment. The environment is envisioned for testing liquidations or other integrations.
- Host: GitHub
- URL: https://github.com/aave/aave-sandbox
- Owner: aave
- License: mit
- Created: 2021-12-15T09:38:32.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-02-21T14:55:52.000Z (over 3 years ago)
- Last Synced: 2025-07-05T13:38:26.174Z (12 months ago)
- Language: TypeScript
- Size: 403 KB
- Stars: 32
- Watchers: 2
- Forks: 14
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Aave Sandbox
Sandbox of Aave Markets that replicates a forked production environment. The environment is envisioned for testing liquidations or other integrations that requires a production state using Hardhat Node and Alchemy.
## Requisites
- Git
- Node.js version >= 16
- You can install and manage any Node.js version easily with [nvm](https://github.com/nvm-sh/nvm)
## Getting Started
Clone the repository:
```
git clone https://github.com/aave/aave-sandbox.git
```
Install dependencies:
```
npm i
```
Compile Contract:
```
npm run compile
```
Create a `.env` file
```
touch .env
```
Obtain an [Alchemy](https://www.alchemy.com/) API key to be able to fork chains. The free tier of Alchemy allows archival node.
Once you have the Alchemy key, open `.env` with your favorite editor and fill the environment variable named `ALCHEMY_KEY`, as follows:
```
# Content of .env file
ALCHEMY_KEY=your-alchemy-key
```
## Fork Aave markets
If you want to integrate any of the deployed Aave markets, you can spin a sandbox node in the following way.
In a separate window, run the sandbox Hardhat fork node that will be reachable via JSON RPC at `http://127.0.0.1:8545/`. You can spin the sandbox node with one of the following commands:
```
node:fork:arc
node:fork:main-v2
node:fork:polygon-v3
node:fork:avalanche-v3
node:fork:arbitrum-v3
node:fork:optimism-v3
node:fork:fantom-v3
node:fork:harmony-v3,
node:fork:main-v3
```
Now you can connect to the Hardhat Node via JSON RPC at `http://127.0.0.1:8545/` in your project and use official deployed addresses to interact with the market.
Once the node is running, the following tasks will be available, and will point to the local sandbox node.
"feed-market": "hardhat --network localhost feed-market --market $0",
"feed-accounts": "hardhat --network localhost feed-accounts --market $0",
"whitelist-accounts:arc": "hardhat --network localhost whitelist-accounts --market $@",
"print-accounts": "hardhat --network localhost print-accounts -- $@",
### feed-market
The `feed-market` command will add simulated users and liquidity to a forked market.
Usage:
```
npm run feed-market:main-v3
```
or replace main-v3 with one of: arc, main-v2, polygon-v3, arbitrum-v3, avalanche-v3, optimism-v3, harmony-v3, fantom-v3.
### feed-accounts
You can mint official ERC20 tokens to any address using the `feed-account` task. The task will override the balance of the address via `hardhat_setStorage`.
You can use the following command as a faucet to get all ERC20 tokens being used inside a market:
```
npm run feed-accounts:polygon-v3 -- --accounts 0x976EA74026E726554dB657fA54763abd0C3a0aa9,
```
Note: the extra `--` is important to pass arguments to Hardhat
### print-accounts
View user positions and health factors from accounts passed to `--accounts` parameter with the following command:
```
npm run print-accounts:polygon-v3 -- --accounts 0x23618e81E3f5cdF7f54C3d65f7FBc0aBf5B21E8f,0x14dC79964da2C08b23698B3D3cc7Ca32193d9955
```
Note: the extra `--` is important to pass arguments to Hardhat
Output:
```
User Info:
- Address: 0x976EA74026E726554dB657fA54763abd0C3a0aa9
- Health Factor: 0.918421511765627487
- Balances
┌─────────┬───────────────────┬───────────────────┬──────────────────────────┬────────┐
│ (index) │ enabledCollateral │ collateralBalance │ debtBalance │ symbol │
├─────────┼───────────────────┼───────────────────┼──────────────────────────┼────────┤
│ 0 │ true │ '50000.0' │ '0.0' │ 'USDC' │
│ 1 │ false │ '0.0' │ '43.0' │ 'WBTC' │
│ 2 │ false │ '0.0' │ '543.999999948668340512' │ 'WETH' │
│ 3 │ true │ '50000.0' │ '0.0' │ 'AAVE' │
└─────────┴───────────────────┴───────────────────┴──────────────────────────┴────────┘
[...]
```
### whitelist-accounts:arc
For whitelisting your accounts or smart contracts like liquidation bots into Aave Arc Sandbox, you can use the following command passing in addresses to `--accounts` parameter:
```
npm run whitelist-accounts:arc --accounts ,
```
Note: the extra `--` is important to pass arguments to Hardhat
## Utilities
### Enable mining by interval
By default Hardhat node mines blocks every time you perform a transaction, but for some scenarios you may need the node to mine blocks by interval.
You can enable Hardhat to mine blocks every 5 seconds with the following command:
```
npm run set-interval-mining
```
To disable mining empty blocks, you can run:
```
npm run set-interval-mining:off
```