diff --git a/README.md b/README.md
index 1cd4a2c8..98ca09a9 100644
--- a/README.md
+++ b/README.md
@@ -1,40 +1,2016 @@
-# Aave utilities
+ 
-
-
+Aave Utilities
-Aave utilities
+The Aave Protocol is a decentralized non-custodial liquidity market protocol
+where users can participate as depositors or borrowers. The protocol is a set of
+open source smart contracts which facilitate the supply and borrowing of user
+funds. These contracts, and all user transactions/balances are stored on a
+public ledger called a blockchain, making them accessible to anyone
+
+Aave Utilities is a JavaScript SDK for interacting with V2 and V3 of the Aave
+Protocol, an upgrade to the existing [aave-js](https://github.com/aave/aave-js)
+library
+
+The `@aave/math-utils` package contains methods for formatting raw
+([ethers.js](#ethers.js)) or indexed ([subgraph](#subgraph),
+[caching server](#caching-server)) contract data for usage on a frontend
+
+The `@aave/contract-helpers` package contains methods for generating trancations
+based on method and parameter inputs. Can be used to read and write data on the
+protocol contracts.
+
+
## Installation
-Aave utilities are available as npm
-packages[¹](https://www.npmjs.com/package/@aave/contract-helpers)[²](https://www.npmjs.com/package/@aave/math-utils).
+Aave utilities are available as npm packages,
+[contract helpers](https://www.npmjs.com/package/@aave/contract-helpers) and
+[math utils](https://www.npmjs.com/package/@aave/math-utils)
+
+[ethers v5](https://docs.ethers.io/v5/) and [reflect-metadata](reflect metadata)
+are peer dependencies of the contract-helpers package
```sh
// with npm
+npm install --save-dev ethers reflect-metadata
npm install @aave/contract-helpers @aave/math-utils
+
// with yarn
+yarn add --dev ethers reflect-metadata
yarn add @aave/contract-helpers @aave/math-utils
```
-## Usage
+
+
+## Features
+
+1. [Data Formatting Methods](#data-formatting-methods)
+ - a. [Fetching Protocol Data](#fetching-protocol-data)
+ - [ethers](#ethers.js)
+ - [Subgraph](#subgraph)
+ - [Caching Server](#caching-server)
+ - b. [Format Reserve Data](#reserve-data)
+ - [formatReserves](#formatReserves)
+ - [formatReservesAndIncentives](#formatReservesAndIncentives)
+ - c. [Format User Data](#user-data)
+ - [formatUserSummary](#formatUserSummary)
+ - [formatUserSummaryAndIncentives](#formatUserSummaryAndIncentives)
+2. [Transaction Methods](#transaction-methods)
+ - a. [Submitting Transactions](#submitting-transactions)
+ - b. [Pool V3](#pool-v3)
+ - [supply](#supply)
+ - [signERC20Approval](#signERC20Approval)
+ - [supplyWithPermit](#supply-with-permit)
+ - [borrow](<#borrow-(v3)>)
+ - [repay](<#repay-(v3)>)
+ - [repayWithPermit](#repayWithPermit)
+ - [repayWithATokens](#repayWithATokens)
+ - [withdraw](<#withdraw-(v3)>)
+ - [swapBorrowRateMode](<#swapBorrowRateMode-(v3)>)
+ - [setUsageAsCollateral](<#setUsageAsCollateral-(v3)>)
+ - [liquidationCall](<#liquidationCall-(v3)>)
+ - [swapCollateral](<#swapCollateral-(v3)>)
+ - [repayWithCollateral](<#repayWithCollateral-(v3)>)
+ - [setUserEMode](#setUserEMode)
+ - c. [Lending Pool V2](#lending-pool-v2)
+ - [deposit](#deposit)
+ - [borrow](#borrow)
+ - [repay](#repay)
+ - [withdraw](#withdraw)
+ - [swapBorrowRateMode](#swapBorrowRateMode)
+ - [setUsageAsCollateral](#setUsageAsCollateral)
+ - [liquidationCall](#liquidationCall)
+ - [swapCollateral](#swapCollateral)
+ - [repayWithCollateral](#repayWithCollateral)
+ - d. [Staking](#staking)
+ - [stake](#stake)
+ - [redeem](#redeem)
+ - [cooldown](#cooldown)
+ - [claimRewards](#claimRewards)
+ - e. [Governance V2](#governancev2)
+ - [create](#create)
+ - [cancel](#cancel)
+ - [queue](#queue)
+ - [execute](#execute)
+ - [submitVote](#submitVote)
+ - [delegate](#delegate)
+ - [delegateByType](#delegateByType)
+ - f. [Faucets](#faucets)
+ - [mint](#mint)
+
+
+
+# Data Formatting Methods
+
+Users interact with the Aave protocol through a set of smart contracts. The
+`@aave/math-utils` package is a collection of methods to take raw input data
+from these contracts, and format to use on a frontend interface such as
+[Aave Ui](https://github.com/aave/aave-ui) or
+[Aave info](https://github.com/sakulstra/info.aave)
+
+## Fetching Protocol Data
+
+Input data for these methods can be obtained in a variety of ways with some
+samples below:
+
+- [ethers](#ethers.js)
+- [Subgraph](#subgraph)
+- [Caching Server](#caching-server)
+
+
+
+### ethers.js
+
+[ethers.js](https://docs.ethers.io/v5/) is a library for interacting with
+Ethereum and other EVM compatible blockchains. To install:
+
+The first step to query contract data with ethers is to inialize a `provider`,
+there are a [variety](https://docs.ethers.io/v5/api/providers/) to choose from,
+all of them requiring the an rpcURL
+
+The sample code below includes an example of initializing a provider, and using
+it query the helper contract data which can be passed directly into data
+formatting methods.
+
+
+ Sample Code
+
+```ts
+import { ethers } from 'ethers';
+import {
+ UiPoolDataProvider,
+ UiIncentiveDataProvider,
+ ChainId,
+} from '@aave/contract-helpers';
+
+// Sample RPC address for querying ETH mainnet
+const provider = new ethers.providers.JsonRpcProvider(
+ 'https://eth-mainnet.alchemyapi.io/v2/demo',
+);
+
+// This is the provider used in Aave UI, it checks the chainId locally to reduce RPC calls with frequent network switches, but requires that the rpc url and chainId to remain consistent with the request being sent from the wallet (i.e. actively detecting the active chainId)
+const provider = new ethers.providers.StaticJsonRpcProvider(
+ 'https://eth-mainnet.alchemyapi.io/v2/demo',
+ ChainId.mainnet,
+);
+
+// Aave protocol contract addresses, will be different for each market and can be found at https://docs.aave.com/developers/deployed-contracts/deployed-contracts
+// For V3 Testnet Release, contract addresses can be found here https://github.com/aave/aave-ui/blob/feat/arbitrum-clean/src/ui-config/markets/index.ts
+const uiPoolDataProviderAddress = '0xa2DC1422E0cE89E1074A6cd7e2481e8e9c4415A6';
+const uiIncentiveDataProviderAddress =
+ '0xD01ab9a6577E1D84F142e44D49380e23A340387d';
+const lendingPoolAddressProvider = '0xB53C1a33016B2DC2fF3653530bfF1848a515c8c5';
+
+// User address to fetch data for
+const currentAccount = '';
+
+// View contract used to fetch all reserves data (including market base currency data), and user reserves
+const poolDataProviderContract = new UiPoolDataProvider({
+ uiPoolDataProviderAddress,
+ provider,
+});
+
+// View contract used to fetch all reserve incentives (APRs), and user incentives
+const incentiveDataProviderContract = new UiIncentiveDataProvider({
+ uiIncentiveDataProviderAddress,
+ provider,
+});
+
+// Note, contract calls should be performed in an async block, and updated on interval or on network/market change
+
+// Object containing array of pool reserves and market base currency data
+// { reservesArray, baseCurrencyData }
+const reserves = await poolDataProviderContract.getReservesHumanized({
+ lendingPoolAddressProvider,
+});
+
+// Object containing array or users aave positions and active eMode category
+// { userReserves, userEmodeCategoryId }
+const userReserves = await poolDataProviderContract.getUserReservesHumanized({
+ lendingPoolAddressProvider,
+ currentAccount,
+});
+
+// Array of incentive tokens with price feed and emission APR
+const reserveIncentives =
+ await incentiveDataProviderContract.getReservesIncentivesDataHumanized({
+ lendingPoolAddressProvider,
+ });
+
+// Dictionary of claimable user incentives
+const userIncentives =
+ await incentiveDataProviderContract.getUserReservesIncentivesDataHumanized({
+ lendingPoolAddressProvider,
+ currentAccount,
+ });
+```
+
+These four variables are passed as parameters into the [reserve](#reserve-data)
+and [user](#user-data) formatters to compute all of the fields needed for a
+frontend interface.
+
+
+
+
+
+### Subgraph
+
+A subgraph indexes events emitted from a smart contract and exposes a graphql
+endpoing to query data from. Each network where the protocol is deployed is a
+corresponding subgraph. Subgraph can be queried directly using the playground
+(links below) and integrated into applications directly via TheGraph API. Check
+out these guides from
+[Aave](https://docs.aave.com/developers/getting-started/using-graphql) and
+[TheGraph](https://thegraph.com/docs/en/developer/querying-from-your-app/) for
+resources on querying subgraph from a frontend application.
+
+Here are queries for fetching the data fields required for
+[data formatting methods](#data-formatting-methods). The formatting methods are
+the same for V2 and V3, but the queries required to fetch the input data are
+different. Queries will depend on two parameters:
+
+- `pool` : lendingPoolAddressProvider address for the market you are querying
+ data for
+- `user` : user to fetch account data for
+
+
+ V2
+
+
+ Reserves
+
+```graphql
+{
+ reserves(
+ where: { pool: "insert_lowercase_lending_pool_address_provider_here" }
+ ) {
+ id
+ symbol
+ name
+ decimals
+ underlyingAsset
+ usageAsCollateralEnabled
+ reserveFactor
+ baseLTVasCollateral
+ averageStableRate
+ stableDebtLastUpdateTimestamp
+ liquidityIndex
+ reserveLiquidationThreshold
+ reserveLiquidationBonus
+ variableBorrowIndex
+ variableBorrowRate
+ liquidityRate
+ totalPrincipalStableDebt
+ totalScaledVariableDebt
+ lastUpdateTimestamp
+ availableLiquidity
+ stableBorrowRate
+ totalLiquidity
+ price {
+ priceInEth
+ }
+ }
+}
+```
+
+Then formatted to match expected input schema with:
+
+```ts
+const reserves = queryResult.reserves.map(reserve => {
+ return {
+ ...reserve,
+ priceInMarketReferenceCurrency: reserve.price.priceInEth,
+ eModeCategoryId: 0,
+ borrowCap: '',
+ supplyCap: '',
+ debtCeiling: '',
+ debtCeilingDecimals: 0,
+ isolationModeTotalDebt: '',
+ eModeLtv: 0,
+ eModeLiquidationThreshold: 0,
+ eModeLiquidationBonus: 0,
+ };
+});
+```
+
+
+
+
+ User Reserves
+
+```graphql
+{
+ userReserves(where: {pool: "insert_lowercase_lending_pool_address_provider_here", user: "insert_lowercase_user_address_here"}) {
+ reserve{
+ underlyingAsset
+ }
+ scaledATokenBalance
+ usageAsCollateralEnabledOnUser
+ stableBorrowRate
+ scaledVariableDebt
+ principalStableDebt
+ stableBorrowLastUpdateTimestamp
+ }
+ }
+}
+```
+
+Then formatted to match expected input schema with:
+
+```ts
+const userReserves = queryResults.userReserves.map(userReserve => {
+ return {
+ ...userReserve,
+ underlyingAsset: userReserve.reserve.underlyingAsset,
+ };
+});
+```
+
+The `userEmodeCategoryId` parameter will always be 0 for V2 markets.
+
+
+
+
+ Base Currency Data
+
+```graphql
+{
+ priceOracles {
+ usdPriceEth
+ }
+}
+```
+
+For ETH-based markets (all V2 markets except Avalanche):
+
+- `marketReferencePriceInUsd` = 1 / (queryResult.priceOracles[0].usdPriceEth /
+ (10 \*\* 18))
+
+- `marketReferenceCurrencyDecimals` = 18
+
+For USD-based markets (Avalanche and all v3 markets):
+
+- `marketReferencePriceInUsd` = 1 / (queryResult.priceOracles[0].usdPriceEth /
+ (10 \*\* 8))
+
+- `marketReferenceCurrencyDecimals` = 8
+
+
+
+
+ Incentives
+
+Samples for incentives data coming soon. Uses `incentivesControlllers` field and
+maps incentives to reserves and userReserves.
+
+
+
+
+
+
+ V3
+
+
+ Reserves
+
+```graphql
+{
+ reserves(
+ where: { pool: "insert_lowercase_lending_pool_address_provider_here" }
+ ) {
+ id
+ symbol
+ name
+ decimals
+ underlyingAsset
+ usageAsCollateralEnabled
+ reserveFactor
+ baseLTVasCollateral
+ averageStableRate
+ stableDebtLastUpdateTimestamp
+ liquidityIndex
+ reserveLiquidationThreshold
+ reserveLiquidationBonus
+ variableBorrowIndex
+ variableBorrowRate
+ liquidityRate
+ totalPrincipalStableDebt
+ totalScaledVariableDebt
+ lastUpdateTimestamp
+ availableLiquidity
+ stableBorrowRate
+ totalLiquidity
+ price {
+ priceInEth
+ }
+ eModeCategoryId
+ borrowCap
+ supplyCap
+ debtCeiling
+ debtCeilingDecimals
+ isolationModeTotalDebt
+ eModeLtv
+ eModeLiquidationThreshold
+ eModeLiquidationBonus
+ }
+}
+```
+
+Then formatted to match expected input schema with:
+
+```ts
+const reserves = queryResults.map(queryResult => {
+ return {
+ ...queryResult,
+ priceInMarketReferenceCurrency: queryResult.price.priceInEth,
+ };
+});
+```
+
+
+
+
+ User Reserves
+
+```graphql
+{
+ userReserves(
+ where: {
+ pool: "insert_lowercase_lending_pool_address_provider_here"
+ user: "insert_lowercase_user_address_here"
+ }
+ ) {
+ reserve {
+ underlyingAsset
+ }
+ scaledATokenBalance
+ usageAsCollateralEnabledOnUser
+ stableBorrowRate
+ scaledVariableDebt
+ principalStableDebt
+ stableBorrowLastUpdateTimestamp
+ user {
+ eModeCategoryId {
+ id
+ }
+ }
+ }
+}
+```
+
+Then formatted to match expected input schema with:
+
+```ts
+const userReserves = queryResults.map(queryResult => {
+ return {
+ ...queryResult,
+ underlyingAsset: queryResult.reserve.underlyingAsset,
+ };
+});
+```
+
+The field `queryResults[0].user.eModeCategoryId.id` is the active eModeCategory
+and will input to the user formatters separately.
+
+
+
+
+ Base Currency Data
+
+```graphql
+{
+ priceOracles {
+ usdPriceEth
+ baseCurrencyUnit
+ }
+}
+```
+
+- `marketReferencePriceInUsd` = 1 / (queryResult.priceOracles[0].usdPriceEth /
+ (10 \*\* 8))
+- `marketReferenceCurrencyDecimals` =
+ queryResult.priceOracles[0].baseCurrencyUnit.toString().length
+
+
+
+
+ Incentives
+
+Samples for incentives data coming soon. Uses `incentivesControlllers` field and
+maps incentives to reserves and userReserves.
+
+
+
+
+
+
+
+### Caching Server
+
+Given that the Aave Ui has decentralized hosting with IPFS, it makes sense to
+not require any API keys to run the UI, but this means only public rpc endpoints
+are used which are quickly rate limited. To account for this, Aave has publushed
+a [caching server](https://github.com/aave/aave-ui-caching-server) to perform
+contract queries on one server, then serve this data to all frontend users
+through a graphQL endpoint.
+
+The four queries to fetch input data (in both query and subscription form) are
+located
+[here](https://github.com/aave/aave-ui/tree/master/src/libs/caching-server-data-provider/graphql)
+in the follow files:
+
+- protocol-data.graphql
+- user-data.graphql
+- incentives-data.graphql
+- user-incentives-data.graphql
+
+Examples of hooks for fetching data with these queries are located
+[here](https://github.com/aave/aave-ui/tree/master/src/libs/caching-server-data-provider/hooks).
+
+
+
+## Reserve Data
+
+Formatted reserve data is an array of tokens in the Aave market, containing
+realtime, human-readable data above asset configuration (maxLtv,
+liquidationThreshold, usageAsCollateral, etc.) and current status (rates,
+liquidity, utilization, etc.)
+
+There are two formatter functions, one with incentives data and one without.
+Both require input data from the
+[fetching protocol data](#fetching-protocol-data) section
+
+### formatReserves
+
+formatReserves returns an array of formatted configuration and status data for
+each reserve in an Aave market
+
+
+ Sample Code
+
+```ts
+import { formatReserves } from '@aave/math-utils';
+import dayjs from 'dayjs';
+
+// reserves input from Fetching Protocol Data section
+
+const reservesArray = reserves.reservesData;
+const baseCurrencyData = reserves.baseCurrencyData;
+
+const currentTimestamp = dayjs().unix();
+
+/*
+- @param `reserves` Input from [Fetching Protocol Data](#fetching-protocol-data), `reserves.reservesArray`
+- @param `currentTimestamp` Current UNIX timestamp in seconds
+- @param `marketReferencePriceInUsd` Input from [Fetching Protocol Data](#fetching-protocol-data), `reserves.baseCurrencyData.marketReferencePriceInUsd`
+- @param `marketReferenceCurrencyDecimals` Input from [Fetching Protocol Data](#fetching-protocol-data), `reserves.baseCurrencyData.marketReferenceCurrencyDecimals`
+*/
+const formattedPoolReserves = formatReserves({
+ reserves: reservesArray,
+ currentTimestamp,
+ marketReferenceCurrencyDecimals:
+ baseCurrencyData.marketReferenceCurrencyDecimals,
+ marketReferencePriceInUsd: baseCurrencyData.marketReferenceCurrencyPriceInUsd,
+});
+```
+
+
+
+
+
+### formatReservesAndIncentives
+
+formatReservesAndIncentives returns an array of formatted configuration and
+status data plus an object with supply, variable borrow, and stable borrow
+incentives for each reserve in an Aave market
+
+
+ Sample Code
+
+```ts
+import { formatReservesAndIncentives } from '@aave/math-utils';
+import dayjs from 'dayjs';
+
+// 'reserves' and 'reserveIncentives' inputs from Fetching Protocol Data section
+
+const reservesArray = reserves.reservesData;
+const baseCurrencyData = reserves.baseCurrencyData;
+
+const currentTimestamp = dayjs().unix();
+
+/*
+- @param `reserves` Input from [Fetching Protocol Data](#fetching-protocol-data), `reserves.reservesArray`
+- @param `currentTimestamp` Current UNIX timestamp in seconds, Math.floor(Date.now() / 1000)
+- @param `marketReferencePriceInUsd` Input from [Fetching Protocol Data](#fetching-protocol-data), `reserves.baseCurrencyData.marketReferencePriceInUsd`
+- @param `marketReferenceCurrencyDecimals` Input from [Fetching Protocol Data](#fetching-protocol-data), `reserves.baseCurrencyData.marketReferenceCurrencyDecimals`
+- @param `reserveIncentives` Input from [Fetching Protocol Data](#fetching-protocol-data), `reserveIncentives`
+*/
+const formattedPoolReserves = formatReservesAndIncentives({
+ reserves: reservesArray,
+ currentTimestamp,
+ marketReferenceCurrencyDecimals:
+ baseCurrencyData.marketReferenceCurrencyDecimals,
+ marketReferencePriceInUsd: baseCurrencyData.marketReferenceCurrencyPriceInUsd,
+ reserveIncentives,
+});
+```
+
+
+
+
+
+## User Data
+
+Formatted user data is an object containing cumulative metrics (healthFactor,
+totalLiquidity, totalBorrows, etc.) and an array of formatted reserve data plus
+user holdings (aTokens, debtTokens) for each reserve in an Aave market
+
+### formatUserSummary
+
+Returns formatted summary of Aave user portfolio including: array of holdings,
+total liquidity, total collateral, total borrows, liquidation threshold, health
+factor, and available borrowing power
+
+
+ Sample Code
+
+```ts
+import { formatUserSummary } from '@aave/math-utils';
+import dayjs from 'dayjs';
+
+// 'reserves' and 'userReserves' inputs from Fetching Protocol Data section
+
+const reservesArray = reserves.reservesData;
+const baseCurrencyData = reserves.baseCurrencyData;
+const userReservesArray = userReserves.userReserves;
+
+const currentTimestamp = dayjs().unix();
+
+const formattedPoolReserves = formatReserves({
+ reserves: reservesArray,
+ currentTimestamp,
+ marketReferenceCurrencyDecimals:
+ baseCurrencyData.marketReferenceCurrencyDecimals,
+ marketReferencePriceInUsd: baseCurrencyData.marketReferenceCurrencyPriceInUsd,
+});
+
+/*
+- @param `currentTimestamp` Current UNIX timestamp in seconds, Math.floor(Date.now() / 1000)
+- @param `marketReferencePriceInUsd` Input from [Fetching Protocol Data](#fetching-protocol-data), `reserves.baseCurrencyData.marketReferencePriceInUsd`
+- @param `marketReferenceCurrencyDecimals` Input from [Fetching Protocol Data](#fetching-protocol-data), `reserves.baseCurrencyData.marketReferenceCurrencyDecimals`
+- @param `userReserves` Input from [Fetching Protocol Data](#fetching-protocol-data), combination of `userReserves.userReserves` and `reserves.reservesArray`
+- @param `userEmodeCategoryId` Input from [Fetching Protocol Data](#fetching-protocol-data), `userReserves.userEmodeCategoryId`
+*/
+const userSummary = formatUserSummaryAndIncentives({
+ currentTimestamp,
+ marketReferencePriceInUsd: baseCurrencyData.marketReferenceCurrencyPriceInUsd,
+ marketReferenceCurrencyDecimals:
+ baseCurrencyData.marketReferenceCurrencyDecimals,
+ userReserves: userReservesFormatted,
+ userEmodeCategoryId: userReserves.userEmodeCategoryId,
+});
+```
+
+
+
+
+
+### formatUserSummaryAndIncentives
+
+Returns formatted summary of Aave user portfolio including: array of holdings,
+total liquidity, total collateral, total borrows, liquidation threshold, health
+factor, available borrowing power, and dictionary of claimable incentives
+
+
+ Sample Code
+
+```ts
+import { formatUserSummaryAndIncentives } from '@aave/math-utils';
+import dayjs from 'dayjs';
+
+// 'reserves', 'userReserves', 'reserveIncentives', and 'userIncentives' inputs from Fetching Protocol Data section
+
+const reservesArray = reserves.reservesData;
+const baseCurrencyData = reserves.baseCurrencyData;
+const userReservesArray = userReserves.userReserves;
+
+const currentTimestamp = dayjs().unix();
+
+// Combine reserve data with user data
+const userReservesFormatted: UserReserveData[] = [];
+if (userReservesArray && reservesArray.length) {
+ userReservesArray.forEach(rawUserReserve => {
+ const reserve = reservesArray.find(
+ r =>
+ r.underlyingAsset.toLowerCase() ===
+ rawUserReserve.underlyingAsset.toLowerCase(),
+ );
+ if (reserve) {
+ userReservesFormatted.push({
+ ...rawUserReserve,
+ reserve,
+ });
+ }
+ });
+}
+
+/*
+- @param `currentTimestamp` Current UNIX timestamp in seconds, Math.floor(Date.now() / 1000)
+- @param `marketReferencePriceInUsd` Input from [Fetching Protocol Data](#fetching-protocol-data), `reserves.baseCurrencyData.marketReferencePriceInUsd`
+- @param `marketReferenceCurrencyDecimals` Input from [Fetching Protocol Data](#fetching-protocol-data), `reserves.baseCurrencyData.marketReferenceCurrencyDecimals`
+- @param `userReserves` Input from [Fetching Protocol Data](#fetching-protocol-data), combination of `userReserves.userReserves` and `reserves.reservesArray`
+- @param `userEmodeCategoryId` Input from [Fetching Protocol Data](#fetching-protocol-data), `userReserves.userEmodeCategoryId`
+- @param `reserveIncentives` Input from [Fetching Protocol Data](#fetching-protocol-data), `reserveIncentives`
+- @param `userIncentives` Input from [Fetching Protocol Data](#fetching-protocol-data), `userIncentives`
+*/
+const userSummary = formatUserSummaryAndIncentives({
+ currentTimestamp,
+ marketReferencePriceInUsd: baseCurrencyData.marketReferenceCurrencyPriceInUsd,
+ marketReferenceCurrencyDecimals:
+ baseCurrencyData.marketReferenceCurrencyDecimals,
+ userReserves: userReservesFormatted,
+ userEmodeCategoryId: userReserves.userEmodeCategoryId,
+ reserveIncentives,
+ userIncentives,
+});
+```
+
+
+
+
+
+# Transaction Methods
+
+The transaction methods package provides an sdk to interact with Aave Protocol
+contracts. See [ethers.js](#ethers.js) for instructions on installing setting up
+and ethers provider
+
+Once initialized this sdk can be used to generate the transaction data needed to
+perform an action. If an approval is required, the method will return an array
+with two transactions, or single transaction if no approval is needed.
+
+## Submitting Transactions
+
+All transaction methods will return an array of transaction objects of this
+type:
+
+```ts
+import { EthereumTransactionTypeExtended } from '@aave/contract-helpers';
+```
+
+To send a transaction from this object:
+
+```ts
+import { BigNumber, providers } from 'ethers';
+
+function submitTransaction({
+ provider: providers.Web3Provider,
+ tx: EthereumTransactionTypeExtended
+}){
+ const extendedTxData = await tx.unsignedData();
+ const { from, ...txData } = extendedTxData;
+ const signer = provider.getSigner(from);
+ const txResponse = await signer.sendTransaction({
+ ...txData,
+ value: txData.value ? BigNumber.from(txData.value) : undefined,
+ });
+}
+```
+
+## Pool V3
+
+Transaction methods to perform actions on the V3 Pool contract
+
+### supply
+
+Formerly `deposit`, supply the underlying asset into the Pool reserve. For every
+token that is supplied, a corresponding amount of aTokens is minted
+
+
+ Sample Code
+
+```ts
+import { Pool } from '@aave/contract-helpers';
+
+const pool = new Pool(provider, {
+ POOL: poolAddress,
+ WETH_GATEWAY: wethGatewayAddress,
+});
+
+/*
+- @param `user` The ethereum address that will make the deposit
+- @param `reserve` The ethereum address of the reserve
+- @param `amount` The amount to be deposited
+- @param @optional `onBehalfOf` The ethereum address for which user is depositing. It will default to the user address
+*/
+const txs: EthereumTransactionTypeExtended[] = await pool.supply({
+ user,
+ reserve,
+ amount,
+ onBehalfOf,
+});
+
+// If the user has not appoved the pool contract to spend their tokens, txs will also contain two transactions: approve and supply. These approval and supply transactions can be submitted just as in V2,OR you can skip the first approval transaction with a gasless signature by using signERC20Approval -> supplyWithPermit which are documented below
+
+// If there is no approval transaction, then supply() can called without the need for an approval or signature
+```
+
+Submit transaction(s) as shown [here](#submitting-transactions)
+
+
+
+
+
+### signERC20Approval
+
+This method is used to generate the raw signature data to be signed by the user.
+Once generated, a function is called to trigger a signature request from the
+users wallet. This signature can be passed a parameter to `supplyWithPermit` or
+`repayWithPermit` in place of an approval transaction
+
+
+ Sample Code
+
+```ts
+import { Pool } from '@aave/contract-helpers';
+
+const pool = new Pool(provider, {
+ POOL: poolAddress,
+ WETH_GATEWAY: wethGatewayAddress,
+});
+
+/*
+- @param `user` The ethereum address that will make the deposit
+- @param `reserve` The ethereum address of the reserve
+- @param `amount` The amount to be deposited
+*/
+const dataToSign: string = await pool.signERC20Approval({
+ user,
+ reserve,
+ amount,
+});
+
+const signature = await provider.send('eth_signTypedData_v4', [
+ currentAccount,
+ dataToSign,
+]);
+
+// This signature can now be passed into the supplyWithPermit() function below
+```
+
+
+
+
+
+### supplyWithPermit
+
+Same underlying method as `supply` but uses a signature based approval passed as
+a paramter.
+
+
+ Sample Code
+
+```ts
+import { Pool } from '@aave/contract-helpers';
+
+const pool = new Pool(provider, {
+ POOL: poolAddress,
+ WETH_GATEWAY: wethGatewayAddress,
+});
+
+/*
+- @param `user` The ethereum address that will make the deposit
+- @param `reserve` The ethereum address of the reserve
+- @param `amount` The amount to be deposited
+- @param `signature` Signature approving Pool to spend user funds, received from signing output data of signERC20Approval()
+- @param @optional `onBehalfOf` The ethereum address for which user is depositing. It will default to the user address
+*/
+const txs: EthereumTransactionTypeExtended[] = await pool.supplyWithPermit({
+ user,
+ reserve,
+ amount,
+ signature,
+ onBehalfOf,
+});
+```
+
+Submit transaction as shown [here](#submitting-transactions)
+
+
+
+
+
+### borrow (V3)
+
+Borrow an `amount` of `reserve` asset.
+
+User must have a collaterised position (i.e. aTokens in their wallet)
+
+
+ Sample Code
+
+```ts
+import { Pool, InterestRate } from '@aave/contract-helpers';
+
+const pool = new Pool(provider, {
+ POOL: poolAddress,
+ WETH_GATEWAY: wethGatewayAddress,
+});
+
+/*
+- @param `user` The ethereum address that repays
+- @param `reserve` The ethereum address of the reserve on which the user borrowed
+- @param `amount` The amount to repay, or (-1) if the user wants to repay everything
+- @param `interestRateMode` // Whether the borrow will incur a stable (InterestRate.Stable) or variable (InterestRate.Variable) interest rate
+- @param @optional `onBehalfOf` The ethereum address for which user is repaying. It will default to the user address
+*/
+const txs: EthereumTransactionTypeExtended[] = pool.Borrow({
+ user,
+ reserve,
+ amount,
+ interestRateMode,
+ onBehalfOf,
+});
+```
+
+Submit transaction as shown [here](#submitting-transactions)
+
+
+
+
+
+### repay (V3)
+
+Repays a borrow on the specific reserve, for the specified amount (or for the
+whole amount, if (-1) is specified). the target user is defined by `onBehalfOf`.
+If there is no repayment on behalf of another account, `onBehalfOf` must be
+equal to `user`
-Here is a quick example to get you started:
+If the Pool is not approved to spend `user` funds, an approval transaction will
+also be returned
+
+
+ Sample Code
```ts
-import { PermissionManager } from '@aave/contract-helpers';
+import { Pool } from '@aave/contract-helpers';
+
+const pool = new Pool(provider, {
+ POOL: poolAddress,
+ WETH_GATEWAY: wethGatewayAddress,
+});
-const instance = new PermissionManager({
- provider: rpcProvider,
- permissionManagerAddress: permissionManagerAddress,
+/*
+- @param `user` The ethereum address that will make the deposit
+- @param `reserve` The ethereum address of the reserve
+- @param `amount` The amount to be deposited
+- @param `interestRateMode` // Whether stable (InterestRate.Stable) or variable (InterestRate.Variable) debt will be repaid
+- @param @optional `onBehalfOf` The ethereum address for which user is depositing. It will default to the user address
+*/
+const txs: EthereumTransactionTypeExtended[] = await pool.repay({
+ user,
+ reserve,
+ amount,
+ interestRateMode,
+ onBehalfOf,
});
-const permissions = await instance.getHumanizedUserPermissions(walletAddress);
+
+// If the user has not appoved the pool contract to spend their tokens, txs will also contain two transactions: approve and repay. This approval transaction can be submitted just as in V2, OR you approve with a gasless signature by using signERC20Approval -> supplyWithPermit which are documented below
+
+// If there is no approval transaction, then repay() can called without the need for an approval or signature
```
-## Examples
+Submit transaction(s) as shown [here](#submitting-transactions)
+
+
+
+
+
+### repayWithPermit
+
+Same underlying method as `repay` but uses a signature based approval passed as
+a paramter.
+
+
+ Sample Code
+
+```ts
+import { Pool } from '@aave/contract-helpers';
+
+const pool = new Pool(provider, {
+ POOL: poolAddress,
+ WETH_GATEWAY: wethGatewayAddress,
+});
+
+/*
+- @param `user` The ethereum address that will make the deposit
+- @param `reserve` The ethereum address of the reserve
+- @param `amount` The amount to be deposited
+- @param `signature` Signature approving Pool to spend user funds, from signERC20Approval()
+- @param @optional `onBehalfOf` The ethereum address for which user is depositing. It will default to the user address
+*/
+const txs: EthereumTransactionTypeExtended[] = await pool.supplyWithPermit({
+ user,
+ reserve,
+ amount,
+ signature,
+ onBehalfOf,
+});
+```
+
+Submit transaction as shown [here](#submitting-transactions)
+
+
+
+
+
+### repayWithATokens
+
+Repays a borrow on the specific reserve, for the specified amount, deducting
+funds from a users aToken balance instead of the underlying balance. To repay
+the max debt amount or max aToken balance without dust (whichever is lowest),
+set the amount to -1
+
+There is no need for an approval or signature when repaying with aTokens
+
+
+ Sample Code
+
+```ts
+import { Pool, InterestRate } from '@aave/contract-helpers';
+
+const pool = new Pool(provider, {
+ POOL: poolAddress,
+ WETH_GATEWAY: wethGatewayAddress,
+});
+
+/*
+- @param `user` The ethereum address that will make the deposit
+- @param `amount` The amount to be deposited, -1 to repay max aToken balance or max debt balance without dust (whichever is lowest)
+- @param `reserve` The ethereum address of the reserve
+- @param `rateMode` The debt type to repay, stable (InterestRate.Stable) or variable (InterestRate.Variable)
+*/
+const txs: EthereumTransactionTypeExtended[] = await pool.repayWithATokens({
+ user,
+ amount,
+ reserve,
+ reateMode,
+});
+```
+
+Submit transaction as shown [here](#submitting-transactions)
+
+
+
+
+
+### withdraw (V3)
+
+Withdraws the underlying asset of an aToken asset.
+
+
+ Sample Code
+
+```ts
+import { Pool } from '@aave/contract-helpers';
+
+const pool = new Pool(provider, {
+ POOL: poolAddress,
+ WETH_GATEWAY: wethGatewayAddress,
+});
+
+/*
+- @param `user` The ethereum address that will make the deposit
+- @param `reserve` The ethereum address of the reserve
+- @param `amount` The amount to be deposited
+- @param `aTokenAddress` The aToken to redeem for underlying asset
+- @param @optional `onBehalfOf` The ethereum address for which user is depositing. It will default to the user address
+*/
+const txs: EthereumTransactionTypeExtended[] = await pool.withdraw({
+ user,
+ reserve,
+ amount,
+ aTokenAddress,
+ onBehalfOf,
+});
+```
+
+Submit transaction as shown [here](#submitting-transactions)
+
+
+
+
+
+### swapBorrowRateMode (V3)
+
+Borrowers can use this function to swap between stable and variable borrow rate
+modes
+
+
+ Sample Code
+
+```ts
+import { Pool, InterestRate } from '@aave/contract-helpers';
+
+const pool = new Pool(provider, {
+ POOL: poolAddress,
+ WETH_GATEWAY: wethGatewayAddress,
+});
+
+/*
+- @param `user` The ethereum address that will make the deposit
+- @param `reserve` The ethereum address of the reserve
+- @param `interestRateMode` The rate mode to swap to, stable (InterestRate.Stable) or variable (InterestRate.Variable)
+*/
+const txs: EthereumTransactionTypeExtended[] = await pool.swapBorrowRateMode({
+ user,
+ reserve,
+ amount,
+ onBehalfOf,
+});
+```
+
+Submit transaction as shown [here](#submitting-transactions)
+
+
+
+
+
+### setUsageAsCollateral (V3)
+
+Allows depositors to enable or disable a specific deposit as collateral
+
+
+ Sample Code
+
+```ts
+import { Pool } from '@aave/contract-helpers';
+
+const pool = new Pool(provider, {
+ POOL: poolAddress,
+ WETH_GATEWAY: wethGatewayAddress,
+});
+
+/*
+- @param `user` The ethereum address that will make the deposit
+- @param `reserve` The ethereum address of the reserve
+- @param `usageAsCollateral` Boolean, true if the user wants to use the deposit as collateral, false otherwise
+*/
+const txs: EthereumTransactionTypeExtended[] = await pool.setUsageAsCollateral({
+ user,
+ reserve,
+ usageAsCollateral,
+});
+```
+
+Submit transaction as shown [here](#submitting-transactions)
+
+
+
+
+
+### liquidationCall (V3)
+
+Users can invoke this function to liquidate an undercollateralized position
+
+
+ Sample Code
+
+```ts
+import { Pool } from '@aave/contract-helpers';
+
+const pool = new Pool(provider, {
+ POOL: poolAddress,
+ WETH_GATEWAY: wethGatewayAddress,
+});
+
+/*
+- @param `liquidator` The ethereum address that will liquidate the position
+- @param `liquidatedUser` The address of the borrower
+- @param `debtReserve` The ethereum address of the principal reserve
+- @param `collateralReserve` The address of the collateral to liquidated
+- @param `purchaseAmount` The amount of principal that the liquidator wants to repay
+- @param @optional `getAToken` Boolean to indicate if the user wants to receive the aToken instead of the asset. Defaults to false
+*/
+const txs: EthereumTransactionTypeExtended[] = lendingPool.liquidationCall({
+ liquidator,
+ liquidatedUser,
+ debtReserve,
+ collateralReserve,
+ purchaseAmount,
+ getAToken,
+});
+```
+
+Submit transaction(s) as shown [here](#submitting-transactions)
+
+
+
+
+
+### swapCollateral (V3)
+
+Utilizes flashloan to swap to a different collateral asset
+
+
+ Sample Code
+
+```ts
+import { Pool } from '@aave/contract-helpers';
+
+const pool = new Pool(provider, {
+ POOL: poolAddress,
+ SWAP_COLLATERAL_ADAPTER: swapCollateralAdapterAddress,
+ WETH_GATEWAY: wethGatewayAddress,
+});
+
+/*
+- @param `user` The ethereum address that will liquidate the position
+- @param @optional `flash` If the transaction will be executed through a flasloan(true) or will be done directly through the adapters(false). Defaults to false
+- @param `fromAsset` The ethereum address of the asset you want to swap
+- @param `fromAToken` The ethereum address of the aToken of the asset you want to swap
+- @param `toAsset` The ethereum address of the asset you want to swap to (get)
+- @param `fromAmount` The amount you want to swap
+- @param `toAmount` The amount you want to get after the swap
+- @param `maxSlippage` The max slippage that the user accepts in the swap
+- @param @optional `permitSignature` A permit signature of the tx. Only needed when previously signed (Not needed at the moment).
+- @param `swapAll` Bool indicating if the user wants to swap all the current collateral
+- @param @optional `onBehalfOf` The ethereum address for which user is swaping. It will default to the user address
+- @param @optional `referralCode` Integrators are assigned a referral code and can potentially receive rewards. It defaults to 0 (no referrer)
+- @param @optional `useEthPath` Boolean to indicate if the swap will use an ETH path. Defaults to false
+*/
+const txs: EthereumTransactionTypeExtended[] = await lendingPool.swapCollateral(
+ {
+ user,
+ flash,
+ fromAsset,
+ fromAToken,
+ toAsset,
+ fromAmount,
+ toAmount,
+ maxSlippage,
+ permitSignature,
+ swapAll,
+ onBehalfOf,
+ referralCode,
+ useEthPath,
+ },
+);
+```
+
+Submit transaction(s) as shown [here](#submitting-transactions)
+
+
+
+
+
+### repayWithCollateral (V3)
+
+Allows a borrower to repay the open debt with their collateral
+
+
+ Sample Code
+
+```ts
+import { Pool } from '@aave/contract-helpers';
+
+const pool = new Pool(provider, {
+ POOL: poolAddress,
+ REPAY_WITH_COLLATERAL_ADAPTER: repayWithCollateralAddress,
+ WETH_GATEWAY: wethGatewayAddress,
+});
+
+/*
+- @param `user` The ethereum address that will liquidate the position
+- @param `fromAsset` The ethereum address of the asset you want to repay with (collateral)
+- @param `fromAToken` The ethereum address of the aToken of the asset you want to repay with (collateral)
+- @param `assetToRepay` The ethereum address of the asset you want to repay
+- @param `repayWithAmount` The amount of collateral you want to repay the debt with
+- @param `repayAmount` The amount of debt you want to repay
+- @param `permitSignature` A permit signature of the tx. Optional
+- @param @optional `repayAllDebt` Bool indicating if the user wants to repay all current debt. Defaults to false
+- @param `rateMode` //Enum indicating the type of the interest rate of the collateral
+- @param @optional `onBehalfOf` The ethereum address for which user is swaping. It will default to the user address
+- @param @optional `referralCode` Integrators are assigned a referral code and can potentially receive rewards. It defaults to 0 (no referrer)
+- @param @optional `flash` If the transaction will be executed through a flasloan(true) or will be done directly through the adapters(false). Defaults to false
+- @param @optional `useEthPath` Boolean to indicate if the swap will use an ETH path. Defaults to false
+*/
+const txs: EthereumTransactionTypeExtended[] =
+ await lendingPool.repayWithCollateral({
+ user,
+ fromAsset,
+ fromAToken,
+ assetToRepay,
+ repayWithAmount,
+ repayAmount,
+ permitSignature,
+ repayAllDebt,
+ rateMode,
+ onBehalfOf,
+ referralCode,
+ flash,
+ useEthPath,
+ });
+```
+
+Submit transaction(s) as shown [here](#submitting-transactions)
+
+
+
+
+
+### setUserEMode
+
+Function to enable eMode on a user account IF conditions are met:
+
+To enable, pass `categoryId` of desired eMode (1 = stablecoins), can only be
+enabled if a users currently borrowed assests are ALL within this eMode category
+To disable, pass `categoryId` of 0, can only be disabled if new LTV will not
+leave user undercollateralized
+
+
+ Sample Code
+
+```ts
+import { Pool } from '@aave/contract-helpers';
+
+const pool = new Pool(provider, {
+ POOL: poolAddress,
+ WETH_GATEWAY: wethGatewayAddress,
+});
+
+/*
+- @param `user` The ethereum address that will make the deposit
+- @param `categoryId` number representing the eMode to switch to, 0 = disable, 1 = stablecoins
+*/
+const txs: EthereumTransactionTypeExtended[] = await pool.setUserEMode({
+ user,
+ categoryId,
+});
+```
+
+Submit transaction as shown [here](#submitting-transactions)
+
+
+
+
+
+## Lending Pool V2
+
+Object that contains all the necessary methods to create Aave V2 lending pool
+transactions
+
+### deposit
+
+Deposits the underlying asset into the reserve. For every token that is
+deposited, a corresponding amount of aTokens is minted
+
+
+ Sample Code
+
+```ts
+import { LendingPool } from '@aave/contract-helpers';
+
+const lendingPool = new LendingPool(provider, {
+ LENDING_POOL: lendingPoolAddress,
+ WETH_GATEWAY: wethGatewayAddress,
+});
+
+/*
+- @param `user` The ethereum address that will make the deposit
+- @param `reserve` The ethereum address of the reserve
+- @param `amount` The amount to be deposited
+- @param @optional `onBehalfOf` The ethereum address for which user is depositing. It will default to the user address
+*/
+const txs: EthereumTransactionTypeExtended[] = await lendingPool.deposit({
+ user,
+ reserve,
+ amount,
+ onBehalfOf,
+});
+```
+
+Submit transaction(s) as shown [here](#submitting-transactions)
+
+
+
+
+
+### borrow
+
+Borrow an `amount` of `reserve` asset.
+
+User must have a collaterised position (i.e. aTokens in their wallet)
+
+
+
+
+ Sample Code
+
+```ts
+import { LendingPool, InterestRate } from '@aave/contract-helpers';
+
+const lendingPool = new LendingPool(provider, {
+ LENDING_POOL: lendingPoolAddress,
+ WETH_GATEWAY: wethGatewayAddress,
+});
+
+/*
+- @param `user` The ethereum address that will receive the borrowed amount
+- @param `reserve` The ethereum address of the reserve asset
+- @param `amount` The amount to be borrowed, in human readable units (e.g. 2.5 ETH)
+- @param `interestRateMode`//Whether the borrow will incur a stable (InterestRate.Stable) or variable (InterestRate.Variable) interest rate
+- @param @optional `debtTokenAddress` The ethereum address of the debt token of the asset you want to borrow. Only needed if the reserve is ETH mock address
+- @param @optional `onBehalfOf` The ethereum address for which user is borrowing. It will default to the user address
+*/
+const txs: EthereumTransactionTypeExtended[] = await lendingPool.borrow({
+ user,
+ reserve,
+ amount,
+ interestRateMode,
+ debtTokenAddress,
+ onBehalfOf,
+ referralCode,
+});
+```
+
+Submit transaction as shown [here](#submitting-transactions)
+
+
+
+
+
+### repay
+
+Repays a borrow on the specific reserve, for the specified amount (or for the
+whole amount, if (-1) is specified). the target user is defined by `onBehalfOf`.
+If there is no repayment on behalf of another account, `onBehalfOf` must be
+equal to `user`
+
+If the `user` is not approved, an approval transaction will also be returned
+
+
+ Sample Code
+
+```ts
+import { LendingPool, InterestRate } from '@aave/contract-helpers';
+
+const lendingPool = new LendingPool(provider, {
+ LENDING_POOL: lendingPoolAddress,
+ WETH_GATEWAY: wethGatewayAddress,
+});
+
+/*
+- @param `user` The ethereum address that repays
+- @param `reserve` The ethereum address of the reserve on which the user borrowed
+- @param `amount` The amount to repay, or (-1) if the user wants to repay everything
+- @param `interestRateMode` // Whether stable (InterestRate.Stable) or variable (InterestRate.Variable) debt will be repaid
+- @param @optional `onBehalfOf` The ethereum address for which user is repaying. It will default to the user address
+*/
+const txs: EthereumTransactionTypeExtended[] = lendingPool.repay({
+ user,
+ reserve,
+ amount,
+ interestRateMode,
+ onBehalfOf,
+});
+```
+
+Submit transaction(s) as shown [here](#submitting-transactions)
+
+
+
+
+
+### withdraw
+
+Withdraws the underlying asset of an aToken asset.
+
+
+ Sample Code
+
+```ts
+import { LendingPool } from '@aave/contract-helpers';
+
+const lendingPool = new LendingPool(provider, {
+ LENDING_POOL: lendingPoolAddress,
+ WETH_GATEWAY: wethGatewayAddress,
+});
+
+/*
+- @param `user` The ethereum address that will receive the aTokens
+- @param `reserve` The ethereum address of the reserve asset
+- @param `amount` The amount of aToken being redeemed
+- @param @optional `aTokenAddress` The ethereum address of the aToken. Only needed if the reserve is ETH mock address
+- @param @optional `onBehalfOf` The amount of aToken being redeemed. It will default to the user address
+*/
+const txs: EthereumTransactionTypeExtended[] = lendingPool.withdraw({
+ user,
+ reserve,
+ amount,
+ aTokenAddress,
+ onBehalfOf,
+});
+```
+
+Submit transaction as shown [here](#submitting-transactions)
+
+
+
+
+
+### swapBorrowRateMode
+
+Borrowers can use this function to swap between stable and variable borrow rate
+modes.
+
+
+ Sample Code
+
+```ts
+import { LendingPool, InterestRate } from '@aave/contract-helpers';
+
+const lendingPool = new LendingPool(provider, {
+ LENDING_POOL: lendingPoolAddress,
+});
+
+/*
+- @param `user` The ethereum address that wants to swap rate modes
+- @param `reserve` The address of the reserve on which the user borrowed
+- @param `interestRateMode` //Whether the borrow will incur a stable (InterestRate.Stable) or variable (InterestRate.Variable) interest rate
+*/
+const txs: EthereumTransactionTypeExtended[] = lendingPool.swapBorrowRateMode({
+ user,
+ reserve,
+ interestRateMode,
+});
+```
+
+Submit transaction as shown [here](#submitting-transactions)
+
+
+
+
+
+### setUsageAsCollateral
+
+Allows depositors to enable or disable a specific deposit as collateral
+
+
+ Sample Code
+
+```ts
+import { LendingPool, InterestRate } from '@aave/contract-helpers';
+
+const lendingPool = new LendingPool(provider, {
+ LENDING_POOL: lendingPoolAddress,
+});
+
+/*
+- @param `user` The ethereum address that enables or disables the deposit as collateral
+- @param `reserve` The ethereum address of the reserve
+- @param `useAsCollateral` Boolean, true if the user wants to use the deposit as collateral, false otherwise
+*/
+const txs: EthereumTransactionTypeExtended[] = lendingPool.setUsageAsCollateral(
+ {
+ user,
+ reserve,
+ usageAsCollateral,
+ },
+);
+```
+
+Submit transaction as shown [here](#submitting-transactions)
+
+
+
+
+
+### liquidationCall
+
+Users can invoke this function to liquidate an undercollateralized position.
+
+
+
+
+ Sample Code
+
+```ts
+import { LendingPool } from '@aave/contract-helpers';
+
+const lendingPool = new LendingPool(provider, {
+ LENDING_POOL: lendingPoolAddress,
+ WETH_GATEWAY: wethGatewayAddress,
+});
+
+/*
+- @param `liquidator` The ethereum address that will liquidate the position
+- @param `liquidatedUser` The address of the borrower
+- @param `debtReserve` The ethereum address of the principal reserve
+- @param `collateralReserve` The address of the collateral to liquidated
+- @param `purchaseAmount` The amount of principal that the liquidator wants to repay
+- @param @optional `getAToken` Boolean to indicate if the user wants to receive the aToken instead of the asset. Defaults to false
+*/
+const txs: EthereumTransactionTypeExtended[] = lendingPool.liquidationCall({
+ liquidator,
+ liquidatedUser,
+ debtReserve,
+ collateralReserve,
+ purchaseAmount,
+ getAToken,
+});
+```
+
+Submit transaction(s) as shown [here](#submitting-transactions)
+
+
+
+
+
+### swapCollateral
+
+Allows users to swap a collateral to another asset
+
+
+ Sample Code
+
+```ts
+import {
+ LendingPool,
+ InterestRate,
+ PermitSignature,
+} from '@aave/contract-helpers';
+
+const lendingPool = new LendingPool(provider, {
+ LENDING_POOL: lendingPoolAddress,
+ SWAP_COLLATERAL_ADAPTER: swapCollateralAdapterAddress,
+ WETH_GATEWAY: wethGatewayAddress,
+});
+
+/*
+- @param `user` The ethereum address that will liquidate the position
+- @param @optional `flash` If the transaction will be executed through a flasloan(true) or will be done directly through the adapters(false). Defaults to false
+- @param `fromAsset` The ethereum address of the asset you want to swap
+- @param `fromAToken` The ethereum address of the aToken of the asset you want to swap
+- @param `toAsset` The ethereum address of the asset you want to swap to (get)
+- @param `fromAmount` The amount you want to swap
+- @param `toAmount` The amount you want to get after the swap
+- @param `maxSlippage` The max slippage that the user accepts in the swap
+- @param @optional `permitSignature` A permit signature of the tx. Only needed when previously signed (Not needed at the moment).
+- @param `swapAll` Bool indicating if the user wants to swap all the current collateral
+- @param @optional `onBehalfOf` The ethereum address for which user is swaping. It will default to the user address
+- @param @optional `referralCode` Integrators are assigned a referral code and can potentially receive rewards. It defaults to 0 (no referrer)
+- @param @optional `useEthPath` Boolean to indicate if the swap will use an ETH path. Defaults to false
+*/
+const txs: EthereumTransactionTypeExtended[] = await lendingPool.swapCollateral(
+ {
+ user,
+ flash,
+ fromAsset,
+ fromAToken,
+ toAsset,
+ fromAmount,
+ toAmount,
+ maxSlippage,
+ permitSignature,
+ swapAll,
+ onBehalfOf,
+ referralCode,
+ useEthPath,
+ },
+);
+```
+
+Submit transaction(s) as shown [here](#submitting-transactions)
+
+
+
+
+
+### repayWithCollateral
+
+Allows a borrower to repay the open debt with their collateral
+
+
+ Sample Code
+
+```ts
+import {
+ LendingPool,
+ InterestRate,
+ PermitSignature,
+} from '@aave/contract-helpers';
+
+const lendingPool = new LendingPool(provider, {
+ LENDING_POOL: lendingPoolAddress,
+ REPAY_WITH_COLLATERAL_ADAPTER: repayWithCollateralAddress,
+ WETH_GATEWAY: wethGatewayAddress,
+});
+
+/*
+- @param `user` The ethereum address that will liquidate the position
+- @param `fromAsset` The ethereum address of the asset you want to repay with (collateral)
+- @param `fromAToken` The ethereum address of the aToken of the asset you want to repay with (collateral)
+- @param `assetToRepay` The ethereum address of the asset you want to repay
+- @param `repayWithAmount` The amount of collateral you want to repay the debt with
+- @param `repayAmount` The amount of debt you want to repay
+- @param `permitSignature` A permit signature of the tx. Optional
+- @param @optional `repayAllDebt` Bool indicating if the user wants to repay all current debt. Defaults to false
+- @param `rateMode` //Enum indicating the type of the interest rate of the collateral
+- @param @optional `onBehalfOf` The ethereum address for which user is swaping. It will default to the user address
+- @param @optional `referralCode` Integrators are assigned a referral code and can potentially receive rewards. It defaults to 0 (no referrer)
+- @param @optional `flash` If the transaction will be executed through a flasloan(true) or will be done directly through the adapters(false). Defaults to false
+- @param @optional `useEthPath` Boolean to indicate if the swap will use an ETH path. Defaults to false
+*/
+const txs: EthereumTransactionTypeExtended[] =
+ await lendingPool.repayWithCollateral({
+ user,
+ fromAsset,
+ fromAToken,
+ assetToRepay,
+ repayWithAmount,
+ repayAmount,
+ permitSignature,
+ repayAllDebt,
+ rateMode,
+ onBehalfOf,
+ referralCode,
+ flash,
+ useEthPath,
+ });
+```
+
+Submit transaction(s) as shown [here](#submitting-transactions)
+
+
+
+
+
+## Governance V2
+
+Example of how to use functions of the Aave governance service
+
+```ts
+import { AaveGovernanceService } from '@aave/contract-helpers';
+
+const httpProvider = new Web3.providers.HttpProvider(
+ process.env.ETHEREUM_URL || 'https://kovan.infura.io/v3/',
+);
+
+const governanceService = new AaveGovernanceService(httpProvider, {
+ GOVERNANCE_ADDRESS: aaveGovernanceV2Address,
+ GOVERNANCE_HELPER_ADDRESS: aaveGovernanceV2HelperAddress,
+ ipfsGateway: IPFS_ENDPOINT,
+});
+```
+
+### create
+
+Creates a Proposal (needs to be validated by the Proposal Validator)
+
+
+ Sample Code
+
+```ts
+import { AaveGovernanceService } from '@aave/contract-helpers';
+
+const governanceService = new AaveGovernanceService(rpcProvider, {
+ GOVERNANCE_ADDRESS: aaveGovernanceV2Address,
+ GOVERNANCE_HELPER_ADDRESS: aaveGovernanceV2HelperAddress,
+ ipfsGateway: IPFS_ENDPOINT,
+});
+
+/*
+- @param `user` The ethereum address that will create the proposal
+- @param `targets` list of contracts called by proposal's associated transactions
+- @param `values` list of value in wei for each propoposal's associated transaction
+- @param `signatures` list of function signatures (can be empty) to be used when created the callData
+- @param `calldatas` list of calldatas: if associated signature empty, calldata ready, else calldata is arguments
+- @param `withDelegatecalls` boolean, true = transaction delegatecalls the taget, else calls the target
+- @param `ipfsHash` IPFS hash of the proposal
+- @param `executor` The ExecutorWithTimelock contract that will execute the proposal: ExecutorType.Short or ExecutorType.Long
+*/
+const tx = governanceService.create({
+ user,
+ targets,
+ values,
+ signatures,
+ calldatas,
+ withDelegatecalls,
+ ipfsHash,
+ executor,
+});
+```
+
+Submit transaction as shown [here](#submitting-transactions)
+
+
+
+
+### cancel
+
+Cancels a Proposal. Callable by the guardian with relaxed conditions, or by
+anybody if the conditions of cancellation on the executor are fulfilled
+
+
+ Sample Code
+
+```ts
+import { AaveGovernanceService } from '@aave/contract-helpers';
+
+const governanceService = new AaveGovernanceService(rpcProvider, {
+ GOVERNANCE_ADDRESS: aaveGovernanceV2Address,
+ GOVERNANCE_HELPER_ADDRESS: aaveGovernanceV2HelperAddress,
+ ipfsGateway: IPFS_ENDPOINT,
+});
+
+/*
+- @param `user` The ethereum address that will create the proposal
+- @param `proposalId` Id of the proposal we want to queue
+*/
+const tx = governanceService.cancel({ user, proposalId });
+```
+
+Submit transaction as shown [here](#submitting-transactions)
+
+
+
+
+### queue
+
+Queue the proposal (If Proposal Succeeded)
+
+
+ Sample Code
+
+```ts
+import { AaveGovernanceService } from '@aave/contract-helpers';
+
+const governanceService = new AaveGovernanceService(rpcProvider, {
+ GOVERNANCE_ADDRESS: aaveGovernanceV2Address,
+ GOVERNANCE_HELPER_ADDRESS: aaveGovernanceV2HelperAddress,
+ ipfsGateway: IPFS_ENDPOINT,
+});
+
+/*
+- @param `user` The ethereum address that will create the proposal
+- @param `proposalId` Id of the proposal we want to queue
+*/
+const tx = governanceService.queue({ user, proposalId });
+```
+
+Submit transaction as shown [here](#submitting-transactions)
+
+
+
+
+
+
+
+### execute
+
+Execute the proposal (If Proposal Queued)
+
+
+ Sample Code
+
+```ts
+import { AaveGovernanceService } from '@aave/contract-helpers';
+
+const governanceService = new AaveGovernanceService(rpcProvider, {
+ GOVERNANCE_ADDRESS: aaveGovernanceV2Address,
+ GOVERNANCE_HELPER_ADDRESS: aaveGovernanceV2HelperAddress,
+ ipfsGateway: IPFS_ENDPOINT,
+});
+
+/*
+- @param `user` The ethereum address that will create the proposal
+- @param `proposalId` Id of the proposal we want to execute
+*/
+const tx = governanceService.execute({ user, proposalId });
+```
+
+Submit transaction as shown [here](#submitting-transactions)
+
+
+
+
+### submitVote
+
+Function allowing msg.sender to vote for/against a proposal
+
+
+ Sample Code
+
+```ts
+import { AaveGovernanceService } from '@aave/contract-helpers';
+
+const governanceService = new AaveGovernanceService(rpcProvider, {
+ GOVERNANCE_ADDRESS: aaveGovernanceV2Address,
+ GOVERNANCE_HELPER_ADDRESS: aaveGovernanceV2HelperAddress,
+ ipfsGateway: IPFS_ENDPOINT,
+});
+
+/*
+- @param `user` The ethereum address that will create the proposal
+- @param `proposalId` Id of the proposal we want to vote
+- @param `support` Bool indicating if you are voting in favor (true) or against (false)
+*/
+const tx = governanceService.submitVote({ user, proposalId, support });
+```
+
+Submit transaction as shown [here](#submitting-transactions)
+
+
+
+
+
+### delegate
+
+Method for the user to delegate voting `and` proposition power to the chosen
+address
+
+
+ Sample Code
+
+```ts
+import { GovernancePowerDelegationTokenService } from '@aave/contract-helpers';
+
+const powerDelegation = new GovernancePowerDelegationTokenService(rpcProvider);
+
+/*
+- @param `user` The ethereum address that will create the proposal
+- @param `delegatee` The ethereum address to which the user wants to delegate proposition power and voting power
+- @param `governanceToken` The ethereum address of the governance token
+*/
+const tx = powerDelegation.delegate({ user, delegatee, governanceToken });
+```
+
+Submit transaction as shown [here](#submitting-transactions)
+
+
+
+
+
+### delegateByType
+
+Method for the user to delegate voting `or` proposition power to the chosen
+address
+
+
+ Sample Code
+
+```ts
+import { GovernancePowerDelegationTokenService } from '@aave/contract-helpers';
+
+const powerDelegation = new GovernancePowerDelegationTokenService(rpcProvider);
+
+/*
+- @param `user` The ethereum address that will create the proposal
+- @param `delegatee` The ethereum address to which the user wants to delegate proposition power and voting power
+- @param `delegationType` The type of the delegation the user wants to do: voting power ('0') or proposition power ('1')
+- @param `governanceToken` The ethereum address of the governance token
+*/
+const tx = powerDelegation.delegateByType({
+ user,
+ delegatee,
+ delegationType,
+ governanceToken,
+});
+```
+
+Submit transaction as shown [here](#submitting-transactions)
+
+
+
+
+
+## Faucets
+
+To use the testnet faucets which are compatible with Aave:
+
+### mint
+
+Mint tokens for the usage on the Aave protocol on a test network. The amount of
+minted tokens is fixed and depends on the token
+
+
+ Sample Code
+
+```ts
+import { FaucetService } from '@aave/contract-helpers';
+
+const faucetService = new FaucetService(provider, faucetAddress);
+
+/*
+- @param `userAddress` The ethereum address of the wallet the minted tokens will go
+- @param `reserve` The ethereum address of the token you want to mint
+- @param `tokenSymbol` The symbol of the token you want to mint
+*/
+const tx = faucet.mint({ userAddress, reserve, tokenSymbol });
+```
-Are you looking for an example project to get started? Check out repositories
-relying on this library:
+Submit transaction as shown [here](#submitting-transactions)
-- [The open source aave ui](https://github.com/aave/aave-ui)
-- [Aave info](https://github.com/sakulstra/info.aave)
+