Whitelist Facet

Note that this page has not been updated to reflect the current state of Beanstalk, but is left here as a reference.

Whitelist Facet handles the whitelisting/dewhitelisting of assets on the Deposit Whitelist.

Call Functions

Dewhitelist Token

function dewhitelistToken(address token) external payable;

Dewhitelists tokens on the Deposit Whitelist. A token can no longer be Deposited in the Silo after dewhitelisting. Can only be called by the owner of Beanstalk.

Parameter	Type	Description
token	address	The token address to dewhitelist.

Whitelist Token

function whitelistToken(
    address token,
    bytes4 selector,
    uint32 stalkIssuedPerBdv,
    uint32 stalkEarnedPerSeason
) external payable;

Adds a token to the Deposit Whitelist. Can only be called by the owner of Beanstalk.

Parameter	Type	Description
token	address	The token address to whitelist.
selector	bytes4	The selector for the BDV function of token.
stalkIssuedPerBdv	uint32	Stalk per BDV for token issued upon Deposit.
stalkEarnedPerSeason	uint32	Grown Stalk per BDV per Season for token.

Whitelist Token with Encode Type

function whitelistTokenWithEncodeType(
    address token,
    bytes4 selector,
    uint32 stalkIssuedPerBdv,
    uint32 stalkEarnedPerSeason,
    bytes1 encodeType
) external payable;

Adds a token to the Deposit Whitelist with an encodeType. Can only be called by the owner of Beanstalk.

Parameter	Type	Description
token	address	The token address to whitelist.
selector	bytes4	The selector for the BDV function of token.
stalkIssuedPerBdv	uint32	Stalk per BDV for token issued upon Deposit.
stalkEarnedPerSeason	uint32	Grown Stalk per BDV per Season for token.
encodeType	bytes1	The encode type that should be used to encode the BDV function call.

Update Stalk per BDV per Season for Token

function updateStalkPerBdvPerSeasonForToken(
    address token,
    uint32 stalkEarnedPerSeason
) external payable;

Changes the Grown Stalk per BDV per Season for a token on the Deposit Whitelist. Can only be called by the owner of Beanstalk.

Parameter	Type	Description
token	address	The token address on the Deposit Whitelist.
stalkEarnedPerSeason	uint32	The new Grown Stalk per BDV per Season.

View Functions

None.

Events

Whitelist Token

event WhitelistToken(
    address indexed token,
    bytes4 selector,
    uint32 stalkEarnedPerSeason,
    uint256 stalkIssuedPerBdv
);

Emitted when a token is added to the Deposit Whitelist.

Parameter	Type	Description
token	address	The whitelisted token address.
selector	bytes4	The selector for the BDV function of token.
stalkEarnedPerSeason	uint32	Grown Stalk per BDV per Season for token.
stalkIssuedPerBdv	uint256	Stalk per BDV for token issued upon Deposit.

Update Stalk per BDV per Season

event UpdatedStalkPerBdvPerSeason(
    address indexed token,
    uint32 stalkEarnedPerSeason,
    uint32 season
);

Emitted when the Grown Stalk per BDV per Season for a token on the Deposit Whitelist is changed.

Parameter	Type	Description
token	address	The token address on the Deposit Whitelist.
stalkEarnedPerSeason	uint32	The new Grown Stalk per BDV per Season.
season	uint32	The current Season at the time of the change.

Dewhitelist Token

event DewhitelistToken(address indexed token);

Emitted when a token is removed from the Deposit Whitelist.

Parameter	Type	Description
token	address	The dewhitelisted token address.