IParameterRegistry

Functions

setBounds

Updates the bounds for a specific parameter.

Only callable by an authorized governor.

function setBounds(ParamKey key, Bounds calldata newBounds) external;

Parameters

Name	Type	Description
`key`	`ParamKey`	The parameter key to update.
`newBounds`	`Bounds`	The new bounds structure to apply.

aParams

function aParams() external view returns (Bounds memory);

Returns

Name	Type	Description
`<none>`	`Bounds`	Bounds for the 'A' coefficient parameter

swapFeeParams

function swapFeeParams() external view returns (Bounds memory);

Returns

Name	Type	Description
`<none>`	`Bounds`	Bounds for the swap fee

mintFeeParams

function mintFeeParams() external view returns (Bounds memory);

Returns

Name	Type	Description
`<none>`	`Bounds`	Bounds for the mint fee

redeemFeeParams

function redeemFeeParams() external view returns (Bounds memory);

Returns

Name	Type	Description
`<none>`	`Bounds`	Bounds for the redeem fee

offPegParams

function offPegParams() external view returns (Bounds memory);

Returns

Name	Type	Description
`<none>`	`Bounds`	Bounds for the off-peg multiplier

exchangeRateFeeParams

function exchangeRateFeeParams() external view returns (Bounds memory);

Returns

Name	Type	Description
`<none>`	`Bounds`	Bounds for exchange rate fee changes

decayPeriodParams

function decayPeriodParams() external view returns (Bounds memory);

Returns

Name	Type	Description
`<none>`	`Bounds`	Bounds for decay period

rateChangeSkipPeriodParams

function rateChangeSkipPeriodParams() external view returns (Bounds memory);

Returns

Name	Type	Description
`<none>`	`Bounds`	Bounds for the rate change skip period

feeErrorMarginParams

function feeErrorMarginParams() external view returns (Bounds memory);

Returns

Name	Type	Description
`<none>`	`Bounds`	Bounds for the fee error margin

yieldErrorMarginParams

function yieldErrorMarginParams() external view returns (Bounds memory);

Returns

Name	Type	Description
`<none>`	`Bounds`	Bounds for the yield error margin

minRampTimeParams

function minRampTimeParams() external view returns (Bounds memory);

Returns

Name	Type	Description
`<none>`	`Bounds`	Bounds for the minimum ramp time

bufferPercentParams

function bufferPercentParams() external view returns (Bounds memory);

Returns

Name	Type	Description
`<none>`	`Bounds`	Bounds for the buffer percentage

Events

BoundsUpdated

Emitted when parameter bounds are updated.

event BoundsUpdated(ParamKey key, Bounds oldParams, Bounds newParams);

Parameters

Name	Type	Description
`key`	`ParamKey`	The parameter key that was updated.
`oldParams`	`Bounds`	The old bounds before the update.
`newParams`	`Bounds`	The new bounds after the update.

Errors

ZeroAddress

error ZeroAddress();

Structs

Bounds

Structure representing bounds for a given parameter.

All percentages are expressed in parts-per-million (ppm), i.e., 1e6 = 100%.

struct Bounds {
    uint256 max;
    uint256 min;
    uint64 maxDecreasePct;
    uint64 maxIncreasePct;
}

Properties

Name	Type	Description
`max`	`uint256`	The maximum hard cap for the parameter value in parameter format.
`min`	`uint256`	The minimum hard cap for the parameter value in parameter format.
`maxDecreasePct`	`uint64`	The maximum decrease allowed per transaction with 1e10 decimal, e.g., 9e9 = -90%.
`maxIncreasePct`	`uint64`	The maximum increase allowed per transaction with 1e10 decimal, e.g., 9e9 = +90%.

Enums

ParamKey

Unique keys identifying different parameter types.

enum ParamKey {
    A,
    SwapFee,
    MintFee,
    RedeemFee,
    OffPeg,
    ExchangeRateFee,
    DecayPeriod,
    RateChangeSkipPeriod,
    FeeErrorMargin,
    YieldErrorMargin,
    MinRampTime,
    BufferPercent
}

Keyboard shortcuts