Valence Compound V3 Position Manager library
The Valence Compound V3 Position Manager library allows management of liquidity positions using an input account and an output account through the Compound V3 Protocol. It is typically used as part of a Valence Program. In that context, a Processor contract will be the main contract interacting with the Compound V3 Position Manager library.
High-level flows
---
title: Compound V3 Position Manager Supply
---
flowchart LR
P[Processor]
PM[Compound V3
Position Manager Library]
IA((Input Account))
MP((Compound
Market Proxy))
P -- 1/supply(amount) --> PM
PM -- 2/Query balances --> IA
PM -- 3/Approve tokens and call supply --> IA
IA -- 4/Supply --> MP
MP -- 5/Return collateral tokens --> IA
---
title: Compound V3 Position Manager Withdraw
---
flowchart LR
P[Processor]
PM[Compound V3
Position Manager Library]
IA((Input Account))
OA((Output Account))
MP((Compound
Market Proxy))
P -- 1/withdraw(amount) --> PM
PM -- 2/Call WithdrawTo --> IA
IA -- 3/WithdrawTo(output
account) --> MP
MP -- 4/Burn collateral tokens --> IA
MP -- 5/Send withdrawn tokens --> OA
Functions
| Function | Parameters | Description |
|---|---|---|
| supply | amount | Supplies tokens from the input account to the Compound V3 protocol. The input account will receive the corresponding collateral tokens. If amount is 0 the entire balance will be used. |
| withdraw | amount | Withdraws previously supplied tokens from Compound V3 and sends them to the output account. Passing 0 will withdraw the entire balance. |
| supplyCollateral | asset, amount | Supplies the token specified in asset. Works the same way as supply but instead of supplying the token specified in the library config, it supplies the token passed as a parameter |
| withdrawCollateral | asset, amount | Withdraw the token specified in asset. Works the same way as withdraw but instead of withdrawing the token specified in the library config, it withdraws the token passed as a parameter |
Configuration
The library is configured on deployment using the CompoundV3PositionManagerConfig type.
/**
* @title CompoundV3PositionManagerConfig
* @notice Configuration struct for CompoundV3 lending operations
* @dev Used to define parameters for interacting with CompoundV3 protocol
* @param inputAccount The Base Account from which transactions will be initiated
* @param outputAccount The Base Account that will receive withdrawals.
* @param baseAsset Address of the base token of the CompoundV3 market
* @param marketProxyAddress Address of the CompoundV3 market proxy
*/
struct CompoundV3PositionManagerConfig {
BaseAccount inputAccount;
BaseAccount outputAccount;
address baseAsset;
address marketProxyAddress;
}
Acknowledgments
Thanks to Mujtaba, Hareem, and Ayush from Orbit for this contribution.