Merge pull request #24 from bugduino/add-idle-finance

sobolev-igor · web-flow · commit d59834064f9b · 2020-03-26T12:07:32.000+03:00
NEW: add Idle finance adapters
diff --git a/README.md b/README.md
@@ -10,20 +10,21 @@
 [![Discord](https://img.shields.io/discord/544761450724458498?label=discord)](https://go.zerion.io/discord)
 [![Twitter Follow](https://img.shields.io/twitter/follow/zerion_io.svg)](https://twitter.com/intent/follow?screen_name=zerion_io)
 
-**DeFi SDK** is an open-source system of smart contracts designed for precise DeFi portfolio accounting. To put it simply, DeFi SDK is the on-chain *balanceOf* for DeFi protocols. 
+**DeFi SDK** is an open-source system of smart contracts designed for precise DeFi portfolio accounting. To put it simply, DeFi SDK is the on-chain *balanceOf* for DeFi protocols.
 
 If you have any questions about DeFi SDK, feel free to reach out to us on our [Discord server](https://go.zerion.io/discord).
 
 ## Features
 
+
 #### 💥Query user assets and debt deposited in DeFi protocols like *Maker, Aave, dYdX*, etc. 
-  > How much debt does `0xdead..beef` have on Compound?
+> How much debt does `0xdead..beef` have on Compound?
 #### 📊Get the underlying components of complex derivative ERC20 tokens 
 > How much `cUSDC` vs `ETH` does `ETHMACOAPY` have?
 #### ✨Interact with multiple DeFi protocols in a unified way (coming soon)
 > See [What’s next for DeFi SDK](#whats-next-for-defi-sdk-)
 
-## Table of Contents 
+## Table of Contents
 
   - [Examples](#examples)
   - [DeFi SDK architecture](#defi-sdk-architecture)
@@ -32,7 +33,7 @@ If you have any questions about DeFi SDK, feel free to reach out to us on our [D
   - [What’s next for DeFi SDK](#whats-next-for-defi-sdk-)
   - [Security vulnerabilities](#security-vulnerabilities-)
 
-## Examples 
+## Examples
 
 ### Fetch Compound debt and collateral
 
@@ -141,26 +142,27 @@ and obtain all balances for a given account. The response from the smart-contrac
 
 ## DeFi SDK architecture
 
-- **ProtocolAdapter** is a special contract for every protocol. Its main purpose is to wrap all the protocol interactions. 
+- **ProtocolAdapter** is a special contract for every protocol. Its main purpose is to wrap all the protocol interactions.
 There are different types of protocol adapters: "Asset" adapter returns the amount of the account's tokens held on the protocol and the "Debt" adapter returns the amount of the account's debt to the protocol. Some protocols do not use "simple" ERC20 tokens but instead have complex derivatives, for example the Compound protocol has CTokens. The **ProtocolAdapter** contract also provides information about the type of tokens used within it.
-- **TokenAdapter** is a contract for every derivative token type (e.g cTokens, aTokens, yTokens, etc.) 
+- **TokenAdapter** is a contract for every derivative token type (e.g cTokens, aTokens, yTokens, etc.)
 Its main purpose is to provide ERC20-style token metadata as well as information about the underlying ERC20 tokens (like DAI for cDAI). Namely, it provides addresses, types and rates of underlying tokens.
-- **AdapterRegistry** is a contract that a) maintains a list of *ProtocolAdapters* and *TokenAdapters* and b) is called to fetch user balances. 
+- **AdapterRegistry** is a contract that a) maintains a list of *ProtocolAdapters* and *TokenAdapters* and b) is called to fetch user balances.
 
 More detailed documentation about contracts can be found in [adapters](../../wiki/Adapters) and [AdapterRegistry](../../wiki/AdapterRegistry) documentation.
 
-## Supported protocols 
+## Supported protocols
 
 | Protocol Name | Description | Protocol Adapters | Token Adapters |
 | :-----------: | :---------: | :---------------: | :------------: |
 | [Aave](./contracts/adapters/aave) | Decentralized lending & borrowing protocol. | [Asset adapter](./contracts/adapters/aave/AaveAssetAdapter.sol) <br> [Debt adapter](contracts/adapters/aave/AaveDebtAdapter.sol) | ["AToken"](./contracts/adapters/aave/AaveTokenAdapter.sol) |
 | [Compound](./contracts/adapters/compound) | Decentralized lending & borrowing protocol. | [Asset adapter](./contracts/adapters/compound/CompoundAssetAdapter.sol) <br> [Debt adapter](./contracts/adapters/compound/CompoundDebtAdapter.sol) | ["CToken"](./contracts/adapters/compound/CompoundTokenAdapter.sol) |
 | [Curve](./contracts/adapters/curve) | Exchange liquidity pool for stablecoin trading. Supports Compound, Y, and BUSD pools. | [Asset adapter](./contracts/adapters/curve/CurveAdapter.sol) | ["Curve pool token"](contracts/adapters/curve/CurveTokenAdapter.sol) |
 | [dYdX](./contracts/adapters/dydx) | Decentralized trading platform. All 4 markets (WETH, SAI, USDC, DAI) are supported. | [Asset adapter](./contracts/adapters/dydx/DyDxAssetAdapter.sol) <br> [Debt adapter](./contracts/adapters/dydx/DyDxDebtAdapter.sol) | — |
+| [Idle](./contracts/adapters/idle) | Yield aggregator for lending platforms. | [Asset adapter](./contracts/adapters/idle/IdleAdapter.sol) | ["IdleToken"](./contracts/adapters/idle/IdleTokenAdapter.sol) |
 | [iearn.finance (v2/v3)](./contracts/adapters/iearn) | Yield aggregator for lending platforms. Protocol adapter is duplicated for v2 and v3 versions of protocol. | [Asset adapter](./contracts/adapters/iearn/IearnAdapter.sol) | ["YToken"](./contracts/adapters/iearn/IearnTokenAdapter.sol) |
 | [Chai](./contracts/adapters/maker) | A simple ERC20 wrapper over the Dai Savings Rate. | [Asset adapter](./contracts/adapters/maker/ChaiAdapter.sol) | ["Chai token"](./contracts/adapters/maker/ChaiTokenAdapter.sol) |
 | [DSR](./contracts/adapters/maker) | Decentralized lending protocol by MakerDAO. | [Asset adapter](./contracts/adapters/maker/DSRAdapter.sol) | — |
-| [MCD](./contracts/adapters/maker) | Collateralized loans on Maker. | [Asset adapter](./contracts/adapters/maker/MCDAssetAdapter.sol) <br> [Debt adapter](./contracts/adapters/maker/MCDDebtAdapter.sol) | — | 
+| [MCD](./contracts/adapters/maker) | Collateralized loans on Maker. | [Asset adapter](./contracts/adapters/maker/MCDAssetAdapter.sol) <br> [Debt adapter](./contracts/adapters/maker/MCDDebtAdapter.sol) | — |
 | [PoolTogether](./contracts/adapters/poolTogether) | Decentralized no-loss lottery. Supports SAI, DAI, and USDC pools. | [Asset adapter](./contracts/adapters/poolTogether/PoolTogetherAdapter.sol) | ["PoolTogether pool"](./contracts/adapters/poolTogether/PoolTogetherTokenAdapter.sol) |
 | [Synthetix](./contracts/adapters/synthetix) | Synthetic assets protocol. Asset adapter returns amount of SNX locked as collateral. | [Asset adapter](./contracts/adapters/synthetix/SynthetixAssetAdapter.sol) <br> [Debt adapter](./contracts/adapters/synthetix/SynthetixDebtAdapter.sol) | — |
 | [Uniswap V1](./contracts/adapters/uniswap) | Automated liquidity protocol. Top 30 pools are added to the **AdapterRegistry** contract, however  adapter supports all Uniswap pools. | [Asset adapter](./contracts/adapters/uniswap/UniswapV1Adapter.sol) supports all Uniswap pools | ["Uniswap V1 pool token"](./contracts/adapters/uniswap/UniswapV1TokenAdapter.sol) |
diff --git a/contracts/adapters/idle/IdleAdapter.sol b/contracts/adapters/idle/IdleAdapter.sol
@@ -0,0 +1,53 @@
+// Copyright (C) 2020 Zerion Inc. <https://zerion.io>
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+pragma solidity 0.6.4;
+pragma experimental ABIEncoderV2;
+
+import { ProtocolAdapter } from "../ProtocolAdapter.sol";
+import { ERC20 } from "../../ERC20.sol";
+
+
+/**
+ * @title Adapter for idle.finance protocol.
+ * @dev Implementation of ProtocolAdapter interface.
+ * @author William Bergamo <william@idle.finance>
+ */
+contract IdleAdapter is ProtocolAdapter {
+
+    /**
+     * @return Type of the adapter.
+     * @dev Implementation of ProtocolAdapter interface function.
+     */
+    function adapterType() external pure override returns (string memory) {
+        return "Asset";
+    }
+
+    /**
+     * @return Type of the token used in adapter.
+     * @dev Implementation of ProtocolAdapter interface function.
+     */
+    function tokenType() external pure override returns (string memory) {
+        return "IdleToken";
+    }
+
+    /**
+     * @return Amount of IdleTokens held by the given account.
+     * @dev Implementation of ProtocolAdapter interface function.
+     */
+    function getBalance(address token, address account) external view override returns (uint256) {
+        return ERC20(token).balanceOf(account);
+    }
+}
diff --git a/contracts/adapters/idle/IdleTokenAdapter.sol b/contracts/adapters/idle/IdleTokenAdapter.sol
@@ -0,0 +1,71 @@
+// Copyright (C) 2020 Zerion Inc. <https://zerion.io>
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+pragma solidity 0.6.4;
+pragma experimental ABIEncoderV2;
+
+import { TokenAdapter } from "../TokenAdapter.sol";
+import { TokenMetadata, Component } from "../../Structs.sol";
+import { ERC20 } from "../../ERC20.sol";
+
+
+/**
+ * @dev IdleToken contract interface.
+ * Only the functions required for IdleTokenAdapter contract are added.
+ * The IdleToken contracts are available here
+ * https://github.com/bugduino/idle-contracts/blob/master/contracts/IdleToken.sol
+ * @author William Bergamo <william@idle.finance>
+ */
+interface IdleToken {
+    function token() external view returns (address);
+    function tokenPrice() external view returns (uint256);
+}
+
+
+/**
+ * @title Token adapter for IdleTokens.
+ * @dev Implementation of TokenAdapter interface.
+ */
+contract IdleTokenAdapter is TokenAdapter {
+
+    /**
+     * @return TokenMetadata struct with ERC20-style token info.
+     * @dev Implementation of TokenAdapter interface function.
+     */
+    function getMetadata(address token) external view override returns (TokenMetadata memory) {
+        return TokenMetadata({
+            token: token,
+            name: ERC20(token).name(),
+            symbol: ERC20(token).symbol(),
+            decimals: ERC20(token).decimals()
+        });
+    }
+
+    /**
+     * @return Array of Component structs with underlying tokens rates for the given asset.
+     * @dev Implementation of TokenAdapter interface function.
+     */
+    function getComponents(address token) external view override returns (Component[] memory) {
+        Component[] memory underlyingTokens = new Component[](1);
+
+        underlyingTokens[0] = Component({
+            token: IdleToken(token).token(),
+            tokenType: "ERC20",
+            rate: IdleToken(token).tokenPrice()
+        });
+
+        return underlyingTokens;
+    }
+}
diff --git a/migrations_scripts/1_use_registry_and_add_adapters.js b/migrations_scripts/1_use_registry_and_add_adapters.js
@@ -65,6 +65,8 @@ const yUSDCv3 = '0x26EA744E5B887E5205727f55dFBE8685e3b21951';
 const yUSDTv3 = '0xE6354ed5bC4b393a5Aad09f21c46E101e692d447';
 const yBUSDv3 = '0x04bC0Ab673d88aE9dbC9DA2380cB6B79C4BCa9aE';
 
+const idleDAI = '0x10eC0D497824e342bCB0EDcE00959142aAa766dD';
+const idleUSDC = '0xeB66ACc3d011056B00ea521F8203580C2E5d3991';
 
 const ssCompoundTokenAddress = '0x845838DF265Dcd2c412A1Dc9e959c7d08537f8a2';
 const ssYTokenAddress = '0xdF5e0e81Dff6FAF3A7e52BA697820c5e32D806A8';
@@ -141,6 +143,10 @@ const iearn3AdapterTokens = [
   yUSDTv3,
   yBUSDv3,
 ];
+const idleAdapterTokens = [
+  idleDAI,
+  idleUSDC
+];
 const dsrAdapterTokens = [
   daiAddress,
 ];
@@ -202,8 +208,8 @@ const zrxAdapterTokens = [
 
 let protocolNames = [];
 let metadata = [];
-let adapters = [[], [], [], [], [], [], [], [], [], [], [], [], []];
-let tokens = [[], [], [], [], [], [], [], [], [], [], [], [], []];
+let adapters = [[], [], [], [], [], [], [], [], [], [], [], [], [], []];
+let tokens = [[], [], [], [], [], [], [], [], [], [], [], [], [], []];
 let tokenAdapters = [];
 
 module.exports = async (deployer, network, accounts) => {
@@ -274,10 +280,23 @@ module.exports = async (deployer, network, accounts) => {
     'protocol-icons.s3.amazonaws.com/dYdX.png',
     '0',
   ]);
+  await deployer.deploy(IdleAdapter, { from: accounts[0] })
+    .then(() => {
+      adapters[4].push(IdleAdapter.address);
+      tokens[4].push(idleAdapterTokens);
+    });
+  protocolNames.push('Idle');
+  metadata.push([
+    'Idle',
+    'Yield aggregator for lending platforms',
+    'idle.finance',
+    'protocol-icons.s3.amazonaws.com/idle.png',
+    '0',
+  ]);
   await deployer.deploy(IearnAdapter, { from: accounts[0] })
     .then(() => {
-      adapters[4].push(IearnAdapter.address);
-      tokens[4].push(iearn2AdapterTokens);
+      adapters[5].push(IearnAdapter.address);
+      tokens[5].push(iearn2AdapterTokens);
     });
   protocolNames.push('iearn.finance (v2)');
   metadata.push([
@@ -289,8 +308,8 @@ module.exports = async (deployer, network, accounts) => {
   ]);
   await deployer.deploy(IearnAdapter, { from: accounts[0] })
     .then(() => {
-      adapters[5].push(IearnAdapter.address);
-      tokens[5].push(iearn3AdapterTokens);
+      adapters[6].push(IearnAdapter.address);
+      tokens[6].push(iearn3AdapterTokens);
     });
   protocolNames.push('iearn.finance (v3)');
   metadata.push([
@@ -302,8 +321,8 @@ module.exports = async (deployer, network, accounts) => {
   ]);
   await deployer.deploy(ChaiAdapter, { from: accounts[0] })
     .then(() => {
-      adapters[6].push(ChaiAdapter.address);
-      tokens[6].push(chaiAdapterTokens);
+      adapters[7].push(ChaiAdapter.address);
+      tokens[7].push(chaiAdapterTokens);
     });
   protocolNames.push('Chai');
   metadata.push([
@@ -315,8 +334,8 @@ module.exports = async (deployer, network, accounts) => {
   ]);
   await deployer.deploy(DSRAdapter, { from: accounts[0] })
     .then(() => {
-      adapters[7].push(DSRAdapter.address);
-      tokens[7].push(dsrAdapterTokens);
+      adapters[8].push(DSRAdapter.address);
+      tokens[8].push(dsrAdapterTokens);
     });
   protocolNames.push('Dai Savings Rate');
   metadata.push([
@@ -328,13 +347,13 @@ module.exports = async (deployer, network, accounts) => {
   ]);
   await deployer.deploy(MCDAssetAdapter, { from: accounts[0] })
     .then(() => {
-      adapters[8].push(MCDAssetAdapter.address);
-      tokens[8].push(mcdAssetAdapterTokens);
+      adapters[9].push(MCDAssetAdapter.address);
+      tokens[9].push(mcdAssetAdapterTokens);
     });
   await deployer.deploy(MCDDebtAdapter, { from: accounts[0] })
     .then(() => {
-      adapters[8].push(MCDDebtAdapter.address);
-      tokens[8].push(mcdDebtAdapterTokens);
+      adapters[9].push(MCDDebtAdapter.address);
+      tokens[9].push(mcdDebtAdapterTokens);
     });
   protocolNames.push('Multi-Collateral Dai');
   metadata.push([
@@ -346,8 +365,8 @@ module.exports = async (deployer, network, accounts) => {
   ]);
   await deployer.deploy(PoolTogetherAdapter, { from: accounts[0] })
     .then(() => {
-      adapters[9].push(PoolTogetherAdapter.address);
-      tokens[9].push(poolTogetherAdapterTokens);
+      adapters[10].push(PoolTogetherAdapter.address);
+      tokens[10].push(poolTogetherAdapterTokens);
     });
   protocolNames.push('PoolTogether');
   metadata.push([
@@ -359,13 +378,13 @@ module.exports = async (deployer, network, accounts) => {
   ]);
   await deployer.deploy(SynthetixAssetAdapter, { from: accounts[0] })
     .then(() => {
-      adapters[10].push(SynthetixAssetAdapter.address);
-      tokens[10].push(synthetixAssetAdapterTokens);
+      adapters[11].push(SynthetixAssetAdapter.address);
+      tokens[11].push(synthetixAssetAdapterTokens);
     });
   await deployer.deploy(SynthetixDebtAdapter, { from: accounts[0] })
     .then(() => {
-      adapters[10].push(SynthetixDebtAdapter.address);
-      tokens[10].push(synthetixDebtAdapterTokens);
+      adapters[11].push(SynthetixDebtAdapter.address);
+      tokens[11].push(synthetixDebtAdapterTokens);
     });
   protocolNames.push('Synthetix');
   metadata.push([
@@ -377,8 +396,8 @@ module.exports = async (deployer, network, accounts) => {
   ]);
   await deployer.deploy(UniswapV1Adapter, { from: accounts[0] })
     .then(() => {
-      adapters[11].push(UniswapV1Adapter.address);
-      tokens[11].push(uniswapV1AdapterTokens);
+      adapters[12].push(UniswapV1Adapter.address);
+      tokens[12].push(uniswapV1AdapterTokens);
     });
   protocolNames.push('Uniswap V1');
   metadata.push([
@@ -390,8 +409,8 @@ module.exports = async (deployer, network, accounts) => {
   ]);
   await deployer.deploy(ZrxAdapter, { from: accounts[0] })
     .then(() => {
-      adapters[12].push(ZrxAdapter.address);
-      tokens[12].push(zrxAdapterTokens);
+      adapters[13].push(ZrxAdapter.address);
+      tokens[13].push(zrxAdapterTokens);
     });
   protocolNames.push('0x Staking');
   metadata.push([
@@ -401,6 +420,7 @@ module.exports = async (deployer, network, accounts) => {
     'protocol-icons.s3.amazonaws.com/0x-staking.png',
     '0',
   ]);
+
   await deployer.deploy(ERC20TokenAdapter, { from: accounts[0] })
     .then(() => {
       tokenAdapters.push(
@@ -431,6 +451,12 @@ module.exports = async (deployer, network, accounts) => {
         IearnTokenAdapter.address,
       );
     });
+  await deployer.deploy(IdleTokenAdapter, { from: accounts[0] })
+    .then(() => {
+      tokenAdapters.push(
+        IdleTokenAdapter.address,
+      );
+    });
   await deployer.deploy(ChaiTokenAdapter, { from: accounts[0] })
     .then(() => {
       tokenAdapters.push(
@@ -467,6 +493,7 @@ module.exports = async (deployer, network, accounts) => {
           'AToken',
           'CToken',
           'Curve pool token',
+          'IdleToken',
           'YToken',
           'Chai token',
           'PoolTogether pool',
diff --git a/test/AdapterRegistryDeployed.js b/test/AdapterRegistryDeployed.js
@@ -26,6 +26,7 @@ contract.skip('AdapterRegistry deployed', () => {
             'Chai',
             'iearn.finance (v3)',
             'iearn.finance (v2)',
+            'Idle',
             'dYdX',
             'Curve',
             'Compound',
@@ -42,6 +43,7 @@ contract.skip('AdapterRegistry deployed', () => {
             'Uniswap V1 pool token',
             'PoolTogether pool',
             'Chai token',
+            'IdleToken',
             'YToken',
             'Curve pool token',
             'CToken',
diff --git a/test/IdleAdapter.js b/test/IdleAdapter.js
