You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**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.
14
14
@@ -140,7 +140,7 @@ and obtain all balances for a given account. The response from the smart-contrac
140
140
...
141
141
```
142
142
143
-
## DeFi SDK architecture
143
+
## DeFi SDK Architecture
144
144
145
145
-**ProtocolAdapter** is a special contract for every protocol. Its main purpose is to wrap all the protocol interactions.
146
146
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.
@@ -150,11 +150,12 @@ Its main purpose is to provide ERC20-style token metadata as well as information
150
150
151
151
More detailed documentation about contracts can be found in [adapters](../../wiki/Adapters) and [AdapterRegistry](../../wiki/AdapterRegistry) documentation.
|[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)|
160
161
|[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)| — |
@@ -168,22 +169,22 @@ More detailed documentation about contracts can be found in [adapters](../../wik
168
169
|[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)|
The full instructions on how to add a custom adapter to the **AdapterRegistry** contract may be found in our [wiki](../../wiki/Adding-new-adapters).
174
175
175
176
If you have questions and/or want to add your adapter to Zerion reach out to us on our [Discord server](https://go.zerion.io/discord).
176
177
177
178
178
-
## What’s next for DeFi SDK? 🚀
179
+
## What’s Next for DeFi SDK? 🚀
179
180
180
181
This first version of DeFi SDK is for read-only accounting purposes. Our next step is to introduce Interactive Adapters that allow users to make cross-protocol transactions from a single interface. We are incredibly excited to work with developers, users and the wider DeFi community to make these integrations as secure and accessible as possible. Watch this space, because the “De” in DeFi is about to get a whole lot more user-friendly!
181
182
182
183
## Security Vulnerabilities 🛡
183
184
184
185
If you discover a security vulnerability within DeFi SDK, please send us an e-mail at inbox@zerion.io. All security vulnerabilities will be promptly addressed.
185
186
186
-
## Dev notes
187
+
## Dev Notes
187
188
188
189
This project uses Truffle and web3js for all Ethereum interactions and testing.
189
190
@@ -217,4 +218,4 @@ Currently, unsupported files are ignored.
217
218
218
219
## License
219
220
220
-
All smart contracts are released under LGPL v.3.
221
+
All smart contracts are released under GNU LGPLv3.
0 commit comments