Merge branch 'master' into add-idle-finance

Author: sobolev-igor

README.md

@@ -2,20 +2,24 @@
 
 # DeFi SDK
 
-![](https://github.com/zeriontech/protocol-wrappers/workflows/lint/badge.svg)
-![](https://github.com/zeriontech/protocol-wrappers/workflows/build/badge.svg)
-![](https://github.com/zeriontech/protocol-wrappers/workflows/test/badge.svg)
-![](https://github.com/zeriontech/protocol-wrappers/workflows/coverage/badge.svg)
+[![Build status](https://github.com/zeriontech/protocol-wrappers/workflows/build/badge.svg)](https://github.com/zeriontech/defi-sdk/actions?query=workflow:build)
+[![Test status](https://github.com/zeriontech/protocol-wrappers/workflows/test/badge.svg)](https://github.com/zeriontech/defi-sdk/actions?query=workflow:test)
+[![Coverage status](https://github.com/zeriontech/protocol-wrappers/workflows/coverage/badge.svg)](https://github.com/zeriontech/defi-sdk/actions?query=workflow:coverage)
+[![Lint status](https://github.com/zeriontech/protocol-wrappers/workflows/lint/badge.svg)](https://github.com/zeriontech/defi-sdk/actions?query=workflow:lint)
+[![License](https://img.shields.io/github/license/zeriontech/defi-sdk)](https://www.gnu.org/licenses/lgpl-3.0.en.html)
+[![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.
 
 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, Curve*, etc.
-  > How much debt does `0xdead..beef` have on Curve Y pool?
-#### 📊Get the underlying components of complex derivative ERC20 tokens
+
+#### 💥Query user assets and debt deposited in DeFi protocols like *Maker, Aave, dYdX*, etc. 
+> 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-)
@@ -33,11 +37,14 @@ If you have any questions about DeFi SDK, feel free to reach out to us on our [D
 
 ### Fetch Compound debt and collateral
 
-As of now, to get all cTokens along with a user's debt on Compound you need to perform over 10 calls to the Ethereum node to different contracts or rely on a centralized API. With DeFi SDK, you can call one function `getProtocolBalances(account, ["Compound"])` on the `api.zerion.eth` smart contract to get all borrowed and supplied tokens.
+As of now, to get all cTokens along with a user's debt on Compound you need to perform over 10 calls to the Ethereum node to different contracts or rely on a centralized API. With DeFi SDK, you can call
 
 ```solidity
-getBalances('0xdead...beef', ['Compound'])
+getProtocolBalances('0xdead...beef', ['Compound'])
 ```
+
+on the `api.zerion.eth` smart contract and get all borrowed and supplied tokens
+
 ```javascript
 [{
   metadata: {
@@ -60,7 +67,7 @@ getBalances('0xdead...beef', ['Compound'])
           symbol: 'cBAT',
           decimals: '8'
         },
-        amount: '0'
+        amount: '314159265'
       },
       underlying: [{
         metadata: {
@@ -69,7 +76,7 @@ getBalances('0xdead...beef', ['Compound'])
           symbol: 'BAT',
           decimals: '18'
         },
-        amount: '0'
+        amount: '6626070040000000000'
       }]
     }]
   },{
@@ -85,7 +92,7 @@ getBalances('0xdead...beef', ['Compound'])
             symbol: 'DAI',
             decimals: '18'
           },
-          amount: '0'
+          amount: '1971081500000000000'
         },
         underlying: []
       }]
@@ -101,31 +108,37 @@ getBalances('0xdead...beef', ['Compound'])
 </p>
 
 Sometimes, a DeFi token contains several other tokens, and to calculate their price, you need to know their underlying assets. For example, a `Uniswap V1 cDAI pool` consists of `ETH` and `cDAI`. `cDAI`, in turn, has `DAI` as an underlying token. With DeFi SDK you can call
-```solidity
+
+```solidity 
 // Uniswap V1 cDAI pool
 getFinalFullTokenBalance('0x34E89740adF97C3A9D3f63Cc2cE4a914382c230b', "Uniswap V1 pool token")
 ```
+
+ and fetch the decomposition of UNI-token into ERC20 tokens, like `ETH` and `DAI`
+
 ```javascript
-100 ETH
-0.1 DAI
+0.98 ETH
+215.6 DAI
 ```
- and fetch the decomposition of UNI-token into ERC20 tokens, like `ETH` and `DAI`.
 
 ### Get account balances across all supported DeFi protocols
 
 In case you want to get account balances across all supported DeFi protocols, you can call
-```solidity
-// bankless.zerion.eth portfolio
-getBalances('0x0ef51b7dac3933b8109482e7d910c21848e45da0f')
+
+```solidity 
+// bankless.zerion.eth portfolio 
+getBalances('0x0ef51b7dac3933b8109482e7d910c21848e45da0f') 
 ```
+
+and obtain all balances for a given account. The response from the smart-contract will contain information about each of the protocols
+
 ```javascript
 100 DAI // collateral on Compound
-0.1 ETH // debt on Compound  
+0.1 ETH // debt on Compound
 100 USDC // locked in PoolTogether
 213 TUSD + 201 USDC + 82 USDT + 11 DAI // Curve Y pool
 ...
 ```
-and obtain all balances for a given account. The response from the smart-contract will contain information about each of the protocols.
 
 ## DeFi SDK architecture
 
@@ -145,8 +158,8 @@ More detailed documentation about contracts can be found in [adapters](../../wik
 | [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) |
-| [idle.finance](./contracts/adapters/idle) | Yield aggregator for lending platforms. | [Asset adapter](./contracts/adapters/idle/IdleAdapter.sol) | ["IdleToken"](./contracts/adapters/idle/IdleTokenAdapter.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) | — |

contracts/AdapterRegistry.sol

@@ -1,4 +1,4 @@
-// Copyright (C) 2020 Igor Sobolev <sobolev@zerion.io>
+// 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
@@ -35,9 +35,10 @@ import {
 
 
 /**
-* @title Registry for protocols, protocol adapters, and token adapters.
-* @notice getBalances() function implements the main functionality.
-*/
+ * @title Registry for protocols, adapters, and token adapters.
+ * @notice getBalances() function implements the main functionality.
+ * @author Igor Sobolev <[email protected]>
+ */
 contract AdapterRegistry is Ownable, ProtocolManager, TokenAdapterManager {
 
     using Strings for string;

contracts/ERC20.sol

@@ -1,4 +1,4 @@
-// Copyright (C) 2020 Igor Sobolev <sobolev@zerion.io>
+// 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

contracts/Ownable.sol

@@ -1,4 +1,4 @@
-// Copyright (C) 2020 Igor Sobolev <sobolev@zerion.io>
+// 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

contracts/ProtocolManager.sol

@@ -1,4 +1,4 @@
-// Copyright (C) 2020 Igor Sobolev <sobolev@zerion.io>
+// 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
@@ -22,7 +22,9 @@ import { Strings } from "./Strings.sol";
 
 
 /**
- * @title Base contract for AdapterRegistry.
+ * @title AdapterRegistry part responsible for protocols and adapters management.
+ * @dev Base contract for AdapterRegistry.
+ * @author Igor Sobolev <[email protected]>
  */
 abstract contract ProtocolManager is Ownable {
 

contracts/Strings.sol

@@ -1,4 +1,4 @@
-// Copyright (C) 2020 Igor Sobolev <sobolev@zerion.io>
+// 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
@@ -16,7 +16,10 @@
 pragma solidity 0.6.4;
 pragma experimental ABIEncoderV2;
 
-
+/**
+ * @notice Library for strings.
+ * @author Igor Sobolev <[email protected]>
+ */
 library Strings {
 
     function isEmpty(string memory s) internal pure returns (bool) {

contracts/Structs.sol

@@ -1,4 +1,4 @@
-// Copyright (C) 2020 Igor Sobolev <sobolev@zerion.io>
+// 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

contracts/TokenAdapterManager.sol

@@ -1,4 +1,4 @@
-// Copyright (C) 2020 Igor Sobolev <sobolev@zerion.io>
+// 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
@@ -21,7 +21,9 @@ import { Strings } from "./Strings.sol";
 
 
 /**
- * @title Base contract for AdapterRegistry.
+ * @title AdapterRegistry part responsible for token adapters management.
+ * @dev Base contract for AdapterRegistry.
+ * @author Igor Sobolev <[email protected]>
  */
 abstract contract TokenAdapterManager is Ownable {
 

contracts/adapters/ERC20TokenAdapter.sol

@@ -1,4 +1,4 @@
-// Copyright (C) 2020 Igor Sobolev <sobolev@zerion.io>
+// 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
@@ -24,6 +24,7 @@ import { TokenMetadata, Component } from "../Structs.sol";
 /**
  * @title Adapter for ERC20 tokens.
  * @dev Implementation of TokenAdapter interface function.
+ * @author Igor Sobolev <[email protected]>
  */
 contract ERC20TokenAdapter is TokenAdapter {
 

contracts/adapters/ProtocolAdapter.sol

@@ -1,4 +1,4 @@
-// Copyright (C) 2020 Igor Sobolev <sobolev@zerion.io>
+// 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
@@ -18,8 +18,9 @@ pragma experimental ABIEncoderV2;
 
 
 /**
- * @title Base contract for protocol adapters.
+ * @title Protocol adapter interface.
  * @dev adapterType(), tokenType(), and getBalance() functions MUST be implemented.
+ * @author Igor Sobolev <[email protected]>
  */
 interface ProtocolAdapter {