Skip to content

Commit 209682a

Browse files
sntsabodesntsabode
committed
updated README.
1 parent da6cc20 commit 209682a

File tree

1 file changed

+146
-17
lines changed

1 file changed

+146
-17
lines changed

‎README.md

Lines changed: 146 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,7 @@ Eventually... I got tired of scouring DeFi Docs and God forbid Git repositories
150150
151151
| Protocol | ID | Name | Support |
152152
| ----------------------------------------------------------------------- |:-----------:| ------------: | ------------------------------------------------------------------------ |
153+
| [<img src="./misc/img/aave.png" />](https://bancor.network/) | **AAVE** | ***Aave*** | <img src="https://img.shields.io/badge/Aave-Supported-yellowgreen"/> |
153154
| [<img src="./misc/img/bancor.png" />](https://bancor.network/) | **BANCOR** | ***Bancor*** | <img src="https://img.shields.io/badge/Bancor-Supported-yellowgreen"/> |
154155
| [<img src="./misc/img/dydx.png"/>](https://dydx.exchange/) | **DYDX** | ***DyDx*** | <img src="https://img.shields.io/badge/DyDx-Supported-yellowgreen"/> |
155156
| [<img src="./misc/img/knc.png"/> ](https://kyber.network/about/kyber) | **KYBER** | ***Kyber Network*** | <img src="https://img.shields.io/badge/Kyber-Supported-yellowgreen"/> |
@@ -323,21 +324,156 @@ If true the protocol's npm package (if any) will be installed as a production de
323324
***
324325
325326
<h1 align="center"><em><strong>Protocols</em></strong></h1>
326-
<br><br/>
327+
328+
<h1 align="center"><em><strong>AAVE</strong></em></h2>
329+
330+
| Logo | Support | Imports |
331+
| :-----------------------------------: | :-------------------------------------------------------------------: | :------------------: |
332+
| <img src="./misc/img/aave.png"/> | <img src="https://img.shields.io/badge/Aave-Supported-yellowgreen"/> | `ILendingPoolAddressesProvider`, `ILendingPool` |
333+
334+
> Aave is a decentralised non-custodial liquidity protocol where users can participate as depositors or borrowers. Depositors provide liquidity to the market to earn a passive income, while borrowers are able to borrow in an over-collateralised (perpetually) or under-collateralised (one-block liquidity) fashion.
335+
336+
for more see [Aave's docs](https://docs.aave.com/developers/)
337+
338+
<br/>
339+
340+
### *Supported Contract Imports*
341+
342+
<br/>
343+
344+
- <h3 align="center"><em>ILendingPool</em></h3>
345+
346+
```json
347+
{
348+
"protocol": "AAVE",
349+
"pack": "ILendingPool",
350+
"omitNpmPack": true,
351+
"abi": false
352+
}
353+
```
354+
355+
Writes `ILendingPoolAddressesProvider` and `ILendingPool` contract interfaces along with a `DataTypes` library.
356+
357+
> The LendingPool contract is the main contract of the protocol. It exposes all the user-oriented actions that can be invoked using either Solidity or web3 libraries.
358+
> The source code can be found on [Github here](https://github.com/aave/protocol-v2/blob/ice/mainnet-deployment-03-12-2020/contracts/protocol/lendingpool/LendingPool.sol).
359+
> If you need development support, join the #developers channel on [the Aave community Discord server](https://discord.gg/CJm5Jt3).
360+
361+
***(snippet)***
362+
```solidity
363+
// SPDX-License-Identifier: NO-LICENSE
364+
pragma solidity 0.6.12;
365+
pragma experimental ABIEncoderV2;
366+
367+
import {ILendingPoolAddressesProvider} from './ILendingPoolAddressesProvider.sol';
368+
import {DataTypes} from '../../libraries/Aave/DataTypes.sol';
369+
370+
interface ILendingPool {
371+
...
372+
373+
event FlashLoan(
374+
address indexed target,
375+
address indexed initiator,
376+
address indexed asset,
377+
uint256 amount,
378+
uint256 premium,
379+
uint16 referralCode
380+
);
381+
382+
event LiquidationCall(
383+
address indexed collateralAsset,
384+
address indexed debtAsset,
385+
address indexed user,
386+
uint256 debtToCover,
387+
uint256 liquidatedCollateralAmount,
388+
address liquidator,
389+
bool receiveAToken
390+
);
391+
392+
...
393+
394+
function liquidationCall(
395+
address collateralAsset,
396+
address debtAsset,
397+
address user,
398+
uint256 debtToCover,
399+
bool receiveAToken
400+
) external;
401+
402+
...
403+
404+
function flashLoan(
405+
address receiverAddress,
406+
address[] calldata assets,
407+
uint256[] calldata amounts,
408+
uint256[] calldata modes,
409+
address onBehalfOf,
410+
bytes calldata params,
411+
uint16 referralCode
412+
) external;
413+
414+
...
415+
}
416+
```
417+
418+
<br/>
419+
420+
- <h3 align="center"><em>ILendingPoolAddressesProvider</em></h3>
421+
422+
```json
423+
{
424+
"protocol": "AAVE",
425+
"pack": "ILendingPoolAddressesProvider",
426+
"omitNpmPack": true,
427+
"abi": false
428+
}
429+
```
430+
431+
Writes an `ILendingPoolAddressesProvider` contract interface.
432+
433+
> Addresses register of the protocol for a particular market. This contract is immutable and the address will never change. Also see [Deployed Contracts](https://docs.aave.com/developers/deployed-contracts/deployed-contracts) section.
434+
435+
***(snippet)***
436+
```solidity
437+
// SPDX-License-Identifier: NO-LICENSE
438+
pragma solidity ${solver};
439+
440+
/**
441+
* @title LendingPoolAddressesProvider contract
442+
* @dev Main registry of addresses part of or connected to the protocol, including permissioned roles
443+
* - Acting also as factory of proxies and admin of those, so with right to change its implementations
444+
* - Owned by the Aave Governance
445+
* @author Aave
446+
**/
447+
interface ILendingPoolAddressesProvider {
448+
event MarketIdSet(string newMarketId);
449+
event LendingPoolUpdated(address indexed newAddress);
450+
451+
...
452+
453+
function getLendingPool() external view returns (address);
454+
455+
...
456+
}
457+
```
458+
459+
<br/>
460+
461+
***
327462
328463
<h1 align="center"><em><strong>BANCOR</strong></em></h2>
329464
330465
| Logo | Support | Imports |
331466
| :-----------------------------------: | :-------------------------------------------------------------------: | :------------------: |
332467
| <img src="./misc/img/bancor.png"/> | <img src="https://img.shields.io/badge/Banor-Supported-yellowgreen"/> | `IBancorNetwork` |
333468
334-
<br></br>
335-
336469
> While many users benefit from the Bancor Network by using the Bancor App or a Bancor Widget, developers can also access Bancor's many features from their own smart contracts. The [***API reference***](https://docs.bancor.network/guides/interfacing-with-bancor-contracts) section provides a detailed look into the full functionality of each contract in the system. This section will provide a quick look into some more common features and should contain sufficient information for most use cases.
337470
471+
<br></br>
472+
338473
### *Supported Contract Imports*
339474
340475
<br></br>
476+
341477
- <h3 align="center"><em>IBancorNetwork</em></h3>
342478
343479
```json
@@ -404,15 +540,12 @@ interface IContractRegistry {
404540
405541
***
406542
407-
<br></br>
408543
<h1 align="center"><em><strong>DyDx</strong></em></h2>
409544
410545
| Logo | Support | Imports |
411546
| :------------------------------: | :------------------------------------------------------------------: | :-----------------------------------: |
412547
| <img src="./misc/img/dydx.png"/> | <img src="https://img.shields.io/badge/DyDx-Supported-yellowgreen"/> | `Flashloan` |
413548
414-
<br></br>
415-
416549
### *Supported Contract Imports*
417550
418551
<br></br>
@@ -495,15 +628,12 @@ contract FlashLoan is ICallee {
495628
496629
***
497630
498-
<br><br/>
499631
<h1 align="center"><em><strong>KYBER</strong></em></h2>
500632
501633
| Logo | Support | Imports |
502634
| :---------------------------------------: | :-------------------------------------------------------------------: | :------------------: |
503635
| <img src="./misc/img/kyber-network.png"/> | <img src="https://img.shields.io/badge/Kyber-Supported-yellowgreen"/> | `IKyberNetworkProxy` |
504636
505-
<br></br>
506-
507637
### *Supported Contract Imports*
508638
509639
<br></br>
@@ -600,12 +730,11 @@ interface IKyberNetworkProxy {
600730
601731
***
602732
603-
<br><br/>
604733
<h1 align="center"><em><strong>ONEINCH</strong></em></h2>
605734
606735
| Logo | Support | Imports |
607736
| :--------------------------------: | :---------------------------------------------------------------------: | :--------------------------: |
608-
| <img src="./misc/img/1inch2.png"/> | <img src="https://img.shields.io/badge/OneInch-Supported-yellowgreen"/> | `OneInch`, `OneInchMulti` |
737+
| <img src="./misc/img/1inch2.png"/> | <img src="https://img.shields.io/badge/OneInch-Supported-yellowgreen"/> | `OneSplit`, `OneSplitMulti` |
609738
610739
> To use this service you have to call methods at [`OneSplitAudit`](https://github.com/CryptoManiacsZone/1inchProtocol/blob/master/contracts/OneSplitAudit.sol)
611740
>
@@ -630,12 +759,12 @@ interface IKyberNetworkProxy {
630759
### *Supported Contract Imports*
631760
632761
<br></br>
633-
- <h3 align="center"><em>OneInch</em></h3>
762+
- <h3 align="center"><em>OneSplit</em></h3>
634763
635764
```json
636765
{
637766
"protocol": "ONEINCH",
638-
"pack": "OneInch",
767+
"pack": "OneSplit",
639768
"omitNpmPack": true,
640769
"abi": true
641770
}
@@ -690,12 +819,13 @@ interface IOneSplit {
690819
```
691820
692821
<br></br>
693-
- <h3 align="center"><em>OneInchMulti</em></h3>
822+
823+
- <h3 align="center"><em>OneSplitMulti</em></h3>
694824
695825
```json
696826
{
697827
"protocol": "ONEINCH",
698-
"pack": "OneInchMulti",
828+
"pack": "OneSplitMulti",
699829
"omitNpmPack": true,
700830
"abi": true
701831
}
@@ -738,14 +868,13 @@ interface IOneSplitMulti is IOneSplit {
738868
***
739869
740870
<br><br/>
871+
741872
<h1 align="center"><em><strong>Uniswap</strong></em></h2>
742873
743874
| Logo | Support | Imports |
744875
:----------------------------------: | :-----------------------------------------------------------------------: | :---------------------------: |
745876
| <img src="./misc/img/uniswap-v2.png"/> | <img src="https://img.shields.io/badge/Uniswap-Supported-yellowgreen"/> | `V2Router` |
746877
747-
<br></br>
748-
749878
### *Supported Contract Imports*
750879
751880
<br></br>

0 commit comments

Comments
 (0)