Skip to content

Commit

Permalink
chore - update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Dvisacker committed Sep 26, 2024
1 parent 61dd408 commit 6cf2b1e
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Aave Interaction CLI

This CLI tool allows you to interact with the Aave protocol on Ethereum and Arbitrum networks. You can supply assets, borrow assets, enter leveraged positions, and run an automated bot.

## Prerequisites

- Rust (latest stable version)
- Cargo (comes with Rust)
- RPC URL

## Building the Project

1. Clone the repository:
```
git clone https://github.com/your-username/aave-interaction-cli.git
cd aave-interaction-cli
```

2. Build the project:
```
cargo build --release
```

The built binary will be located at `target/release/aave-interaction-cli`.

## Configuration

1. Create a `.env` file in the project root with the following content:
```
PRIVATE_KEY=your_wallet_private_key
RPC_URL=your_ethereum_node_url
TELEGRAM_BOT_TOKEN=your_telegram_bot_token (optional)
CHAT_ID=your_telegram_chat_id (optional)
```

2. Ensure that the `src/contract_addresses.json` file contains the correct contract addresses for the networks and tokens you want to interact with.

## Using the CLI

The general syntax for using the CLI is:

0 comments on commit 6cf2b1e

Please sign in to comment.