StakingManager_v1

Router contract that enables users to stake issuance tokens and deploy the underlying collateral to yield-generating strategies. Source: src/core/modules/StakingManager_v1.sol. Interfaces: IStakingManager_v1, IReservePathModule_v1, IStakingManagerRemovalWindow_v1.

Functions

addStrategy

function addStrategy(address strategy_) external;

Adds a strategy to the approved list. Parameters

Name	Type	Description
`strategy_`	`address`	The address of the strategy to add.

IStakingManager_v1.sol#L322

cancelStrategyRemoval

function cancelStrategyRemoval(address strategy_) external;

Cancels a previously scheduled strategy removal. Parameters

Name	Type	Description
`strategy_`	`address`	The address of the strategy whose pending removal should be canceled.

IStakingManager_v1.sol#L346

harvestYield

function harvestYield(address strategy_, address receiver_) external returns (uint yieldAmount_);

Harvests yield from a strategy position. Parameters

Name	Type	Description
`strategy_`	`address`	The address of the strategy.
`receiver_`	`address`	The address to receive the yield.

Returns

Name	Type	Description
`yieldAmount_`	`uint`	The net yield amount after fees.

IStakingManager_v1.sol#L269

initiateStrategyRemoval

function initiateStrategyRemoval(address strategy_) external;

Schedules a strategy for removal, starting a notice period during which users should withdraw their positions. Parameters

Name	Type	Description
`strategy_`	`address`	The address of the strategy to schedule for removal.

IStakingManager_v1.sol#L340

rebalance

function rebalance(
    address strategy_,
    uint minSharesOut_
) external returns (uint additionalDeployed_);

Rebalances a position to current reference price. Parameters

Name	Type	Description
`strategy_`	`address`	The address of the strategy.
`minSharesOut_`	`uint`	Minimum measured minted shares (0 opts out).

Returns

Name	Type	Description
`additionalDeployed_`	`uint`	The additional collateral deployed.

IStakingManager_v1.sol#L313

removeStrategy

function removeStrategy(address strategy_) external;

Finalizes a previously initiated strategy removal. Parameters

Name	Type	Description
`strategy_`	`address`	The address of the strategy to remove.

IStakingManager_v1.sol#L363

setPerformanceFeeBps

function setPerformanceFeeBps(uint feeBps_) external;

Sets the performance fee percentage. Parameters

Name	Type	Description
`feeBps_`	`uint`	The fee in basis points, from 0 through 10,000 inclusive.

IStakingManager_v1.sol#L367

stake

function stake(address strategy_, uint issuanceTokenAmount_, uint minSharesOut_) external;

Stakes issuance tokens and deploys collateral to a strategy. Parameters

Name	Type	Description
`strategy_`	`address`	The address of the strategy.
`issuanceTokenAmount_`	`uint`	The amount of issuance tokens to stake.
`minSharesOut_`	`uint`	Minimum measured shares minted (0 opts out).

IStakingManager_v1.sol#L256

withdrawFunds

function withdrawFunds(
    address strategy_,
    uint reserveAmount_,
    address receiver_,
    uint maxSharesBurned_
) external returns (uint withdrawn_);

Withdraws funds from a strategy position. Parameters

Name	Type	Description
`strategy_`	`address`	The address of the strategy.
`reserveAmount_`	`uint`	The amount of collateral to withdraw.
`receiver_`	`address`	The address to receive the issuance tokens.
`maxSharesBurned_`	`uint`	Maximum measured principal burn (uint.max opts out). Excludes optional harvest. Incomplete principal withdrawal still reverts the entire call.

Returns

Name	Type	Description
`withdrawn_`	`uint`	The actual amount withdrawn.

IStakingManager_v1.sol#L294

View functions

getAvailableYield

function getAvailableYield(address user_, address strategy_) external view returns (uint yield_);

Returns the current yield available for a user in a strategy. Parameters

Name	Type	Description
`user_`	`address`	The address of the user.
`strategy_`	`address`	The address of the strategy.

Returns

Name	Type	Description
`yield_`	`uint`	The available yield amount.

IStakingManager_v1.sol#L208

getPerformanceFeeBps

function getPerformanceFeeBps() external view returns (uint feeBps_);

Returns the current performance fee in basis points. Returns

Name	Type	Description
`feeBps_`	`uint`	The performance fee in basis points.

IStakingManager_v1.sol#L223

getPosition

function getPosition(
    address user_,
    address strategy_
) external view returns (IReserveManager_v1.Position memory position_);

Returns the live ReserveManager position backing a user’s stake in a strategy. Parameters

Name	Type	Description
`user_`	`address`	The address of the user.
`strategy_`	`address`	The address of the strategy.

Returns

Name	Type	Description
`position_`	`IReserveManager_v1.Position`	The ReserveManager position record.

IStakingManager_v1.sol#L190

getPositionValue

function getPositionValue(address user_, address strategy_) external view returns (uint value_);

Returns the current value of a user’s position in collateral. Parameters

Name	Type	Description
`user_`	`address`	The address of the user.
`strategy_`	`address`	The address of the strategy.

Returns

Name	Type	Description
`value_`	`uint`	The current position value in collateral.

IStakingManager_v1.sol#L199

getStrategyRemovalExecuteAfter

function getStrategyRemovalExecuteAfter(
    address strategy_
) external view returns (uint executeAfter_);

Returns the timestamp at which a scheduled strategy removal becomes executable. Parameters

Name	Type	Description
`strategy_`	`address`	The address of the strategy to query.

Returns

Name	Type	Description
`executeAfter_`	`uint`	The execute-after timestamp, or `0` if none.

IStakingManager_v1.sol#L233

getStrategyRemovalExpiresAt

function getStrategyRemovalExpiresAt(address strategy_) external view returns (uint expiresAt_);

Returns the last timestamp at which removal can execute. Parameters

Name	Type	Description
`strategy_`	`address`	The address of the strategy to query.

Returns

Name	Type	Description
`expiresAt_`	`uint`	The inclusive expiry timestamp, or `0` if none.

IStakingManagerRemovalWindow_v1.sol#L32

isReservePathModule

function isReservePathModule() external pure returns (bool);

Identifies a CreditFacility or StakingManager reserve-path module. Returns

Name	Type	Description
	`bool`

IReservePathModule_v1.sol#L9

isStrategyApproved

function isStrategyApproved(address strategy_) external view returns (bool approved_);

Returns whether a strategy is approved. Parameters

Name	Type	Description
`strategy_`	`address`	The address of the strategy.

Returns

Name	Type	Description
`approved_`	`bool`	True if the strategy is approved.

IStakingManager_v1.sol#L216

STRATEGY_REMOVAL_EXECUTION_WINDOW

function STRATEGY_REMOVAL_EXECUTION_WINDOW() external view returns (uint window_);

Duration of the strategy removal execution window (72 hours). Returns

Name	Type	Description
`window_`	`uint`	The execution window in seconds.

IStakingManagerRemovalWindow_v1.sol#L20

Events

FundsWithdrawn

event FundsWithdrawn(
    address indexed user_,
    address indexed strategy_,
    address indexed receiver_,
    uint collateralWithdrawn_,
    uint issuanceTokensReturned_,
    uint sharesBurned_
);

Emitted when a user withdraws funds. Parameters

Name	Type	Description
`user_`	`address indexed`	The address of the user.
`strategy_`	`address indexed`	The address of the strategy.
`receiver_`	`address indexed`	The address that received the issuance tokens.
`collateralWithdrawn_`	`uint`	The amount of collateral withdrawn.
`issuanceTokensReturned_`	`uint`	The amount of issuance tokens returned.
`sharesBurned_`	`uint`	The measured principal-only burn, excluding harvest.

IStakingManager_v1.sol#L131

PerformanceFeeUpdated

event PerformanceFeeUpdated(uint oldFeeBps_, uint newFeeBps_);

Emitted when the performance fee is updated. Parameters

Name	Type	Description
`oldFeeBps_`	`uint`	The old fee in basis points.
`newFeeBps_`	`uint`	The new fee in basis points.

IStakingManager_v1.sol#L177

Rebalanced

event Rebalanced(
    address indexed user_,
    address indexed strategy_,
    uint additionalCollateralDeployed_,
    uint sharesMinted_
);

Emitted when a user rebalances their position. Parameters

Name	Type	Description
`user_`	`address indexed`	The address of the user.
`strategy_`	`address indexed`	The address of the strategy.
`additionalCollateralDeployed_`	`uint`	The additional collateral deployed.
`sharesMinted_`	`uint`	The measured share output.

IStakingManager_v1.sol#L145

Staked

event Staked(
    address indexed user_,
    address indexed strategy_,
    uint issuanceTokenAmount_,
    uint collateralDeployed_,
    uint sharesMinted_
);

Emitted when a user stakes issuance tokens. Parameters

Name	Type	Description
`user_`	`address indexed`	The address of the user.
`strategy_`	`address indexed`	The address of the strategy.
`issuanceTokenAmount_`	`uint`	The amount of issuance tokens staked.
`collateralDeployed_`	`uint`	The amount of collateral deployed.
`sharesMinted_`	`uint`	The measured share output.

IStakingManager_v1.sol#L102

StrategyAdded

event StrategyAdded(address indexed strategy_);

Emitted when a strategy is added. Parameters

Name	Type	Description
`strategy_`	`address indexed`	The address of the strategy.

IStakingManager_v1.sol#L154

StrategyRemovalCanceled

event StrategyRemovalCanceled(address indexed strategy_);

Emitted when a previously scheduled strategy removal is canceled. Parameters

Name	Type	Description
`strategy_`	`address indexed`	The address of the strategy whose pending removal was canceled.

IStakingManager_v1.sol#L172

StrategyRemovalInitiated

event StrategyRemovalInitiated(address indexed strategy_, uint executeAfter_);

Emitted when a strategy removal is initiated. Parameters

Name	Type	Description
`strategy_`	`address indexed`	The address of the strategy scheduled for removal.
`executeAfter_`	`uint`	The first timestamp at which removal can execute. The last is `executeAfter_ + STRATEGY_REMOVAL_EXECUTION_WINDOW`.

IStakingManager_v1.sol#L164

StrategyRemoved

event StrategyRemoved(address indexed strategy_);

Emitted when a strategy is removed. Parameters

Name	Type	Description
`strategy_`	`address indexed`	The address of the strategy.

IStakingManager_v1.sol#L158

YieldHarvested

event YieldHarvested(
    address indexed user_,
    address indexed strategy_,
    address indexed receiver_,
    uint netYield_,
    uint fee_
);

Emitted when a user harvests yield. Parameters

Name	Type	Description
`user_`	`address indexed`	The address of the user.
`strategy_`	`address indexed`	The address of the strategy.
`receiver_`	`address indexed`	The address that received the yield.
`netYield_`	`uint`	The net yield amount sent to receiver.
`fee_`	`uint`	The fee amount taken.

IStakingManager_v1.sol#L116

Errors

ModuleStakingManagerExcessSharesBurned

error Module__StakingManager__ExcessSharesBurned(uint burned_, uint maximum_);

The measured principal burn exceeds the caller bound. Parameters

Name	Type	Description
`burned_`	`uint`	The measured principal-only share burn.
`maximum_`	`uint`	The caller’s maximum principal share burn.

IStakingManager_v1.sol#L89

ModuleStakingManagerIncompleteWithdrawal

error Module__StakingManager__IncompleteWithdrawal();

Strategy returned less than requested on withdrawal. IStakingManager_v1.sol#L59

ModuleStakingManagerInsufficientPosition

error Module__StakingManager__InsufficientPosition();

Requested withdrawal exceeds debt or exceeds position value by more than one wei. IStakingManager_v1.sol#L46

ModuleStakingManagerInsufficientSharesOut

error Module__StakingManager__InsufficientSharesOut(uint minted_, uint minimum_);

The measured share output is below the caller bound. Parameters

Name	Type	Description
`minted_`	`uint`	The measured minted shares.
`minimum_`	`uint`	The caller’s minimum share output.

IStakingManager_v1.sol#L82

ModuleStakingManagerInvalidFeePercentage

error Module__StakingManager__InvalidFeePercentage();

Invalid fee percentage (exceeds maximum). IStakingManager_v1.sol#L53

ModuleStakingManagerInvalidStrategyInterface

error Module__StakingManager__InvalidStrategyInterface();

Strategy does not support the required interface. IStakingManager_v1.sol#L56

ModuleStakingManagerNoPosition

error Module__StakingManager__NoPosition();

User has no position in the strategy. IStakingManager_v1.sol#L40

ModuleStakingManagerNothingToRebalance

error Module__StakingManager__NothingToRebalance();

Nothing to rebalance (ReserveManager position is already at full capacity for the current reference price). IStakingManager_v1.sol#L50

ModuleStakingManagerNoYieldToHarvest

error Module__StakingManager__NoYieldToHarvest();

No yield available to harvest. IStakingManager_v1.sol#L43

ModuleStakingManagerStrategyAlreadyApproved

error Module__StakingManager__StrategyAlreadyApproved();

Strategy is already approved/registered. IStakingManager_v1.sol#L37

ModuleStakingManagerStrategyAssetMismatch

error Module__StakingManager__StrategyAssetMismatch();

Strategy’s underlying asset does not match collateral token. IStakingManager_v1.sol#L62

ModuleStakingManagerStrategyCurveMismatch

error Module__StakingManager__StrategyCurveMismatch();

Strategy belongs to another reference curve. IStakingManager_v1.sol#L68

ModuleStakingManagerStrategyManagerMismatch

error Module__StakingManager__StrategyManagerMismatch();

Strategy belongs to another StakingManager. IStakingManager_v1.sol#L65

ModuleStakingManagerStrategyNotApproved

error Module__StakingManager__StrategyNotApproved();

Strategy is not approved/registered. IStakingManager_v1.sol#L34

ModuleStakingManagerStrategyRemovalDelayNotElapsed

error Module__StakingManager__StrategyRemovalDelayNotElapsed();

The scheduled strategy removal delay has not yet elapsed. IStakingManager_v1.sol#L77

ModuleStakingManagerStrategyRemovalExpired

error Module__StakingManager__StrategyRemovalExpired();

The strategy removal execution window has expired. IStakingManagerRemovalWindow_v1.sol#L15

ModuleStakingManagerStrategyRemovalNotScheduled

error Module__StakingManager__StrategyRemovalNotScheduled();

No strategy removal is scheduled for this strategy. IStakingManager_v1.sol#L74

ModuleStakingManagerStrategyRemovalScheduled

error Module__StakingManager__StrategyRemovalScheduled();

An unexpired removal notice exists for this strategy. IStakingManager_v1.sol#L71