Minimal flashloan borrower contracts with an extensible rust sdk.
Flashloan-rs is published to crates.io as flashloan-rs.
To use the crate in a Rust project, run the cargo add command like so: cargo add flashloan-rs.
Or, add the following to your Cargo.toml:
toml
[dependencies]
flashloan-rs = "0.2.3"
Flashloan-rs is built to be extremely simple to use.
Quick Construction
```rust,ignore use std::{str::FromStr, sync::Arc}; use flashloan_rs::prelude::; use ethers::prelude::;
// Create a web3 provider
let client = Provider::
// Config let walletaddress = Address::fromstr("YOURADDRESS").unwrap(); let lender = Address::fromstr("LENDERADDRESS").unwrap(); let tokentoflashloan = Address::fromstr("TOKENADDRESSTOFLASHLOAN").unwrap(); let amounttoflashloan = U256::fromdec_str("1000000000000000000").unwrap();
// Create a flashloan builder // Alternatively, these parameters can be set using the builder pattern (see the next example) let mut builder = FlashloanBuilder::new( Arc::clone(&arcclient), // web3 provider 1, // chain id Some(walletaddress), // wallet public address Some(lender), // address of the EIP-3156 Compliant Flash Lender Some(tokentoflashloan), // token address to flashloan Some(amounttoflashloan), // amount to flashloan None, // override the flash borrower contract );
// Deploy the flashloan borrower contract builder.deploy(None, None).await.unwrap();
// Execute the flashloan and grab the transaction receipt let optionaltxreceipt = builder.execute().await.unwrap(); let txreceipt = optionaltx_receipt.unwrap(); ```
Builder Pattern
```rust,ignore use std::{str::FromStr, sync::Arc}; use flashloan_rs::prelude::; use ethers::prelude::;
// Create a web3 provider
let client = Provider::
// Config let walletaddress = Address::fromstr("YOURADDRESS").unwrap(); let lender = Address::fromstr("LENDERADDRESS").unwrap(); let tokentoflashloan = Address::fromstr("TOKENADDRESSTOFLASHLOAN").unwrap(); let amounttoflashloan = U256::fromdec_str("1000000000000000000").unwrap();
// Create a flashloan builder let mut builder = FlashloanBuilder::new(arc_client, 1, None, None, None, None, None);
// Set values using the builder pattern builder.withowner(walletaddress).withlender(lender).withtoken(tokentoflashloan).withamount(amountto_flashloan);
// ... ```
txt
flashloan-rs
├─ contracts
│ ├─ interfaces
│ │ ├─ IERC20.sol — ERC20 interface
│ │ ├─ IERC3156FlashBorrower.sol — Flashloan borrower interface
| | └─ IERC3156FlashLender.sol — Flashloan lender interface
│ ├─ FlashBorrower.huff — A https://github.com/huff-language Flashloan Receiver Contract Implementation
│ └─ FlashBorrower.sol — An Extensible Flashloan Receiver Contract
├─ examples
│ ├─ custom_borrower.rs — Flashloan-rs usage with a custom borrower contract
│ └─ pure_arb.rs — Executing a pure arbitrage with flashloan-rs
├─ lib — Foundry Libraries
├─ src
│ ├─ builder.rs — The primary rust FlashloanBuilder library
│ ├─ contract.rs — Abi Generated FlashBorrower Contract
│ ├─ errors.rs — Custom errors for flashloan-rs
│ └─ lib.rs — Module Exports
├─ tests
│ ├─ contracts
│ │ └─ FlashBorrower.t.sol — FlashBorrower.sol test suite
│ └─ crate
| └─ builder.rs — Unit tests for flashloan-rs
├─ foundry.toml — Foundry Config
└─ Cargo.toml — The flashloan-rs Cargo Manifest
A few very notable repositories that were used as reference: