Skip to content

Commit

Permalink
Merge branch 'zaki/moreDocs' of https://github.com/PeggyJV/cellar-con…
Browse files Browse the repository at this point in the history
…tracts into zaki/moreDocs
  • Loading branch information
zmanian committed Jul 15, 2024
2 parents 2d76a7d + 3c05f2c commit 0d3c461
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 11 deletions.
14 changes: 6 additions & 8 deletions docs/adapters.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# Adapters

Adapters integrate Cellars with extenal Defi protocols enabling them to use the assets in the protocol.
Adapters integrate Cellars with external DeFi protocols, enabling them to use the assets in the protocol.

We have an establish catalogue of adapters that can be used to integrate with the following protocols:
We have an established catalogue of adapters that can be used to integrate with the following protocols:

## Aave

Thare are adapters for both Aave V2 and V3.
There are adapters for both Aave V2 and V3.

The adapters support both despoting assets and borrowing assets.

Frequent uses cases include:
- Leveraged Staking
- Stablecoin lending
- Leveraged Peg Arbitrage
- Leveraged Staking
- Stablecoin lending
- Leveraged Peg Arbitrage

## Aura

Expand Down Expand Up @@ -45,8 +45,6 @@ Support for DAI staking to earn stablecoin yield.

## Morpho



## OneInch

Another source of swap liquidity.
Expand Down
6 changes: 3 additions & 3 deletions docs/positions.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Positions

A Position is an instantiation for an adapter for a specific asset. A cellar may have multiple positions using the same adapter.
A Position is an instantiation of an adapter for a specific asset. A cellar may have multiple positions using the same adapter.

The process for setting up a position is as follows:

1. A cellar add an adapter that has been trusted by Registry with `AddAdapterToCatalogue`
1. A cellar add an adapter that has been trusted by Registry with `AddAdapterToCatalogue`,
2. A cellar adds a position that has been trusted by Registry with `AddAdapterToCatalogue`
3. `AddPosition` places the the position in the internal index and passes configuration data to the adapter. This connected to things like holding position, withdrawal order etc.
3. `AddPosition` places the position in the internal index and passes configuration data to the adapter. This is connected to things like holding position, withdrawal order, etc.

0 comments on commit 0d3c461

Please sign in to comment.