From f7a3319fa8f02a643faf26fed4c82893f1817880 Mon Sep 17 00:00:00 2001 From: Collin Brittain Date: Wed, 21 Feb 2024 13:41:01 -0600 Subject: [PATCH] Update API docs --- docs/api/steward_api_doc.md | 4889 ++++++++++++++++++++++++++++------- 1 file changed, 3947 insertions(+), 942 deletions(-) diff --git a/docs/api/steward_api_doc.md b/docs/api/steward_api_doc.md index 3b120c0b..9cf26982 100644 --- a/docs/api/steward_api_doc.md +++ b/docs/api/steward_api_doc.md @@ -50,13 +50,42 @@ - [aave_v3_debt_token.proto](#aave_v3_debt_token-proto) - [AaveV3DebtTokenAdaptorV1](#steward-v4-AaveV3DebtTokenAdaptorV1) - - [AaveV3DebtTokenAdaptorV1.AdaptorCallForAaveV3Flashloan](#steward-v4-AaveV3DebtTokenAdaptorV1-AdaptorCallForAaveV3Flashloan) - [AaveV3DebtTokenAdaptorV1.BorrowFromAave](#steward-v4-AaveV3DebtTokenAdaptorV1-BorrowFromAave) - - [AaveV3DebtTokenAdaptorV1.FlashLoan](#steward-v4-AaveV3DebtTokenAdaptorV1-FlashLoan) - [AaveV3DebtTokenAdaptorV1.RepayAaveDebt](#steward-v4-AaveV3DebtTokenAdaptorV1-RepayAaveDebt) - [AaveV3DebtTokenAdaptorV1.RepayWithATokens](#steward-v4-AaveV3DebtTokenAdaptorV1-RepayWithATokens) - [AaveV3DebtTokenAdaptorV1Calls](#steward-v4-AaveV3DebtTokenAdaptorV1Calls) +- [aave_v3_debt_token_flash_loan.proto](#aave_v3_debt_token_flash_loan-proto) + - [AaveV3DebtTokenAdaptorV1FlashLoan](#steward-v4-AaveV3DebtTokenAdaptorV1FlashLoan) + - [AaveV3DebtTokenAdaptorV1FlashLoan.AdaptorCallForAaveV3FlashLoan](#steward-v4-AaveV3DebtTokenAdaptorV1FlashLoan-AdaptorCallForAaveV3FlashLoan) + - [AaveV3DebtTokenAdaptorV1FlashLoan.FlashLoan](#steward-v4-AaveV3DebtTokenAdaptorV1FlashLoan-FlashLoan) + - [AaveV3DebtTokenAdaptorV1FlashLoanCalls](#steward-v4-AaveV3DebtTokenAdaptorV1FlashLoanCalls) + +- [aura_erc4626.proto](#aura_erc4626-proto) + - [AuraERC4626AdaptorV1](#steward-v4-AuraERC4626AdaptorV1) + - [AuraERC4626AdaptorV1.GetRewards](#steward-v4-AuraERC4626AdaptorV1-GetRewards) + - [AuraERC4626AdaptorV1Calls](#steward-v4-AuraERC4626AdaptorV1Calls) + +- [balancer_pool.proto](#balancer_pool-proto) + - [BalancerPoolAdaptorV1](#steward-v4-BalancerPoolAdaptorV1) + - [BalancerPoolAdaptorV1.ClaimRewards](#steward-v4-BalancerPoolAdaptorV1-ClaimRewards) + - [BalancerPoolAdaptorV1.ExitPool](#steward-v4-BalancerPoolAdaptorV1-ExitPool) + - [BalancerPoolAdaptorV1.ExitPoolRequest](#steward-v4-BalancerPoolAdaptorV1-ExitPoolRequest) + - [BalancerPoolAdaptorV1.JoinPool](#steward-v4-BalancerPoolAdaptorV1-JoinPool) + - [BalancerPoolAdaptorV1.SingleSwap](#steward-v4-BalancerPoolAdaptorV1-SingleSwap) + - [BalancerPoolAdaptorV1.StakeBPT](#steward-v4-BalancerPoolAdaptorV1-StakeBPT) + - [BalancerPoolAdaptorV1.SwapData](#steward-v4-BalancerPoolAdaptorV1-SwapData) + - [BalancerPoolAdaptorV1.UnstakeBPT](#steward-v4-BalancerPoolAdaptorV1-UnstakeBPT) + - [BalancerPoolAdaptorV1Calls](#steward-v4-BalancerPoolAdaptorV1Calls) + + - [BalancerPoolAdaptorV1.SwapKind](#steward-v4-BalancerPoolAdaptorV1-SwapKind) + +- [balancer_pool_flash_loan.proto](#balancer_pool_flash_loan-proto) + - [BalancerPoolAdaptorV1FlashLoan](#steward-v4-BalancerPoolAdaptorV1FlashLoan) + - [BalancerPoolAdaptorV1FlashLoan.AdaptorCallForBalancerPoolFlashLoan](#steward-v4-BalancerPoolAdaptorV1FlashLoan-AdaptorCallForBalancerPoolFlashLoan) + - [BalancerPoolAdaptorV1FlashLoan.MakeFlashLoan](#steward-v4-BalancerPoolAdaptorV1FlashLoan-MakeFlashLoan) + - [BalancerPoolAdaptorV1FlashLoanCalls](#steward-v4-BalancerPoolAdaptorV1FlashLoanCalls) + - [base.proto](#base-proto) - [OracleSwap](#steward-v4-OracleSwap) - [RevokeApproval](#steward-v4-RevokeApproval) @@ -107,26 +136,37 @@ - [CellarV2](#steward-v4-CellarV2) - [CellarV2.AddPosition](#steward-v4-CellarV2-AddPosition) - [CellarV2.CallOnAdaptor](#steward-v4-CellarV2-CallOnAdaptor) + - [CellarV2.InitiateShutdown](#steward-v4-CellarV2-InitiateShutdown) + - [CellarV2.LiftShutdown](#steward-v4-CellarV2-LiftShutdown) - [CellarV2.RemovePosition](#steward-v4-CellarV2-RemovePosition) - [CellarV2.SetHoldingPosition](#steward-v4-CellarV2-SetHoldingPosition) + - [CellarV2.SetPlatformFee](#steward-v4-CellarV2-SetPlatformFee) - [CellarV2.SetRebalanceDeviation](#steward-v4-CellarV2-SetRebalanceDeviation) - [CellarV2.SetShareLockPeriod](#steward-v4-CellarV2-SetShareLockPeriod) - [CellarV2.SetStrategistPayoutAddress](#steward-v4-CellarV2-SetStrategistPayoutAddress) + - [CellarV2.SetStrategistPlatformCut](#steward-v4-CellarV2-SetStrategistPlatformCut) + - [CellarV2.SetupAdaptor](#steward-v4-CellarV2-SetupAdaptor) - [CellarV2.SwapPositions](#steward-v4-CellarV2-SwapPositions) - [CellarV2Governance](#steward-v4-CellarV2Governance) - [CellarV2Governance.InitiateShutdown](#steward-v4-CellarV2Governance-InitiateShutdown) - [CellarV2Governance.LiftShutdown](#steward-v4-CellarV2Governance-LiftShutdown) - [CellarV2Governance.SetPlatformFee](#steward-v4-CellarV2Governance-SetPlatformFee) + - [CellarV2Governance.SetRebalanceDeviation](#steward-v4-CellarV2Governance-SetRebalanceDeviation) - [CellarV2Governance.SetStrategistPlatformCut](#steward-v4-CellarV2Governance-SetStrategistPlatformCut) - [CellarV2Governance.SetupAdaptor](#steward-v4-CellarV2Governance-SetupAdaptor) - [CellarV2_2](#steward-v4-CellarV2_2) + - [CellarV2_2.AddAdaptorToCatalogue](#steward-v4-CellarV2_2-AddAdaptorToCatalogue) - [CellarV2_2.AddPosition](#steward-v4-CellarV2_2-AddPosition) + - [CellarV2_2.AddPositionToCatalogue](#steward-v4-CellarV2_2-AddPositionToCatalogue) + - [CellarV2_2.CachePriceRouter](#steward-v4-CellarV2_2-CachePriceRouter) - [CellarV2_2.CallOnAdaptor](#steward-v4-CellarV2_2-CallOnAdaptor) - [CellarV2_2.FunctionCall](#steward-v4-CellarV2_2-FunctionCall) - [CellarV2_2.InitiateShutdown](#steward-v4-CellarV2_2-InitiateShutdown) - [CellarV2_2.LiftShutdown](#steward-v4-CellarV2_2-LiftShutdown) - [CellarV2_2.Multicall](#steward-v4-CellarV2_2-Multicall) + - [CellarV2_2.RemoveAdaptorFromCatalogue](#steward-v4-CellarV2_2-RemoveAdaptorFromCatalogue) - [CellarV2_2.RemovePosition](#steward-v4-CellarV2_2-RemovePosition) + - [CellarV2_2.RemovePositionFromCatalogue](#steward-v4-CellarV2_2-RemovePositionFromCatalogue) - [CellarV2_2.SetHoldingPosition](#steward-v4-CellarV2_2-SetHoldingPosition) - [CellarV2_2.SetRebalanceDeviation](#steward-v4-CellarV2_2-SetRebalanceDeviation) - [CellarV2_2.SetShareLockPeriod](#steward-v4-CellarV2_2-SetShareLockPeriod) @@ -135,13 +175,79 @@ - [CellarV2_2.SwapPositions](#steward-v4-CellarV2_2-SwapPositions) - [CellarV2_2Governance](#steward-v4-CellarV2_2Governance) - [CellarV2_2Governance.AddAdaptorToCatalogue](#steward-v4-CellarV2_2Governance-AddAdaptorToCatalogue) + - [CellarV2_2Governance.AddPosition](#steward-v4-CellarV2_2Governance-AddPosition) - [CellarV2_2Governance.AddPositionToCatalogue](#steward-v4-CellarV2_2Governance-AddPositionToCatalogue) + - [CellarV2_2Governance.CachePriceRouter](#steward-v4-CellarV2_2Governance-CachePriceRouter) + - [CellarV2_2Governance.CallOnAdaptor](#steward-v4-CellarV2_2Governance-CallOnAdaptor) - [CellarV2_2Governance.ForcePositionOut](#steward-v4-CellarV2_2Governance-ForcePositionOut) + - [CellarV2_2Governance.FunctionCall](#steward-v4-CellarV2_2Governance-FunctionCall) + - [CellarV2_2Governance.InitiateShutdown](#steward-v4-CellarV2_2Governance-InitiateShutdown) + - [CellarV2_2Governance.LiftShutdown](#steward-v4-CellarV2_2Governance-LiftShutdown) + - [CellarV2_2Governance.Multicall](#steward-v4-CellarV2_2Governance-Multicall) - [CellarV2_2Governance.RemoveAdaptorFromCatalogue](#steward-v4-CellarV2_2Governance-RemoveAdaptorFromCatalogue) + - [CellarV2_2Governance.RemovePosition](#steward-v4-CellarV2_2Governance-RemovePosition) - [CellarV2_2Governance.RemovePositionFromCatalogue](#steward-v4-CellarV2_2Governance-RemovePositionFromCatalogue) + - [CellarV2_2Governance.SetHoldingPosition](#steward-v4-CellarV2_2Governance-SetHoldingPosition) + - [CellarV2_2Governance.SetRebalanceDeviation](#steward-v4-CellarV2_2Governance-SetRebalanceDeviation) + - [CellarV2_2Governance.SetShareLockPeriod](#steward-v4-CellarV2_2Governance-SetShareLockPeriod) + - [CellarV2_2Governance.SetStrategistPlatformCut](#steward-v4-CellarV2_2Governance-SetStrategistPlatformCut) + - [CellarV2_2Governance.SwapPositions](#steward-v4-CellarV2_2Governance-SwapPositions) - [CellarV2_2Governance.ToggleIgnorePause](#steward-v4-CellarV2_2Governance-ToggleIgnorePause) + - [CellarV2_5](#steward-v4-CellarV2_5) + - [CellarV2_5.AddAdaptorToCatalogue](#steward-v4-CellarV2_5-AddAdaptorToCatalogue) + - [CellarV2_5.AddPosition](#steward-v4-CellarV2_5-AddPosition) + - [CellarV2_5.AddPositionToCatalogue](#steward-v4-CellarV2_5-AddPositionToCatalogue) + - [CellarV2_5.CachePriceRouter](#steward-v4-CellarV2_5-CachePriceRouter) + - [CellarV2_5.CallOnAdaptor](#steward-v4-CellarV2_5-CallOnAdaptor) + - [CellarV2_5.DecreaseShareSupplyCap](#steward-v4-CellarV2_5-DecreaseShareSupplyCap) + - [CellarV2_5.DropAlternativeAssetData](#steward-v4-CellarV2_5-DropAlternativeAssetData) + - [CellarV2_5.FunctionCall](#steward-v4-CellarV2_5-FunctionCall) + - [CellarV2_5.IncreaseShareSupplyCap](#steward-v4-CellarV2_5-IncreaseShareSupplyCap) + - [CellarV2_5.InitiateShutdown](#steward-v4-CellarV2_5-InitiateShutdown) + - [CellarV2_5.LiftShutdown](#steward-v4-CellarV2_5-LiftShutdown) + - [CellarV2_5.Multicall](#steward-v4-CellarV2_5-Multicall) + - [CellarV2_5.RemoveAdaptorFromCatalogue](#steward-v4-CellarV2_5-RemoveAdaptorFromCatalogue) + - [CellarV2_5.RemovePosition](#steward-v4-CellarV2_5-RemovePosition) + - [CellarV2_5.RemovePositionFromCatalogue](#steward-v4-CellarV2_5-RemovePositionFromCatalogue) + - [CellarV2_5.SetAlternativeAssetData](#steward-v4-CellarV2_5-SetAlternativeAssetData) + - [CellarV2_5.SetHoldingPosition](#steward-v4-CellarV2_5-SetHoldingPosition) + - [CellarV2_5.SetRebalanceDeviation](#steward-v4-CellarV2_5-SetRebalanceDeviation) + - [CellarV2_5.SetShareLockPeriod](#steward-v4-CellarV2_5-SetShareLockPeriod) + - [CellarV2_5.SetSharePriceOracle](#steward-v4-CellarV2_5-SetSharePriceOracle) + - [CellarV2_5.SetStrategistPayoutAddress](#steward-v4-CellarV2_5-SetStrategistPayoutAddress) + - [CellarV2_5.SetStrategistPlatformCut](#steward-v4-CellarV2_5-SetStrategistPlatformCut) + - [CellarV2_5.SwapPositions](#steward-v4-CellarV2_5-SwapPositions) + - [CellarV2_5Governance](#steward-v4-CellarV2_5Governance) + - [CellarV2_5Governance.AddAdaptorToCatalogue](#steward-v4-CellarV2_5Governance-AddAdaptorToCatalogue) + - [CellarV2_5Governance.AddPosition](#steward-v4-CellarV2_5Governance-AddPosition) + - [CellarV2_5Governance.AddPositionToCatalogue](#steward-v4-CellarV2_5Governance-AddPositionToCatalogue) + - [CellarV2_5Governance.CachePriceRouter](#steward-v4-CellarV2_5Governance-CachePriceRouter) + - [CellarV2_5Governance.CallOnAdaptor](#steward-v4-CellarV2_5Governance-CallOnAdaptor) + - [CellarV2_5Governance.DecreaseShareSupplyCap](#steward-v4-CellarV2_5Governance-DecreaseShareSupplyCap) + - [CellarV2_5Governance.ForcePositionOut](#steward-v4-CellarV2_5Governance-ForcePositionOut) + - [CellarV2_5Governance.FunctionCall](#steward-v4-CellarV2_5Governance-FunctionCall) + - [CellarV2_5Governance.IncreaseShareSupplyCap](#steward-v4-CellarV2_5Governance-IncreaseShareSupplyCap) + - [CellarV2_5Governance.InitiateShutdown](#steward-v4-CellarV2_5Governance-InitiateShutdown) + - [CellarV2_5Governance.LiftShutdown](#steward-v4-CellarV2_5Governance-LiftShutdown) + - [CellarV2_5Governance.Multicall](#steward-v4-CellarV2_5Governance-Multicall) + - [CellarV2_5Governance.RemoveAdaptorFromCatalogue](#steward-v4-CellarV2_5Governance-RemoveAdaptorFromCatalogue) + - [CellarV2_5Governance.RemovePosition](#steward-v4-CellarV2_5Governance-RemovePosition) + - [CellarV2_5Governance.RemovePositionFromCatalogue](#steward-v4-CellarV2_5Governance-RemovePositionFromCatalogue) + - [CellarV2_5Governance.SetAutomationActions](#steward-v4-CellarV2_5Governance-SetAutomationActions) + - [CellarV2_5Governance.SetHoldingPosition](#steward-v4-CellarV2_5Governance-SetHoldingPosition) + - [CellarV2_5Governance.SetRebalanceDeviation](#steward-v4-CellarV2_5Governance-SetRebalanceDeviation) + - [CellarV2_5Governance.SetSharePriceOracle](#steward-v4-CellarV2_5Governance-SetSharePriceOracle) + - [CellarV2_5Governance.SetStrategistPlatformCut](#steward-v4-CellarV2_5Governance-SetStrategistPlatformCut) + - [CellarV2_5Governance.ToggleIgnorePause](#steward-v4-CellarV2_5Governance-ToggleIgnorePause) + +- [collateral_f_token.proto](#collateral_f_token-proto) + - [CollateralFTokenAdaptorV1](#steward-v4-CollateralFTokenAdaptorV1) + - [CollateralFTokenAdaptorV1.AddCollateral](#steward-v4-CollateralFTokenAdaptorV1-AddCollateral) + - [CollateralFTokenAdaptorV1.RemoveCollateral](#steward-v4-CollateralFTokenAdaptorV1-RemoveCollateral) + - [CollateralFTokenAdaptorV1Calls](#steward-v4-CollateralFTokenAdaptorV1Calls) - [common.proto](#common-proto) + - [MarketParams](#steward-v4-MarketParams) - [OracleSwapParams](#steward-v4-OracleSwapParams) - [SwapParams](#steward-v4-SwapParams) - [UniV2OracleSwapParams](#steward-v4-UniV2OracleSwapParams) @@ -151,6 +257,31 @@ - [Exchange](#steward-v4-Exchange) +- [convex_curve.proto](#convex_curve-proto) + - [ConvexCurveAdaptorV1](#steward-v4-ConvexCurveAdaptorV1) + - [ConvexCurveAdaptorV1.DepositLPTInConvexAndStake](#steward-v4-ConvexCurveAdaptorV1-DepositLPTInConvexAndStake) + - [ConvexCurveAdaptorV1.GetRewards](#steward-v4-ConvexCurveAdaptorV1-GetRewards) + - [ConvexCurveAdaptorV1.WithdrawFromBaseRewardPoolAsLPT](#steward-v4-ConvexCurveAdaptorV1-WithdrawFromBaseRewardPoolAsLPT) + - [ConvexCurveAdaptorV1Calls](#steward-v4-ConvexCurveAdaptorV1Calls) + +- [curve.proto](#curve-proto) + - [CurveAdaptorV1](#steward-v4-CurveAdaptorV1) + - [CurveAdaptorV1.AddLiquidity](#steward-v4-CurveAdaptorV1-AddLiquidity) + - [CurveAdaptorV1.AddLiquidityETH](#steward-v4-CurveAdaptorV1-AddLiquidityETH) + - [CurveAdaptorV1.ClaimRewards](#steward-v4-CurveAdaptorV1-ClaimRewards) + - [CurveAdaptorV1.RemoveLiquidity](#steward-v4-CurveAdaptorV1-RemoveLiquidity) + - [CurveAdaptorV1.RemoveLiquidityETH](#steward-v4-CurveAdaptorV1-RemoveLiquidityETH) + - [CurveAdaptorV1.StakeInGauge](#steward-v4-CurveAdaptorV1-StakeInGauge) + - [CurveAdaptorV1.UnstakeFromGauge](#steward-v4-CurveAdaptorV1-UnstakeFromGauge) + - [CurveAdaptorV1Calls](#steward-v4-CurveAdaptorV1Calls) + +- [debt_f_token.proto](#debt_f_token-proto) + - [DebtFTokenAdaptorV1](#steward-v4-DebtFTokenAdaptorV1) + - [DebtFTokenAdaptorV1.BorrowFromFraxlend](#steward-v4-DebtFTokenAdaptorV1-BorrowFromFraxlend) + - [DebtFTokenAdaptorV1.CallAddInterest](#steward-v4-DebtFTokenAdaptorV1-CallAddInterest) + - [DebtFTokenAdaptorV1.RepayFraxlendDebt](#steward-v4-DebtFTokenAdaptorV1-RepayFraxlendDebt) + - [DebtFTokenAdaptorV1Calls](#steward-v4-DebtFTokenAdaptorV1Calls) + - [debt_token.proto](#debt_token-proto) - [AaveDebtTokenAdaptorV1](#steward-v4-AaveDebtTokenAdaptorV1) - [AaveDebtTokenAdaptorV1.BorrowFromAave](#steward-v4-AaveDebtTokenAdaptorV1-BorrowFromAave) @@ -162,6 +293,12 @@ - [AaveDebtTokenAdaptorV2.RepayAaveDebt](#steward-v4-AaveDebtTokenAdaptorV2-RepayAaveDebt) - [AaveDebtTokenAdaptorV2Calls](#steward-v4-AaveDebtTokenAdaptorV2Calls) +- [erc4626.proto](#erc4626-proto) + - [ERC4626AdaptorV1](#steward-v4-ERC4626AdaptorV1) + - [ERC4626AdaptorV1.DepositToVault](#steward-v4-ERC4626AdaptorV1-DepositToVault) + - [ERC4626AdaptorV1.WithdrawFromVault](#steward-v4-ERC4626AdaptorV1-WithdrawFromVault) + - [ERC4626AdaptorV1Calls](#steward-v4-ERC4626AdaptorV1Calls) + - [f_token.proto](#f_token-proto) - [FTokenAdaptorV1](#steward-v4-FTokenAdaptorV1) - [FTokenAdaptorV1.CallAddInterest](#steward-v4-FTokenAdaptorV1-CallAddInterest) @@ -185,6 +322,12 @@ - [governance.proto](#governance-proto) - [GovernanceCall](#steward-v4-GovernanceCall) +- [legacy_cellar_adaptor.proto](#legacy_cellar_adaptor-proto) + - [LegacyCellarAdaptorV1](#steward-v4-LegacyCellarAdaptorV1) + - [LegacyCellarAdaptorV1.DepositToCellar](#steward-v4-LegacyCellarAdaptorV1-DepositToCellar) + - [LegacyCellarAdaptorV1.WithdrawFromCellar](#steward-v4-LegacyCellarAdaptorV1-WithdrawFromCellar) + - [LegacyCellarAdaptorV1Calls](#steward-v4-LegacyCellarAdaptorV1Calls) + - [morpho_aave_v2_a_token.proto](#morpho_aave_v2_a_token-proto) - [MorphoAaveV2ATokenAdaptorV1](#steward-v4-MorphoAaveV2ATokenAdaptorV1) - [MorphoAaveV2ATokenAdaptorV1.DepositToAaveV2Morpho](#steward-v4-MorphoAaveV2ATokenAdaptorV1-DepositToAaveV2Morpho) @@ -215,6 +358,24 @@ - [MorphoAaveV3DebtTokenAdaptorV1.RepayAaveV3MorphoDebt](#steward-v4-MorphoAaveV3DebtTokenAdaptorV1-RepayAaveV3MorphoDebt) - [MorphoAaveV3DebtTokenAdaptorV1Calls](#steward-v4-MorphoAaveV3DebtTokenAdaptorV1Calls) +- [morpho_blue_collateral.proto](#morpho_blue_collateral-proto) + - [MorphoBlueCollateralAdaptorV1](#steward-v4-MorphoBlueCollateralAdaptorV1) + - [MorphoBlueCollateralAdaptorV1.AddCollateral](#steward-v4-MorphoBlueCollateralAdaptorV1-AddCollateral) + - [MorphoBlueCollateralAdaptorV1.RemoveCollateral](#steward-v4-MorphoBlueCollateralAdaptorV1-RemoveCollateral) + - [MorphoBlueCollateralAdaptorV1Calls](#steward-v4-MorphoBlueCollateralAdaptorV1Calls) + +- [morpho_blue_debt.proto](#morpho_blue_debt-proto) + - [MorphoBlueDebtAdaptorV1](#steward-v4-MorphoBlueDebtAdaptorV1) + - [MorphoBlueDebtAdaptorV1.BorrowFromMorphoBlue](#steward-v4-MorphoBlueDebtAdaptorV1-BorrowFromMorphoBlue) + - [MorphoBlueDebtAdaptorV1.RepayMorphoBlueDebt](#steward-v4-MorphoBlueDebtAdaptorV1-RepayMorphoBlueDebt) + - [MorphoBlueDebtAdaptorV1Calls](#steward-v4-MorphoBlueDebtAdaptorV1Calls) + +- [morpho_blue_supply.proto](#morpho_blue_supply-proto) + - [MorphoBlueSupplyAdaptorV1](#steward-v4-MorphoBlueSupplyAdaptorV1) + - [MorphoBlueSupplyAdaptorV1.LendToMorphoBlue](#steward-v4-MorphoBlueSupplyAdaptorV1-LendToMorphoBlue) + - [MorphoBlueSupplyAdaptorV1.WithdrawFromMorphoBlue](#steward-v4-MorphoBlueSupplyAdaptorV1-WithdrawFromMorphoBlue) + - [MorphoBlueSupplyAdaptorV1Calls](#steward-v4-MorphoBlueSupplyAdaptorV1Calls) + - [morpho_reward_handler.proto](#morpho_reward_handler-proto) - [Claim](#steward-v4-Claim) @@ -223,6 +384,18 @@ - [OneInchAdaptorV1.SwapWithOneInch](#steward-v4-OneInchAdaptorV1-SwapWithOneInch) - [OneInchAdaptorV1Calls](#steward-v4-OneInchAdaptorV1Calls) +- [staking.proto](#staking-proto) + - [StakingAdaptorV1](#steward-v4-StakingAdaptorV1) + - [StakingAdaptorV1.CancelBurn](#steward-v4-StakingAdaptorV1-CancelBurn) + - [StakingAdaptorV1.CompleteBurn](#steward-v4-StakingAdaptorV1-CompleteBurn) + - [StakingAdaptorV1.Mint](#steward-v4-StakingAdaptorV1-Mint) + - [StakingAdaptorV1.MintERC20](#steward-v4-StakingAdaptorV1-MintERC20) + - [StakingAdaptorV1.RemoveClaimedRequest](#steward-v4-StakingAdaptorV1-RemoveClaimedRequest) + - [StakingAdaptorV1.RequestBurn](#steward-v4-StakingAdaptorV1-RequestBurn) + - [StakingAdaptorV1.Unwrap](#steward-v4-StakingAdaptorV1-Unwrap) + - [StakingAdaptorV1.Wrap](#steward-v4-StakingAdaptorV1-Wrap) + - [StakingAdaptorV1Calls](#steward-v4-StakingAdaptorV1Calls) + - [steward.proto](#steward-proto) - [ScheduleRequest](#steward-v4-ScheduleRequest) - [ScheduleResponse](#steward-v4-ScheduleResponse) @@ -965,43 +1138,6 @@ Represents call data for the Aave Debt Token adaptor, used for borrowing and rep | borrow_from_aave | [AaveV3DebtTokenAdaptorV1.BorrowFromAave](#steward-v4-AaveV3DebtTokenAdaptorV1-BorrowFromAave) | | Represents function `borrowFromAave(ERC20 debtTokenToBorrow, uint256 amountToBorrow)` | | repay_aave_debt | [AaveV3DebtTokenAdaptorV1.RepayAaveDebt](#steward-v4-AaveV3DebtTokenAdaptorV1-RepayAaveDebt) | | Represents function `repayAaveDebt(ERC20 tokenToRepay, uint256 amountToRepay)` | | repay_with_a_tokens | [AaveV3DebtTokenAdaptorV1.RepayWithATokens](#steward-v4-AaveV3DebtTokenAdaptorV1-RepayWithATokens) | | Represents function `repayWithATokens(ERC20 underlying, uint256 amount)` | -| flash_loan | [AaveV3DebtTokenAdaptorV1.FlashLoan](#steward-v4-AaveV3DebtTokenAdaptorV1-FlashLoan) | | Represents function `flashLoan(address[] loanToken, uint256[] loanAmount, bytes params)` | - - - - - - - - -### AaveV3DebtTokenAdaptorV1.AdaptorCallForAaveV3Flashloan -Represents a call to adaptor an. The cellar must be authorized to call the target adaptor. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| adaptor | [string](#string) | | Address of the adaptor | -| aave_a_token_v1_calls | [AaveATokenAdaptorV1Calls](#steward-v4-AaveATokenAdaptorV1Calls) | | Represents function calls to the AaveATokenAdaptor V1 | -| aave_debt_token_v1_calls | [AaveDebtTokenAdaptorV1Calls](#steward-v4-AaveDebtTokenAdaptorV1Calls) | | Represents function calls to the AavaDebtTokenAdaptor V1 | -| compound_c_token_v2_calls | [CompoundCTokenAdaptorV2Calls](#steward-v4-CompoundCTokenAdaptorV2Calls) | | Represents function calls to the CompoundCTokenAdaptor V2 | -| aave_a_token_v2_calls | [AaveATokenAdaptorV2Calls](#steward-v4-AaveATokenAdaptorV2Calls) | | Represents function calls to the AaveATokenV2Adaptor | -| aave_debt_token_v2_calls | [AaveDebtTokenAdaptorV2Calls](#steward-v4-AaveDebtTokenAdaptorV2Calls) | | Represents function calls to the AavaDebtTokenV2Adaptor | -| aave_v3_a_token_v1_calls | [AaveV3ATokenAdaptorV1Calls](#steward-v4-AaveV3ATokenAdaptorV1Calls) | | Represents function calls to the AaveATokenV1Adaptor | -| aave_v3_debt_token_v1_calls | [AaveV3DebtTokenAdaptorV1Calls](#steward-v4-AaveV3DebtTokenAdaptorV1Calls) | | Represents function calls to the AavaDebtTokenV1Adaptor | -| one_inch_v1_calls | [OneInchAdaptorV1Calls](#steward-v4-OneInchAdaptorV1Calls) | | Represents function calls to the OneInchAdaptorV1 | -| fees_and_reserves_v1_calls | [FeesAndReservesAdaptorV1Calls](#steward-v4-FeesAndReservesAdaptorV1Calls) | | Represents function calls to the FeesAndReservesAdaptorV1 | -| zero_x_v1_calls | [ZeroXAdaptorV1Calls](#steward-v4-ZeroXAdaptorV1Calls) | | Represents functionc alls to the ZeroXAdaptorV1 | -| swap_with_uniswap_v1_calls | [SwapWithUniswapAdaptorV1Calls](#steward-v4-SwapWithUniswapAdaptorV1Calls) | | Represents function calls to the SwapWithUniswapAdaptorV1 | -| vesting_simple_v2_calls | [VestingSimpleAdaptorV2Calls](#steward-v4-VestingSimpleAdaptorV2Calls) | | Represents function calls to VestingSimpleAdaptor | -| cellar_v1_calls | [CellarAdaptorV1Calls](#steward-v4-CellarAdaptorV1Calls) | | Represents function calls to the CellarAdaptor | -| uniswap_v3_v2_calls | [UniswapV3AdaptorV2Calls](#steward-v4-UniswapV3AdaptorV2Calls) | | Represents function calls to the UniswapV3Adaptor V2 | -| aave_v2_enable_asset_as_collateral_v1_calls | [AaveV2EnableAssetAsCollateralAdaptorV1Calls](#steward-v4-AaveV2EnableAssetAsCollateralAdaptorV1Calls) | | Represents function calls to the AaveV2EnableAssetAsCollatorAdaptor V1 | -| f_token_v1_calls | [FTokenAdaptorV1Calls](#steward-v4-FTokenAdaptorV1Calls) | | Represents function calls to the FTokenAdaptor V1 | -| morpho_aave_v2_a_token_v1_calls | [MorphoAaveV2ATokenAdaptorV1Calls](#steward-v4-MorphoAaveV2ATokenAdaptorV1Calls) | | Represents function calls to the MorphoAaveV2AToken V1 | -| morpho_aave_v2_debt_token_v1_calls | [MorphoAaveV2DebtTokenAdaptorV1Calls](#steward-v4-MorphoAaveV2DebtTokenAdaptorV1Calls) | | Represents function calls to the MorphoAaveV2DebtToken V1 | -| morpho_aave_v3_a_token_collateral_v1_calls | [MorphoAaveV3ATokenCollateralAdaptorV1Calls](#steward-v4-MorphoAaveV3ATokenCollateralAdaptorV1Calls) | | Represents function calls to the MorphoAaveV3ATokenCollateral V1 | -| morpho_aave_v3_a_token_p2p_v1_calls | [MorphoAaveV3ATokenP2PAdaptorV1Calls](#steward-v4-MorphoAaveV3ATokenP2PAdaptorV1Calls) | | Represents function calls to the MorphoAaveV3ATokenP2P V1 | -| morpho_aave_v3_debt_token_v1_calls | [MorphoAaveV3DebtTokenAdaptorV1Calls](#steward-v4-MorphoAaveV3DebtTokenAdaptorV1Calls) | | Represents function calls to the MorphoAaveV3DebtToken V1 | @@ -1026,25 +1162,6 @@ Represents function `depositToAave(ERC20 tokenToDeposit, uint256 amountToDeposit - - -### AaveV3DebtTokenAdaptorV1.FlashLoan -Allows strategists to have Cellars take out flash loans - -Represents function `flashLoan(address[] loanToken, uint256[] loanAmount, bytes params)` - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| loan_tokens | [string](#string) | repeated | The addresses of the ERC20 tokens to borrow | -| loan_amounts | [string](#string) | repeated | The amounts to borrow | -| params | [AaveV3DebtTokenAdaptorV1.AdaptorCallForAaveV3Flashloan](#steward-v4-AaveV3DebtTokenAdaptorV1-AdaptorCallForAaveV3Flashloan) | repeated | The params to pass to the flash loan callback. | - - - - - - ### AaveV3DebtTokenAdaptorV1.RepayAaveDebt @@ -1105,165 +1222,168 @@ Represents function `repayWithATokens(ERC20 underlying, uint256 amount)` - +

Top

-## base.proto - +## aave_v3_debt_token_flash_loan.proto - -### OracleSwap -Helper function to make safe "blind" Uniswap Swaps by comparing value in vs value out of the swap. + -Represents function `oracleSwap(ERC20 assetIn, ERC20 assetOut, uint256 amountIn, SwapRouter.Exchange exchange, bytes memory params, uint64 slippage)` +### AaveV3DebtTokenAdaptorV1FlashLoan +Represents call data for the Aave Debt Token adaptor, used for borrowing and repaying debt on Aave. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| asset_in | [string](#string) | | Asset to swap from | -| asset_out | [string](#string) | | Asset to swap to | -| amount_in | [string](#string) | | Amount to swap | -| exchange | [Exchange](#steward-v4-Exchange) | | The exchange to make the swap on | -| params | [OracleSwapParams](#steward-v4-OracleSwapParams) | | The parameters for the swap | -| slippage | [uint64](#uint64) | | The slippage allowed for the swap | - +| flash_loan | [AaveV3DebtTokenAdaptorV1FlashLoan.FlashLoan](#steward-v4-AaveV3DebtTokenAdaptorV1FlashLoan-FlashLoan) | | Represents function `flashLoan(address[] loanToken, uint256[] loanAmount, bytes params)` | - -### RevokeApproval -Allows strategists to zero out an approval for a given `asset`. + -Represents function `revokeApproval(ERC20 asset, address spender)` +### AaveV3DebtTokenAdaptorV1FlashLoan.AdaptorCallForAaveV3FlashLoan +Represents a call to adaptor an. The cellar must be authorized to call the target adaptor. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| asset | [string](#string) | | ERC20 Asset to revoke spender's approval for | -| spender | [string](#string) | | The spender to revoke approval of asset for | +| adaptor | [string](#string) | | Address of the adaptor | +| aave_a_token_v1_calls | [AaveATokenAdaptorV1Calls](#steward-v4-AaveATokenAdaptorV1Calls) | | Represents function calls to the AaveATokenAdaptor V1 | +| aave_debt_token_v1_calls | [AaveDebtTokenAdaptorV1Calls](#steward-v4-AaveDebtTokenAdaptorV1Calls) | | Represents function calls to the AavaDebtTokenAdaptor V1 | +| compound_c_token_v2_calls | [CompoundCTokenAdaptorV2Calls](#steward-v4-CompoundCTokenAdaptorV2Calls) | | Represents function calls to the CompoundCTokenAdaptor V2 | +| aave_a_token_v2_calls | [AaveATokenAdaptorV2Calls](#steward-v4-AaveATokenAdaptorV2Calls) | | Represents function calls to the AaveATokenV2Adaptor | +| aave_debt_token_v2_calls | [AaveDebtTokenAdaptorV2Calls](#steward-v4-AaveDebtTokenAdaptorV2Calls) | | Represents function calls to the AavaDebtTokenV2Adaptor | +| aave_v3_a_token_v1_calls | [AaveV3ATokenAdaptorV1Calls](#steward-v4-AaveV3ATokenAdaptorV1Calls) | | Represents function calls to the AaveATokenV1Adaptor | +| one_inch_v1_calls | [OneInchAdaptorV1Calls](#steward-v4-OneInchAdaptorV1Calls) | | Represents function calls to the OneInchAdaptorV1 | +| fees_and_reserves_v1_calls | [FeesAndReservesAdaptorV1Calls](#steward-v4-FeesAndReservesAdaptorV1Calls) | | Represents function calls to the FeesAndReservesAdaptorV1 | +| zero_x_v1_calls | [ZeroXAdaptorV1Calls](#steward-v4-ZeroXAdaptorV1Calls) | | Represents functionc alls to the ZeroXAdaptorV1 | +| swap_with_uniswap_v1_calls | [SwapWithUniswapAdaptorV1Calls](#steward-v4-SwapWithUniswapAdaptorV1Calls) | | Represents function calls to the SwapWithUniswapAdaptorV1 | +| vesting_simple_v2_calls | [VestingSimpleAdaptorV2Calls](#steward-v4-VestingSimpleAdaptorV2Calls) | | Represents function calls to VestingSimpleAdaptor | +| cellar_v1_calls | [CellarAdaptorV1Calls](#steward-v4-CellarAdaptorV1Calls) | | Represents function calls to the CellarAdaptor | +| uniswap_v3_v2_calls | [UniswapV3AdaptorV2Calls](#steward-v4-UniswapV3AdaptorV2Calls) | | Represents function calls to the UniswapV3Adaptor V2 | +| aave_v2_enable_asset_as_collateral_v1_calls | [AaveV2EnableAssetAsCollateralAdaptorV1Calls](#steward-v4-AaveV2EnableAssetAsCollateralAdaptorV1Calls) | | Represents function calls to the AaveV2EnableAssetAsCollatorAdaptor V1 | +| f_token_v1_calls | [FTokenAdaptorV1Calls](#steward-v4-FTokenAdaptorV1Calls) | | Represents function calls to the FTokenAdaptor V1 | +| morpho_aave_v2_a_token_v1_calls | [MorphoAaveV2ATokenAdaptorV1Calls](#steward-v4-MorphoAaveV2ATokenAdaptorV1Calls) | | Represents function calls to the MorphoAaveV2AToken V1 | +| morpho_aave_v2_debt_token_v1_calls | [MorphoAaveV2DebtTokenAdaptorV1Calls](#steward-v4-MorphoAaveV2DebtTokenAdaptorV1Calls) | | Represents function calls to the MorphoAaveV2DebtToken V1 | +| morpho_aave_v3_a_token_collateral_v1_calls | [MorphoAaveV3ATokenCollateralAdaptorV1Calls](#steward-v4-MorphoAaveV3ATokenCollateralAdaptorV1Calls) | | Represents function calls to the MorphoAaveV3ATokenCollateral V1 | +| morpho_aave_v3_a_token_p2p_v1_calls | [MorphoAaveV3ATokenP2PAdaptorV1Calls](#steward-v4-MorphoAaveV3ATokenP2PAdaptorV1Calls) | | Represents function calls to the MorphoAaveV3ATokenP2P V1 | +| morpho_aave_v3_debt_token_v1_calls | [MorphoAaveV3DebtTokenAdaptorV1Calls](#steward-v4-MorphoAaveV3DebtTokenAdaptorV1Calls) | | Represents function calls to the MorphoAaveV3DebtToken V1 | +| balancer_pool_v1_calls | [BalancerPoolAdaptorV1Calls](#steward-v4-BalancerPoolAdaptorV1Calls) | | Represents function calls to the BalancerPoolAdaptor V1 | +| legacy_cellar_v1_calls | [LegacyCellarAdaptorV1Calls](#steward-v4-LegacyCellarAdaptorV1Calls) | | Represents function calls to the LegacyCellarAdaptor V1 | +| debt_f_token_v1_calls | [DebtFTokenAdaptorV1Calls](#steward-v4-DebtFTokenAdaptorV1Calls) | | Represents function calls to the DebtFTokenAdaptor V1 | +| collateral_f_token_v1_calls | [CollateralFTokenAdaptorV1Calls](#steward-v4-CollateralFTokenAdaptorV1Calls) | | Represents function calls to the CollateralFTokenAdaptor V1 | +| convex_curve_v1_calls | [ConvexCurveAdaptorV1Calls](#steward-v4-ConvexCurveAdaptorV1Calls) | | Represents function calls for the ConvexCurveAdaptorV1 | +| curve_v1_calls | [CurveAdaptorV1Calls](#steward-v4-CurveAdaptorV1Calls) | | Represents function calls for the CurveAdaptorV1 | +| aura_erc4626_v1_calls | [AuraERC4626AdaptorV1Calls](#steward-v4-AuraERC4626AdaptorV1Calls) | | Represents function calls for the AuraERC4626AdaptorV1 | +| morpho_blue_collateral_v1_calls | [MorphoBlueCollateralAdaptorV1Calls](#steward-v4-MorphoBlueCollateralAdaptorV1Calls) | | Represents function calls for the MorphoBlueCollateralAdaptorV1 | +| morpho_blue_debt_v1_calls | [MorphoBlueDebtAdaptorV1Calls](#steward-v4-MorphoBlueDebtAdaptorV1Calls) | | Represents function calls for the MorphoBlueDebtAdaptorV1 | +| morpho_blue_supply_v1_calls | [MorphoBlueSupplyAdaptorV1Calls](#steward-v4-MorphoBlueSupplyAdaptorV1Calls) | | Represents function calls for the MorphoBlueSupplyAdaptorV1 | +| erc4626_v1_calls | [ERC4626AdaptorV1Calls](#steward-v4-ERC4626AdaptorV1Calls) | | Represents function calls for the ERC4626AdaptorV1 | +| staking_v1_calls | [StakingAdaptorV1Calls](#steward-v4-StakingAdaptorV1Calls) | | Represents function calls for the StakingAdaptorV1 | - + -### Swap -Helper function that allows swaps using the Swap Router +### AaveV3DebtTokenAdaptorV1FlashLoan.FlashLoan +Allows strategists to have Cellars take out flash loans -Represents function `swap(ERC20 assetIn, ERC20 assetOut, uint256 amountIn, SwapRouter.Exchange exchange, bytes memory params)` +Represents function `flashLoan(address[] loanToken, uint256[] loanAmount, bytes params)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| asset_in | [string](#string) | | Asset to swap from | -| asset_out | [string](#string) | | Asset to swap to | -| amount_in | [string](#string) | | Amount to swap | -| exchange | [Exchange](#steward-v4-Exchange) | | The exchange to make the swap on | -| params | [SwapParams](#steward-v4-SwapParams) | | The parameters for the swap | - - - - - - - - - - - - +| loan_tokens | [string](#string) | repeated | The addresses of the ERC20 tokens to borrow | +| loan_amounts | [string](#string) | repeated | The amounts to borrow | +| params | [AaveV3DebtTokenAdaptorV1FlashLoan.AdaptorCallForAaveV3FlashLoan](#steward-v4-AaveV3DebtTokenAdaptorV1FlashLoan-AdaptorCallForAaveV3FlashLoan) | repeated | The params to pass to the flash loan callback. | - -

Top

-## c_token.proto + - +### AaveV3DebtTokenAdaptorV1FlashLoanCalls -### CompoundCTokenAdaptorV2 -Represents call data for the Compound C Token adaptor V2, managing lending positions on Compound. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| revoke_approval | [RevokeApproval](#steward-v4-RevokeApproval) | | Represents function `revokeApproval(ERC20 asset, address spender)` | -| deposit_to_compound | [CompoundCTokenAdaptorV2.DepositToCompound](#steward-v4-CompoundCTokenAdaptorV2-DepositToCompound) | | Represents function `depositToCompound(CErc20 market, uint256 amountToDeposit)` | -| withdraw_from_compound | [CompoundCTokenAdaptorV2.WithdrawFromCompound](#steward-v4-CompoundCTokenAdaptorV2-WithdrawFromCompound) | | Represents function `withdrawFromCompound(CErc20 market, uint256 amountToWithdraw)` | -| claim_comp | [CompoundCTokenAdaptorV2.ClaimComp](#steward-v4-CompoundCTokenAdaptorV2-ClaimComp) | | Represents function `claimComp()` | +| calls | [AaveV3DebtTokenAdaptorV1FlashLoan](#steward-v4-AaveV3DebtTokenAdaptorV1FlashLoan) | repeated | | + - + -### CompoundCTokenAdaptorV2.ClaimComp -Allows strategists to claim COMP rewards. + -Represents function `claimComp()` + + +

Top

+## aura_erc4626.proto - -### CompoundCTokenAdaptorV2.DepositToCompound -Allows strategists to lend assets on Compound. + -Represents function `depositToCompound(CErc20 market, uint256 amountToDeposit)` +### AuraERC4626AdaptorV1 +Represents call data for the Aura ERC4626 adaptor V1 | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| market | [string](#string) | | | -| amount_to_deposit | [string](#string) | | | +| revoke_approval | [RevokeApproval](#steward-v4-RevokeApproval) | | Represents function `revokeApproval(ERC20 asset, address spender)` | +| get_rewards | [AuraERC4626AdaptorV1.GetRewards](#steward-v4-AuraERC4626AdaptorV1-GetRewards) | | Represents function `getRewards(IBaseRewardPool _auraPool, bool _claimExtras)` | - + -### CompoundCTokenAdaptorV2.WithdrawFromCompound -Allows strategists to withdraw assets from Compound. +### AuraERC4626AdaptorV1.GetRewards +Allows strategist to get rewards for an Aura pool. -Represents function `withdrawFromCompound(CErc20 market, uint256 amountToWithdraw)` +Represents function `getRewards(IBaseRewardPool _auraPool, bool _claimExtras)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| market | [string](#string) | | | -| amount_to_withdraw | [string](#string) | | | +| aura_pool | [string](#string) | | The address of the Aura pool to get rewards for | +| claim_extras | [bool](#bool) | | Whether to claim extra rewards associated with the pool | - + -### CompoundCTokenAdaptorV2Calls +### AuraERC4626AdaptorV1Calls | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| calls | [CompoundCTokenAdaptorV2](#steward-v4-CompoundCTokenAdaptorV2) | repeated | | +| calls | [AuraERC4626AdaptorV1](#steward-v4-AuraERC4626AdaptorV1) | repeated | | @@ -1279,1270 +1399,4144 @@ Represents function `withdrawFromCompound(CErc20 market, uint256 amountToWithdra - +

Top

-## cellar_adaptor.proto - +## balancer_pool.proto - -### CellarAdaptorV1 + +### BalancerPoolAdaptorV1 +Represents call data for the Balancer Pool adaptor V1, for managing pool positions on Balancer. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | revoke_approval | [RevokeApproval](#steward-v4-RevokeApproval) | | Represents function `revokeApproval(ERC20 asset, address spender)` | -| depositToCellar | [CellarAdaptorV1.DepositToCellar](#steward-v4-CellarAdaptorV1-DepositToCellar) | | Represents function `depositToCellar(Cellar cellar, uint256 assets)` | -| withdrawFromCellar | [CellarAdaptorV1.WithdrawFromCellar](#steward-v4-CellarAdaptorV1-WithdrawFromCellar) | | Represents function `withdrawFromCellar(Cellar cellar, uint256 assets)` | +| join_pool | [BalancerPoolAdaptorV1.JoinPool](#steward-v4-BalancerPoolAdaptorV1-JoinPool) | | Represents function `relayerJoinPool(ERC20[] tokensIn, uint256[] amountsIn, ERC20 btpOut, bytes[] memory callData)` | +| exit_pool | [BalancerPoolAdaptorV1.ExitPool](#steward-v4-BalancerPoolAdaptorV1-ExitPool) | | Represents function `relayerExitPool(ERC20 bptIn, uint256 amountIn, ERC20[] memory tokensOut, bytes[] memory callData)` | +| stake_bpt | [BalancerPoolAdaptorV1.StakeBPT](#steward-v4-BalancerPoolAdaptorV1-StakeBPT) | | Represents function `stakeBPT(ERC20 _bpt, address _liquidityGauge, uint256 _amountIn)` | +| unstake_bpt | [BalancerPoolAdaptorV1.UnstakeBPT](#steward-v4-BalancerPoolAdaptorV1-UnstakeBPT) | | Represents function `unstakeBPT(ERC20 _bpt, address _liquidityGauge, uint256 _amountOut)` | +| claim_rewards | [BalancerPoolAdaptorV1.ClaimRewards](#steward-v4-BalancerPoolAdaptorV1-ClaimRewards) | | Represents function `claimRewards(address gauge)` | - + -### CellarAdaptorV1.DepositToCellar -Allows strategists to deposit into Cellar positions. +### BalancerPoolAdaptorV1.ClaimRewards +Claim rewards ($BAL) from LP position -Represents function `depositToCellar(Cellar cellar, uint256 assets)` +Represents `function claimRewards(address gauge)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| cellar | [string](#string) | | | -| assets | [string](#string) | | | +| gauge | [string](#string) | | The gauge to claim rewards from | - + -### CellarAdaptorV1.WithdrawFromCellar -Allows strategists to withdraw from Cellar positions. +### BalancerPoolAdaptorV1.ExitPool +Call `BalancerRelayer` on mainnet to carry out exit txs -Represents function `withdrawFromCellar(Cellar cellar, uint256 assets)` +Represents function `exitPool(ERC20 targetBpt, IVault.SingleSwap[] memory swapsBeforeJoin, SwapData memory swapData, IVault.ExitPoolRequest request)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| cellar | [string](#string) | | | -| assets | [string](#string) | | | +| target_bpt | [string](#string) | | The target pool | +| swaps_after_exit | [BalancerPoolAdaptorV1.SingleSwap](#steward-v4-BalancerPoolAdaptorV1-SingleSwap) | repeated | Swaps to execute after exiting pool | +| swap_data | [BalancerPoolAdaptorV1.SwapData](#steward-v4-BalancerPoolAdaptorV1-SwapData) | | Data for swaps | +| request | [BalancerPoolAdaptorV1.ExitPoolRequest](#steward-v4-BalancerPoolAdaptorV1-ExitPoolRequest) | | | - + -### CellarAdaptorV1Calls +### BalancerPoolAdaptorV1.ExitPoolRequest | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| calls | [CellarAdaptorV1](#steward-v4-CellarAdaptorV1) | repeated | | +| assets | [string](#string) | repeated | | +| min_amounts_out | [string](#string) | repeated | | +| user_data | [bytes](#bytes) | | | +| to_internal_balance | [bool](#bool) | | | - - + - +### BalancerPoolAdaptorV1.JoinPool +Allows strategists to join Balancer pools using EXACT_TOKENS_IN_FOR_BPT_OUT joins - +Represents function `joinPool(ERC20 targetBpt, IVault.SingleSwap[] memory swapsBeforeJoin, SwapData memory swapData, uint256 minimumBpt)` +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| target_bpt | [string](#string) | | The target pool | +| swaps_before_join | [BalancerPoolAdaptorV1.SingleSwap](#steward-v4-BalancerPoolAdaptorV1-SingleSwap) | repeated | Swap to execute before joining pool | +| swap_data | [BalancerPoolAdaptorV1.SwapData](#steward-v4-BalancerPoolAdaptorV1-SwapData) | | Data for swaps | +| minimum_bpt | [string](#string) | | The minimum BPT to mint | - -

Top

-## cellar_v1.proto - -### CellarV1 -Represents a function call to a cellar that implements Cellar.sol + + +### BalancerPoolAdaptorV1.SingleSwap +Data for a single swap executed by `swap`. `amount` is either `amountIn` or `amountOut` depending on the `kind` value. +Represents the SingleSwap struct defined here: +https://github.com/PeggyJV/cellar-contracts/blob/main/src/interfaces/external/Balancer/IVault.sol | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| add_position | [CellarV1.AddPosition](#steward-v4-CellarV1-AddPosition) | | Represents function `addPosition(uint256 index, address position)` | -| push_position | [CellarV1.PushPosition](#steward-v4-CellarV1-PushPosition) | | Represents function `pushPosition(address position)` | -| remove_position | [CellarV1.RemovePosition](#steward-v4-CellarV1-RemovePosition) | | Represents function `removePosition(uint256 index)` | -| set_holding_position | [CellarV1.SetHoldingPosition](#steward-v4-CellarV1-SetHoldingPosition) | | Represents function `setHoldingPosition(address newHoldingPosition)` | -| rebalance | [CellarV1.Rebalance](#steward-v4-CellarV1-Rebalance) | | Represents function `rebalance(address fromPosition, address toPosition, uint256 assetsFrom, SwapRouter.Exchange exchange, bytes calldata params)` | -| set_strategist_payout_address | [CellarV1.SetStrategistPayoutAddress](#steward-v4-CellarV1-SetStrategistPayoutAddress) | | Represents function `setStrategistPayoutAddress(address payout)` | -| set_withdraw_type | [CellarV1.SetWithdrawType](#steward-v4-CellarV1-SetWithdrawType) | | Represents function `setWithdrawType(WithdrawType newWithdrawType)` | -| swap_positions | [CellarV1.SwapPositions](#steward-v4-CellarV1-SwapPositions) | | Represents function `swapPositions(uint256 index1, uint256 index2)` | -| set_deposit_limit | [CellarV1.SetDepositLimit](#steward-v4-CellarV1-SetDepositLimit) | | Represents function `setDepositLimit()` | -| set_liquidity_limit | [CellarV1.SetLiquidityLimit](#steward-v4-CellarV1-SetLiquidityLimit) | | Represents function `setLiquidityLimit()` | -| set_share_lock_period | [CellarV1.SetShareLockPeriod](#steward-v4-CellarV1-SetShareLockPeriod) | | Represents function `setShareLockPeriod()` | -| set_rebalance_deviation | [CellarV1.SetRebalanceDeviation](#steward-v4-CellarV1-SetRebalanceDeviation) | | Represents function `setRebalanceDeviation(uint265)` | +| pool_id | [string](#string) | | The pool ID (bytes32) | +| kind | [BalancerPoolAdaptorV1.SwapKind](#steward-v4-BalancerPoolAdaptorV1-SwapKind) | | The swap kind (enum) | +| asset_in | [string](#string) | | The asset in (address) | +| asset_out | [string](#string) | | The asset out (address) | +| amount | [string](#string) | | The amount (uint256) | +| user_data | [bytes](#bytes) | | The user data (bytes) | - + -### CellarV1.AddPosition -Insert a trusted position to the list of positions used by the cellar at a given index. +### BalancerPoolAdaptorV1.StakeBPT +Stake (deposit) BPTs into respective pool gauge -Represents function `addPosition(uint256 index, address position)` +Represents `function stakeBPT(ERC20 _bpt, address _liquidityGauge, uint256 _amountIn)`` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| index | [string](#string) | | Index at which to add the position | -| position | [string](#string) | | Address of the position to add | +| bpt | [string](#string) | | The BPT to stake | +| liquidity_gauge | [string](#string) | | The liquidity gauge to stake into | +| amount_in | [string](#string) | | The amount to stake | - - -### CellarV1.PushPosition -Push a trusted position to the end of the list of positions used by the cellar. If you -know you are going to add a position to the end of the array, this is more efficient then -`addPosition`. + -Represents function `pushPosition(address position)` +### BalancerPoolAdaptorV1.SwapData +Stores each swaps min amount, and deadline | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| position | [string](#string) | | Address of the position to push | +| min_amounts_for_swaps | [string](#string) | repeated | The minimum amounts for swaps | +| swap_deadlines | [string](#string) | repeated | The swap deadlines | - + -### CellarV1.Rebalance -Move assets between positions. To move assets from/to this cellar's holdings, specify -the address of this cellar as the `fromPosition`/`toPosition`. +### BalancerPoolAdaptorV1.UnstakeBPT +Unstake (withdraw) BPT from respective pool gauge -Represents function `rebalance(address fromPosition, address toPosition, - uint256 assetsFrom, SwapRouter.Exchange exchange, bytes calldata params) +Represents `function unstakeBPT(ERC20 _bpt, address _liquidityGauge, uint256 _amountOut)`` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| from_position | [string](#string) | | | -| to_position | [string](#string) | | | -| assets_from | [string](#string) | | | -| exchange | [Exchange](#steward-v4-Exchange) | | | -| params | [SwapParams](#steward-v4-SwapParams) | | | +| bpt | [string](#string) | | The BPT to unstake | +| liquidity_gauge | [string](#string) | | The liquidity gauge to unstake from | +| amount_out | [string](#string) | | The amount to unstake | - + -### CellarV1.RemovePosition -Remove the position at a given index from the list of positions used by the cellar. +### BalancerPoolAdaptorV1Calls -Represents function `removePosition(uint256 index)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| index | [string](#string) | | Index at which to remove the position | +| calls | [BalancerPoolAdaptorV1](#steward-v4-BalancerPoolAdaptorV1) | repeated | | + - -### CellarV1.SetDepositLimit -Set the per-wallet deposit limit. Uses the same decimals as the current asset. + -Represents function `setDepositLimit()` +### BalancerPoolAdaptorV1.SwapKind +Represents the SwapKind enum defined here: +https://github.com/PeggyJV/cellar-contracts/blob/main/src/interfaces/external/Balancer/IVault.sol +| Name | Number | Description | +| ---- | ------ | ----------- | +| SWAP_KIND_UNSPECIFIED | 0 | | +| SWAP_KIND_GIVEN_IN | 1 | | +| SWAP_KIND_GIVEN_OUT | 2 | | -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| new_limit | [string](#string) | | | + + + + + + + + + +

Top

+ +## balancer_pool_flash_loan.proto + + + + + +### BalancerPoolAdaptorV1FlashLoan +Represents flash loan call data for the Balancer Pool adaptor V1, for managing pool positions on Balancer. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| make_flash_loan | [BalancerPoolAdaptorV1FlashLoan.MakeFlashLoan](#steward-v4-BalancerPoolAdaptorV1FlashLoan-MakeFlashLoan) | | | + + + + + + + + +### BalancerPoolAdaptorV1FlashLoan.AdaptorCallForBalancerPoolFlashLoan +NOTE: Make FlashLoan takes an array of AdaptorCall. cellar_v2.proto defines it, but also imports this file, therefore we can't import cellar_v2.proto in order to use the AdaptorCall message here. To avoid the recursive import, we duplicate the message definition. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| adaptor | [string](#string) | | Address of the adaptor | +| aave_a_token_v1_calls | [AaveATokenAdaptorV1Calls](#steward-v4-AaveATokenAdaptorV1Calls) | | Represents function calls to the AaveATokenAdaptor V1 | +| aave_debt_token_v1_calls | [AaveDebtTokenAdaptorV1Calls](#steward-v4-AaveDebtTokenAdaptorV1Calls) | | Represents function calls to the AavaDebtTokenAdaptor V1 | +| compound_c_token_v2_calls | [CompoundCTokenAdaptorV2Calls](#steward-v4-CompoundCTokenAdaptorV2Calls) | | Represents function calls to the CompoundCTokenAdaptor V2 | +| aave_a_token_v2_calls | [AaveATokenAdaptorV2Calls](#steward-v4-AaveATokenAdaptorV2Calls) | | Represents function calls to the AaveATokenV2Adaptor | +| aave_debt_token_v2_calls | [AaveDebtTokenAdaptorV2Calls](#steward-v4-AaveDebtTokenAdaptorV2Calls) | | Represents function calls to the AavaDebtTokenV2Adaptor | +| aave_v3_a_token_v1_calls | [AaveV3ATokenAdaptorV1Calls](#steward-v4-AaveV3ATokenAdaptorV1Calls) | | Represents function calls to the AaveATokenV1Adaptor | +| aave_v3_debt_token_v1_calls | [AaveV3DebtTokenAdaptorV1Calls](#steward-v4-AaveV3DebtTokenAdaptorV1Calls) | | Represents function calls to the AavaDebtTokenV1Adaptor | +| one_inch_v1_calls | [OneInchAdaptorV1Calls](#steward-v4-OneInchAdaptorV1Calls) | | Represents function calls to the OneInchAdaptorV1 | +| fees_and_reserves_v1_calls | [FeesAndReservesAdaptorV1Calls](#steward-v4-FeesAndReservesAdaptorV1Calls) | | Represents function calls to the FeesAndReservesAdaptorV1 | +| zero_x_v1_calls | [ZeroXAdaptorV1Calls](#steward-v4-ZeroXAdaptorV1Calls) | | Represents functionc alls to the ZeroXAdaptorV1 | +| swap_with_uniswap_v1_calls | [SwapWithUniswapAdaptorV1Calls](#steward-v4-SwapWithUniswapAdaptorV1Calls) | | Represents function calls to the SwapWithUniswapAdaptorV1 | +| vesting_simple_v2_calls | [VestingSimpleAdaptorV2Calls](#steward-v4-VestingSimpleAdaptorV2Calls) | | Represents function calls to VestingSimpleAdaptor | +| cellar_v1_calls | [CellarAdaptorV1Calls](#steward-v4-CellarAdaptorV1Calls) | | Represents function calls to the CellarAdaptor | +| uniswap_v3_v2_calls | [UniswapV3AdaptorV2Calls](#steward-v4-UniswapV3AdaptorV2Calls) | | Represents function calls to the UniswapV3Adaptor V2 | +| aave_v2_enable_asset_as_collateral_v1_calls | [AaveV2EnableAssetAsCollateralAdaptorV1Calls](#steward-v4-AaveV2EnableAssetAsCollateralAdaptorV1Calls) | | Represents function calls to the AaveV2EnableAssetAsCollatorAdaptor V1 | +| f_token_v1_calls | [FTokenAdaptorV1Calls](#steward-v4-FTokenAdaptorV1Calls) | | Represents function calls to the FTokenAdaptor V1 | +| morpho_aave_v2_a_token_v1_calls | [MorphoAaveV2ATokenAdaptorV1Calls](#steward-v4-MorphoAaveV2ATokenAdaptorV1Calls) | | Represents function calls to the MorphoAaveV2AToken V1 | +| morpho_aave_v2_debt_token_v1_calls | [MorphoAaveV2DebtTokenAdaptorV1Calls](#steward-v4-MorphoAaveV2DebtTokenAdaptorV1Calls) | | Represents function calls to the MorphoAaveV2DebtToken V1 | +| morpho_aave_v3_a_token_collateral_v1_calls | [MorphoAaveV3ATokenCollateralAdaptorV1Calls](#steward-v4-MorphoAaveV3ATokenCollateralAdaptorV1Calls) | | Represents function calls to the MorphoAaveV3ATokenCollateral V1 | +| morpho_aave_v3_a_token_p2p_v1_calls | [MorphoAaveV3ATokenP2PAdaptorV1Calls](#steward-v4-MorphoAaveV3ATokenP2PAdaptorV1Calls) | | Represents function calls to the MorphoAaveV3ATokenP2P V1 | +| morpho_aave_v3_debt_token_v1_calls | [MorphoAaveV3DebtTokenAdaptorV1Calls](#steward-v4-MorphoAaveV3DebtTokenAdaptorV1Calls) | | Represents function calls to the MorphoAaveV3DebtToken V1 | +| legacy_cellar_v1_calls | [LegacyCellarAdaptorV1Calls](#steward-v4-LegacyCellarAdaptorV1Calls) | | Represents function calls to the LegacyCellarAdaptor V1 | +| debt_f_token_v1_calls | [DebtFTokenAdaptorV1Calls](#steward-v4-DebtFTokenAdaptorV1Calls) | | Represents function calls to the DebtFTokenAdaptor V1 | +| collateral_f_token_v1_calls | [CollateralFTokenAdaptorV1Calls](#steward-v4-CollateralFTokenAdaptorV1Calls) | | Represents function calls to the CollateralFTokenAdaptor V1 | +| convex_curve_v1_calls | [ConvexCurveAdaptorV1Calls](#steward-v4-ConvexCurveAdaptorV1Calls) | | Represents function calls for the ConvexCurveAdaptorV1 | +| curve_v1_calls | [CurveAdaptorV1Calls](#steward-v4-CurveAdaptorV1Calls) | | Represents function calls for the CurveAdaptorV1 | +| aura_erc4626_v1_calls | [AuraERC4626AdaptorV1Calls](#steward-v4-AuraERC4626AdaptorV1Calls) | | Represents function calls for the AuraERC4626AdaptorV1 | +| morpho_blue_collateral_v1_calls | [MorphoBlueCollateralAdaptorV1Calls](#steward-v4-MorphoBlueCollateralAdaptorV1Calls) | | Represents function calls for the MorphoBlueCollateralAdaptorV1 | +| morpho_blue_debt_v1_calls | [MorphoBlueDebtAdaptorV1Calls](#steward-v4-MorphoBlueDebtAdaptorV1Calls) | | Represents function calls for the MorphoBlueDebtAdaptorV1 | +| morpho_blue_supply_v1_calls | [MorphoBlueSupplyAdaptorV1Calls](#steward-v4-MorphoBlueSupplyAdaptorV1Calls) | | Represents function calls for the MorphoBlueSupplyAdaptorV1 | +| erc4626_v1_calls | [ERC4626AdaptorV1Calls](#steward-v4-ERC4626AdaptorV1Calls) | | Represents function calls for the ERC4626AdaptorV1 | +| staking_v1_calls | [StakingAdaptorV1Calls](#steward-v4-StakingAdaptorV1Calls) | | Represents function calls for the StakingAdaptorV1 | + + + + + + + + +### BalancerPoolAdaptorV1FlashLoan.MakeFlashLoan +Make a flash loan + +Represents `function makeFlashLoan(IERC20[] tokens, uint256[] amounts, bytes memory data)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| tokens | [string](#string) | repeated | The tokens to flash loan | +| amounts | [string](#string) | repeated | The amounts to flash loan | +| data | [BalancerPoolAdaptorV1FlashLoan.AdaptorCallForBalancerPoolFlashLoan](#steward-v4-BalancerPoolAdaptorV1FlashLoan-AdaptorCallForBalancerPoolFlashLoan) | repeated | The data to flash loan | + + + + + + + + +### BalancerPoolAdaptorV1FlashLoanCalls + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| calls | [BalancerPoolAdaptorV1FlashLoan](#steward-v4-BalancerPoolAdaptorV1FlashLoan) | repeated | | + + + + + + + + + + + + + + + + +

Top

+ +## base.proto + + + + + +### OracleSwap +Helper function to make safe "blind" Uniswap Swaps by comparing value in vs value out of the swap. + +Represents function `oracleSwap(ERC20 assetIn, ERC20 assetOut, uint256 amountIn, SwapRouter.Exchange exchange, bytes memory params, uint64 slippage)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| asset_in | [string](#string) | | Asset to swap from | +| asset_out | [string](#string) | | Asset to swap to | +| amount_in | [string](#string) | | Amount to swap | +| exchange | [Exchange](#steward-v4-Exchange) | | The exchange to make the swap on | +| params | [OracleSwapParams](#steward-v4-OracleSwapParams) | | The parameters for the swap | +| slippage | [uint64](#uint64) | | The slippage allowed for the swap | + + + + + + + + +### RevokeApproval +Allows strategists to zero out an approval for a given `asset`. + +Represents function `revokeApproval(ERC20 asset, address spender)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| asset | [string](#string) | | ERC20 Asset to revoke spender's approval for | +| spender | [string](#string) | | The spender to revoke approval of asset for | + + + + + + + + +### Swap +Helper function that allows swaps using the Swap Router + +Represents function `swap(ERC20 assetIn, ERC20 assetOut, uint256 amountIn, SwapRouter.Exchange exchange, bytes memory params)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| asset_in | [string](#string) | | Asset to swap from | +| asset_out | [string](#string) | | Asset to swap to | +| amount_in | [string](#string) | | Amount to swap | +| exchange | [Exchange](#steward-v4-Exchange) | | The exchange to make the swap on | +| params | [SwapParams](#steward-v4-SwapParams) | | The parameters for the swap | + + + + + + + + + + + + + + + + +

Top

+ +## c_token.proto + + + + + +### CompoundCTokenAdaptorV2 +Represents call data for the Compound C Token adaptor V2, managing lending positions on Compound. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| revoke_approval | [RevokeApproval](#steward-v4-RevokeApproval) | | Represents function `revokeApproval(ERC20 asset, address spender)` | +| deposit_to_compound | [CompoundCTokenAdaptorV2.DepositToCompound](#steward-v4-CompoundCTokenAdaptorV2-DepositToCompound) | | Represents function `depositToCompound(CErc20 market, uint256 amountToDeposit)` | +| withdraw_from_compound | [CompoundCTokenAdaptorV2.WithdrawFromCompound](#steward-v4-CompoundCTokenAdaptorV2-WithdrawFromCompound) | | Represents function `withdrawFromCompound(CErc20 market, uint256 amountToWithdraw)` | +| claim_comp | [CompoundCTokenAdaptorV2.ClaimComp](#steward-v4-CompoundCTokenAdaptorV2-ClaimComp) | | Represents function `claimComp()` | + + + + + + + + +### CompoundCTokenAdaptorV2.ClaimComp +Allows strategists to claim COMP rewards. + +Represents function `claimComp()` + + + + + + + + +### CompoundCTokenAdaptorV2.DepositToCompound +Allows strategists to lend assets on Compound. + +Represents function `depositToCompound(CErc20 market, uint256 amountToDeposit)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| market | [string](#string) | | | +| amount_to_deposit | [string](#string) | | | + + + + + + + + +### CompoundCTokenAdaptorV2.WithdrawFromCompound +Allows strategists to withdraw assets from Compound. + +Represents function `withdrawFromCompound(CErc20 market, uint256 amountToWithdraw)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| market | [string](#string) | | | +| amount_to_withdraw | [string](#string) | | | + + + + + + + + +### CompoundCTokenAdaptorV2Calls + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| calls | [CompoundCTokenAdaptorV2](#steward-v4-CompoundCTokenAdaptorV2) | repeated | | + + + + + + + + + + + + + + + + +

Top

+ +## cellar_adaptor.proto + + + + + +### CellarAdaptorV1 + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| revoke_approval | [RevokeApproval](#steward-v4-RevokeApproval) | | Represents function `revokeApproval(ERC20 asset, address spender)` | +| depositToCellar | [CellarAdaptorV1.DepositToCellar](#steward-v4-CellarAdaptorV1-DepositToCellar) | | Represents function `depositToCellar(Cellar cellar, uint256 assets)` | +| withdrawFromCellar | [CellarAdaptorV1.WithdrawFromCellar](#steward-v4-CellarAdaptorV1-WithdrawFromCellar) | | Represents function `withdrawFromCellar(Cellar cellar, uint256 assets)` | + + + + + + + + +### CellarAdaptorV1.DepositToCellar +Allows strategists to deposit into Cellar positions. + +Represents function `depositToCellar(Cellar cellar, uint256 assets)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| cellar | [string](#string) | | | +| assets | [string](#string) | | | + + + + + + + + +### CellarAdaptorV1.WithdrawFromCellar +Allows strategists to withdraw from Cellar positions. + +Represents function `withdrawFromCellar(Cellar cellar, uint256 assets)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| cellar | [string](#string) | | | +| assets | [string](#string) | | | + + + + + + + + +### CellarAdaptorV1Calls + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| calls | [CellarAdaptorV1](#steward-v4-CellarAdaptorV1) | repeated | | + + + + + + + + + + + + + + + + +

Top

+ +## cellar_v1.proto + + + + + +### CellarV1 +Represents a function call to a cellar that implements Cellar.sol + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| add_position | [CellarV1.AddPosition](#steward-v4-CellarV1-AddPosition) | | Represents function `addPosition(uint256 index, address position)` | +| push_position | [CellarV1.PushPosition](#steward-v4-CellarV1-PushPosition) | | Represents function `pushPosition(address position)` | +| remove_position | [CellarV1.RemovePosition](#steward-v4-CellarV1-RemovePosition) | | Represents function `removePosition(uint256 index)` | +| set_holding_position | [CellarV1.SetHoldingPosition](#steward-v4-CellarV1-SetHoldingPosition) | | Represents function `setHoldingPosition(address newHoldingPosition)` | +| rebalance | [CellarV1.Rebalance](#steward-v4-CellarV1-Rebalance) | | Represents function `rebalance(address fromPosition, address toPosition, uint256 assetsFrom, SwapRouter.Exchange exchange, bytes calldata params)` | +| set_strategist_payout_address | [CellarV1.SetStrategistPayoutAddress](#steward-v4-CellarV1-SetStrategistPayoutAddress) | | Represents function `setStrategistPayoutAddress(address payout)` | +| set_withdraw_type | [CellarV1.SetWithdrawType](#steward-v4-CellarV1-SetWithdrawType) | | Represents function `setWithdrawType(WithdrawType newWithdrawType)` | +| swap_positions | [CellarV1.SwapPositions](#steward-v4-CellarV1-SwapPositions) | | Represents function `swapPositions(uint256 index1, uint256 index2)` | +| set_deposit_limit | [CellarV1.SetDepositLimit](#steward-v4-CellarV1-SetDepositLimit) | | Represents function `setDepositLimit()` | +| set_liquidity_limit | [CellarV1.SetLiquidityLimit](#steward-v4-CellarV1-SetLiquidityLimit) | | Represents function `setLiquidityLimit()` | +| set_share_lock_period | [CellarV1.SetShareLockPeriod](#steward-v4-CellarV1-SetShareLockPeriod) | | Represents function `setShareLockPeriod()` | +| set_rebalance_deviation | [CellarV1.SetRebalanceDeviation](#steward-v4-CellarV1-SetRebalanceDeviation) | | Represents function `setRebalanceDeviation(uint256)` | + + + + + + + + +### CellarV1.AddPosition +Insert a trusted position to the list of positions used by the cellar at a given index. + +Represents function `addPosition(uint256 index, address position)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| index | [string](#string) | | Index at which to add the position | +| position | [string](#string) | | Address of the position to add | + + + + + + + + +### CellarV1.PushPosition +Push a trusted position to the end of the list of positions used by the cellar. If you +know you are going to add a position to the end of the array, this is more efficient then +`addPosition`. + +Represents function `pushPosition(address position)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| position | [string](#string) | | Address of the position to push | + + + + + + + + +### CellarV1.Rebalance +Move assets between positions. To move assets from/to this cellar's holdings, specify +the address of this cellar as the `fromPosition`/`toPosition`. + +Represents function `rebalance(address fromPosition, address toPosition, + uint256 assetsFrom, SwapRouter.Exchange exchange, bytes calldata params) + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| from_position | [string](#string) | | | +| to_position | [string](#string) | | | +| assets_from | [string](#string) | | | +| exchange | [Exchange](#steward-v4-Exchange) | | | +| params | [SwapParams](#steward-v4-SwapParams) | | | + + + + + + + + +### CellarV1.RemovePosition +Remove the position at a given index from the list of positions used by the cellar. + +Represents function `removePosition(uint256 index)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| index | [string](#string) | | Index at which to remove the position | + + + + + + + + +### CellarV1.SetDepositLimit +Set the per-wallet deposit limit. Uses the same decimals as the current asset. + +Represents function `setDepositLimit()` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| new_limit | [string](#string) | | | + + + + + + + + +### CellarV1.SetHoldingPosition +Set the holding position used by the cellar. + +Represents function `setHoldingPosition(address newHoldingPosition)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| new_holding_position | [string](#string) | | Address of the new holding position to use | + + + + + + + + +### CellarV1.SetLiquidityLimit +Set the maximum liquidity that cellar can manage. Uses the same decimals as the current asset. + +Represents function `setLiquidityLimit()` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| new_limit | [string](#string) | | | + + + + + + + + +### CellarV1.SetRebalanceDeviation +Represents function `setRebalanceDeviation(uint256)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| new_deviation | [string](#string) | | | + + + + + + + + +### CellarV1.SetShareLockPeriod +Allows share lock period to be updated. + +Represents function `setShareLockPeriod()` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| new_lock | [string](#string) | | | + + + + + + + + +### CellarV1.SetStrategistPayoutAddress +Sets the Strategists payout address. + +Represents function `setStrategistPayoutAddress(address payout)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| payout | [string](#string) | | | + + + + + + + + +### CellarV1.SetWithdrawType +Set the withdraw type used by the cellar. + +Represents function `setWithdrawType(WithdrawType newWithdrawType)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| new_withdraw_type | [CellarV1.WithdrawType](#steward-v4-CellarV1-WithdrawType) | | The withdraw type to use for the cellar | + + + + + + + + +### CellarV1.SwapPositions +Swap the positions at two given indeces. + +Represents function `swapPositions(uint256 index1, uint256 index2)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| index_1 | [string](#string) | | Index of the first position | +| index_2 | [string](#string) | | Index of the second position | + + + + + + + + +### CellarV1Governance +Represent a function call initiated through a governance proposal + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| initiate_shutdown | [CellarV1Governance.InitiateShutdown](#steward-v4-CellarV1Governance-InitiateShutdown) | | Represents function `initiateShutdown()` | +| lift_shutdown | [CellarV1Governance.LiftShutdown](#steward-v4-CellarV1Governance-LiftShutdown) | | Represents function `liftShutdown()` | +| reset_high_watermark | [CellarV1Governance.ResetHighWatermark](#steward-v4-CellarV1Governance-ResetHighWatermark) | | Represents function `resetHighWatermark()` | +| set_fees_distributor | [CellarV1Governance.SetFeesDistributor](#steward-v4-CellarV1Governance-SetFeesDistributor) | | Represents function `setFeesDistributor(address)` | +| set_performance_fee | [CellarV1Governance.SetPerformanceFee](#steward-v4-CellarV1Governance-SetPerformanceFee) | | Represents function `setPerformanceFee(uint256)` | +| set_platform_fee | [CellarV1Governance.SetPlatformFee](#steward-v4-CellarV1Governance-SetPlatformFee) | | Represents function `setPlatformFee(uint256)` | +| set_strategist_performance_cut | [CellarV1Governance.SetStrategistPerformanceCut](#steward-v4-CellarV1Governance-SetStrategistPerformanceCut) | | Represents function `setStrategistPerformanceCut(uint256)` | +| set_strategist_platform_cut | [CellarV1Governance.SetStrategistPlatformCut](#steward-v4-CellarV1Governance-SetStrategistPlatformCut) | | Represents function `setStrategistPlatformCut(address)` | +| trust_position | [CellarV1Governance.TrustPosition](#steward-v4-CellarV1Governance-TrustPosition) | | Represents function `trustPosition(address)` | + + + + + + + + +### CellarV1Governance.InitiateShutdown +Represents function `initiateShutdown()` + + + + + + + + +### CellarV1Governance.LiftShutdown +Represents function `liftShutdown()` + + + + + + + + +### CellarV1Governance.ResetHighWatermark +Represents function `resetHighWatermark()` + + + + + + + + +### CellarV1Governance.SetFeesDistributor +Represents function `setFeesDistributor(bytes32)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| new_fees_distributor | [string](#string) | | Cosmos address of the new fees distributor | + + + + + + + + +### CellarV1Governance.SetPerformanceFee +Represents function `setPerformanceFee(uint64)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| amount | [uint64](#uint64) | | New performance fee | + + + + + + + + +### CellarV1Governance.SetPlatformFee +Represents function `setPlatformFee(uint64)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| amount | [uint64](#uint64) | | New platform fee | + + + + + + + + +### CellarV1Governance.SetStrategistPerformanceCut +Represents function `setStrategistPerformanceCut(uint64)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| amount | [uint64](#uint64) | | New strategist performance cut | + + + + + + + + +### CellarV1Governance.SetStrategistPlatformCut +Represents function `setStrategistPlatformCut(uint64)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| amount | [uint64](#uint64) | | New strategist platform cut | + + + + + + + + +### CellarV1Governance.TrustPosition +Represents function `trustPosition(address)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| erc20_address | [string](#string) | | | +| erc4626_address | [string](#string) | | | +| cellar_address | [string](#string) | | | + + + + + + + + + + +### CellarV1.WithdrawType +Represents the withdraw type to use for the cellar + +| Name | Number | Description | +| ---- | ------ | ----------- | +| WITHDRAW_TYPE_UNSPECIFIED | 0 | | +| WITHDRAW_TYPE_ORDERLY | 1 | | +| WITHDRAW_TYPE_PROPORTIONAL | 2 | | + + + + + + + + + + + +

Top

+ +## cellar_v2.proto + + + + + +### AdaptorCall +Represents a call to adaptor an. The cellar must be authorized to call the target adaptor. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| adaptor | [string](#string) | | Address of the adaptor | +| aave_a_token_v1_calls | [AaveATokenAdaptorV1Calls](#steward-v4-AaveATokenAdaptorV1Calls) | | Represents function calls to the AaveATokenAdaptor V1 | +| aave_debt_token_v1_calls | [AaveDebtTokenAdaptorV1Calls](#steward-v4-AaveDebtTokenAdaptorV1Calls) | | Represents function calls to the AavaDebtTokenAdaptor V1 | +| compound_c_token_v2_calls | [CompoundCTokenAdaptorV2Calls](#steward-v4-CompoundCTokenAdaptorV2Calls) | | Represents function calls to the CompoundCTokenAdaptor V2 | +| aave_a_token_v2_calls | [AaveATokenAdaptorV2Calls](#steward-v4-AaveATokenAdaptorV2Calls) | | Represents function calls to the AaveATokenV2Adaptor | +| aave_debt_token_v2_calls | [AaveDebtTokenAdaptorV2Calls](#steward-v4-AaveDebtTokenAdaptorV2Calls) | | Represents function calls to the AavaDebtTokenV2Adaptor | +| aave_v3_a_token_v1_calls | [AaveV3ATokenAdaptorV1Calls](#steward-v4-AaveV3ATokenAdaptorV1Calls) | | Represents function calls to the AaveATokenV1Adaptor | +| aave_v3_debt_token_v1_calls | [AaveV3DebtTokenAdaptorV1Calls](#steward-v4-AaveV3DebtTokenAdaptorV1Calls) | | Represents function calls to the AavaDebtTokenV1Adaptor | +| one_inch_v1_calls | [OneInchAdaptorV1Calls](#steward-v4-OneInchAdaptorV1Calls) | | Represents function calls to the OneInchAdaptorV1 | +| fees_and_reserves_v1_calls | [FeesAndReservesAdaptorV1Calls](#steward-v4-FeesAndReservesAdaptorV1Calls) | | Represents function calls to the FeesAndReservesAdaptorV1 | +| zero_x_v1_calls | [ZeroXAdaptorV1Calls](#steward-v4-ZeroXAdaptorV1Calls) | | Represents functionc alls to the ZeroXAdaptorV1 | +| swap_with_uniswap_v1_calls | [SwapWithUniswapAdaptorV1Calls](#steward-v4-SwapWithUniswapAdaptorV1Calls) | | Represents function calls to the SwapWithUniswapAdaptorV1 | +| vesting_simple_v2_calls | [VestingSimpleAdaptorV2Calls](#steward-v4-VestingSimpleAdaptorV2Calls) | | Represents function calls to VestingSimpleAdaptor | +| cellar_v1_calls | [CellarAdaptorV1Calls](#steward-v4-CellarAdaptorV1Calls) | | Represents function calls to the CellarAdaptor | +| uniswap_v3_v2_calls | [UniswapV3AdaptorV2Calls](#steward-v4-UniswapV3AdaptorV2Calls) | | Represents function calls to the UniswapV3Adaptor V2 | +| aave_v2_enable_asset_as_collateral_v1_calls | [AaveV2EnableAssetAsCollateralAdaptorV1Calls](#steward-v4-AaveV2EnableAssetAsCollateralAdaptorV1Calls) | | Represents function calls to the AaveV2EnableAssetAsCollatorAdaptor V1 | +| f_token_v1_calls | [FTokenAdaptorV1Calls](#steward-v4-FTokenAdaptorV1Calls) | | Represents function calls to the FTokenAdaptor V1 | +| morpho_aave_v2_a_token_v1_calls | [MorphoAaveV2ATokenAdaptorV1Calls](#steward-v4-MorphoAaveV2ATokenAdaptorV1Calls) | | Represents function calls to the MorphoAaveV2AToken V1 | +| morpho_aave_v2_debt_token_v1_calls | [MorphoAaveV2DebtTokenAdaptorV1Calls](#steward-v4-MorphoAaveV2DebtTokenAdaptorV1Calls) | | Represents function calls to the MorphoAaveV2DebtToken V1 | +| morpho_aave_v3_a_token_collateral_v1_calls | [MorphoAaveV3ATokenCollateralAdaptorV1Calls](#steward-v4-MorphoAaveV3ATokenCollateralAdaptorV1Calls) | | Represents function calls to the MorphoAaveV3ATokenCollateral V1 | +| morpho_aave_v3_a_token_p2p_v1_calls | [MorphoAaveV3ATokenP2PAdaptorV1Calls](#steward-v4-MorphoAaveV3ATokenP2PAdaptorV1Calls) | | Represents function calls to the MorphoAaveV3ATokenP2P V1 | +| morpho_aave_v3_debt_token_v1_calls | [MorphoAaveV3DebtTokenAdaptorV1Calls](#steward-v4-MorphoAaveV3DebtTokenAdaptorV1Calls) | | Represents function calls to the MorphoAaveV3DebtToken V1 | +| balancer_pool_v1_calls | [BalancerPoolAdaptorV1Calls](#steward-v4-BalancerPoolAdaptorV1Calls) | | Represents function calls to the BalancerPoolAdaptor V1 | +| legacy_cellar_v1_calls | [LegacyCellarAdaptorV1Calls](#steward-v4-LegacyCellarAdaptorV1Calls) | | Represents function calls to the LegacyCellarAdaptor V1 | +| debt_f_token_v1_calls | [DebtFTokenAdaptorV1Calls](#steward-v4-DebtFTokenAdaptorV1Calls) | | Represents function calls to the DebtFTokenAdaptor V1 | +| collateral_f_token_v1_calls | [CollateralFTokenAdaptorV1Calls](#steward-v4-CollateralFTokenAdaptorV1Calls) | | Represents function calls to the CollateralFTokenAdaptor V1 | +| aave_v3_debt_token_v1_flash_loan_calls | [AaveV3DebtTokenAdaptorV1FlashLoanCalls](#steward-v4-AaveV3DebtTokenAdaptorV1FlashLoanCalls) | | Represents function call for the AaveV3DebtTokenAdaptorV1 | +| balancer_pool_v1_flash_loan_calls | [BalancerPoolAdaptorV1FlashLoanCalls](#steward-v4-BalancerPoolAdaptorV1FlashLoanCalls) | | Represents function call for the BalancerPoolAdaptorV1 | +| convex_curve_v1_calls | [ConvexCurveAdaptorV1Calls](#steward-v4-ConvexCurveAdaptorV1Calls) | | Represents function calls for the ConvexCurveAdaptorV1 | +| curve_v1_calls | [CurveAdaptorV1Calls](#steward-v4-CurveAdaptorV1Calls) | | Represents function calls for the CurveAdaptorV1 | +| aura_erc4626_v1_calls | [AuraERC4626AdaptorV1Calls](#steward-v4-AuraERC4626AdaptorV1Calls) | | Represents function calls for the AuraERC4626AdaptorV1 | +| morpho_blue_collateral_v1_calls | [MorphoBlueCollateralAdaptorV1Calls](#steward-v4-MorphoBlueCollateralAdaptorV1Calls) | | Represents function calls for the MorphoBlueCollateralAdaptorV1 | +| morpho_blue_debt_v1_calls | [MorphoBlueDebtAdaptorV1Calls](#steward-v4-MorphoBlueDebtAdaptorV1Calls) | | Represents function calls for the MorphoBlueDebtAdaptorV1 | +| morpho_blue_supply_v1_calls | [MorphoBlueSupplyAdaptorV1Calls](#steward-v4-MorphoBlueSupplyAdaptorV1Calls) | | Represents function calls for the MorphoBlueSupplyAdaptorV1 | +| erc4626_v1_calls | [ERC4626AdaptorV1Calls](#steward-v4-ERC4626AdaptorV1Calls) | | Represents function calls for the ERC4626AdaptorV1 | +| staking_v1_calls | [StakingAdaptorV1Calls](#steward-v4-StakingAdaptorV1Calls) | | Represents function calls for the StakingAdaptorV1 | + + + + + + + + +### CellarV2 +Represents a function call to a cellar that implements Cellar.sol + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| call_on_adaptor | [CellarV2.CallOnAdaptor](#steward-v4-CellarV2-CallOnAdaptor) | | Represents function `callOnAdaptor(AdaptorCall[] memory data)` | +| remove_position | [CellarV2.RemovePosition](#steward-v4-CellarV2-RemovePosition) | | Represents function `removePosition(uint256 index)` | +| set_holding_position | [CellarV2.SetHoldingPosition](#steward-v4-CellarV2-SetHoldingPosition) | | Represents function `setHoldingPosition(uint32 position_id)` | +| set_strategist_payout_address | [CellarV2.SetStrategistPayoutAddress](#steward-v4-CellarV2-SetStrategistPayoutAddress) | | Represents function `setStrategistPayoutAddress(address payout)` | +| swap_positions | [CellarV2.SwapPositions](#steward-v4-CellarV2-SwapPositions) | | Represents function `swapPositions(uint256 index1, uint256 index2)` | +| set_share_lock_period | [CellarV2.SetShareLockPeriod](#steward-v4-CellarV2-SetShareLockPeriod) | | Represents function `setShareLockPeriod(uint256 newLock)` | +| add_position | [CellarV2.AddPosition](#steward-v4-CellarV2-AddPosition) | | Represents function `addPosition(uint256 index, address position)` | +| setup_adaptor | [CellarV2.SetupAdaptor](#steward-v4-CellarV2-SetupAdaptor) | | Represents function `setupAdaptor(address adaptor)` | +| initiate_shutdown | [CellarV2.InitiateShutdown](#steward-v4-CellarV2-InitiateShutdown) | | Represents function `initiateShutdown()` | +| lift_shutdown | [CellarV2.LiftShutdown](#steward-v4-CellarV2-LiftShutdown) | | Represents function `liftShutdown()` | +| set_platform_fee | [CellarV2.SetPlatformFee](#steward-v4-CellarV2-SetPlatformFee) | | Represents function `setPlatformFee(uint256)` | +| set_strategist_platform_cut | [CellarV2.SetStrategistPlatformCut](#steward-v4-CellarV2-SetStrategistPlatformCut) | | Represents function `setStrategistPlatformCut(address)` | +| set_rebalance_deviation | [CellarV2.SetRebalanceDeviation](#steward-v4-CellarV2-SetRebalanceDeviation) | | Represents function `setRebalanceDeviation(uint256)` | + + + + + + + + +### CellarV2.AddPosition +Insert a trusted position to the list of positions used by the cellar at a given index. + +Represents function `addPosition(uint32 index, uint32 positionId, bytes configurationData, bool inDebtArray)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| index | [uint32](#uint32) | | Index at which to add the position | +| position_id | [uint32](#uint32) | | The position's ID in the cellar registry | +| configuration_data | [bytes](#bytes) | | Data used to configure how the position behaves | +| in_debt_array | [bool](#bool) | | Whether to add position in the debt array, or the credit array. | + + + + + + + + +### CellarV2.CallOnAdaptor +Allows strategists to manage their Cellar using arbitrary logic calls to adaptors. + +Represents function `callOnAdaptor(AdaptorCall[] memory data)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| data | [AdaptorCall](#steward-v4-AdaptorCall) | repeated | | + + + + + + + + +### CellarV2.InitiateShutdown +Represents function `initiateShutdown()` + + + + + + + + +### CellarV2.LiftShutdown +Represents function `liftShutdown()` + + + + + + + + +### CellarV2.RemovePosition +Remove the position at a given index from the list of positions used by the cellar. + +Represents function `removePosition(uint32 index, bool inDebtArray)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| index | [uint32](#uint32) | | Index at which to remove the position | +| in_debt_array | [bool](#bool) | | Whether to remove position from the debt array, or the credit array. | + + + + + + + + +### CellarV2.SetHoldingPosition +Set the holding position used of the cellar. + +Represents function `setHoldingIndex(uint8 index)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| position_id | [uint32](#uint32) | | ID (index) of the new holding position to use | + + + + + + + + +### CellarV2.SetPlatformFee +Represents function `setPlatformFee(uint64)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| amount | [uint64](#uint64) | | New platform fee | + + + + + + + + +### CellarV2.SetRebalanceDeviation +Changes the cellar's allowed rebalance deviation, which is the percent the total assets of a cellar may deviate +during a `callOnAdaptor`(rebalance) call. The maximum allowed deviation is 100000000000000000 (0.1e18), or 10%. + +Represents function `setRebalanceDeviation(uint256)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| new_deviation | [string](#string) | | | + + + + + + + + +### CellarV2.SetShareLockPeriod +Allows share lock period to be updated. + +Represents function `setShareLockPeriod()` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| new_lock | [string](#string) | | | + + + + + + + + +### CellarV2.SetStrategistPayoutAddress +Sets the Strategists payout address. + +Represents function `setStrategistPayoutAddress(address payout)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| payout | [string](#string) | | | + + + + + + + + +### CellarV2.SetStrategistPlatformCut +Represents function `setStrategistPlatformCut(uint64)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| amount | [uint64](#uint64) | | New strategist platform cut | + + + + + + + + +### CellarV2.SetupAdaptor +Allows owner to add new adaptors for the cellar to use. + +Represents function `setupAdaptor(address adaptor)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| adaptor | [string](#string) | | Address of the adaptor | + + + + + + + + +### CellarV2.SwapPositions +Swap the positions at two given indeces. + +Represents function `swapPositions(uint32 index1, uint32 index2)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| index_1 | [uint32](#uint32) | | Index of the first position | +| index_2 | [uint32](#uint32) | | Index of the second position | +| in_debt_array | [bool](#bool) | | Whether to switch positions in the debt array, or the credit array. | + + + + + + + + +### CellarV2Governance +Represent a function call initiated through a governance proposal + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| initiate_shutdown | [CellarV2Governance.InitiateShutdown](#steward-v4-CellarV2Governance-InitiateShutdown) | | Represents function `initiateShutdown()` | +| lift_shutdown | [CellarV2Governance.LiftShutdown](#steward-v4-CellarV2Governance-LiftShutdown) | | Represents function `liftShutdown()` | +| set_platform_fee | [CellarV2Governance.SetPlatformFee](#steward-v4-CellarV2Governance-SetPlatformFee) | | Represents function `setPlatformFee(uint256)` | +| set_strategist_platform_cut | [CellarV2Governance.SetStrategistPlatformCut](#steward-v4-CellarV2Governance-SetStrategistPlatformCut) | | Represents function `setStrategistPlatformCut(address)` | +| setup_adaptor | [CellarV2Governance.SetupAdaptor](#steward-v4-CellarV2Governance-SetupAdaptor) | | Represents function `setupAdaptor(address adaptor)` | +| set_rebalance_deviation | [CellarV2Governance.SetRebalanceDeviation](#steward-v4-CellarV2Governance-SetRebalanceDeviation) | | Represents function `setRebalanceDeviation(uint256)` | + + + + + + + + +### CellarV2Governance.InitiateShutdown +Represents function `initiateShutdown()` + + + + + + + + +### CellarV2Governance.LiftShutdown +Represents function `liftShutdown()` + + + + + + + + +### CellarV2Governance.SetPlatformFee +Represents function `setPlatformFee(uint64)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| amount | [uint64](#uint64) | | New platform fee | + + + + + + + + +### CellarV2Governance.SetRebalanceDeviation +Changes the cellar's allowed rebalance deviation, which is the percent the total assets of a cellar may deviate +during a `callOnAdaptor`(rebalance) call. The maximum allowed deviation is 100000000000000000 (0.1e18), or 10%. + +Represents function `setRebalanceDeviation(uint256)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| new_deviation | [string](#string) | | | + + + + + + + + +### CellarV2Governance.SetStrategistPlatformCut +Represents function `setStrategistPlatformCut(uint64)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| amount | [uint64](#uint64) | | New strategist platform cut | + + + + + + + + +### CellarV2Governance.SetupAdaptor +Allows owner to add new adaptors for the cellar to use. + +Represents function `setupAdaptor(address adaptor)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| adaptor | [string](#string) | | Address of the adaptor | + + + + + + + + +### CellarV2_2 + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| function_call | [CellarV2_2.FunctionCall](#steward-v4-CellarV2_2-FunctionCall) | | Represents a single function call | +| multicall | [CellarV2_2.Multicall](#steward-v4-CellarV2_2-Multicall) | | Represents multiple, ordered function calls | + + + + + + + + +### CellarV2_2.AddAdaptorToCatalogue +Allows the owner to add an adaptor to the Cellar's adaptor catalogue + +Represents function `addAdaptorToCatalogue(address adaptor)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| adaptor | [string](#string) | | | + + + + + + + + +### CellarV2_2.AddPosition +Insert a trusted position to the list of positions used by the cellar at a given index. + +Represents function `addPosition(uint32 index, uint32 positionId, bytes configurationData, bool inDebtArray)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| index | [uint32](#uint32) | | Index at which to add the position | +| position_id | [uint32](#uint32) | | The position's ID in the cellar registry | +| configuration_data | [bytes](#bytes) | | Data used to configure how the position behaves | +| in_debt_array | [bool](#bool) | | Whether to add position in the debt array, or the credit array. | + + + + + + + + +### CellarV2_2.AddPositionToCatalogue +Allows the owner to add a position to the Cellar's position catalogue + +Represents function `addPositionToCatalogue(uint32 positionId)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| position_id | [uint32](#uint32) | | | + + + + + + + + +### CellarV2_2.CachePriceRouter +Updates the cellar to use the latest price router in the registry. + +Represents function `cachePriceRouter(bool checkTotalAssets, uint16 allowableRange, address expectedPriceRouter)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| check_total_assets | [bool](#bool) | | Whether to check the total assets of the cellar | +| allowable_range | [uint32](#uint32) | | The allowable range of the cellar's total assets to deviate between old and new routers | +| expected_price_router | [string](#string) | | The expected price router address | + + + + + + + + +### CellarV2_2.CallOnAdaptor +Allows strategists to manage their Cellar using arbitrary logic calls to adaptors. + +Represents function `callOnAdaptor(AdaptorCall[] memory data)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| data | [AdaptorCall](#steward-v4-AdaptorCall) | repeated | | + + + + + + + + +### CellarV2_2.FunctionCall +The function you wish to execute on the target cellar + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| add_position | [CellarV2_2.AddPosition](#steward-v4-CellarV2_2-AddPosition) | | Represents function `addPosition(uint256 index, address position)` | +| call_on_adaptor | [CellarV2_2.CallOnAdaptor](#steward-v4-CellarV2_2-CallOnAdaptor) | | Represents function `callOnAdaptor(AdaptorCall[] memory data)` | +| remove_position | [CellarV2_2.RemovePosition](#steward-v4-CellarV2_2-RemovePosition) | | Represents function `removePosition(uint256 index, bool inDebtArray)` | +| remove_adaptor_from_catalogue | [CellarV2_2.RemoveAdaptorFromCatalogue](#steward-v4-CellarV2_2-RemoveAdaptorFromCatalogue) | | Represents function `removeAdaptorFromCatalogue(address adaptor)` | +| remove_position_from_catalogue | [CellarV2_2.RemovePositionFromCatalogue](#steward-v4-CellarV2_2-RemovePositionFromCatalogue) | | Represents function `removePositionFromCatalogue(uint32 positionId)` | +| set_holding_position | [CellarV2_2.SetHoldingPosition](#steward-v4-CellarV2_2-SetHoldingPosition) | | Represents function `setHoldingPosition(uint32 position_id)` | +| set_strategist_payout_address | [CellarV2_2.SetStrategistPayoutAddress](#steward-v4-CellarV2_2-SetStrategistPayoutAddress) | | Represents function `setStrategistPayoutAddress(address payout)` | +| swap_positions | [CellarV2_2.SwapPositions](#steward-v4-CellarV2_2-SwapPositions) | | Represents function `swapPositions(uint256 index1, uint256 index2)` | +| add_adaptor_to_catalogue | [CellarV2_2.AddAdaptorToCatalogue](#steward-v4-CellarV2_2-AddAdaptorToCatalogue) | | Represents function `addAdaptorToCatalogue(address adaptor)` | +| add_position_to_catalogue | [CellarV2_2.AddPositionToCatalogue](#steward-v4-CellarV2_2-AddPositionToCatalogue) | | Represents function `addPositionToCatalogue(uint32 positionId)` | +| set_rebalance_deviation | [CellarV2_2.SetRebalanceDeviation](#steward-v4-CellarV2_2-SetRebalanceDeviation) | | Represents function `setRebalanceDeviation(uint256)` | +| set_share_lock_period | [CellarV2_2.SetShareLockPeriod](#steward-v4-CellarV2_2-SetShareLockPeriod) | | Represents function `setShareLockPeriod(uint256 newLock)` | +| set_strategist_platform_cut | [CellarV2_2.SetStrategistPlatformCut](#steward-v4-CellarV2_2-SetStrategistPlatformCut) | | Represents function `setStrategistPlatformCut(uint64 cut)` | +| initiate_shutdown | [CellarV2_2.InitiateShutdown](#steward-v4-CellarV2_2-InitiateShutdown) | | Represents function `initiateShutdown()` | +| lift_shutdown | [CellarV2_2.LiftShutdown](#steward-v4-CellarV2_2-LiftShutdown) | | Represents function `liftShutdown()` | +| cache_price_router | [CellarV2_2.CachePriceRouter](#steward-v4-CellarV2_2-CachePriceRouter) | | Represents function `cachePriceRouter(bool checkTotalAssets, uint16 allowableRange, address expectedPriceRouter)` | + + + + + + + + +### CellarV2_2.InitiateShutdown +Shutdown the cellar. Used in an emergency or if the cellar has been deprecated. + +Represents function `initiateShutdown()` + + + + + + + + +### CellarV2_2.LiftShutdown +Allows the owner to restart a shut down Cellar + +Represents function `liftShutdown()` + + + + + + + + +### CellarV2_2.Multicall +Allows caller to call multiple functions in a single TX. + +Represents function `multicall(bytes[] data)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| function_calls | [CellarV2_2.FunctionCall](#steward-v4-CellarV2_2-FunctionCall) | repeated | | + + + + + + + + +### CellarV2_2.RemoveAdaptorFromCatalogue +Allows callers to remove adaptors from this cellar's catalogue + +Represents function `removeAdaptorFromCatalogue(address adaptor)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| adaptor | [string](#string) | | | + + + + + + + + +### CellarV2_2.RemovePosition +Remove the position at a given index from the list of positions used by the cellar. + +Represents function `removePosition(uint32 index, bool inDebtArray)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| index | [uint32](#uint32) | | Index at which to remove the position | +| in_debt_array | [bool](#bool) | | Whether to remove position from the debt array, or the credit array. | + + + + + + + + +### CellarV2_2.RemovePositionFromCatalogue +Allows caller to remove positions from this cellar's catalogue + +Represents function `removePositionFromCatalogue(uint32 positionId)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| position_id | [uint32](#uint32) | | | + + + + + + + + +### CellarV2_2.SetHoldingPosition +Set the holding position used of the cellar. + +Represents function `setHoldingIndex(uint8 index)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| position_id | [uint32](#uint32) | | ID (index) of the new holding position to use | + + + + + + + + +### CellarV2_2.SetRebalanceDeviation +Changes the cellar's allowed rebalance deviation, which is the percent the total assets of a cellar may deviate +during a `callOnAdaptor`(rebalance) call. The maximum allowed deviation is 100000000000000000 (0.1e18), or 10%. + +Represents function `setRebalanceDeviation(uint256)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| new_deviation | [string](#string) | | | + + + + + + + + +### CellarV2_2.SetShareLockPeriod +Allows share lock period to be updated. + +Represents function `setShareLockPeriod()` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| new_lock | [string](#string) | | | + + + + + + + + +### CellarV2_2.SetStrategistPayoutAddress +Sets the Strategists payout address. + +Represents function `setStrategistPayoutAddress(address payout)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| payout | [string](#string) | | | + + + + + + + + +### CellarV2_2.SetStrategistPlatformCut +Allows strategist to set the platform cut for the cellar. + +Represents function `setStrategistPlatformCut(uint64 cut)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| new_cut | [uint64](#uint64) | | The new strategist platform cut | + + + + + + + + +### CellarV2_2.SwapPositions +Swap the positions at two given indeces. + +Represents function `swapPositions(uint32 index1, uint32 index2)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| index_1 | [uint32](#uint32) | | Index of the first position | +| index_2 | [uint32](#uint32) | | Index of the second position | +| in_debt_array | [bool](#bool) | | Whether to switch positions in the debt array, or the credit array. | + + + + + + + + +### CellarV2_2Governance +Represent a function call initiated through a governance proposal + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| function_call | [CellarV2_2Governance.FunctionCall](#steward-v4-CellarV2_2Governance-FunctionCall) | | Represents a single function call | +| multicall | [CellarV2_2Governance.Multicall](#steward-v4-CellarV2_2Governance-Multicall) | | Represents multiple, ordered function calls | + + + + + + + + +### CellarV2_2Governance.AddAdaptorToCatalogue +Allows the owner to add an adaptor to the Cellar's adaptor catalogue + +Represents function `addAdaptorToCatalogue(address adaptor)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| adaptor | [string](#string) | | | + + + + + + + + +### CellarV2_2Governance.AddPosition +Insert a trusted position to the list of positions used by the cellar at a given index. + +Represents function `addPosition(uint32 index, uint32 positionId, bytes configurationData, bool inDebtArray)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| index | [uint32](#uint32) | | Index at which to add the position | +| position_id | [uint32](#uint32) | | The position's ID in the cellar registry | +| configuration_data | [bytes](#bytes) | | Data used to configure how the position behaves | +| in_debt_array | [bool](#bool) | | Whether to add position in the debt array, or the credit array. | + + + + + + + + +### CellarV2_2Governance.AddPositionToCatalogue +Allows the owner to add a position to the Cellar's position catalogue + +Represents function `addPositionToCatalogue(uint32 positionId)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| position_id | [uint32](#uint32) | | | + + + + + + + + +### CellarV2_2Governance.CachePriceRouter +Updates the cellar to use the latest price router in the registry. + +Represents function `cachePriceRouter(bool checkTotalAssets, uint16 allowableRange, address expectedPriceRouter)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| check_total_assets | [bool](#bool) | | Whether to check the total assets of the cellar | +| allowable_range | [uint32](#uint32) | | The allowable range of the cellar's total assets to deviate between old and new routers | +| expected_price_router | [string](#string) | | The expected price router address | + + + + + + + + +### CellarV2_2Governance.CallOnAdaptor +Allows strategists to manage their Cellar using arbitrary logic calls to adaptors. + +Represents function `callOnAdaptor(AdaptorCall[] memory data)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| data | [AdaptorCall](#steward-v4-AdaptorCall) | repeated | | + + + + + + + + +### CellarV2_2Governance.ForcePositionOut +Allows caller to force a position out of the cellar + +Represents function `forcePositionOut(uint32 index, uint32 positionId, bool inDebtArray)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| index | [uint32](#uint32) | | | +| position_id | [uint32](#uint32) | | | +| in_debt_array | [bool](#bool) | | | + + + + + + + + +### CellarV2_2Governance.FunctionCall +The function you wish to execute on the target cellar + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| add_adaptor_to_catalogue | [CellarV2_2Governance.AddAdaptorToCatalogue](#steward-v4-CellarV2_2Governance-AddAdaptorToCatalogue) | | Represents function `addAdaptorToCatalogue(address adaptor)` | +| add_position_to_catalogue | [CellarV2_2Governance.AddPositionToCatalogue](#steward-v4-CellarV2_2Governance-AddPositionToCatalogue) | | Represents function `addPositionToCatalogue(uint32 positionId)` | +| set_rebalance_deviation | [CellarV2_2Governance.SetRebalanceDeviation](#steward-v4-CellarV2_2Governance-SetRebalanceDeviation) | | Represents function `setRebalanceDeviation(uint256)` | +| set_share_lock_period | [CellarV2_2Governance.SetShareLockPeriod](#steward-v4-CellarV2_2Governance-SetShareLockPeriod) | | Represents function `setShareLockPeriod(uint256 newLock)` | +| set_strategist_platform_cut | [CellarV2_2Governance.SetStrategistPlatformCut](#steward-v4-CellarV2_2Governance-SetStrategistPlatformCut) | | Represents function `setStrategistPlatformCut(uint64 cut)` | +| initiate_shutdown | [CellarV2_2Governance.InitiateShutdown](#steward-v4-CellarV2_2Governance-InitiateShutdown) | | Represents function `initiateShutdown()` | +| lift_shutdown | [CellarV2_2Governance.LiftShutdown](#steward-v4-CellarV2_2Governance-LiftShutdown) | | Represents function `liftShutdown()` | +| force_position_out | [CellarV2_2Governance.ForcePositionOut](#steward-v4-CellarV2_2Governance-ForcePositionOut) | | Represents function `forcePositionOut(uint32 index, uint32 positionId, bool inDebtArray)` | +| toggle_ignore_pause | [CellarV2_2Governance.ToggleIgnorePause](#steward-v4-CellarV2_2Governance-ToggleIgnorePause) | | Represents function `toggleIgnorePause(bool ignore)` | +| cache_price_router | [CellarV2_2Governance.CachePriceRouter](#steward-v4-CellarV2_2Governance-CachePriceRouter) | | Represents function `cachePriceRouter(bool checkTotalAssets, uint16 allowableRange, address expectedPriceRouter)` | +| add_position | [CellarV2_2Governance.AddPosition](#steward-v4-CellarV2_2Governance-AddPosition) | | Represents function `addPosition(uint256 index, address position)` | +| call_on_adaptor | [CellarV2_2Governance.CallOnAdaptor](#steward-v4-CellarV2_2Governance-CallOnAdaptor) | | Represents function `callOnAdaptor(AdaptorCall[] memory data)` | +| remove_position | [CellarV2_2Governance.RemovePosition](#steward-v4-CellarV2_2Governance-RemovePosition) | | Represents function `removePosition(uint256 index, bool inDebtArray)` | +| remove_adaptor_from_catalogue | [CellarV2_2Governance.RemoveAdaptorFromCatalogue](#steward-v4-CellarV2_2Governance-RemoveAdaptorFromCatalogue) | | Represents function `removeAdaptorFromCatalogue(address adaptor)` | +| remove_position_from_catalogue | [CellarV2_2Governance.RemovePositionFromCatalogue](#steward-v4-CellarV2_2Governance-RemovePositionFromCatalogue) | | Represents function `removePositionFromCatalogue(uint32 positionId)` | +| set_holding_position | [CellarV2_2Governance.SetHoldingPosition](#steward-v4-CellarV2_2Governance-SetHoldingPosition) | | Represents function `setHoldingPosition(uint32 position_id)` | +| swap_positions | [CellarV2_2Governance.SwapPositions](#steward-v4-CellarV2_2Governance-SwapPositions) | | Represents function `swapPositions(uint256 index1, uint256 index2)` | + + + + + + + + +### CellarV2_2Governance.InitiateShutdown +Shutdown the cellar. Used in an emergency or if the cellar has been deprecated. + +Represents function `initiateShutdown()` + + + + + + + + +### CellarV2_2Governance.LiftShutdown +Allows the owner to restart a shut down Cellar + +Represents function `liftShutdown()` + + + + + + + + +### CellarV2_2Governance.Multicall +Allows caller to call multiple functions in a single TX. + +Represents function `multicall(bytes[] data)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| function_calls | [CellarV2_2Governance.FunctionCall](#steward-v4-CellarV2_2Governance-FunctionCall) | repeated | | + + + + + + + + +### CellarV2_2Governance.RemoveAdaptorFromCatalogue +Allows callers to remove adaptors from this cellar's catalogue + +Represents function `removeAdaptorFromCatalogue(address adaptor)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| adaptor | [string](#string) | | | + + + + + + + + +### CellarV2_2Governance.RemovePosition +Remove the position at a given index from the list of positions used by the cellar. + +Represents function `removePosition(uint32 index, bool inDebtArray)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| index | [uint32](#uint32) | | Index at which to remove the position | +| in_debt_array | [bool](#bool) | | Whether to remove position from the debt array, or the credit array. | + + + + + + + + +### CellarV2_2Governance.RemovePositionFromCatalogue +Allows caller to remove positions from this cellar's catalogue + +Represents function `removePositionFromCatalogue(uint32 positionId)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| position_id | [uint32](#uint32) | | | + + + + + + + + +### CellarV2_2Governance.SetHoldingPosition +Set the holding position used of the cellar. + +Represents function `setHoldingIndex(uint8 index)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| position_id | [uint32](#uint32) | | ID (index) of the new holding position to use | + + + + + + + + +### CellarV2_2Governance.SetRebalanceDeviation +Changes the cellar's allowed rebalance deviation, which is the percent the total assets of a cellar may deviate +during a `callOnAdaptor`(rebalance) call. The maximum allowed deviation is 100000000000000000 (0.1e18), or 10%. + +Represents function `setRebalanceDeviation(uint256)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| new_deviation | [string](#string) | | | + + + + + + + + +### CellarV2_2Governance.SetShareLockPeriod +Allows share lock period to be updated. + +Represents function `setShareLockPeriod()` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| new_lock | [string](#string) | | | + + + + + + + + +### CellarV2_2Governance.SetStrategistPlatformCut +Allows strategist to set the platform cut for the cellar. + +Represents function `setStrategistPlatformCut(uint64 cut)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| new_cut | [uint64](#uint64) | | The new strategist platform cut | + + + + + + + + +### CellarV2_2Governance.SwapPositions +Swap the positions at two given indeces. + +Represents function `swapPositions(uint32 index1, uint32 index2)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| index_1 | [uint32](#uint32) | | Index of the first position | +| index_2 | [uint32](#uint32) | | Index of the second position | +| in_debt_array | [bool](#bool) | | Whether to switch positions in the debt array, or the credit array. | + + + + + + + + +### CellarV2_2Governance.ToggleIgnorePause +Allows caller to toggle the ignorePause flag on the cellar + +Represents function `toggleIgnorePause(bool ignore)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| ignore | [bool](#bool) | | | + + + + + + + + +### CellarV2_5 + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| function_call | [CellarV2_5.FunctionCall](#steward-v4-CellarV2_5-FunctionCall) | | Represents a single function call | +| multicall | [CellarV2_5.Multicall](#steward-v4-CellarV2_5-Multicall) | | Represents multiple, ordered function calls | + + + + + + + + +### CellarV2_5.AddAdaptorToCatalogue +Allows the owner to add an adaptor to the Cellar's adaptor catalogue + +Represents function `addAdaptorToCatalogue(address adaptor)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| adaptor | [string](#string) | | | + + + + + + + + +### CellarV2_5.AddPosition +Insert a trusted position to the list of positions used by the cellar at a given index. + +Represents function `addPosition(uint32 index, uint32 positionId, bytes configurationData, bool inDebtArray)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| index | [uint32](#uint32) | | Index at which to add the position | +| position_id | [uint32](#uint32) | | The position's ID in the cellar registry | +| configuration_data | [bytes](#bytes) | | Data used to configure how the position behaves | +| in_debt_array | [bool](#bool) | | Whether to add position in the debt array, or the credit array. | + + + + + + + + +### CellarV2_5.AddPositionToCatalogue +Allows the owner to add a position to the Cellar's position catalogue + +Represents function `addPositionToCatalogue(uint32 positionId)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| position_id | [uint32](#uint32) | | | + + + + + + + + +### CellarV2_5.CachePriceRouter +Updates the cellar to use the latest price router in the registry. + +Represents function `cachePriceRouter(bool checkTotalAssets, uint16 allowableRange, address expectedPriceRouter)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| check_total_assets | [bool](#bool) | | Whether to check the total assets of the cellar | +| allowable_range | [uint32](#uint32) | | The allowable range of the cellar's total assets to deviate between old and new routers | +| expected_price_router | [string](#string) | | The expected price router address | + + + + + + + + +### CellarV2_5.CallOnAdaptor +Allows strategists to manage their Cellar using arbitrary logic calls to adaptors. + +Represents function `callOnAdaptor(AdaptorCall[] memory data)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| data | [AdaptorCall](#steward-v4-AdaptorCall) | repeated | | + + + + + + + + +### CellarV2_5.DecreaseShareSupplyCap +Allows strategist to decrease the share supply cap + +Represents function `decreaseShareSupplyCap(uint192)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| new_cap | [string](#string) | | | + + + + + + + + +### CellarV2_5.DropAlternativeAssetData +Allows the strategist to stop an alternative asset from being deposited. + +Represents function `dropAlternativeAssetData(ERC20 _alternativeAsset)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| alternative_asset | [string](#string) | | The address of the alternative asset | + + + + + + + + +### CellarV2_5.FunctionCall +The function you wish to execute on the target cellar + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| add_position | [CellarV2_5.AddPosition](#steward-v4-CellarV2_5-AddPosition) | | Represents function `addPosition(uint256 index, address position)` | +| call_on_adaptor | [CellarV2_5.CallOnAdaptor](#steward-v4-CellarV2_5-CallOnAdaptor) | | Represents function `callOnAdaptor(AdaptorCall[] memory data)` | +| remove_position | [CellarV2_5.RemovePosition](#steward-v4-CellarV2_5-RemovePosition) | | Represents function `removePosition(uint256 index)` | +| set_holding_position | [CellarV2_5.SetHoldingPosition](#steward-v4-CellarV2_5-SetHoldingPosition) | | Represents function `setHoldingPosition(uint32 position_id)` | +| set_strategist_payout_address | [CellarV2_5.SetStrategistPayoutAddress](#steward-v4-CellarV2_5-SetStrategistPayoutAddress) | | Represents function `setStrategistPayoutAddress(address payout)` | +| swap_positions | [CellarV2_5.SwapPositions](#steward-v4-CellarV2_5-SwapPositions) | | Represents function `swapPositions(uint256 index1, uint256 index2)` | +| set_share_lock_period | [CellarV2_5.SetShareLockPeriod](#steward-v4-CellarV2_5-SetShareLockPeriod) | | Represents function `setShareLockPeriod(uint256 newLock)` | +| initiate_shutdown | [CellarV2_5.InitiateShutdown](#steward-v4-CellarV2_5-InitiateShutdown) | | Represents function `initiateShutdown()` | +| lift_shutdown | [CellarV2_5.LiftShutdown](#steward-v4-CellarV2_5-LiftShutdown) | | Represents function `liftShutdown()` | +| remove_adaptor_from_catalogue | [CellarV2_5.RemoveAdaptorFromCatalogue](#steward-v4-CellarV2_5-RemoveAdaptorFromCatalogue) | | Represents function `removeAdaptorFromCatalogue(address adaptor)` | +| remove_position_from_catalogue | [CellarV2_5.RemovePositionFromCatalogue](#steward-v4-CellarV2_5-RemovePositionFromCatalogue) | | Represents function `removePositionFromCatalogue(uint32 positionId)` | +| decrease_share_supply_cap | [CellarV2_5.DecreaseShareSupplyCap](#steward-v4-CellarV2_5-DecreaseShareSupplyCap) | | Represents function `decreaseShareSupplyCap(uint192) | +| set_alternative_asset_data | [CellarV2_5.SetAlternativeAssetData](#steward-v4-CellarV2_5-SetAlternativeAssetData) | | Represents function `setAlternativeAssetData(ERC20 _alternativeAsset, uint32 _alternativeHoldingPosition, uint32 _alternativeAssetFee)` | +| drop_alternative_asset_data | [CellarV2_5.DropAlternativeAssetData](#steward-v4-CellarV2_5-DropAlternativeAssetData) | | Represents function `setDropAlternativeAssetData(ERC20 _alternativeAsset)` | +| add_adaptor_to_catalogue | [CellarV2_5.AddAdaptorToCatalogue](#steward-v4-CellarV2_5-AddAdaptorToCatalogue) | | Represents function `addAdaptorToCatalogue(address adaptor)` | +| add_position_to_catalogue | [CellarV2_5.AddPositionToCatalogue](#steward-v4-CellarV2_5-AddPositionToCatalogue) | | Represents function `addPositionToCatalogue(uint32 positionId)` | +| set_rebalance_deviation | [CellarV2_5.SetRebalanceDeviation](#steward-v4-CellarV2_5-SetRebalanceDeviation) | | Represents function `setRebalanceDeviation(uint256)` | +| set_strategist_platform_cut | [CellarV2_5.SetStrategistPlatformCut](#steward-v4-CellarV2_5-SetStrategistPlatformCut) | | Represents function `setStrategistPlatformCut(uint64 cut)` | +| set_share_price_oracle | [CellarV2_5.SetSharePriceOracle](#steward-v4-CellarV2_5-SetSharePriceOracle) | | Represents function `setSharePriceOracle(uint256 _registryId, ERC4626SharePriceOracle _sharePriceOracle)` | +| increase_share_supply_cap | [CellarV2_5.IncreaseShareSupplyCap](#steward-v4-CellarV2_5-IncreaseShareSupplyCap) | | Represents function `increaseShareSupplyCap(uint192 _newShareSupplyCap)` | +| cache_price_router | [CellarV2_5.CachePriceRouter](#steward-v4-CellarV2_5-CachePriceRouter) | | Represents function `cachePriceRouter(bool checkTotalAssets, uint16 allowableRange, address expectedPriceRouter)` | + + + + + + + + +### CellarV2_5.IncreaseShareSupplyCap +Allows the caller to increase the share supply cap + +Represents function `increaseShareSupplyCap(uint192 _newShareSupplyCap)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| new_cap | [string](#string) | | | + + + + + + + + +### CellarV2_5.InitiateShutdown +Shutdown the cellar. Used in an emergency or if the cellar has been deprecated. + +Represents function `initiateShutdown()` + + + + + + + + +### CellarV2_5.LiftShutdown +Allows the owner to restart a shut down Cellar + +Represents function `liftShutdown()` + + + + + + + + +### CellarV2_5.Multicall +Allows caller to call multiple functions in a single TX. + +Represents function `multicall(bytes[] data)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| function_calls | [CellarV2_5.FunctionCall](#steward-v4-CellarV2_5-FunctionCall) | repeated | | + + + + + + + + +### CellarV2_5.RemoveAdaptorFromCatalogue +Allows callers to remove adaptors from this cellar's catalogue + +Represents function `removeAdaptorFromCatalogue(address adaptor)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| adaptor | [string](#string) | | | + + + + + + + + +### CellarV2_5.RemovePosition +Remove the position at a given index from the list of positions used by the cellar. + +Represents function `removePosition(uint32 index, bool inDebtArray)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| index | [uint32](#uint32) | | Index at which to remove the position | +| in_debt_array | [bool](#bool) | | Whether to remove position from the debt array, or the credit array. | + + + + + + + + +### CellarV2_5.RemovePositionFromCatalogue +Allows caller to remove positions from this cellar's catalogue + +Represents function `removePositionFromCatalogue(uint32 positionId)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| position_id | [uint32](#uint32) | | | + + + + + + + + +### CellarV2_5.SetAlternativeAssetData +Allows the strategist to add, or update an existing alternative asset deposit. + +Represents function `setAlternativeAssetData(ERC20 _alternativeAsset, uint32 _alternativeHoldingPosition, uint32 _alternativeAssetFee)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| alternative_asset | [string](#string) | | The address of the alternative asset | +| alternative_holding_position | [uint32](#uint32) | | The holding position to direct alternative asset deposits to | +| alternative_asset_fee | [uint32](#uint32) | | The fee to charge for depositing this alternative asset | + + + + + + + + +### CellarV2_5.SetHoldingPosition +Set the holding position used of the cellar. + +Represents function `setHoldingIndex(uint8 index)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| position_id | [uint32](#uint32) | | ID (index) of the new holding position to use | + + + + + + + + +### CellarV2_5.SetRebalanceDeviation +Changes the cellar's allowed rebalance deviation, which is the percent the total assets of a cellar may deviate +during a `callOnAdaptor`(rebalance) call. The maximum allowed deviation is 100000000000000000 (0.1e18), or 10%. + +Represents function `setRebalanceDeviation(uint256)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| new_deviation | [string](#string) | | | + + + + + + + + +### CellarV2_5.SetShareLockPeriod +Allows share lock period to be updated. + +Represents function `setShareLockPeriod()` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| new_lock | [string](#string) | | | + + + + + + + + +### CellarV2_5.SetSharePriceOracle +Allows the caller to set the share price oracle contract + +Represents function `setSharePriceOracle(uint256 _registryId, ERC4626SharePriceOracle _sharePriceOracle)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| registry_id | [string](#string) | | The oracle registry ID | +| share_price_oracle | [string](#string) | | The oracle contract address | + + + + + + + + +### CellarV2_5.SetStrategistPayoutAddress +Sets the Strategists payout address. + +Represents function `setStrategistPayoutAddress(address payout)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| payout | [string](#string) | | | + + + + + + + + +### CellarV2_5.SetStrategistPlatformCut +Allows strategist to set the platform cut for the cellar. + +Represents function `setStrategistPlatformCut(uint64 cut)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| new_cut | [uint64](#uint64) | | The new strategist platform cut | + + + + + + + + +### CellarV2_5.SwapPositions +Swap the positions at two given indeces. + +Represents function `swapPositions(uint32 index1, uint32 index2)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| index_1 | [uint32](#uint32) | | Index of the first position | +| index_2 | [uint32](#uint32) | | Index of the second position | +| in_debt_array | [bool](#bool) | | Whether to switch positions in the debt array, or the credit array. | + + + + + + + + +### CellarV2_5Governance +Represent a function call initiated through a governance proposal + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| function_call | [CellarV2_5Governance.FunctionCall](#steward-v4-CellarV2_5Governance-FunctionCall) | | Represents a single function call | +| multicall | [CellarV2_5Governance.Multicall](#steward-v4-CellarV2_5Governance-Multicall) | | Represents multiple, ordered function calls | + + + + + + + + +### CellarV2_5Governance.AddAdaptorToCatalogue +Allows the owner to add an adaptor to the Cellar's adaptor catalogue + +Represents function `addAdaptorToCatalogue(address adaptor)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| adaptor | [string](#string) | | | + + + + + + + + +### CellarV2_5Governance.AddPosition +Insert a trusted position to the list of positions used by the cellar at a given index. + +Represents function `addPosition(uint32 index, uint32 positionId, bytes configurationData, bool inDebtArray)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| index | [uint32](#uint32) | | Index at which to add the position | +| position_id | [uint32](#uint32) | | The position's ID in the cellar registry | +| configuration_data | [bytes](#bytes) | | Data used to configure how the position behaves | +| in_debt_array | [bool](#bool) | | Whether to add position in the debt array, or the credit array. | + + + + + + + + +### CellarV2_5Governance.AddPositionToCatalogue +Allows the owner to add a position to the Cellar's position catalogue + +Represents function `addPositionToCatalogue(uint32 positionId)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| position_id | [uint32](#uint32) | | | + + + + + + + + +### CellarV2_5Governance.CachePriceRouter +Updates the cellar to use the latest price router in the registry. + +Represents function `cachePriceRouter(bool checkTotalAssets, uint16 allowableRange, address expectedPriceRouter)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| check_total_assets | [bool](#bool) | | Whether to check the total assets of the cellar | +| allowable_range | [uint32](#uint32) | | The allowable range of the cellar's total assets to deviate between old and new routers | +| expected_price_router | [string](#string) | | The expected price router address | + + + + + + + + +### CellarV2_5Governance.CallOnAdaptor +Allows strategists to manage their Cellar using arbitrary logic calls to adaptors. + +Represents function `callOnAdaptor(AdaptorCall[] memory data)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| data | [AdaptorCall](#steward-v4-AdaptorCall) | repeated | | + + + + + + + + +### CellarV2_5Governance.DecreaseShareSupplyCap +Allows strategist to decrease the share supply cap + +Represents function `decreaseShareSupplyCap(uint192)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| new_cap | [string](#string) | | | + + + + + + + + +### CellarV2_5Governance.ForcePositionOut +Allows caller to force a position out of the cellar + +Represents function `forcePositionOut(uint32 index, uint32 positionId, bool inDebtArray)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| index | [uint32](#uint32) | | | +| position_id | [uint32](#uint32) | | | +| in_debt_array | [bool](#bool) | | | + + + + + + + + +### CellarV2_5Governance.FunctionCall +The function you wish to execute on the target cellar + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| add_adaptor_to_catalogue | [CellarV2_5Governance.AddAdaptorToCatalogue](#steward-v4-CellarV2_5Governance-AddAdaptorToCatalogue) | | Represents function `addAdaptorToCatalogue(address adaptor)` | +| add_position_to_catalogue | [CellarV2_5Governance.AddPositionToCatalogue](#steward-v4-CellarV2_5Governance-AddPositionToCatalogue) | | Represents function `addPositionToCatalogue(uint32 positionId)` | +| set_rebalance_deviation | [CellarV2_5Governance.SetRebalanceDeviation](#steward-v4-CellarV2_5Governance-SetRebalanceDeviation) | | Represents function `setRebalanceDeviation(uint256)` | +| set_strategist_platform_cut | [CellarV2_5Governance.SetStrategistPlatformCut](#steward-v4-CellarV2_5Governance-SetStrategistPlatformCut) | | Represents function `setStrategistPlatformCut(uint64 cut)` | +| force_position_out | [CellarV2_5Governance.ForcePositionOut](#steward-v4-CellarV2_5Governance-ForcePositionOut) | | Represents function `forcePositionOut(uint32 index, uint32 positionId, bool inDebtArray)` | +| toggle_ignore_pause | [CellarV2_5Governance.ToggleIgnorePause](#steward-v4-CellarV2_5Governance-ToggleIgnorePause) | | Represents function `toggleIgnorePause()` | +| set_share_price_oracle | [CellarV2_5Governance.SetSharePriceOracle](#steward-v4-CellarV2_5Governance-SetSharePriceOracle) | | Represents function `setSharePriceOracle(uint256 _registryId, ERC4626SharePriceOracle _sharePriceOracle)` | +| increase_share_supply_cap | [CellarV2_5Governance.IncreaseShareSupplyCap](#steward-v4-CellarV2_5Governance-IncreaseShareSupplyCap) | | Represents function `increaseShareSupplyCap(uint192 _newShareSupplyCap)` | +| set_automation_actions | [CellarV2_5Governance.SetAutomationActions](#steward-v4-CellarV2_5Governance-SetAutomationActions) | | Represents function `setAutomatiionActions(uint256 _registryId, address _expectedAutomationActions)` | +| cache_price_router | [CellarV2_5Governance.CachePriceRouter](#steward-v4-CellarV2_5Governance-CachePriceRouter) | | Represents function `cachePriceRouter(bool checkTotalAssets, uint16 allowableRange, address expectedPriceRouter)` | +| initiate_shutdown | [CellarV2_5Governance.InitiateShutdown](#steward-v4-CellarV2_5Governance-InitiateShutdown) | | Represents function `initiateShutdown()` | +| lift_shutdown | [CellarV2_5Governance.LiftShutdown](#steward-v4-CellarV2_5Governance-LiftShutdown) | | Represents function `liftShutdown()` | +| remove_adaptor_from_catalogue | [CellarV2_5Governance.RemoveAdaptorFromCatalogue](#steward-v4-CellarV2_5Governance-RemoveAdaptorFromCatalogue) | | Represents function `removeAdaptorFromCatalogue(address adaptor)` | +| remove_position_from_catalogue | [CellarV2_5Governance.RemovePositionFromCatalogue](#steward-v4-CellarV2_5Governance-RemovePositionFromCatalogue) | | Represents function `removePositionFromCatalogue(uint32 positionId)` | +| decrease_share_supply_cap | [CellarV2_5Governance.DecreaseShareSupplyCap](#steward-v4-CellarV2_5Governance-DecreaseShareSupplyCap) | | Represents function `decreaseShareSupplyCap(uint192) | +| set_holding_position | [CellarV2_5Governance.SetHoldingPosition](#steward-v4-CellarV2_5Governance-SetHoldingPosition) | | Represents function `setHoldingPosition(uint32 position_id)` | +| add_position | [CellarV2_5Governance.AddPosition](#steward-v4-CellarV2_5Governance-AddPosition) | | Represents function `addPosition(uint256 index, address position)` | +| call_on_adaptor | [CellarV2_5Governance.CallOnAdaptor](#steward-v4-CellarV2_5Governance-CallOnAdaptor) | | Represents function `callOnAdaptor(AdaptorCall[] memory data)` | +| remove_position | [CellarV2_5Governance.RemovePosition](#steward-v4-CellarV2_5Governance-RemovePosition) | | Represents function `removePosition(uint256 index)` | + + + + + + + + +### CellarV2_5Governance.IncreaseShareSupplyCap +Allows the caller to increase the share supply cap + +Represents function `increaseShareSupplyCap(uint192 _newShareSupplyCap)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| new_cap | [string](#string) | | | + + + + + + + + +### CellarV2_5Governance.InitiateShutdown +Shutdown the cellar. Used in an emergency or if the cellar has been deprecated. + +Represents function `initiateShutdown()` + + + + + + + + +### CellarV2_5Governance.LiftShutdown +Allows the owner to restart a shut down Cellar + +Represents function `liftShutdown()` + + + + + + + + +### CellarV2_5Governance.Multicall +Allows caller to call multiple functions in a single TX. + +Represents function `multicall(bytes[] data)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| function_calls | [CellarV2_5Governance.FunctionCall](#steward-v4-CellarV2_5Governance-FunctionCall) | repeated | | + + + + + + + + +### CellarV2_5Governance.RemoveAdaptorFromCatalogue +Allows callers to remove adaptors from this cellar's catalogue + +Represents function `removeAdaptorFromCatalogue(address adaptor)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| adaptor | [string](#string) | | | + + + + + + + + +### CellarV2_5Governance.RemovePosition +Remove the position at a given index from the list of positions used by the cellar. + +Represents function `removePosition(uint32 index, bool inDebtArray)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| index | [uint32](#uint32) | | Index at which to remove the position | +| in_debt_array | [bool](#bool) | | Whether to remove position from the debt array, or the credit array. | + + + + + + + + +### CellarV2_5Governance.RemovePositionFromCatalogue +Allows caller to remove positions from this cellar's catalogue + +Represents function `removePositionFromCatalogue(uint32 positionId)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| position_id | [uint32](#uint32) | | | + + + + + + + + +### CellarV2_5Governance.SetAutomationActions +Allows caller to set automation actions + +Represents function `setAutomatiionActions(uint256 _registryId, address _expectedAutomationActions)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| registry_id | [string](#string) | | The oracle registry ID | +| expected_automation_actions | [string](#string) | | The automation actions contract address | + + + + + + + + +### CellarV2_5Governance.SetHoldingPosition +Set the holding position used of the cellar. + +Represents function `setHoldingIndex(uint8 index)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| position_id | [uint32](#uint32) | | ID (index) of the new holding position to use | + + + + + + + + +### CellarV2_5Governance.SetRebalanceDeviation +Changes the cellar's allowed rebalance deviation, which is the percent the total assets of a cellar may deviate +during a `callOnAdaptor`(rebalance) call. The maximum allowed deviation is 100000000000000000 (0.1e18), or 10%. + +Represents function `setRebalanceDeviation(uint256)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| new_deviation | [string](#string) | | | + + + + + + + + +### CellarV2_5Governance.SetSharePriceOracle +Allows the caller to set the share price oracle contract + +Represents function `setSharePriceOracle(uint256 _registryId, ERC4626SharePriceOracle _sharePriceOracle)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| registry_id | [string](#string) | | The oracle registry ID | +| share_price_oracle | [string](#string) | | The oracle contract address | + + + + + + + + +### CellarV2_5Governance.SetStrategistPlatformCut +Allows strategist to set the platform cut for the cellar. + +Represents function `setStrategistPlatformCut(uint64 cut)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| new_cut | [uint64](#uint64) | | The new strategist platform cut | + + + + + + + + +### CellarV2_5Governance.ToggleIgnorePause +Allows caller to toggle the ignorePause flag on the cellar + +Represents function `toggleIgnorePause()` + + + + + + + + + + + + + + + + +

Top

+ +## collateral_f_token.proto + + + + + +### CollateralFTokenAdaptorV1 +Represents call data for the Frax Collateral F Token adaptor. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| revoke_approval | [RevokeApproval](#steward-v4-RevokeApproval) | | Represents function `revokeApproval(ERC20 asset, address spender)` | +| add_collateral | [CollateralFTokenAdaptorV1.AddCollateral](#steward-v4-CollateralFTokenAdaptorV1-AddCollateral) | | Represents function `addCollateral(IFToken _fraxlendPair, uint256 _collateralToDeposit)` | +| remove_collateral | [CollateralFTokenAdaptorV1.RemoveCollateral](#steward-v4-CollateralFTokenAdaptorV1-RemoveCollateral) | | Represents function `removeCollateral(uint256 _collateralAmount, IFToken _fraxlendPair)` | + + + + + + + + +### CollateralFTokenAdaptorV1.AddCollateral +Allows strategists to add collateral to the respective cellar position on FraxLend, enabling borrowing. + +Represents function `addCollateral(IFToken _fraxlendPair, uint256 _collateralToDeposit)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| fraxlend_pair | [string](#string) | | The FraxLend pair to add collateral to. | +| collateral_to_deposit | [string](#string) | | The amount of collateral to add to the cellar position. | - -### CellarV1.SetHoldingPosition -Set the holding position used by the cellar. + -Represents function `setHoldingPosition(address newHoldingPosition)` +### CollateralFTokenAdaptorV1.RemoveCollateral +Allows strategists to remove collateral from the respective cellar position on FraxLend. + +Represents function `removeCollateral(uint256 _collateralAmount, IFToken _fraxlendPair)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| new_holding_position | [string](#string) | | Address of the new holding position to use | +| collateral_amount | [string](#string) | | The amount of collateral to remove from the cellar position. | +| fraxlend_pair | [string](#string) | | The FraxLend pair to remove collateral from. | - + -### CellarV1.SetLiquidityLimit -Set the maximum liquidity that cellar can manage. Uses the same decimals as the current asset. +### CollateralFTokenAdaptorV1Calls -Represents function `setLiquidityLimit()` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| new_limit | [string](#string) | | | +| calls | [CollateralFTokenAdaptorV1](#steward-v4-CollateralFTokenAdaptorV1) | repeated | | + - + -### CellarV1.SetRebalanceDeviation -Represents function `setRebalanceDeviation(uint256)` + + + + + + + +

Top

+ +## common.proto + + + + + +### MarketParams +Represents parameters for a Morpho Blue market | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| new_deviation | [string](#string) | | | - +| loan_token | [string](#string) | | The address of the loan token | +| collateral_token | [string](#string) | | The address of the collateral token | +| oracle | [string](#string) | | The address of the oracle | +| irm | [string](#string) | | The address of the interest rate model | +| lltv | [string](#string) | | The loan-to-value ratio | - -### CellarV1.SetShareLockPeriod -Allows share lock period to be updated. + -Represents function `setShareLockPeriod()` +### OracleSwapParams +Represents swap params for BaseAdaptor.oracleSwap() | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| new_lock | [string](#string) | | | - +| univ2_params | [UniV2OracleSwapParams](#steward-v4-UniV2OracleSwapParams) | | | +| univ3_params | [UniV3OracleSwapParams](#steward-v4-UniV3OracleSwapParams) | | | - -### CellarV1.SetStrategistPayoutAddress -Sets the Strategists payout address. + -Represents function `setStrategistPayoutAddress(address payout)` +### SwapParams +Represents swap parameters for an exchange | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| payout | [string](#string) | | | - +| univ2_params | [UniV2SwapParams](#steward-v4-UniV2SwapParams) | | Params for a Uniswap V2 swap | +| univ3_params | [UniV3SwapParams](#steward-v4-UniV3SwapParams) | | Params for a Uniswap V3 swap | - -### CellarV1.SetWithdrawType -Set the withdraw type used by the cellar. + -Represents function `setWithdrawType(WithdrawType newWithdrawType)` +### UniV2OracleSwapParams +Represents oracle swap parameters for UniswapV2 | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| new_withdraw_type | [CellarV1.WithdrawType](#steward-v4-CellarV1-WithdrawType) | | The withdraw type to use for the cellar | +| path | [string](#string) | repeated | Array of addresses dictating what swap path to follow | - + + +### UniV2SwapParams +Represents swap parameters for UniswapV2 + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| path | [string](#string) | repeated | Array of addresses dictating what swap path to follow | +| amount | [string](#string) | | Amount of the first asset in the path to swap | +| amount_out_min | [string](#string) | | The minimum amount of the last asset in the path to receive | + + -### CellarV1.SwapPositions -Swap the positions at two given indeces. -Represents function `swapPositions(uint256 index1, uint256 index2)` + + + + +### UniV3OracleSwapParams +Represents oracle swap parameters for UniswapV3 | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| index_1 | [string](#string) | | Index of the first position | -| index_2 | [string](#string) | | Index of the second position | +| path | [string](#string) | repeated | Array of addresses dictating what swap path to follow | +| pool_fees | [uint32](#uint32) | repeated | Array of pool fees dictating what swap pools to use | - + -### CellarV1Governance -Represent a function call initiated through a governance proposal +### UniV3SwapParams +Represents swap parameters for UniswapV3 | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| initiate_shutdown | [CellarV1Governance.InitiateShutdown](#steward-v4-CellarV1Governance-InitiateShutdown) | | Represents function `initiateShutdown()` | -| lift_shutdown | [CellarV1Governance.LiftShutdown](#steward-v4-CellarV1Governance-LiftShutdown) | | Represents function `liftShutdown()` | -| reset_high_watermark | [CellarV1Governance.ResetHighWatermark](#steward-v4-CellarV1Governance-ResetHighWatermark) | | Represents function `resetHighWatermark()` | -| set_fees_distributor | [CellarV1Governance.SetFeesDistributor](#steward-v4-CellarV1Governance-SetFeesDistributor) | | Represents function `setFeesDistributor(address)` | -| set_performance_fee | [CellarV1Governance.SetPerformanceFee](#steward-v4-CellarV1Governance-SetPerformanceFee) | | Represents function `setPerformanceFee(uint256)` | -| set_platform_fee | [CellarV1Governance.SetPlatformFee](#steward-v4-CellarV1Governance-SetPlatformFee) | | Represents function `setPlatformFee(uint256)` | -| set_strategist_performance_cut | [CellarV1Governance.SetStrategistPerformanceCut](#steward-v4-CellarV1Governance-SetStrategistPerformanceCut) | | Represents function `setStrategistPerformanceCut(uint256)` | -| set_strategist_platform_cut | [CellarV1Governance.SetStrategistPlatformCut](#steward-v4-CellarV1Governance-SetStrategistPlatformCut) | | Represents function `setStrategistPlatformCut(address)` | -| trust_position | [CellarV1Governance.TrustPosition](#steward-v4-CellarV1Governance-TrustPosition) | | Represents function `trustPosition(address)` | +| path | [string](#string) | repeated | Array of addresses dictating what swap path to follow | +| pool_fees | [uint32](#uint32) | repeated | Array of pool fees dictating what swap pools to use | +| amount | [string](#string) | | Amount of the first asset in the path to swap | +| amount_out_min | [string](#string) | | The minimum amount of the last asset in the path to receive | + - -### CellarV1Governance.InitiateShutdown -Represents function `initiateShutdown()` + + +### Exchange +Exchange selector +| Name | Number | Description | +| ---- | ------ | ----------- | +| EXCHANGE_UNSPECIFIED | 0 | | +| EXCHANGE_UNIV2 | 1 | Represents Uniswap V2 | +| EXCHANGE_UNIV3 | 2 | Represents Uniswap V3 | + + + - -### CellarV1Governance.LiftShutdown -Represents function `liftShutdown()` + +

Top

+## convex_curve.proto + - +### ConvexCurveAdaptorV1 +Represents call data for the Convex Curve adaptor V1 -### CellarV1Governance.ResetHighWatermark -Represents function `resetHighWatermark()` +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| revoke_approval | [RevokeApproval](#steward-v4-RevokeApproval) | | Represents function `revokeApproval(ERC20 asset, address spender)` | +| deposit_lpt_in_convex_and_stake | [ConvexCurveAdaptorV1.DepositLPTInConvexAndStake](#steward-v4-ConvexCurveAdaptorV1-DepositLPTInConvexAndStake) | | Represents function `depositLPTInConvexAndStake(uint256 _pid, address baseRewardPool, ERC20 _lpt, CurvePool _pool, bytes4 _selector, uint256 _amount)` | +| withdraw_from_base_reward_pool_as_lpt | [ConvexCurveAdaptorV1.WithdrawFromBaseRewardPoolAsLPT](#steward-v4-ConvexCurveAdaptorV1-WithdrawFromBaseRewardPoolAsLPT) | | Represents function `withdrawFromBaseRewardPoolAsLPTaddress(_baseRewardPool, uint256 _amount, bool _claim)` | +| get_rewards | [ConvexCurveAdaptorV1.GetRewards](#steward-v4-ConvexCurveAdaptorV1-GetRewards) | | Represents function `getRewards(address _baseRewardPool, bool _claimExtras)` | - -### CellarV1Governance.SetFeesDistributor -Represents function `setFeesDistributor(bytes32)` + + +### ConvexCurveAdaptorV1.DepositLPTInConvexAndStake +Allows strategists to deposit and stake LPTs into Convex markets via the respective Convex market Booster contract + +Represents function `depositLPTInConvexAndStake(uint256 _pid, address baseRewardPool, ERC20 _lpt, CurvePool _pool, bytes4 _selector, uint256 _amount)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| new_fees_distributor | [string](#string) | | Cosmos address of the new fees distributor | +| pid | [string](#string) | | | +| base_reward_pool | [string](#string) | | | +| lpt | [string](#string) | | | +| pool | [string](#string) | | | +| selector | [string](#string) | | | +| amount_to_deposit | [string](#string) | | | - + -### CellarV1Governance.SetPerformanceFee -Represents function `setPerformanceFee(uint64)` +### ConvexCurveAdaptorV1.GetRewards +Allows strategists to get rewards for an Convex Booster without withdrawing/unwrapping from Convex market + +Represents function `getRewards(address _baseRewardPool, bool _claimExtras)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| amount | [uint64](#uint64) | | New performance fee | +| base_reward_pool | [string](#string) | | | +| claim_extras | [bool](#bool) | | | - + -### CellarV1Governance.SetPlatformFee -Represents function `setPlatformFee(uint64)` +### ConvexCurveAdaptorV1.WithdrawFromBaseRewardPoolAsLPT +Allows strategists to withdraw from Convex markets via Booster contract w/ or w/o claiming rewards + +Represents function `withdrawFromBaseRewardPoolAsLPTaddress(_baseRewardPool, uint256 _amount, bool _claim)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| amount | [uint64](#uint64) | | New platform fee | +| base_reward_pool | [string](#string) | | | +| amount_to_withdraw | [string](#string) | | | +| claim | [bool](#bool) | | | - + + +### ConvexCurveAdaptorV1Calls -### CellarV1Governance.SetStrategistPerformanceCut -Represents function `setStrategistPerformanceCut(uint64)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| amount | [uint64](#uint64) | | New strategist performance cut | +| calls | [ConvexCurveAdaptorV1](#steward-v4-ConvexCurveAdaptorV1) | repeated | | + + + + + + + - -### CellarV1Governance.SetStrategistPlatformCut -Represents function `setStrategistPlatformCut(uint64)` + + +

Top

+ +## curve.proto + + + + + +### CurveAdaptorV1 +Represents call data for the Curve adaptor V1 | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| amount | [uint64](#uint64) | | New strategist platform cut | +| revoke_approval | [RevokeApproval](#steward-v4-RevokeApproval) | | Represents function `revokeApproval(ERC20 asset, address spender)` | +| add_liquidity | [CurveAdaptorV1.AddLiquidity](#steward-v4-CurveAdaptorV1-AddLiquidity) | | Represents function `addLiquidity(address pool, ERC20 lpToken, uint256[] orderedUnderlyingTokenAmounts, uint256 minLPAmount, CurveGauge gauge, bytes4 selector)` | +| add_liquidity_eth | [CurveAdaptorV1.AddLiquidityETH](#steward-v4-CurveAdaptorV1-AddLiquidityETH) | | Represents function `addLiquidityETH(address pool, ERC20 lpToken, uint256[] orderedMinimumUnderlyingTokenAmountsOut, uint256 minLPAmount, bool useUnderlying, CurveGauge gauge, bytes4 selector)` | +| remove_liquidity | [CurveAdaptorV1.RemoveLiquidity](#steward-v4-CurveAdaptorV1-RemoveLiquidity) | | Represents function `removeLiquidity(address pool, ERC20 lpToken, uint256 lpTokenAmount, uint256[] orderedMinimumUnderlyingTokenAmountsOut, CurveGauge gauge, bytes4 selector)` | +| remove_liquidity_eth | [CurveAdaptorV1.RemoveLiquidityETH](#steward-v4-CurveAdaptorV1-RemoveLiquidityETH) | | Represents function `removeLiquidityETH(address pool, ERC20 lpToken, uint256 lpTokenAmount, uint256[] orderedMinimumUnderlyingTokenAmountsOut, bool useUnderlying, CurveGauge gauge, bytes4 selector)` | +| stake_in_gauge | [CurveAdaptorV1.StakeInGauge](#steward-v4-CurveAdaptorV1-StakeInGauge) | | Represents function `stakeInGauge(ERC20 lpToken, CurveGauge gauge, uint256 amount, CurvePool pool, bytes4 selector)` | +| unstake_from_gauge | [CurveAdaptorV1.UnstakeFromGauge](#steward-v4-CurveAdaptorV1-UnstakeFromGauge) | | Represents function `unstakeFromGauge(CurveGauge gauge, uint256 amount)` | +| claim_rewards | [CurveAdaptorV1.ClaimRewards](#steward-v4-CurveAdaptorV1-ClaimRewards) | | Represents function `claimRewards(CurveGauge gauge)` | - + -### CellarV1Governance.TrustPosition -Represents function `trustPosition(address)` +### CurveAdaptorV1.AddLiquidity +Allows strategist to add liquidity to Curve pairs that do NOT use the native asset. + +Represents function `addLiquidity(address pool, ERC20 lpToken, uint256[] orderedUnderlyingTokenAmounts, uint256 minLPAmount, CurveGauge gauge, bytes4 selector)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| erc20_address | [string](#string) | | | -| erc4626_address | [string](#string) | | | -| cellar_address | [string](#string) | | | +| pool | [string](#string) | | Address of the Curve pool | +| lp_token | [string](#string) | | Address of the LP token | +| ordered_underlying_token_amounts | [string](#string) | repeated | Minimum amount of each underlying token to receive | +| min_lp_amount | [string](#string) | | Minimum amount of LP tokens to receive | +| gauge | [string](#string) | | Address of the Curve gauge | +| selector | [string](#string) | | Selector of the function to call | - + - +### CurveAdaptorV1.AddLiquidityETH +Allows strategist to add liquidity to Curve pairs that use the native asset. -### CellarV1.WithdrawType -Represents the withdraw type to use for the cellar +Represents function `addLiquidityETH(address pool, ERC20 lpToken, uint256[] orderedUnderlyingTokenAmounts, uint256 minLPAmount, bool useUnderlying, CurveGauge gauge, bytes4 selector)` -| Name | Number | Description | -| ---- | ------ | ----------- | -| WITHDRAW_TYPE_UNSPECIFIED | 0 | | -| WITHDRAW_TYPE_ORDERLY | 1 | | -| WITHDRAW_TYPE_PROPORTIONAL | 2 | | +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| pool | [string](#string) | | Address of the Curve pool | +| lp_token | [string](#string) | | Address of the LP token | +| ordered_underlying_token_amounts | [string](#string) | repeated | Minimum amount of each underlying token to receive | +| min_lp_amount | [string](#string) | | Minimum amount of LP tokens to receive | +| use_underlying | [bool](#bool) | | Whether to use the underlying asset or the wrapped asset | +| gauge | [string](#string) | | Address of the Curve gauge | +| selector | [string](#string) | | Selector of the function to call | - - - - -

Top

+ -## cellar_v2.proto +### CurveAdaptorV1.ClaimRewards +Allows strategist to claim rewards from a gauge. +Represents function `claimRewards(CurveGauge gauge)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| gauge | [string](#string) | | Address of the Curve gauge | - -### AdaptorCall -Represents a call to adaptor an. The cellar must be authorized to call the target adaptor. + + + + + +### CurveAdaptorV1.RemoveLiquidity +Allows strategist to remove liquidity from Curve pairs that do NOT use the native asset. + +Represents function `removeLiquidity(address pool, ERC20 lpToken, uint256 lpTokenAmount, uint256[] orderedMinimumUnderlyingTokenAmountsOut, CurveGauge gauge, bytes4 selector)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| adaptor | [string](#string) | | Address of the adaptor | -| aave_a_token_v1_calls | [AaveATokenAdaptorV1Calls](#steward-v4-AaveATokenAdaptorV1Calls) | | Represents function calls to the AaveATokenAdaptor V1 | -| aave_debt_token_v1_calls | [AaveDebtTokenAdaptorV1Calls](#steward-v4-AaveDebtTokenAdaptorV1Calls) | | Represents function calls to the AavaDebtTokenAdaptor V1 | -| compound_c_token_v2_calls | [CompoundCTokenAdaptorV2Calls](#steward-v4-CompoundCTokenAdaptorV2Calls) | | Represents function calls to the CompoundCTokenAdaptor V2 | -| aave_a_token_v2_calls | [AaveATokenAdaptorV2Calls](#steward-v4-AaveATokenAdaptorV2Calls) | | Represents function calls to the AaveATokenV2Adaptor | -| aave_debt_token_v2_calls | [AaveDebtTokenAdaptorV2Calls](#steward-v4-AaveDebtTokenAdaptorV2Calls) | | Represents function calls to the AavaDebtTokenV2Adaptor | -| aave_v3_a_token_v1_calls | [AaveV3ATokenAdaptorV1Calls](#steward-v4-AaveV3ATokenAdaptorV1Calls) | | Represents function calls to the AaveATokenV1Adaptor | -| aave_v3_debt_token_v1_calls | [AaveV3DebtTokenAdaptorV1Calls](#steward-v4-AaveV3DebtTokenAdaptorV1Calls) | | Represents function calls to the AavaDebtTokenV1Adaptor | -| one_inch_v1_calls | [OneInchAdaptorV1Calls](#steward-v4-OneInchAdaptorV1Calls) | | Represents function calls to the OneInchAdaptorV1 | -| fees_and_reserves_v1_calls | [FeesAndReservesAdaptorV1Calls](#steward-v4-FeesAndReservesAdaptorV1Calls) | | Represents function calls to the FeesAndReservesAdaptorV1 | -| zero_x_v1_calls | [ZeroXAdaptorV1Calls](#steward-v4-ZeroXAdaptorV1Calls) | | Represents functionc alls to the ZeroXAdaptorV1 | -| swap_with_uniswap_v1_calls | [SwapWithUniswapAdaptorV1Calls](#steward-v4-SwapWithUniswapAdaptorV1Calls) | | Represents function calls to the SwapWithUniswapAdaptorV1 | -| vesting_simple_v2_calls | [VestingSimpleAdaptorV2Calls](#steward-v4-VestingSimpleAdaptorV2Calls) | | Represents function calls to VestingSimpleAdaptor | -| cellar_v1_calls | [CellarAdaptorV1Calls](#steward-v4-CellarAdaptorV1Calls) | | Represents function calls to the CellarAdaptor | -| uniswap_v3_v2_calls | [UniswapV3AdaptorV2Calls](#steward-v4-UniswapV3AdaptorV2Calls) | | Represents function calls to the UniswapV3Adaptor V2 | -| aave_v2_enable_asset_as_collateral_v1_calls | [AaveV2EnableAssetAsCollateralAdaptorV1Calls](#steward-v4-AaveV2EnableAssetAsCollateralAdaptorV1Calls) | | Represents function calls to the AaveV2EnableAssetAsCollatorAdaptor V1 | -| f_token_v1_calls | [FTokenAdaptorV1Calls](#steward-v4-FTokenAdaptorV1Calls) | | Represents function calls to the FTokenAdaptor V1 | -| morpho_aave_v2_a_token_v1_calls | [MorphoAaveV2ATokenAdaptorV1Calls](#steward-v4-MorphoAaveV2ATokenAdaptorV1Calls) | | Represents function calls to the MorphoAaveV2AToken V1 | -| morpho_aave_v2_debt_token_v1_calls | [MorphoAaveV2DebtTokenAdaptorV1Calls](#steward-v4-MorphoAaveV2DebtTokenAdaptorV1Calls) | | Represents function calls to the MorphoAaveV2DebtToken V1 | -| morpho_aave_v3_a_token_collateral_v1_calls | [MorphoAaveV3ATokenCollateralAdaptorV1Calls](#steward-v4-MorphoAaveV3ATokenCollateralAdaptorV1Calls) | | Represents function calls to the MorphoAaveV3ATokenCollateral V1 | -| morpho_aave_v3_a_token_p2p_v1_calls | [MorphoAaveV3ATokenP2PAdaptorV1Calls](#steward-v4-MorphoAaveV3ATokenP2PAdaptorV1Calls) | | Represents function calls to the MorphoAaveV3ATokenP2P V1 | -| morpho_aave_v3_debt_token_v1_calls | [MorphoAaveV3DebtTokenAdaptorV1Calls](#steward-v4-MorphoAaveV3DebtTokenAdaptorV1Calls) | | Represents function calls to the MorphoAaveV3DebtToken V1 | +| pool | [string](#string) | | Address of the Curve pool | +| lp_token | [string](#string) | | Address of the LP token | +| lp_token_amount | [string](#string) | | Amount of LP tokens to remove | +| ordered_minimum_underlying_token_amounts_out | [string](#string) | repeated | Minimum amount of each underlying token to receive | +| gauge | [string](#string) | | Address of the Curve gauge | +| selector | [string](#string) | | Selector of the function to call | - + -### CellarV2 -Represents a function call to a cellar that implements Cellar.sol +### CurveAdaptorV1.RemoveLiquidityETH +Allows strategist to remove liquidity from Curve pairs that use the native asset. + +Represents function `removeLiquidityETH(address pool, ERC20 lpToken, uint256 lpTokenAmount, uint256[] orderedMinimumUnderlyingTokenAmountsOut, bool useUnderlying, CurveGauge gauge, bytes4 selector)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| add_position | [CellarV2.AddPosition](#steward-v4-CellarV2-AddPosition) | | Represents function `addPosition(uint256 index, address position)` | -| call_on_adaptor | [CellarV2.CallOnAdaptor](#steward-v4-CellarV2-CallOnAdaptor) | | Represents function `callOnAdaptor(AdaptorCall[] memory data)` | -| remove_position | [CellarV2.RemovePosition](#steward-v4-CellarV2-RemovePosition) | | Represents function `removePosition(uint256 index)` | -| set_holding_position | [CellarV2.SetHoldingPosition](#steward-v4-CellarV2-SetHoldingPosition) | | Represents function `setHoldingPosition(uint32 position_id)` | -| set_strategist_payout_address | [CellarV2.SetStrategistPayoutAddress](#steward-v4-CellarV2-SetStrategistPayoutAddress) | | Represents function `setStrategistPayoutAddress(address payout)` | -| swap_positions | [CellarV2.SwapPositions](#steward-v4-CellarV2-SwapPositions) | | Represents function `swapPositions(uint256 index1, uint256 index2)` | -| set_rebalance_deviation | [CellarV2.SetRebalanceDeviation](#steward-v4-CellarV2-SetRebalanceDeviation) | | Represents function `setRebalanceDeviation(uint265)` | -| set_share_lock_period | [CellarV2.SetShareLockPeriod](#steward-v4-CellarV2-SetShareLockPeriod) | | Represents function `setShareLockPeriod(uint256 newLock)` | +| pool | [string](#string) | | Address of the Curve pool | +| lp_token | [string](#string) | | Address of the LP token | +| lp_token_amount | [string](#string) | | Amount of LP tokens to remove | +| ordered_minimum_underlying_token_amounts_out | [string](#string) | repeated | Minimum amount of each underlying token to receive | +| use_underlying | [bool](#bool) | | Whether to use the underlying asset or the wrapped asset | +| gauge | [string](#string) | | Address of the Curve gauge | +| selector | [string](#string) | | Selector of the function to call | + + + + + + + + +### CurveAdaptorV1.StakeInGauge +Allows strategist to stake Curve LP tokens in their gauge. + +Represents function `stakeInGauge(ERC20 lpToken, CurveGauge gauge, uint256 amount, CurvePool pool, bytes4 selector)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| lp_token | [string](#string) | | Address of the LP token | +| gauge | [string](#string) | | Address of the Curve gauge | +| amount | [string](#string) | | Amount of LP tokens to stake | +| pool | [string](#string) | | Address of the Curve pool | +| selector | [string](#string) | | Selector of the function to call | - + -### CellarV2.AddPosition -Insert a trusted position to the list of positions used by the cellar at a given index. +### CurveAdaptorV1.UnstakeFromGauge +Allows strategist to unstake Curve LP tokens from their gauge. -Represents function `addPosition(uint32 index, uint32 positionId, bytes configurationData, bool inDebtArray)` +Represents function `unstakeFromGauge(CurveGauge gauge, uint256 amount)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| index | [uint32](#uint32) | | Index at which to add the position | -| position_id | [uint32](#uint32) | | The position's ID in the cellar registry | -| configuration_data | [bytes](#bytes) | | Data used to configure how the position behaves | -| in_debt_array | [bool](#bool) | | Whether to add position in the debt array, or the credit array. | +| gauge | [string](#string) | | Address of the Curve gauge | +| amount | [string](#string) | | Amount of LP tokens to unstake | - + -### CellarV2.CallOnAdaptor -Allows strategists to manage their Cellar using arbitrary logic calls to adaptors. +### CurveAdaptorV1Calls -Represents function `callOnAdaptor(AdaptorCall[] memory data)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| data | [AdaptorCall](#steward-v4-AdaptorCall) | repeated | | - +| calls | [CurveAdaptorV1](#steward-v4-CurveAdaptorV1) | repeated | | - - -### CellarV2.RemovePosition -Remove the position at a given index from the list of positions used by the cellar. + -Represents function `removePosition(uint32 index, bool inDebtArray)` + + -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| index | [uint32](#uint32) | | Index at which to remove the position | -| in_debt_array | [bool](#bool) | | Whether to remove position from the debt array, or the credit array. | + + +

Top

+## debt_f_token.proto - -### CellarV2.SetHoldingPosition -Set the holding position used of the cellar. + -Represents function `setHoldingIndex(uint8 index)` +### DebtFTokenAdaptorV1 +Represents call data for the Frax adaptor. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| position_id | [uint32](#uint32) | | ID (index) of the new holding position to use | +| revoke_approval | [RevokeApproval](#steward-v4-RevokeApproval) | | Represents function `revokeApproval(ERC20 asset, address spender)` | +| borrow_from_fraxlend | [DebtFTokenAdaptorV1.BorrowFromFraxlend](#steward-v4-DebtFTokenAdaptorV1-BorrowFromFraxlend) | | Represents function `borrowFromFraxlend(IFToken fraxlendPair, uint256 amountToBorrow)` | +| repay_fraxlend_debt | [DebtFTokenAdaptorV1.RepayFraxlendDebt](#steward-v4-DebtFTokenAdaptorV1-RepayFraxlendDebt) | | Represents function `repayFraxlendDebt(IFToken _fraxlendPair, uint256 _debtTokenRepayAmount)` | +| call_add_interest | [DebtFTokenAdaptorV1.CallAddInterest](#steward-v4-DebtFTokenAdaptorV1-CallAddInterest) | | Represents function `callAddInterest(IFToken _fraxlendPair)` | - + -### CellarV2.SetRebalanceDeviation -Changes the cellar's allowed rebalance deviation, which is the percent the total assets of a cellar may deviate -during a `callOnAdaptor`(rebalance) call. The maximum allowed deviation is 100000000000000000 (0.1e18), or 10%. +### DebtFTokenAdaptorV1.BorrowFromFraxlend +Allows a strategist to borrow assets from Fraxlend -Represents function `setRebalanceDeviation(uint256)` +Represents `function borrowFromFraxlend(IFToken fraxlendPair, uint256 amountToBorrow)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| new_deviation | [string](#string) | | | +| fraxlend_pair | [string](#string) | | The address of the Frax Pair to borrow from. | +| amount_to_borrow | [string](#string) | | The amount of the asset to borrow. | - + -### CellarV2.SetShareLockPeriod -Allows share lock period to be updated. +### DebtFTokenAdaptorV1.CallAddInterest +Allows a strategist to call `addInterest` on a Frax Pair they are using -Represents function `setShareLockPeriod()` +Represents `function callAddInterest(IFToken _fraxlendPair)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| new_lock | [string](#string) | | | +| fraxlend_pair | [string](#string) | | The address of the pair to call addInterest on. | - + -### CellarV2.SetStrategistPayoutAddress -Sets the Strategists payout address. +### DebtFTokenAdaptorV1.RepayFraxlendDebt +Allows strategists to repay loan debt on Fraxlend Pair. +Make sure to call addInterest() beforehand to ensure we are repaying what is required. -Represents function `setStrategistPayoutAddress(address payout)` +Represents `function repayFraxlendDebt(IFToken _fraxlendPair, uint256 _debtTokenRepayAmount)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| payout | [string](#string) | | | +| fraxlend_pair | [string](#string) | | The address of the Frax Pair to repay debt on. | +| debt_token_repay_amount | [string](#string) | | The amount of the debt token to repay. | - + -### CellarV2.SwapPositions -Swap the positions at two given indeces. +### DebtFTokenAdaptorV1Calls -Represents function `swapPositions(uint32 index1, uint32 index2)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| index_1 | [uint32](#uint32) | | Index of the first position | -| index_2 | [uint32](#uint32) | | Index of the second position | -| in_debt_array | [bool](#bool) | | Whether to switch positions in the debt array, or the credit array. | +| calls | [DebtFTokenAdaptorV1](#steward-v4-DebtFTokenAdaptorV1) | repeated | | + - + -### CellarV2Governance -Represent a function call initiated through a governance proposal + + -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| initiate_shutdown | [CellarV2Governance.InitiateShutdown](#steward-v4-CellarV2Governance-InitiateShutdown) | | Represents function `initiateShutdown()` | -| lift_shutdown | [CellarV2Governance.LiftShutdown](#steward-v4-CellarV2Governance-LiftShutdown) | | Represents function `liftShutdown()` | -| set_platform_fee | [CellarV2Governance.SetPlatformFee](#steward-v4-CellarV2Governance-SetPlatformFee) | | Represents function `setPlatformFee(uint256)` | -| set_strategist_platform_cut | [CellarV2Governance.SetStrategistPlatformCut](#steward-v4-CellarV2Governance-SetStrategistPlatformCut) | | Represents function `setStrategistPlatformCut(address)` | -| setup_adaptor | [CellarV2Governance.SetupAdaptor](#steward-v4-CellarV2Governance-SetupAdaptor) | | Represents function `setupAdaptor(address adaptor)` | + +

Top

+## debt_token.proto - + -### CellarV2Governance.InitiateShutdown -Represents function `initiateShutdown()` +### AaveDebtTokenAdaptorV1 +Represents call data for the Aave Debt Token adaptor V1, used for borrowing and repaying debt on Aave. +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| swap | [Swap](#steward-v4-Swap) | | Represents function `swap(ERC20 assetIn, ERC20 assetOut, uint256 amountIn, SwapRouter.Exchange exchange, bytes memory params)` | +| oracle_swap | [OracleSwap](#steward-v4-OracleSwap) | | Represents function `oracleSwap(ERC20 assetIn, ERC20 assetOut, uint256 amountIn, SwapRouter.Exchange exchange, bytes memory params, uint64 slippage)` | +| revoke_approval | [RevokeApproval](#steward-v4-RevokeApproval) | | Represents function `revokeApproval(ERC20 asset, address spender)` | +| borrow_from_aave | [AaveDebtTokenAdaptorV1.BorrowFromAave](#steward-v4-AaveDebtTokenAdaptorV1-BorrowFromAave) | | Represents function `borrowFromAave(ERC20 debtTokenToBorrow, uint256 amountToBorrow)` | +| repay_aave_debt | [AaveDebtTokenAdaptorV1.RepayAaveDebt](#steward-v4-AaveDebtTokenAdaptorV1-RepayAaveDebt) | | Represents function `repayAaveDebt(ERC20 tokenToRepay, uint256 amountToRepay)` | +| swap_and_repay | [AaveDebtTokenAdaptorV1.SwapAndRepay](#steward-v4-AaveDebtTokenAdaptorV1-SwapAndRepay) | | Represents function `swapAndRepay(ERC20 tokenIn, ERC20 tokenToRepay, uint256 amountIn, SwapRouter.Exchange exchange, bytes memory params)` | - -### CellarV2Governance.LiftShutdown -Represents function `liftShutdown()` + + +### AaveDebtTokenAdaptorV1.BorrowFromAave +Allows strategists to borrow assets from Aave. + +Represents function `depositToAave(ERC20 tokenToDeposit, uint256 amountToDeposit)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| token | [string](#string) | | The address of the ERC20 token to borrow | +| amount | [string](#string) | | The amount to borrow | - -### CellarV2Governance.SetPlatformFee -Represents function `setPlatformFee(uint64)` + + +### AaveDebtTokenAdaptorV1.RepayAaveDebt +Allows strategists to repay loan debt on Aave. + +Represents function `repayAaveDebt(ERC20 tokenToRepay, uint256 amountToRepay)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| amount | [uint64](#uint64) | | New platform fee | +| token | [string](#string) | | The address of the ERC20 token to repay | +| amount | [string](#string) | | The amount to repay | - + -### CellarV2Governance.SetStrategistPlatformCut -Represents function `setStrategistPlatformCut(uint64)` +### AaveDebtTokenAdaptorV1.SwapAndRepay +Allows strategists to swap assets and repay loans in one call. + +Represents function `swapAndRepay(ERC20 tokenIn, ERC20 tokenToRepay, uint256 amountIn, SwapRouter.Exchange exchange, bytes memory params)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| amount | [uint64](#uint64) | | New strategist platform cut | +| token_in | [string](#string) | | The address of the token to swap from | +| token_to_repay | [string](#string) | | The address of the token to swap to and repay with | +| amount_in | [string](#string) | | The amount to swap | +| exchange | [Exchange](#steward-v4-Exchange) | | The exchange to make the swap on | +| params | [SwapParams](#steward-v4-SwapParams) | | The parameters for the swap | - + -### CellarV2Governance.SetupAdaptor -Allows owner to add new adaptors for the cellar to use. +### AaveDebtTokenAdaptorV1Calls -Represents function `setupAdaptor(address adaptor)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| adaptor | [string](#string) | | Address of the adaptor | - +| calls | [AaveDebtTokenAdaptorV1](#steward-v4-AaveDebtTokenAdaptorV1) | repeated | | - -### CellarV2_2 + +### AaveDebtTokenAdaptorV2 +Represents call data for the Aave Debt Token adaptor V2, used for borrowing and repaying debt on Aave. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| function_call | [CellarV2_2.FunctionCall](#steward-v4-CellarV2_2-FunctionCall) | | Represents a single function call | -| multicall | [CellarV2_2.Multicall](#steward-v4-CellarV2_2-Multicall) | | Represents multiple, ordered function calls | +| revoke_approval | [RevokeApproval](#steward-v4-RevokeApproval) | | Represents function `revokeApproval(ERC20 asset, address spender)` | +| borrow_from_aave | [AaveDebtTokenAdaptorV2.BorrowFromAave](#steward-v4-AaveDebtTokenAdaptorV2-BorrowFromAave) | | Represents function `borrowFromAave(ERC20 debtTokenToBorrow, uint256 amountToBorrow)` | +| repay_aave_debt | [AaveDebtTokenAdaptorV2.RepayAaveDebt](#steward-v4-AaveDebtTokenAdaptorV2-RepayAaveDebt) | | Represents function `repayAaveDebt(ERC20 tokenToRepay, uint256 amountToRepay)` | - + -### CellarV2_2.AddPosition -Insert a trusted position to the list of positions used by the cellar at a given index. +### AaveDebtTokenAdaptorV2.BorrowFromAave +Allows strategists to borrow assets from Aave. -Represents function `addPosition(uint32 index, uint32 positionId, bytes configurationData, bool inDebtArray)` +Represents function `depositToAave(ERC20 tokenToDeposit, uint256 amountToDeposit)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| index | [uint32](#uint32) | | Index at which to add the position | -| position_id | [uint32](#uint32) | | The position's ID in the cellar registry | -| configuration_data | [bytes](#bytes) | | Data used to configure how the position behaves | -| in_debt_array | [bool](#bool) | | Whether to add position in the debt array, or the credit array. | +| token | [string](#string) | | The address of the ERC20 token to borrow | +| amount | [string](#string) | | The amount to borrow | - + -### CellarV2_2.CallOnAdaptor -Allows strategists to manage their Cellar using arbitrary logic calls to adaptors. +### AaveDebtTokenAdaptorV2.RepayAaveDebt +Allows strategists to repay loan debt on Aave. -Represents function `callOnAdaptor(AdaptorCall[] memory data)` +Represents function `repayAaveDebt(ERC20 tokenToRepay, uint256 amountToRepay)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| data | [AdaptorCall](#steward-v4-AdaptorCall) | repeated | | +| token | [string](#string) | | The address of the ERC20 token to repay | +| amount | [string](#string) | | The amount to repay | - + + +### AaveDebtTokenAdaptorV2Calls -### CellarV2_2.FunctionCall -The function you wish to execute on the target cellar | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| add_position | [CellarV2_2.AddPosition](#steward-v4-CellarV2_2-AddPosition) | | Represents function `addPosition(uint256 index, address position)` | -| call_on_adaptor | [CellarV2_2.CallOnAdaptor](#steward-v4-CellarV2_2-CallOnAdaptor) | | Represents function `callOnAdaptor(AdaptorCall[] memory data)` | -| remove_position | [CellarV2_2.RemovePosition](#steward-v4-CellarV2_2-RemovePosition) | | Represents function `removePosition(uint256 index)` | -| set_holding_position | [CellarV2_2.SetHoldingPosition](#steward-v4-CellarV2_2-SetHoldingPosition) | | Represents function `setHoldingPosition(uint32 position_id)` | -| set_strategist_payout_address | [CellarV2_2.SetStrategistPayoutAddress](#steward-v4-CellarV2_2-SetStrategistPayoutAddress) | | Represents function `setStrategistPayoutAddress(address payout)` | -| swap_positions | [CellarV2_2.SwapPositions](#steward-v4-CellarV2_2-SwapPositions) | | Represents function `swapPositions(uint256 index1, uint256 index2)` | -| set_rebalance_deviation | [CellarV2_2.SetRebalanceDeviation](#steward-v4-CellarV2_2-SetRebalanceDeviation) | | Represents function `setRebalanceDeviation(uint265)` | -| set_share_lock_period | [CellarV2_2.SetShareLockPeriod](#steward-v4-CellarV2_2-SetShareLockPeriod) | | Represents function `setShareLockPeriod(uint256 newLock)` | -| initiate_shutdown | [CellarV2_2.InitiateShutdown](#steward-v4-CellarV2_2-InitiateShutdown) | | Represents function `initiateShutdown()` | -| set_strategist_platform_cut | [CellarV2_2.SetStrategistPlatformCut](#steward-v4-CellarV2_2-SetStrategistPlatformCut) | | Represents function `setStrategistPlatformCut(uint64 cut)` | -| lift_shutdown | [CellarV2_2.LiftShutdown](#steward-v4-CellarV2_2-LiftShutdown) | | Represents function `liftShutdown()` | +| calls | [AaveDebtTokenAdaptorV2](#steward-v4-AaveDebtTokenAdaptorV2) | repeated | | + - + -### CellarV2_2.InitiateShutdown -Shutdown the cellar. Used in an emergency or if the cellar has been deprecated. + -Represents function `initiateShutdown()` + + +

Top

+## erc4626.proto - -### CellarV2_2.LiftShutdown -Allows the owner to restart a shut down Cellar + + +### ERC4626AdaptorV1 +Represents call data for the ERC4626 adaptor V1 -Represents function `liftShutdown()` +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| revoke_approval | [RevokeApproval](#steward-v4-RevokeApproval) | | Represents function `revokeApproval(ERC20 asset, address spender)` | +| deposit_to_vault | [ERC4626AdaptorV1.DepositToVault](#steward-v4-ERC4626AdaptorV1-DepositToVault) | | Represents function `depositToVault(ERC4626 erc4626Vault, uint256 assets)` | +| withdraw_from_vault | [ERC4626AdaptorV1.WithdrawFromVault](#steward-v4-ERC4626AdaptorV1-WithdrawFromVault) | | Represents function `withdrawFromVault(ERC4626 erc4626Vault, uint256 assets)` | - -### CellarV2_2.Multicall -Allows caller to call multiple functions in a single TX. + -Represents function `multicall(bytes[] data)` +### ERC4626AdaptorV1.DepositToVault +Allows strategists to deposit into ERC4626 positions. + +Represents function `depositToVault(ERC4626 erc4626Vault, uint256 assets)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| function_calls | [CellarV2_2.FunctionCall](#steward-v4-CellarV2_2-FunctionCall) | repeated | | +| erc4626_vault | [string](#string) | | The address of the ERC4626 vault | +| assets | [string](#string) | | The amount of assets to deposit | - + -### CellarV2_2.RemovePosition -Remove the position at a given index from the list of positions used by the cellar. +### ERC4626AdaptorV1.WithdrawFromVault +Allows strategists to withdraw from ERC4626 positions. -Represents function `removePosition(uint32 index, bool inDebtArray)` +Represents function `withdrawFromVault(ERC4626 erc4626Vault, uint256 assets)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| index | [uint32](#uint32) | | Index at which to remove the position | -| in_debt_array | [bool](#bool) | | Whether to remove position from the debt array, or the credit array. | +| erc4626_vault | [string](#string) | | The address of the ERC4626 vault | +| assets | [string](#string) | | The amount of assets to withdraw | - + -### CellarV2_2.SetHoldingPosition -Set the holding position used of the cellar. +### ERC4626AdaptorV1Calls -Represents function `setHoldingIndex(uint8 index)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| position_id | [uint32](#uint32) | | ID (index) of the new holding position to use | +| calls | [ERC4626AdaptorV1](#steward-v4-ERC4626AdaptorV1) | repeated | | + - + -### CellarV2_2.SetRebalanceDeviation -Changes the cellar's allowed rebalance deviation, which is the percent the total assets of a cellar may deviate -during a `callOnAdaptor`(rebalance) call. The maximum allowed deviation is 100000000000000000 (0.1e18), or 10%. + -Represents function `setRebalanceDeviation(uint256)` + + + + + +

Top

+ +## f_token.proto + + + + + +### FTokenAdaptorV1 +Represents call data for the Frax adaptor. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| new_deviation | [string](#string) | | | +| revoke_approval | [RevokeApproval](#steward-v4-RevokeApproval) | | Represents function `revokeApproval(ERC20 asset, address spender)` | +| lend_frax | [FTokenAdaptorV1.LendFrax](#steward-v4-FTokenAdaptorV1-LendFrax) | | Represents function `lendFrax(IFToken fToken, uint256 amountToDeposit)` | +| redeem_frax_share | [FTokenAdaptorV1.RedeemFraxShare](#steward-v4-FTokenAdaptorV1-RedeemFraxShare) | | Represents function `redeemFraxShare(IFToken fToken, uint256 amountToRedeem)` | +| withdraw_frax | [FTokenAdaptorV1.WithdrawFrax](#steward-v4-FTokenAdaptorV1-WithdrawFrax) | | Represents function `withdrawFrax(IFToken fToken, uint256 amountToWithdraw)` | +| call_add_interest | [FTokenAdaptorV1.CallAddInterest](#steward-v4-FTokenAdaptorV1-CallAddInterest) | | Represents function `callAddInterest(IFToken fToken)` | - + -### CellarV2_2.SetShareLockPeriod -Allows share lock period to be updated. +### FTokenAdaptorV1.CallAddInterest +Allows a strategist to call `addInterest` on a Frax Pair they are using -Represents function `setShareLockPeriod()` +Represents `function callAddInterest(IFToken fToken)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| new_lock | [string](#string) | | | +| f_token | [string](#string) | | The address of the fToken to call `addInterest` on. | - + -### CellarV2_2.SetStrategistPayoutAddress -Sets the Strategists payout address. +### FTokenAdaptorV1.LendFrax +Allows strategists to lend FRAX on FraxLend -Represents function `setStrategistPayoutAddress(address payout)` +Represents `function lendFrax(IFToken fToken, uint256 amountToDeposit)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| payout | [string](#string) | | | +| f_token | [string](#string) | | The address of the fToken to lend. | +| amount_to_deposit | [string](#string) | | The amount of the fToken to lend. | - + -### CellarV2_2.SetStrategistPlatformCut -Allows strategist to set the platform cut for the cellar. +### FTokenAdaptorV1.RedeemFraxShare +Allows strategists to redeem FRAX shares on FraxLend -Represents function `setStrategistPlatformCut(uint64 cut)` +Represents `function redeemFraxShare(IFToken fToken, uint256 amountToRedeem)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| new_cut | [uint64](#uint64) | | The new strategist platform cut | +| f_token | [string](#string) | | The address of the fToken to redeem. | +| amount_to_redeem | [string](#string) | | The amount of the fToken to redeem. | - + -### CellarV2_2.SwapPositions -Swap the positions at two given indeces. +### FTokenAdaptorV1.WithdrawFrax +Allows strategists to withdraw FRAX from FraxLend -Represents function `swapPositions(uint32 index1, uint32 index2)` +Represents `function withdrawFrax(IFToken fToken, uint256 amountToWithdraw)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| index_1 | [uint32](#uint32) | | Index of the first position | -| index_2 | [uint32](#uint32) | | Index of the second position | -| in_debt_array | [bool](#bool) | | Whether to switch positions in the debt array, or the credit array. | +| f_token | [string](#string) | | The address of the fToken to withdraw. | +| amount_to_withdraw | [string](#string) | | The amount of the fToken to withdraw. | - + + +### FTokenAdaptorV1Calls -### CellarV2_2Governance -Represent a function call initiated through a governance proposal | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| add_adaptor_to_catalogue | [CellarV2_2Governance.AddAdaptorToCatalogue](#steward-v4-CellarV2_2Governance-AddAdaptorToCatalogue) | | Represents function `addAdaptorToCatalogue(address adaptor)` | -| add_position_to_catalogue | [CellarV2_2Governance.AddPositionToCatalogue](#steward-v4-CellarV2_2Governance-AddPositionToCatalogue) | | Represents function `addPositionToCatalogue(uint32 positionId)` | -| remove_adaptor_from_catalogue | [CellarV2_2Governance.RemoveAdaptorFromCatalogue](#steward-v4-CellarV2_2Governance-RemoveAdaptorFromCatalogue) | | Represents function `removeAdaptorFromCatalogue(address adaptor)` | -| remove_position_from_catalogue | [CellarV2_2Governance.RemovePositionFromCatalogue](#steward-v4-CellarV2_2Governance-RemovePositionFromCatalogue) | | Represents function `removePositionFromCatalogue(uint32 positionId)` | -| force_position_out | [CellarV2_2Governance.ForcePositionOut](#steward-v4-CellarV2_2Governance-ForcePositionOut) | | Represents function `forcePositionOut(uint32 index, uint32 positionId, bool inDebtArray)` | -| toggle_ignore_pause | [CellarV2_2Governance.ToggleIgnorePause](#steward-v4-CellarV2_2Governance-ToggleIgnorePause) | | Represents function `toggleIgnorePause(bool ignore)` | - - +| calls | [FTokenAdaptorV1](#steward-v4-FTokenAdaptorV1) | repeated | | - -### CellarV2_2Governance.AddAdaptorToCatalogue -Allows the owner to add an adaptor to the Cellar's adaptor catalogue + -Represents function `addAdaptorToCatalogue(address adaptor)` + + -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| adaptor | [string](#string) | | | + + +

Top

+## fees_and_reserves.proto - -### CellarV2_2Governance.AddPositionToCatalogue -Allows the owner to add a position to the Cellar's position catalogue + -Represents function `addPositionToCatalogue(uint32 positionId)` +### FeesAndReservesAdaptorV1 +Represents call data for the FeesAndReserves and FeesAndReservesAdaptor contracts. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| position_id | [uint32](#uint32) | | | +| revoke_approval | [RevokeApproval](#steward-v4-RevokeApproval) | | Represents function `revokeApproval(ERC20 asset, address spender)` | +| update_performance_fees | [FeesAndReservesAdaptorV1.UpdatePerformanceFees](#steward-v4-FeesAndReservesAdaptorV1-UpdatePerformanceFees) | | Represents function `updatePerformanceFee(uint32 performanceFee)` | +| update_management_fees | [FeesAndReservesAdaptorV1.UpdateManagementFees](#steward-v4-FeesAndReservesAdaptorV1-UpdateManagementFees) | | Represents function `updateManagementFee(uint32 managementFee)` | +| change_upkeep_frequency | [FeesAndReservesAdaptorV1.ChangeUpkeepFrequency](#steward-v4-FeesAndReservesAdaptorV1-ChangeUpkeepFrequency) | | Represents function `changeUpkeepFrequency(uint64 newFrequency)` | +| change_upkeep_max_gas | [FeesAndReservesAdaptorV1.ChangeUpkeepMaxGas](#steward-v4-FeesAndReservesAdaptorV1-ChangeUpkeepMaxGas) | | Represents function `changeUpkeepMaxGas(uint64 newMaxGas)` | +| setup_meta_data | [FeesAndReservesAdaptorV1.SetupMetaData](#steward-v4-FeesAndReservesAdaptorV1-SetupMetaData) | | Represents function `setupMetaData(uint32 managementFee, uint32 performanceFee)` | +| add_assets_to_reserves | [FeesAndReservesAdaptorV1.AddAssetsToReserves](#steward-v4-FeesAndReservesAdaptorV1-AddAssetsToReserves) | | Represents function `addAssetsToReserves(uint256 amount)` | +| withdraw_assets_from_reserves | [FeesAndReservesAdaptorV1.WithdrawAssetsFromReserves](#steward-v4-FeesAndReservesAdaptorV1-WithdrawAssetsFromReserves) | | Represents function `withdrawAssetsFromReserves(uint256 amount)` | +| prepare_fees | [FeesAndReservesAdaptorV1.PrepareFees](#steward-v4-FeesAndReservesAdaptorV1-PrepareFees) | | Represents function `prepareFees(uint256 amount)` | - + -### CellarV2_2Governance.ForcePositionOut -Allows caller to force a position out of the cellar +### FeesAndReservesAdaptorV1.AddAssetsToReserves +Allows the owner to add assets to the Cellar's reserves -Represents function `forcePositionOut(uint32 index, uint32 positionId, bool inDebtArray)` +Represents function `addAssetsToReserves(uint256 amount)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| index | [uint32](#uint32) | | | -| position_id | [uint32](#uint32) | | | -| in_debt_array | [bool](#bool) | | | +| amount | [string](#string) | | | - + -### CellarV2_2Governance.RemoveAdaptorFromCatalogue -Allows callers to remove adaptors from this cellar's catalogue +### FeesAndReservesAdaptorV1.ChangeUpkeepFrequency +Allows the owner to update a Cellar's upkeep frequency. -Represents function `removeAdaptorFromCatalogue(address adaptor)` +Represents function `changeUpkeepFrequency(uint64 newFrequency)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| adaptor | [string](#string) | | | +| new_frequency | [uint64](#uint64) | | | - + -### CellarV2_2Governance.RemovePositionFromCatalogue -Allows caller to remove positions from this cellar's catalogue +### FeesAndReservesAdaptorV1.ChangeUpkeepMaxGas +Allows the owner to update a Cellar's upkeep max gas. -Represents function `removePositionFromCatalogue(uint32 positionId)` +Represents function `changeUpkeepMaxGas(uint64 newMaxGas)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| position_id | [uint32](#uint32) | | | +| new_max_gas | [uint64](#uint64) | | | - + -### CellarV2_2Governance.ToggleIgnorePause -Allows caller to toggle the ignorePause flag on the cellar +### FeesAndReservesAdaptorV1.PrepareFees +Allows the owner to prepare fees to be split between the platform, strategist, and protocol -Represents function `toggleIgnorePause(bool ignore)` +Represents function `prepareFees(uint256 amount)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| ignore | [bool](#bool) | | | +| amount | [string](#string) | | | - - + - +### FeesAndReservesAdaptorV1.SetupMetaData +Allows the owner to set the Cellar's fee metadata - +Represents function `setupMetaData(uint32 managementFee, uint32 performanceFee)` + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| management_fee | [uint32](#uint32) | | | +| performance_fee | [uint32](#uint32) | | | - -

Top

-## common.proto + - +### FeesAndReservesAdaptorV1.UpdateManagementFees +Allows the owner to update a Cellar's management fee. -### OracleSwapParams -Represents swap params for BaseAdaptor.oracleSwap() +Represents function `updateManagementFee(uint32 managementFee)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| univ2_params | [UniV2OracleSwapParams](#steward-v4-UniV2OracleSwapParams) | | | -| univ3_params | [UniV3OracleSwapParams](#steward-v4-UniV3OracleSwapParams) | | | +| management_fee | [uint32](#uint32) | | | - + -### SwapParams -Represents swap parameters for an exchange +### FeesAndReservesAdaptorV1.UpdatePerformanceFees +Allows the owner to update a Cellar's performance fee. + +Represents function `updatePerformanceFee(uint32 performanceFee)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| univ2_params | [UniV2SwapParams](#steward-v4-UniV2SwapParams) | | Params for a Uniswap V2 swap | -| univ3_params | [UniV3SwapParams](#steward-v4-UniV3SwapParams) | | Params for a Uniswap V3 swap | +| performance_fee | [uint32](#uint32) | | | - + -### UniV2OracleSwapParams -Represents oracle swap parameters for UniswapV2 +### FeesAndReservesAdaptorV1.WithdrawAssetsFromReserves +Allows the owner to withdraw assets from the Cellar's reserves + +Represents function `withdrawAssetsFromReserves(uint256 amount)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| path | [string](#string) | repeated | Array of addresses dictating what swap path to follow | +| amount | [string](#string) | | | - + + +### FeesAndReservesAdaptorV1Calls -### UniV2SwapParams -Represents swap parameters for UniswapV2 | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| path | [string](#string) | repeated | Array of addresses dictating what swap path to follow | -| amount | [string](#string) | | Amount of the first asset in the path to swap | -| amount_out_min | [string](#string) | | The minimum amount of the last asset in the path to receive | +| calls | [FeesAndReservesAdaptorV1](#steward-v4-FeesAndReservesAdaptorV1) | repeated | | + - + -### UniV3OracleSwapParams -Represents oracle swap parameters for UniswapV3 + + -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| path | [string](#string) | repeated | Array of addresses dictating what swap path to follow | -| pool_fees | [uint32](#uint32) | repeated | Array of pool fees dictating what swap pools to use | + +

Top

+## governance.proto - + -### UniV3SwapParams -Represents swap parameters for UniswapV3 +### GovernanceCall +Represents a governance-executed cellar function call. Used for Scheduled Cork Proposals in Sommelier. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| path | [string](#string) | repeated | Array of addresses dictating what swap path to follow | -| pool_fees | [uint32](#uint32) | repeated | Array of pool fees dictating what swap pools to use | -| amount | [string](#string) | | Amount of the first asset in the path to swap | -| amount_out_min | [string](#string) | | The minimum amount of the last asset in the path to receive | +| aave_v2_stablecoin | [AaveV2StablecoinGovernance](#steward-v4-AaveV2StablecoinGovernance) | | Governance function calls to the AaveV2Stablecoin cellar | +| cellar_v1 | [CellarV1Governance](#steward-v4-CellarV1Governance) | | Governance function calls to V1 cellars | +| cellar_v2 | [CellarV2Governance](#steward-v4-CellarV2Governance) | | Governance function calls to V2 cellars | +| cellar_v2_2 | [CellarV2_2Governance](#steward-v4-CellarV2_2Governance) | | Governance function calls to the V2.2 cellars | +| cellar_v2_5 | [CellarV2_5Governance](#steward-v4-CellarV2_5Governance) | | Governance function calls to the V2.5 cellars | @@ -2550,19 +5544,6 @@ Represents swap parameters for UniswapV3 - - - -### Exchange -Exchange selector - -| Name | Number | Description | -| ---- | ------ | ----------- | -| EXCHANGE_UNSPECIFIED | 0 | | -| EXCHANGE_UNIV2 | 1 | Represents Uniswap V2 | -| EXCHANGE_UNIV3 | 2 | Represents Uniswap V3 | - - @@ -2571,167 +5552,162 @@ Exchange selector - +

Top

-## debt_token.proto +## legacy_cellar_adaptor.proto - + + +### LegacyCellarAdaptorV1 -### AaveDebtTokenAdaptorV1 -Represents call data for the Aave Debt Token adaptor V1, used for borrowing and repaying debt on Aave. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| swap | [Swap](#steward-v4-Swap) | | Represents function `swap(ERC20 assetIn, ERC20 assetOut, uint256 amountIn, SwapRouter.Exchange exchange, bytes memory params)` | -| oracle_swap | [OracleSwap](#steward-v4-OracleSwap) | | Represents function `oracleSwap(ERC20 assetIn, ERC20 assetOut, uint256 amountIn, SwapRouter.Exchange exchange, bytes memory params, uint64 slippage)` | | revoke_approval | [RevokeApproval](#steward-v4-RevokeApproval) | | Represents function `revokeApproval(ERC20 asset, address spender)` | -| borrow_from_aave | [AaveDebtTokenAdaptorV1.BorrowFromAave](#steward-v4-AaveDebtTokenAdaptorV1-BorrowFromAave) | | Represents function `borrowFromAave(ERC20 debtTokenToBorrow, uint256 amountToBorrow)` | -| repay_aave_debt | [AaveDebtTokenAdaptorV1.RepayAaveDebt](#steward-v4-AaveDebtTokenAdaptorV1-RepayAaveDebt) | | Represents function `repayAaveDebt(ERC20 tokenToRepay, uint256 amountToRepay)` | -| swap_and_repay | [AaveDebtTokenAdaptorV1.SwapAndRepay](#steward-v4-AaveDebtTokenAdaptorV1-SwapAndRepay) | | Represents function `swapAndRepay(ERC20 tokenIn, ERC20 tokenToRepay, uint256 amountIn, SwapRouter.Exchange exchange, bytes memory params)` | +| depositToCellar | [LegacyCellarAdaptorV1.DepositToCellar](#steward-v4-LegacyCellarAdaptorV1-DepositToCellar) | | Represents function `depositToCellar(Cellar cellar, uint256 assets, address oracle)` | +| withdrawFromCellar | [LegacyCellarAdaptorV1.WithdrawFromCellar](#steward-v4-LegacyCellarAdaptorV1-WithdrawFromCellar) | | Represents function `withdrawFromCellar(Cellar cellar, uint256 assets, address oracle)` | - + -### AaveDebtTokenAdaptorV1.BorrowFromAave -Allows strategists to borrow assets from Aave. +### LegacyCellarAdaptorV1.DepositToCellar +Allows strategists to deposit into Cellar positions. -Represents function `depositToAave(ERC20 tokenToDeposit, uint256 amountToDeposit)` +Represents function `depositToCellar(Cellar cellar, uint256 assets, address oracle)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| token | [string](#string) | | The address of the ERC20 token to borrow | -| amount | [string](#string) | | The amount to borrow | +| cellar | [string](#string) | | | +| assets | [string](#string) | | | +| oracle | [string](#string) | | | - + -### AaveDebtTokenAdaptorV1.RepayAaveDebt -Allows strategists to repay loan debt on Aave. +### LegacyCellarAdaptorV1.WithdrawFromCellar +Allows strategists to withdraw from Cellar positions. -Represents function `repayAaveDebt(ERC20 tokenToRepay, uint256 amountToRepay)` +Represents function `withdrawFromCellar(Cellar cellar, uint256 assets, address oracle)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| token | [string](#string) | | The address of the ERC20 token to repay | -| amount | [string](#string) | | The amount to repay | +| cellar | [string](#string) | | | +| assets | [string](#string) | | | +| oracle | [string](#string) | | | - + -### AaveDebtTokenAdaptorV1.SwapAndRepay -Allows strategists to swap assets and repay loans in one call. +### LegacyCellarAdaptorV1Calls -Represents function `swapAndRepay(ERC20 tokenIn, ERC20 tokenToRepay, uint256 amountIn, SwapRouter.Exchange exchange, bytes memory params)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| token_in | [string](#string) | | The address of the token to swap from | -| token_to_repay | [string](#string) | | The address of the token to swap to and repay with | -| amount_in | [string](#string) | | The amount to swap | -| exchange | [Exchange](#steward-v4-Exchange) | | The exchange to make the swap on | -| params | [SwapParams](#steward-v4-SwapParams) | | The parameters for the swap | - +| calls | [LegacyCellarAdaptorV1](#steward-v4-LegacyCellarAdaptorV1) | repeated | | - + -### AaveDebtTokenAdaptorV1Calls + + + -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| calls | [AaveDebtTokenAdaptorV1](#steward-v4-AaveDebtTokenAdaptorV1) | repeated | | + +

Top

+## morpho_aave_v2_a_token.proto - + -### AaveDebtTokenAdaptorV2 -Represents call data for the Aave Debt Token adaptor V2, used for borrowing and repaying debt on Aave. +### MorphoAaveV2ATokenAdaptorV1 +Represents call data for the Morpho Aave V2 AToken adaptor. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | revoke_approval | [RevokeApproval](#steward-v4-RevokeApproval) | | Represents function `revokeApproval(ERC20 asset, address spender)` | -| borrow_from_aave | [AaveDebtTokenAdaptorV2.BorrowFromAave](#steward-v4-AaveDebtTokenAdaptorV2-BorrowFromAave) | | Represents function `borrowFromAave(ERC20 debtTokenToBorrow, uint256 amountToBorrow)` | -| repay_aave_debt | [AaveDebtTokenAdaptorV2.RepayAaveDebt](#steward-v4-AaveDebtTokenAdaptorV2-RepayAaveDebt) | | Represents function `repayAaveDebt(ERC20 tokenToRepay, uint256 amountToRepay)` | +| deposit_to_aave_v2_morpho | [MorphoAaveV2ATokenAdaptorV1.DepositToAaveV2Morpho](#steward-v4-MorphoAaveV2ATokenAdaptorV1-DepositToAaveV2Morpho) | | Represents function `depositToAaveV2Morpho(IAaveToken aToken, uint256 amountToDeposit)` | +| withdraw_from_aave_v2_morpho | [MorphoAaveV2ATokenAdaptorV1.WithdrawFromAaveV2Morpho](#steward-v4-MorphoAaveV2ATokenAdaptorV1-WithdrawFromAaveV2Morpho) | | Represents function `withdrawFromAaveV2Morpho(IAaveToken aToken, uint256 amountToWithdraw)` | +| claim | [Claim](#steward-v4-Claim) | | Represents function `claim(uint256 claimable, bytes32[] memory proof)` | - + -### AaveDebtTokenAdaptorV2.BorrowFromAave -Allows strategists to borrow assets from Aave. +### MorphoAaveV2ATokenAdaptorV1.DepositToAaveV2Morpho +Allows strategists to lend assets on Morpho. -Represents function `depositToAave(ERC20 tokenToDeposit, uint256 amountToDeposit)` +Represents function `depositToAaveV2Morpho(IAaveToken aToken, uint256 amountToDeposit)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| token | [string](#string) | | The address of the ERC20 token to borrow | -| amount | [string](#string) | | The amount to borrow | +| a_token | [string](#string) | | The address of the Aave V2 aToken to deposit to. | +| amount_to_deposit | [string](#string) | | The amount of the asset to deposit. | - + -### AaveDebtTokenAdaptorV2.RepayAaveDebt -Allows strategists to repay loan debt on Aave. +### MorphoAaveV2ATokenAdaptorV1.WithdrawFromAaveV2Morpho +Allows strategists to withdraw assets from Morpho. -Represents function `repayAaveDebt(ERC20 tokenToRepay, uint256 amountToRepay)` +Represents function `withdrawFromAaveV2Morpho(IAaveToken aToken, uint256 amountToWithdraw)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| token | [string](#string) | | The address of the ERC20 token to repay | -| amount | [string](#string) | | The amount to repay | +| a_token | [string](#string) | | The address of the Aave V2 aToken to withdraw from. | +| amount_to_withdraw | [string](#string) | | The amount of the asset to withdraw. | - + -### AaveDebtTokenAdaptorV2Calls +### MorphoAaveV2ATokenAdaptorV1Calls | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| calls | [AaveDebtTokenAdaptorV2](#steward-v4-AaveDebtTokenAdaptorV2) | repeated | | +| calls | [MorphoAaveV2ATokenAdaptorV1](#steward-v4-MorphoAaveV2ATokenAdaptorV1) | repeated | | @@ -2747,337 +5723,332 @@ Represents function `repayAaveDebt(ERC20 tokenToRepay, uint256 amountToRepay)` - +

Top

-## f_token.proto +## morpho_aave_v2_debt_token.proto - + -### FTokenAdaptorV1 -Represents call data for the Frax adaptor. +### MorphoAaveV2DebtTokenAdaptorV1 +Represents call data for the Morpho Aave V2 Debt Token adaptor. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | revoke_approval | [RevokeApproval](#steward-v4-RevokeApproval) | | Represents function `revokeApproval(ERC20 asset, address spender)` | -| lend_frax | [FTokenAdaptorV1.LendFrax](#steward-v4-FTokenAdaptorV1-LendFrax) | | Represents function `lendFrax(IFToken fToken, uint256 amountToDeposit)` | -| redeem_frax_share | [FTokenAdaptorV1.RedeemFraxShare](#steward-v4-FTokenAdaptorV1-RedeemFraxShare) | | Represents function `redeemFraxShare(IFToken fToken, uint256 amountToRedeem)` | -| withdraw_frax | [FTokenAdaptorV1.WithdrawFrax](#steward-v4-FTokenAdaptorV1-WithdrawFrax) | | Represents function `withdrawFrax(IFToken fToken, uint256 amountToWithdraw)` | -| call_add_interest | [FTokenAdaptorV1.CallAddInterest](#steward-v4-FTokenAdaptorV1-CallAddInterest) | | Represents function `callAddInterest(IFToken fToken)` | +| borrow_from_aave_v2_morpho | [MorphoAaveV2DebtTokenAdaptorV1.BorrowFromAaveV2Morpho](#steward-v4-MorphoAaveV2DebtTokenAdaptorV1-BorrowFromAaveV2Morpho) | | Represents function `borrowFromAaveV2Morpho(address aToken, uint256 amountToBorrow)` | +| repay_aave_v2_morpho_debt | [MorphoAaveV2DebtTokenAdaptorV1.RepayAaveV2MorphoDebt](#steward-v4-MorphoAaveV2DebtTokenAdaptorV1-RepayAaveV2MorphoDebt) | | Represents function `repayAaveV2MorphoDebt(IAaveToken aToken, uint256 amountToRepay)` | - + -### FTokenAdaptorV1.CallAddInterest -Allows a strategist to call `addInterest` on a Frax Pair they are using +### MorphoAaveV2DebtTokenAdaptorV1.BorrowFromAaveV2Morpho +Allows strategists to borrow assets from Aave. -Represents `function callAddInterest(IFToken fToken)` +Represents function `borrowFromAaveV2Morpho(address aToken, uint256 amountToBorrow)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| f_token | [string](#string) | | The address of the fToken to call `addInterest` on. | +| a_token | [string](#string) | | The address of the Aave V2 aToken to borrow. | +| amount_to_borrow | [string](#string) | | The amount of the asset to borrow. | - + -### FTokenAdaptorV1.LendFrax -Allows strategists to lend FRAX on FraxLend +### MorphoAaveV2DebtTokenAdaptorV1.RepayAaveV2MorphoDebt +Allows strategists to repay loan debt on Aave. -Represents `function lendFrax(IFToken fToken, uint256 amountToDeposit)` +Represents function `repayAaveV2MorphoDebt(IAaveToken aToken, uint256 amountToRepay)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| f_token | [string](#string) | | The address of the fToken to lend. | -| amount_to_deposit | [string](#string) | | The amount of the fToken to lend. | +| a_token | [string](#string) | | The address of the Aave V2 aToken to repay. | +| amount_to_repay | [string](#string) | | The amount of the asset to repay. | - + -### FTokenAdaptorV1.RedeemFraxShare -Allows strategists to redeem FRAX shares on FraxLend +### MorphoAaveV2DebtTokenAdaptorV1Calls -Represents `function redeemFraxShare(IFToken fToken, uint256 amountToRedeem)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| f_token | [string](#string) | | The address of the fToken to redeem. | -| amount_to_redeem | [string](#string) | | The amount of the fToken to redeem. | - - +| calls | [MorphoAaveV2DebtTokenAdaptorV1](#steward-v4-MorphoAaveV2DebtTokenAdaptorV1) | repeated | | - -### FTokenAdaptorV1.WithdrawFrax -Allows strategists to withdraw FRAX from FraxLend + -Represents `function withdrawFrax(IFToken fToken, uint256 amountToWithdraw)` + + -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| f_token | [string](#string) | | The address of the fToken to withdraw. | -| amount_to_withdraw | [string](#string) | | The amount of the fToken to withdraw. | + + +

Top

+## morpho_aave_v3_a_token_collateral.proto - -### FTokenAdaptorV1Calls + +### MorphoAaveV3ATokenCollateralAdaptorV1 +Represents call data for the Morpho Aave V3 AToken Collateral adaptor. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| calls | [FTokenAdaptorV1](#steward-v4-FTokenAdaptorV1) | repeated | | +| revoke_approval | [RevokeApproval](#steward-v4-RevokeApproval) | | Represents function `revokeApproval(ERC20 asset, address spender)` | +| deposit_to_aave_v3_morpho | [MorphoAaveV3ATokenCollateralAdaptorV1.DepositToAaveV3Morpho](#steward-v4-MorphoAaveV3ATokenCollateralAdaptorV1-DepositToAaveV3Morpho) | | Represents function `depositToAaveV3Morpho(ERC20 tokenToDeposit, uint256 amountToDeposit)` | +| withdraw_from_aave_v3_morpho | [MorphoAaveV3ATokenCollateralAdaptorV1.WithdrawFromAaveV3Morpho](#steward-v4-MorphoAaveV3ATokenCollateralAdaptorV1-WithdrawFromAaveV3Morpho) | | Represents function `withdrawFromAaveV3Morpho(ERC20 tokenToWithdraw, uint256 amountToWithdraw)` | +| claim | [Claim](#steward-v4-Claim) | | Represents function `claim(uint256 claimable, bytes32[] memory proof)` | - - + - +### MorphoAaveV3ATokenCollateralAdaptorV1.DepositToAaveV3Morpho +Allows strategists to lend assets on Morpho - +Represents function `depositToAaveV3Morpho(ERC20 tokenToDeposit, uint256 amountToDeposit)` +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| token_to_deposit | [string](#string) | | The address of the token to deposit | +| amount_to_deposit | [string](#string) | | The amount of tokens to deposit | - -

Top

-## fees_and_reserves.proto - -### FeesAndReservesAdaptorV1 -Represents call data for the FeesAndReserves and FeesAndReservesAdaptor contracts. + + +### MorphoAaveV3ATokenCollateralAdaptorV1.WithdrawFromAaveV3Morpho +Allows strategists to withdraw assets from Morpho + +Represents function `withdrawFromAaveV3Morpho(ERC20 tokenToWithdraw, uint256 amountToWithdraw)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| revoke_approval | [RevokeApproval](#steward-v4-RevokeApproval) | | Represents function `revokeApproval(ERC20 asset, address spender)` | -| update_performance_fees | [FeesAndReservesAdaptorV1.UpdatePerformanceFees](#steward-v4-FeesAndReservesAdaptorV1-UpdatePerformanceFees) | | Represents function `updatePerformanceFee(uint32 performanceFee)` | -| update_management_fees | [FeesAndReservesAdaptorV1.UpdateManagementFees](#steward-v4-FeesAndReservesAdaptorV1-UpdateManagementFees) | | Represents function `updateManagementFee(uint32 managementFee)` | -| change_upkeep_frequency | [FeesAndReservesAdaptorV1.ChangeUpkeepFrequency](#steward-v4-FeesAndReservesAdaptorV1-ChangeUpkeepFrequency) | | Represents function `changeUpkeepFrequency(uint64 newFrequency)` | -| change_upkeep_max_gas | [FeesAndReservesAdaptorV1.ChangeUpkeepMaxGas](#steward-v4-FeesAndReservesAdaptorV1-ChangeUpkeepMaxGas) | | Represents function `changeUpkeepMaxGas(uint64 newMaxGas)` | -| setup_meta_data | [FeesAndReservesAdaptorV1.SetupMetaData](#steward-v4-FeesAndReservesAdaptorV1-SetupMetaData) | | Represents function `setupMetaData(uint32 managementFee, uint32 performanceFee)` | -| add_assets_to_reserves | [FeesAndReservesAdaptorV1.AddAssetsToReserves](#steward-v4-FeesAndReservesAdaptorV1-AddAssetsToReserves) | | Represents function `addAssetsToReserves(uint256 amount)` | -| withdraw_assets_from_reserves | [FeesAndReservesAdaptorV1.WithdrawAssetsFromReserves](#steward-v4-FeesAndReservesAdaptorV1-WithdrawAssetsFromReserves) | | Represents function `withdrawAssetsFromReserves(uint256 amount)` | -| prepare_fees | [FeesAndReservesAdaptorV1.PrepareFees](#steward-v4-FeesAndReservesAdaptorV1-PrepareFees) | | Represents function `prepareFees(uint256 amount)` | +| token_to_withdraw | [string](#string) | | The address of the token to withdraw | +| amount_to_withdraw | [string](#string) | | The amount of tokens to withdraw | - + -### FeesAndReservesAdaptorV1.AddAssetsToReserves -Allows the owner to add assets to the Cellar's reserves +### MorphoAaveV3ATokenCollateralAdaptorV1Calls -Represents function `addAssetsToReserves(uint256 amount)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| amount | [string](#string) | | | - - +| calls | [MorphoAaveV3ATokenCollateralAdaptorV1](#steward-v4-MorphoAaveV3ATokenCollateralAdaptorV1) | repeated | | - -### FeesAndReservesAdaptorV1.ChangeUpkeepFrequency -Allows the owner to update a Cellar's upkeep frequency. + -Represents function `changeUpkeepFrequency(uint64 newFrequency)` + + -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| new_frequency | [uint64](#uint64) | | | + + +

Top

+## morpho_aave_v3_a_token_p2p.proto - -### FeesAndReservesAdaptorV1.ChangeUpkeepMaxGas -Allows the owner to update a Cellar's upkeep max gas. + -Represents function `changeUpkeepMaxGas(uint64 newMaxGas)` +### MorphoAaveV3ATokenP2PAdaptorV1 +Represents call data for the Morpho Aave V3 A Token P2P adaptor. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| new_max_gas | [uint64](#uint64) | | | +| revoke_approval | [RevokeApproval](#steward-v4-RevokeApproval) | | Represents function `revokeApproval(ERC20 asset, address spender)` | +| deposit_to_aave_v3_morpho | [MorphoAaveV3ATokenP2PAdaptorV1.DepositToAaveV3Morpho](#steward-v4-MorphoAaveV3ATokenP2PAdaptorV1-DepositToAaveV3Morpho) | | Represents function `depositToAaveV3Morpho(ERC20 tokenToDeposit, uint256 amountToDeposit, uint256 maxIterations)` | +| withdraw_from_aave_v3_morpho | [MorphoAaveV3ATokenP2PAdaptorV1.WithdrawFromAaveV3Morpho](#steward-v4-MorphoAaveV3ATokenP2PAdaptorV1-WithdrawFromAaveV3Morpho) | | Represents function `withdrawFromAaveV3Morpho(ERC20 tokenToWithdraw, uint256 amountToWithdraw, uint256 maxIterations)` | +| claim | [Claim](#steward-v4-Claim) | | Represents function `claim(uint256 claimable, bytes32[] memory proof)` | - + -### FeesAndReservesAdaptorV1.PrepareFees -Allows the owner to prepare fees to be split between the platform, strategist, and protocol +### MorphoAaveV3ATokenP2PAdaptorV1.DepositToAaveV3Morpho +Allows strategists to lend assets on Morpho -Represents function `prepareFees(uint256 amount)` +Represents function `depositToAaveV3Morpho(ERC20 tokenToDeposit, uint256 amountToDeposit, uint256 maxIterations)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| amount | [string](#string) | | | +| token_to_deposit | [string](#string) | | The address of the token to deposit | +| amount_to_deposit | [string](#string) | | The amount of tokens to deposit | +| max_iterations | [string](#string) | | The maximum number of iterations to run | - + -### FeesAndReservesAdaptorV1.SetupMetaData -Allows the owner to set the Cellar's fee metadata +### MorphoAaveV3ATokenP2PAdaptorV1.WithdrawFromAaveV3Morpho +Allows strategists to withdraw assets from Morpho -Represents function `setupMetaData(uint32 managementFee, uint32 performanceFee)` +Represents function `withdrawFromAaveV3Morpho(ERC20 tokenToWithdraw, uint256 amountToWithdraw, uint256 maxIterations)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| management_fee | [uint32](#uint32) | | | -| performance_fee | [uint32](#uint32) | | | +| token_to_withdraw | [string](#string) | | The address of the token to withdraw | +| amount_to_withdraw | [string](#string) | | The amount of tokens to withdraw | +| max_iterations | [string](#string) | | The maximum number of iterations to run | - + -### FeesAndReservesAdaptorV1.UpdateManagementFees -Allows the owner to update a Cellar's management fee. +### MorphoAaveV3ATokenP2PAdaptorV1Calls -Represents function `updateManagementFee(uint32 managementFee)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| management_fee | [uint32](#uint32) | | | - - +| calls | [MorphoAaveV3ATokenP2PAdaptorV1](#steward-v4-MorphoAaveV3ATokenP2PAdaptorV1) | repeated | | - -### FeesAndReservesAdaptorV1.UpdatePerformanceFees -Allows the owner to update a Cellar's performance fee. + -Represents function `updatePerformanceFee(uint32 performanceFee)` + + -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| performance_fee | [uint32](#uint32) | | | + + +

Top

+## morpho_aave_v3_debt_token.proto - -### FeesAndReservesAdaptorV1.WithdrawAssetsFromReserves -Allows the owner to withdraw assets from the Cellar's reserves + -Represents function `withdrawAssetsFromReserves(uint256 amount)` +### MorphoAaveV3DebtTokenAdaptorV1 +Represents call data for the Morpho Aave V3 Debt Token adaptor. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| amount | [string](#string) | | | +| revoke_approval | [RevokeApproval](#steward-v4-RevokeApproval) | | Represents function `revokeApproval(ERC20 asset, address spender)` | +| borrow_from_aave_v3_morpho | [MorphoAaveV3DebtTokenAdaptorV1.BorrowFromAaveV3Morpho](#steward-v4-MorphoAaveV3DebtTokenAdaptorV1-BorrowFromAaveV3Morpho) | | Represents function `borrowFromAaveV3Morpho(address underlying, uint256 amountToBorrow, uint256 maxIterations)` | +| repay_aave_v3_morpho_debt | [MorphoAaveV3DebtTokenAdaptorV1.RepayAaveV3MorphoDebt](#steward-v4-MorphoAaveV3DebtTokenAdaptorV1-RepayAaveV3MorphoDebt) | | Represents function `repayAaveV3MorphoDebt(ERC20 tokenToRepay, uint256 amountToRepay)` | - + -### FeesAndReservesAdaptorV1Calls +### MorphoAaveV3DebtTokenAdaptorV1.BorrowFromAaveV3Morpho +Allows strategists to borrow assets from Morpho +Represents function `borrowFromAaveV3Morpho(address underlying, uint256 amountToBorrow, uint256 maxIterations)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| calls | [FeesAndReservesAdaptorV1](#steward-v4-FeesAndReservesAdaptorV1) | repeated | | +| underlying | [string](#string) | | The underlying asset to borrow | +| amount_to_borrow | [string](#string) | | The amount of the underlying asset to borrow | +| max_iterations | [string](#string) | | The maximum number of iterations to perform | - - + - +### MorphoAaveV3DebtTokenAdaptorV1.RepayAaveV3MorphoDebt +Allows strategists to repay loan debt on Morpho - +Represents function `repayAaveV3MorphoDebt(ERC20 tokenToRepay, uint256 amountToRepay)` +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| token_to_repay | [string](#string) | | The token to repay | +| amount_to_repay | [string](#string) | | The amount of the token to repay | - -

Top

-## governance.proto - -### GovernanceCall -Represents a governance-executed cellar function call. Used for Scheduled Cork Proposals in Sommelier. + + +### MorphoAaveV3DebtTokenAdaptorV1Calls + | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| aave_v2_stablecoin | [AaveV2StablecoinGovernance](#steward-v4-AaveV2StablecoinGovernance) | | Governance function calls to the AaveV2Stablecoin cellar | -| cellar_v1 | [CellarV1Governance](#steward-v4-CellarV1Governance) | | Governance function calls to V1 cellars | -| cellar_v2 | [CellarV2Governance](#steward-v4-CellarV2Governance) | | Governance function calls to V2 cellars | -| cellar_v2_2 | [CellarV2_2Governance](#steward-v4-CellarV2_2Governance) | | Governance function calls to the V2.2 cellars | +| calls | [MorphoAaveV3DebtTokenAdaptorV1](#steward-v4-MorphoAaveV3DebtTokenAdaptorV1) | repeated | | @@ -3093,76 +6064,75 @@ Represents a governance-executed cellar function call. Used for Scheduled Cork P - +

Top

-## morpho_aave_v2_a_token.proto +## morpho_blue_collateral.proto - + -### MorphoAaveV2ATokenAdaptorV1 -Represents call data for the Morpho Aave V2 AToken adaptor. +### MorphoBlueCollateralAdaptorV1 +Represents call data for the Morpho Blue Collateral adaptor. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | revoke_approval | [RevokeApproval](#steward-v4-RevokeApproval) | | Represents function `revokeApproval(ERC20 asset, address spender)` | -| deposit_to_aave_v2_morpho | [MorphoAaveV2ATokenAdaptorV1.DepositToAaveV2Morpho](#steward-v4-MorphoAaveV2ATokenAdaptorV1-DepositToAaveV2Morpho) | | Represents function `depositToAaveV2Morpho(IAaveToken aToken, uint256 amountToDeposit)` | -| withdraw_from_aave_v2_morpho | [MorphoAaveV2ATokenAdaptorV1.WithdrawFromAaveV2Morpho](#steward-v4-MorphoAaveV2ATokenAdaptorV1-WithdrawFromAaveV2Morpho) | | Represents function `withdrawFromAaveV2Morpho(IAaveToken aToken, uint256 amountToWithdraw)` | -| claim | [Claim](#steward-v4-Claim) | | Represents function `claim(uint256 claimable, bytes32[] memory proof)` | +| add_collateral | [MorphoBlueCollateralAdaptorV1.AddCollateral](#steward-v4-MorphoBlueCollateralAdaptorV1-AddCollateral) | | Represents function `addCollateral(MarketParams memory _market, uint256 _collateralToDeposit)` | +| remove_collateral | [MorphoBlueCollateralAdaptorV1.RemoveCollateral](#steward-v4-MorphoBlueCollateralAdaptorV1-RemoveCollateral) | | Represents function `removeCollateral(MarketParams memory _market, uint256 _collateralAmount)` | - + -### MorphoAaveV2ATokenAdaptorV1.DepositToAaveV2Morpho -Allows strategists to lend assets on Morpho. +### MorphoBlueCollateralAdaptorV1.AddCollateral +Allows strategists to add collateral to the respective cellar position on specified MB Market, enabling borrowing. -Represents function `depositToAaveV2Morpho(IAaveToken aToken, uint256 amountToDeposit)` +Represents function `addCollateral(MarketParams memory _market, uint256 _collateralToDeposit)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| a_token | [string](#string) | | The address of the Aave V2 aToken to deposit to. | -| amount_to_deposit | [string](#string) | | The amount of the asset to deposit. | +| market | [MarketParams](#steward-v4-MarketParams) | | Identifier of a Morpho Blue Market | +| collateral_to_deposit | [string](#string) | | The amount of collateral to add | - + -### MorphoAaveV2ATokenAdaptorV1.WithdrawFromAaveV2Morpho -Allows strategists to withdraw assets from Morpho. +### MorphoBlueCollateralAdaptorV1.RemoveCollateral +Allows strategists to remove collateral from the respective cellar position on specified MB Market. -Represents function `withdrawFromAaveV2Morpho(IAaveToken aToken, uint256 amountToWithdraw)` +Represents function `removeCollateral(MarketParams memory _market, uint256 _collateralAmount)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| a_token | [string](#string) | | The address of the Aave V2 aToken to withdraw from. | -| amount_to_withdraw | [string](#string) | | The amount of the asset to withdraw. | +| market | [MarketParams](#steward-v4-MarketParams) | | Identifier of a Morpho Blue Market | +| collateral_amount | [string](#string) | | The amount of collateral to remove | - + -### MorphoAaveV2ATokenAdaptorV1Calls +### MorphoBlueCollateralAdaptorV1Calls | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| calls | [MorphoAaveV2ATokenAdaptorV1](#steward-v4-MorphoAaveV2ATokenAdaptorV1) | repeated | | +| calls | [MorphoBlueCollateralAdaptorV1](#steward-v4-MorphoBlueCollateralAdaptorV1) | repeated | | @@ -3178,75 +6148,75 @@ Represents function `withdrawFromAaveV2Morpho(IAaveToken aToken, uint256 amountT - +

Top

-## morpho_aave_v2_debt_token.proto +## morpho_blue_debt.proto - + -### MorphoAaveV2DebtTokenAdaptorV1 -Represents call data for the Morpho Aave V2 Debt Token adaptor. +### MorphoBlueDebtAdaptorV1 +Represents call data for the Morpho Blue Debt adaptor. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | revoke_approval | [RevokeApproval](#steward-v4-RevokeApproval) | | Represents function `revokeApproval(ERC20 asset, address spender)` | -| borrow_from_aave_v2_morpho | [MorphoAaveV2DebtTokenAdaptorV1.BorrowFromAaveV2Morpho](#steward-v4-MorphoAaveV2DebtTokenAdaptorV1-BorrowFromAaveV2Morpho) | | Represents function `borrowFromAaveV2Morpho(address aToken, uint256 amountToBorrow)` | -| repay_aave_v2_morpho_debt | [MorphoAaveV2DebtTokenAdaptorV1.RepayAaveV2MorphoDebt](#steward-v4-MorphoAaveV2DebtTokenAdaptorV1-RepayAaveV2MorphoDebt) | | Represents function `repayAaveV2MorphoDebt(IAaveToken aToken, uint256 amountToRepay)` | +| borrow_from_morpho_blue | [MorphoBlueDebtAdaptorV1.BorrowFromMorphoBlue](#steward-v4-MorphoBlueDebtAdaptorV1-BorrowFromMorphoBlue) | | Represents function `borrowFromMorphoBlue(MarketParams memory _market, uint256 _amountToBorrow)` | +| repay_morpho_blue_debt | [MorphoBlueDebtAdaptorV1.RepayMorphoBlueDebt](#steward-v4-MorphoBlueDebtAdaptorV1-RepayMorphoBlueDebt) | | Represents function `repayMorphoBlueDebt(MarketParams memory _market, uint256 _debtTokenRepayAmount)` | - + -### MorphoAaveV2DebtTokenAdaptorV1.BorrowFromAaveV2Morpho -Allows strategists to borrow assets from Aave. +### MorphoBlueDebtAdaptorV1.BorrowFromMorphoBlue +Allows strategists borrow a specific amount of an asset on Morpho Blue -Represents function `borrowFromAaveV2Morpho(address aToken, uint256 amountToBorrow)` +Represents function `borrowFromMorphoBlue(MarketParams memory _market, uint256 _amountToBorrow)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| a_token | [string](#string) | | The address of the Aave V2 aToken to borrow. | -| amount_to_borrow | [string](#string) | | The amount of the asset to borrow. | +| market | [MarketParams](#steward-v4-MarketParams) | | Identifier of a Morpho Blue Market | +| amount_to_borrow | [string](#string) | | The amount of the debt token to borrow | - + -### MorphoAaveV2DebtTokenAdaptorV1.RepayAaveV2MorphoDebt -Allows strategists to repay loan debt on Aave. +### MorphoBlueDebtAdaptorV1.RepayMorphoBlueDebt +Allows strategists to repay loan debt on Morph Blue Lending Market. Make sure to call addInterest() beforehand to ensure we are repaying what is required. -Represents function `repayAaveV2MorphoDebt(IAaveToken aToken, uint256 amountToRepay)` +Represents function `repayMorphoBlueDebt(MarketParams memory _market, uint256 _debtTokenRepayAmount)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| a_token | [string](#string) | | The address of the Aave V2 aToken to repay. | -| amount_to_repay | [string](#string) | | The amount of the asset to repay. | +| market | [MarketParams](#steward-v4-MarketParams) | | Identifier of a Morpho Blue Market | +| debt_token_repay_amount | [string](#string) | | The amount of the debt token to repay | - + -### MorphoAaveV2DebtTokenAdaptorV1Calls +### MorphoBlueDebtAdaptorV1Calls | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| calls | [MorphoAaveV2DebtTokenAdaptorV1](#steward-v4-MorphoAaveV2DebtTokenAdaptorV1) | repeated | | +| calls | [MorphoBlueDebtAdaptorV1](#steward-v4-MorphoBlueDebtAdaptorV1) | repeated | | @@ -3262,76 +6232,75 @@ Represents function `repayAaveV2MorphoDebt(IAaveToken aToken, uint256 amountToRe - +

Top

-## morpho_aave_v3_a_token_collateral.proto +## morpho_blue_supply.proto - + -### MorphoAaveV3ATokenCollateralAdaptorV1 -Represents call data for the Morpho Aave V3 AToken Collateral adaptor. +### MorphoBlueSupplyAdaptorV1 +Represents call data for the Morpho Blue Supply adaptor. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | revoke_approval | [RevokeApproval](#steward-v4-RevokeApproval) | | Represents function `revokeApproval(ERC20 asset, address spender)` | -| deposit_to_aave_v3_morpho | [MorphoAaveV3ATokenCollateralAdaptorV1.DepositToAaveV3Morpho](#steward-v4-MorphoAaveV3ATokenCollateralAdaptorV1-DepositToAaveV3Morpho) | | Represents function `depositToAaveV3Morpho(ERC20 tokenToDeposit, uint256 amountToDeposit)` | -| withdraw_from_aave_v3_morpho | [MorphoAaveV3ATokenCollateralAdaptorV1.WithdrawFromAaveV3Morpho](#steward-v4-MorphoAaveV3ATokenCollateralAdaptorV1-WithdrawFromAaveV3Morpho) | | Represents function `withdrawFromAaveV3Morpho(ERC20 tokenToWithdraw, uint256 amountToWithdraw)` | -| claim | [Claim](#steward-v4-Claim) | | Represents function `claim(uint256 claimable, bytes32[] memory proof)` | +| lend_to_morpho_blue | [MorphoBlueSupplyAdaptorV1.LendToMorphoBlue](#steward-v4-MorphoBlueSupplyAdaptorV1-LendToMorphoBlue) | | Represents function `lendToMorphoBlue(MarketParams memory _market, uint256 _assets)` | +| withdraw_from_morpho_blue | [MorphoBlueSupplyAdaptorV1.WithdrawFromMorphoBlue](#steward-v4-MorphoBlueSupplyAdaptorV1-WithdrawFromMorphoBlue) | | Represents function `withdrawFromMorphoBlue(MarketParams memory _market, uint256 _assets)` | - + -### MorphoAaveV3ATokenCollateralAdaptorV1.DepositToAaveV3Morpho -Allows strategists to lend assets on Morpho +### MorphoBlueSupplyAdaptorV1.LendToMorphoBlue +Allows strategists to lend a specific amount for an asset on Morpho Blue -Represents function `depositToAaveV3Morpho(ERC20 tokenToDeposit, uint256 amountToDeposit)` +Represents function `lendToMorphoBlue(MarketParams memory _market, uint256 _assets)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| token_to_deposit | [string](#string) | | The address of the token to deposit | -| amount_to_deposit | [string](#string) | | The amount of tokens to deposit | +| market | [MarketParams](#steward-v4-MarketParams) | | Identifier of a Morpho Blue Market | +| assets | [string](#string) | | The amount of the loan token to lend | - + -### MorphoAaveV3ATokenCollateralAdaptorV1.WithdrawFromAaveV3Morpho -Allows strategists to withdraw assets from Morpho +### MorphoBlueSupplyAdaptorV1.WithdrawFromMorphoBlue +Allows strategists to withdraw the underlying asset plus interest -Represents function `withdrawFromAaveV3Morpho(ERC20 tokenToWithdraw, uint256 amountToWithdraw)` +Represents function `withdrawFromMorphoBlue(MarketParams memory _market, uint256 _assets)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| token_to_withdraw | [string](#string) | | The address of the token to withdraw | -| amount_to_withdraw | [string](#string) | | The amount of tokens to withdraw | +| market | [MarketParams](#steward-v4-MarketParams) | | Identifier of a Morpho Blue Market | +| assets | [string](#string) | | The amount of the loan token to lend | - + -### MorphoAaveV3ATokenCollateralAdaptorV1Calls +### MorphoBlueSupplyAdaptorV1Calls | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| calls | [MorphoAaveV3ATokenCollateralAdaptorV1](#steward-v4-MorphoAaveV3ATokenCollateralAdaptorV1) | repeated | | +| calls | [MorphoBlueSupplyAdaptorV1](#steward-v4-MorphoBlueSupplyAdaptorV1) | repeated | | @@ -3347,78 +6316,92 @@ Represents function `withdrawFromAaveV3Morpho(ERC20 tokenToWithdraw, uint256 amo - +

Top

-## morpho_aave_v3_a_token_p2p.proto +## morpho_reward_handler.proto - + -### MorphoAaveV3ATokenP2PAdaptorV1 -Represents call data for the Morpho Aave V3 A Token P2P adaptor. +### Claim +Allows Morpho A Token cellars to claim Morpho Rewards + +Represents function `claim(uint256 claimable, bytes32[] memory proof)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| revoke_approval | [RevokeApproval](#steward-v4-RevokeApproval) | | Represents function `revokeApproval(ERC20 asset, address spender)` | -| deposit_to_aave_v3_morpho | [MorphoAaveV3ATokenP2PAdaptorV1.DepositToAaveV3Morpho](#steward-v4-MorphoAaveV3ATokenP2PAdaptorV1-DepositToAaveV3Morpho) | | Represents function `depositToAaveV3Morpho(ERC20 tokenToDeposit, uint256 amountToDeposit, uint256 maxIterations)` | -| withdraw_from_aave_v3_morpho | [MorphoAaveV3ATokenP2PAdaptorV1.WithdrawFromAaveV3Morpho](#steward-v4-MorphoAaveV3ATokenP2PAdaptorV1-WithdrawFromAaveV3Morpho) | | Represents function `withdrawFromAaveV3Morpho(ERC20 tokenToWithdraw, uint256 amountToWithdraw, uint256 maxIterations)` | -| claim | [Claim](#steward-v4-Claim) | | Represents function `claim(uint256 claimable, bytes32[] memory proof)` | +| claimable | [string](#string) | | The amount of the asset to withdraw. | +| proof | [bytes](#bytes) | repeated | Proof of claim | + - + -### MorphoAaveV3ATokenP2PAdaptorV1.DepositToAaveV3Morpho -Allows strategists to lend assets on Morpho + -Represents function `depositToAaveV3Morpho(ERC20 tokenToDeposit, uint256 amountToDeposit, uint256 maxIterations)` + + + + + +

Top

+ +## oneinch.proto + + + + + +### OneInchAdaptorV1 +Represents call data for the OneInch adaptor. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| token_to_deposit | [string](#string) | | The address of the token to deposit | -| amount_to_deposit | [string](#string) | | The amount of tokens to deposit | -| max_iterations | [string](#string) | | The maximum number of iterations to run | +| revoke_approval | [RevokeApproval](#steward-v4-RevokeApproval) | | Represents function `revokeApproval(ERC20 asset, address spender)` | +| swap_with_one_inch | [OneInchAdaptorV1.SwapWithOneInch](#steward-v4-OneInchAdaptorV1-SwapWithOneInch) | | Represents function `swapWithOneInch(ERC20 tokenIn, ERC20 tokenOut, uint256 amount, bytes swapCallData)` | - + -### MorphoAaveV3ATokenP2PAdaptorV1.WithdrawFromAaveV3Morpho -Allows strategists to withdraw assets from Morpho +### OneInchAdaptorV1.SwapWithOneInch +Allows strategists to make ERC20 swaps using 1Inch. -Represents function `withdrawFromAaveV3Morpho(ERC20 tokenToWithdraw, uint256 amountToWithdraw, uint256 maxIterations)` +Represents function `swapWithOneInch(ERC20 tokenIn, ERC20 tokenOut, uint256 amount, bytes swapCallData)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| token_to_withdraw | [string](#string) | | The address of the token to withdraw | -| amount_to_withdraw | [string](#string) | | The amount of tokens to withdraw | -| max_iterations | [string](#string) | | The maximum number of iterations to run | +| token_in | [string](#string) | | | +| token_out | [string](#string) | | | +| amount | [string](#string) | | | +| swap_call_data | [bytes](#bytes) | | | - + -### MorphoAaveV3ATokenP2PAdaptorV1Calls +### OneInchAdaptorV1Calls | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| calls | [MorphoAaveV3ATokenP2PAdaptorV1](#steward-v4-MorphoAaveV3ATokenP2PAdaptorV1) | repeated | | +| calls | [OneInchAdaptorV1](#steward-v4-OneInchAdaptorV1) | repeated | | @@ -3434,177 +6417,195 @@ Represents function `withdrawFromAaveV3Morpho(ERC20 tokenToWithdraw, uint256 amo - +

Top

-## morpho_aave_v3_debt_token.proto +## staking.proto - + -### MorphoAaveV3DebtTokenAdaptorV1 -Represents call data for the Morpho Aave V3 Debt Token adaptor. +### StakingAdaptorV1 +Represents call data for the Staking adaptor V1 | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | revoke_approval | [RevokeApproval](#steward-v4-RevokeApproval) | | Represents function `revokeApproval(ERC20 asset, address spender)` | -| borrow_from_aave_v3_morpho | [MorphoAaveV3DebtTokenAdaptorV1.BorrowFromAaveV3Morpho](#steward-v4-MorphoAaveV3DebtTokenAdaptorV1-BorrowFromAaveV3Morpho) | | Represents function `borrowFromAaveV3Morpho(address underlying, uint256 amountToBorrow, uint256 maxIterations)` | -| repay_aave_v3_morpho_debt | [MorphoAaveV3DebtTokenAdaptorV1.RepayAaveV3MorphoDebt](#steward-v4-MorphoAaveV3DebtTokenAdaptorV1-RepayAaveV3MorphoDebt) | | Represents function `repayAaveV3MorphoDebt(ERC20 tokenToRepay, uint256 amountToRepay)` | +| mint | [StakingAdaptorV1.Mint](#steward-v4-StakingAdaptorV1-Mint) | | Represents function `mint(uint256 amount, uint256 minAmountOut, bytes calldata wildcard)` | +| request_burn | [StakingAdaptorV1.RequestBurn](#steward-v4-StakingAdaptorV1-RequestBurn) | | Represents function `requestBurn(uint256 amount, bytes calldata wildcard)` | +| complete_burn | [StakingAdaptorV1.CompleteBurn](#steward-v4-StakingAdaptorV1-CompleteBurn) | | Represents function `completeBurn(uint256 id, uint256 minAmountOut, bytes calldata wildcard)` | +| cancel_burn | [StakingAdaptorV1.CancelBurn](#steward-v4-StakingAdaptorV1-CancelBurn) | | Represents function `cancelBurn(uint256 id, bytes calldata wildcard)` | +| wrap | [StakingAdaptorV1.Wrap](#steward-v4-StakingAdaptorV1-Wrap) | | Represents function `wrap(uint256 amount, uint256 minAmountOut, bytes calldata wildcard)` | +| unwrap | [StakingAdaptorV1.Unwrap](#steward-v4-StakingAdaptorV1-Unwrap) | | Represents function `unwrap(uint256 amount, uint256 minAmountOut, bytes calldata wildcard)` | +| mint_erc20 | [StakingAdaptorV1.MintERC20](#steward-v4-StakingAdaptorV1-MintERC20) | | Represents function `mintERC20(ERC20 depositAsset, uint256 amount, uint256 minAmountOut, bytes calldata wildcard)` | +| remove_claimed_request | [StakingAdaptorV1.RemoveClaimedRequest](#steward-v4-StakingAdaptorV1-RemoveClaimedRequest) | | Represents function `removeClaimedRequest(uint256, bytes calldata)` | - + -### MorphoAaveV3DebtTokenAdaptorV1.BorrowFromAaveV3Morpho -Allows strategists to borrow assets from Morpho +### StakingAdaptorV1.CancelBurn +Allows a strategist to cancel an active burn/withdraw request. -Represents function `borrowFromAaveV3Morpho(address underlying, uint256 amountToBorrow, uint256 maxIterations)` +Represents the function `cancelBurn(uint256 id, bytes calldata wildcard)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| underlying | [string](#string) | | The underlying asset to borrow | -| amount_to_borrow | [string](#string) | | The amount of the underlying asset to borrow | -| max_iterations | [string](#string) | | The maximum number of iterations to perform | +| id | [string](#string) | | The id of the burn request | +| wildcard | [string](#string) | | Arbitrary ABI encoded data that can be used by inheriting adaptors | - + -### MorphoAaveV3DebtTokenAdaptorV1.RepayAaveV3MorphoDebt -Allows strategists to repay loan debt on Morpho +### StakingAdaptorV1.CompleteBurn +Allows a strategist to complete a burn/withdraw of a derivative asset for a native asset. -Represents function `repayAaveV3MorphoDebt(ERC20 tokenToRepay, uint256 amountToRepay)` +Represents the function `completeBurn(uint256 id, uint256 minAmountOut, bytes calldata wildcard)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| token_to_repay | [string](#string) | | The token to repay | -| amount_to_repay | [string](#string) | | The amount of the token to repay | +| id | [string](#string) | | The id of the burn request | +| min_amount_out | [string](#string) | | The minimum amount of the asset to receive | +| wildcard | [string](#string) | | Arbitrary ABI encoded data that can be used by inheriting adaptors | - + -### MorphoAaveV3DebtTokenAdaptorV1Calls +### StakingAdaptorV1.Mint +Allows a strategist to `mint` a derivative asset using the chains native asset. +Represents the function `mint(uint256 amount, uint256 minAmountOut, bytes calldata wildcard)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| calls | [MorphoAaveV3DebtTokenAdaptorV1](#steward-v4-MorphoAaveV3DebtTokenAdaptorV1) | repeated | | +| amount | [string](#string) | | The amount of the asset to mint | +| min_amount_out | [string](#string) | | The minimum amount of the asset to receive | +| wildcard | [string](#string) | | Arbitrary ABI encoded data that can be used by inheriting adaptors | - - + - +### StakingAdaptorV1.MintERC20 +Allows a strategist to mint a derivative asset using an ERC20. - +Represents the function `mintERC20(ERC20 depositAsset, uint256 amount, uint256 minAmountOut, bytes calldata wildcard)` +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| deposit_asset | [string](#string) | | The address of the ERC20 asset to deposit | +| amount | [string](#string) | | The amount of the asset to mint | +| min_amount_out | [string](#string) | | The minimum amount of the asset to receive | +| wildcard | [string](#string) | | Arbitrary ABI encoded data that can be used by inheriting adaptors | - -

Top

-## morpho_reward_handler.proto - -### Claim -Allows Morpho A Token cellars to claim Morpho Rewards + -Represents function `claim(uint256 claimable, bytes32[] memory proof)` +### StakingAdaptorV1.RemoveClaimedRequest +Allows strategist to remove a request from `requestIds` if it has already been claimed. + +Represents the function `removeClaimedRequest(uint256, bytes calldata)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| claimable | [string](#string) | | The amount of the asset to withdraw. | -| proof | [bytes](#bytes) | repeated | Proof of claim | +| id | [string](#string) | | The id of the request to remove | +| wildcard | [string](#string) | | Arbitrary ABI encoded data that can be used by inheriting adaptors | - - + - +### StakingAdaptorV1.RequestBurn +Allows a strategist to request to burn/withdraw a derivative for a chains native asset. - +Represents the function `requestBurn(uint256 amount, bytes calldata wildcard)` +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| amount | [string](#string) | | The amount of the asset to burn | +| wildcard | [string](#string) | | Arbitrary ABI encoded data that can be used by inheriting adaptors | - -

Top

-## oneinch.proto - -### OneInchAdaptorV1 -Represents call data for the OneInch adaptor. + + +### StakingAdaptorV1.Unwrap +Allows a strategist to unwrap a wrapped derivative asset. + +Represents the function `unwrap(uint256 amount, uint256 minAmountOut, bytes calldata wildcard)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| revoke_approval | [RevokeApproval](#steward-v4-RevokeApproval) | | Represents function `revokeApproval(ERC20 asset, address spender)` | -| swap_with_one_inch | [OneInchAdaptorV1.SwapWithOneInch](#steward-v4-OneInchAdaptorV1-SwapWithOneInch) | | Represents function `swapWithOneInch(ERC20 tokenIn, ERC20 tokenOut, uint256 amount, bytes swapCallData)` | +| amount | [string](#string) | | The amount of the asset to unwrap | +| min_amount_out | [string](#string) | | The minimum amount of the asset to receive | +| wildcard | [string](#string) | | Arbitrary ABI encoded data that can be used by inheriting adaptors | - + -### OneInchAdaptorV1.SwapWithOneInch -Allows strategists to make ERC20 swaps using 1Inch. +### StakingAdaptorV1.Wrap +Allows a strategist to wrap a derivative asset. -Represents function `swapWithOneInch(ERC20 tokenIn, ERC20 tokenOut, uint256 amount, bytes swapCallData)` +Represents the function `wrap(uint256 amount, uint256 minAmountOut, bytes calldata wildcard)` | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| token_in | [string](#string) | | | -| token_out | [string](#string) | | | -| amount | [string](#string) | | | -| swap_call_data | [bytes](#bytes) | | | +| amount | [string](#string) | | The amount of the asset to wrap | +| min_amount_out | [string](#string) | | The minimum amount of the asset to receive | +| wildcard | [string](#string) | | Arbitrary ABI encoded data that can be used by inheriting adaptors | - + -### OneInchAdaptorV1Calls +### StakingAdaptorV1Calls | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| calls | [OneInchAdaptorV1](#steward-v4-OneInchAdaptorV1) | repeated | | +| calls | [StakingAdaptorV1](#steward-v4-StakingAdaptorV1) | repeated | | @@ -3641,6 +6642,9 @@ Represents a scheduled function call to a particular Cellar | cellar_v1 | [CellarV1](#steward-v4-CellarV1) | | | | cellar_v2 | [CellarV2](#steward-v4-CellarV2) | | | | cellar_v2_2 | [CellarV2_2](#steward-v4-CellarV2_2) | | | +| cellar_v2_5 | [CellarV2_5](#steward-v4-CellarV2_5) | | | +| chain_id | [uint64](#uint64) | | The ID of the chain on which the target Cellar resides | +| deadline | [uint64](#uint64) | | The unix timestamp deadline for the contract call to be executed | @@ -3656,6 +6660,7 @@ Represents a scheduled function call to a particular Cellar | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | id | [string](#string) | | The hex encoded ID of the scheduled cork | +| chain_id | [uint64](#uint64) | | The ID of the chain on which the target Cellar resides |