Instadapp/dsa-connectors

mirror of https://github.com/Instadapp/dsa-connectors.git synced 2024-07-29 22:37:00 +00:00

DSA Connectors

Go to file

Thomas Bouder 04f6bebefd 👥 Update for review		2021-09-02 10:00:55 +02:00
.github/workflows	Checker for solidity code (#32 )	2021-05-07 22:06:52 +05:30
.husky	Checker for solidity code (#32 )	2021-05-07 22:06:52 +05:30
contracts	👥 Update for review	2021-09-02 10:00:55 +02:00
deployements/mainnet	Added basic compound testcases	2021-05-15 00:46:54 +05:30
docs	Added Liquity connector	2021-08-24 02:32:44 +05:30
scripts	Merge branch 'main' into dep/compound-mapping-update	2021-08-06 00:57:35 +05:30
status-checks	check if public function is payable	2021-07-26 18:59:54 +03:00
test	Add new Yearn vault connector	2021-08-23 23:35:06 +02:00
.env.example
.gitignore
hardhat.config.js	Add new Yearn vault connector	2021-08-23 23:35:06 +02:00
LICENSE
package-lock.json	Updated dependencies	2021-06-14 12:36:05 +05:30
package.json	Updated package.json	2021-06-25 22:45:54 +05:30
README.md	Update README.md	2021-04-14 16:29:37 +05:30

README.md

DSA connectors

Connectors are standard proxy logics contract that let DeFi Smart Account (DSA) interact with various smart contracts, and make the important actions accessible like cross protocol interoperability.

DSAs are powerful because they can easily be extended with connectors. Every new connector that is added is immediately usable by any developer building on top of DSAs. Connectors can either be base connectors to protocols, auth connectors, higher level connectors with more specific use cases like optimized lending, or connectors to native liquidity pools.

You can create a PR to request a support for specific protocol or external contracts. The process to add a new connector is explained here. Following is the list of all the supported connectors. Following is the list of all the primary connectors used to cast spells:

Read this post to learn about getId and setId used in the connectors

Authority

`add(authority)`

Add an address authority

authority - Address of the authority to add

`remove(authority)`

Remove an address authority

authority - Address of the authority to remove

Basic

`deposit(erc20, amt, getId, setId)`

Deposit a token or ETH to DSA.

erc20 - Address of the token to deposit. ETH = 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE

amt - Amount of token to deposit

In case of an ERC20 Token, allowance must be given to DSA before depositing

`withdraw(erc20, amt, getId, setId)`

Withdraw a token or ETH from DSA.

erc20 - Address of the token to withdraw. ETH = 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE

amt - Amount of token to withdraw

to - Address to which token will be withdrawn

MakerDAO

`open(collateralType)`

Open a Maker vault of the collateralType. E.g. "ETH-A", "USDC-B", etc...

`close(vault)`

Close a Maker vault

vault - Vault ID (Use 0 for last opened vault)

`deposit(vault, amt, getId, setId)`

Deposit collateral to a Maker vault.

vault - Vault ID (Use 0 for last opened vault)

amt - Amount of collteral to deposit

`withdraw(vault, amt, getId, setId)`

Withdraw collateral from a Maker vault.

vault - Vault ID (Use 0 for last opened vault)

amt - Amount of collteral to withdraw

`borrow(vault, amt, getId, setId)`

Borrow DAI from a Maker vault.

vault - Vault ID (Use 0 for last opened vault)

amt - Amount of DAI to borrow

`payback(vault, amt, getId, setId)`

Payback DAI to a Maker vault.

vault - Vault ID (Use 0 for last opened vault)

amt - Amount of DAI to payback

`withdrawLiquidated(vault, amt, getId, setId)`

Withdraw leftover collateral after liquidation.

vault - Vault ID (Use 0 for last opened vault)

amt - Amount of collateral to withdraw

`depositAndBorrow(vault, depositAmt, borrowAmt, getIdDeposit, getIdBorrow, setIdDeposit, setIdBorrow)`

Deposit collateral & borrow DAI from a vault.

vault - Vault ID (Use 0 for last opened vault)

depositAmt - Amount of collateral to deposit

borrowAmt - Amount of DAI to borrow

Compound

`deposit(token, amt, getId, setId)`

Deposit token to Compound.

token - Address of the token to deposit

amt - Amount of token to deposit

`withdraw(token, amt, getId, setId)`

Withdraw token from Compound.

token - Address of the token to withdraw

amt - Amount of token to withdraw

`borrow(token, amt, getId, setId)`

Borrow token from Compound.

token - Address of the token to borrow

amt - Amount of token to borrow

`payback(token, amt, getId, setId)`

Payback debt to Compound.

token - Address of the token to payback

amt - Amount of token to payback

COMP

`ClaimComp(setId)`

Claim unclaimed COMP

`ClaimCompTwo(tokens, setId)`

Claim unclaimed COMP

tokens - List of tokens supplied or borrowed

`ClaimCompThree(supplyTokens, borrowTokens, setId)`

Claim unclaimed COMP

supplyTokens - List of tokens supplied

borrowTokens - List of tokens borrowed

`delegate(delegatee)`

Delegate COMP votes

delegatee - Address of the delegatee

Aave v1

`deposit(token, amt, getId, setId)`

Deposit token to Aave.

token - Address of the token to deposit

amt - Amount of token to deposit

`withdraw(token, amt, getId, setId)`

Withdraw token from Aave.

token - Address of the token to withdraw

amt - Amount of token to withdraw

`borrow(token, amt, getId, setId)`

Borrow token from Aave.

token - Address of the token to borrow

amt - Amount of token to borrow

`payback(token, amt, getId, setId)`

Payback debt to Aave.

token - Address of the token to payback

amt - Amount of token to payback

Aave v2

`deposit(token, amt, getId, setId)`

Deposit token to Aave.

token - Address of the token to deposit

amt - Amount of token to deposit

`withdraw(token, amt, getId, setId)`

Withdraw token from Aave.

token - Address of the token to withdraw

amt - Amount of token to withdraw

`borrow(token, amt, rateMode, getId, setId)`

Borrow token from Aave.

token - Address of the token to borrow

amt - Amount of token to borrow

rateMode - Borrow interest rate mode (1 = Stable & 2 = Variable)

`payback(token, amt, rateMode, getId, setId)`

Payback debt to Aave.

token - Address of the token to payback

amt - Amount of token to payback

rateMode - Borrow interest rate mode (1 = Stable & 2 = Variable)

dYdX

`deposit(token, amt, getId, setId)`

Deposit token to dYdX.

token - Address of the token to deposit

amt - Amount of token to deposit

`withdraw(token, amt, getId, setId)`

Withdraw token from dYdX.

token - Address of the token to withdraw

amt - Amount of token to withdraw

`borrow(token, amt, getId, setId)`

Borrow token from dYdX.

token - Address of the token to borrow

amt - Amount of token to borrow

`payback(token, amt, getId, setId)`

Payback debt to dYdX.

token - Address of the token to payback

amt - Amount of token to payback

Uniswap

`deposit(tokenA, tokenB, amtA, unitAmt, slippage, getId, setId)`

Deposit liquidity to tokenA/tokenB pool

tokenA - Address of token A

tokenB - Address of token B

amtA - Amount of token A to deposit

unitAmt - Unit amount of amtB/amtA with slippage.

slippage - Slippage amount in wei

`withdraw(tokenA, tokenB, uniAmt, unitAmtA, unitAmtB, getId, setId)`

Withdraw liquidity from tokenA/tokenB pool

tokenA - Address of token A

tokenB - Address of token B

uniAmt - Amount of LP tokens to withdraw

unitAmtA - Unit amount of amtA/uniAmt with slippage.

unitAmtB - Unit amount of amtB/uniAmt with slippage.

`buy(buyAddr, sellAddr, buyAmt, unitAmt, getId, setId)`

Buy a token/ETH

buyAddr - Address of the buying token

sellAddr - Address of the selling token

buyAmt - Amount of tokens to buy

unitAmt - Unit amount of sellAmt/buyAmt with slippage

`sell(buyAddr, sellAddr, sellAmt, unitAmt, getId, setId)`

Sell a token/ETH

buyAddr - Address of the buying token

sellAddr - Address of the selling token

sellAmt - Amount of tokens to sell

unitAmt - Unit amount of buyAmt/sellAmt with slippage

1Inch

`sell(buyAddr, sellAddr, sellAmt, unitAmt, getId, setId)`

Sell ETH/ERC20 using 1proto

buyAddr - Address of the buying token

sellAddr - Address of the selling token

sellAmt - Amount of tokens to sell

unitAmt - Unit amount of buyAmt/sellAmt with slippage

`sellTwo(buyAddr, sellAddr, sellAmt, unitAmt, getId, setId)`

Sell ETH/ERC20 using 1proto

buyAddr - Address of the buying token

sellAddr - Address of the selling token

sellAmt - Amount of tokens to sell

unitAmt - Unit amount of buyAmt/sellAmt with slippage

[]distribution - Distribution of swap across different dex.

disableDexes - Disable a dex. (To disable none: 0)

`sellTwo(buyAddr, sellAddr, sellAmt, unitAmt, getId, setId)`

Sell ETH/ERC20 using 1inch

Use 1Inch API for calldata

buyAddr - Address of the buying token

sellAddr - Address of the selling token

sellAmt - Amount of tokens to sell

unitAmt - Unit amount of buyAmt/sellAmt with slippage

callData - Data from 1inch API