Silo Facet
Note that this page has not been updated to reflect the current state of Beanstalk, but is left here as a reference.
The Silo Facet handles Depositing, Withdrawing, and transferring Deposits (whitelisted assets in the Silo).
Stems keep track of when the Deposit was created. When the Deposit was created determines how much Grown Stalk per BDV the Deposit has.
Call Functions
function deposit(
address token,
uint256 _amount,
LibTransfer.From mode
)
external
payable
nonReentrant
mowSender(token)
returns (uint256 amount, uint256 bdv, int96 stem);
Deposits ERC20 token into internal Farmer balances.
token
address
Address of the token to Deposit.
_amount
uint256
Amount of the token to be Deposited.
mode
From
amount
address
Amount of the token Deposited.
bdv
uint256
BDV of the Deposit.
stem
int96
Stem of the Deposit.
function withdrawDeposit(
address token,
int96 stem,
uint256 amount
LibTransfer.To mode
) external payable mowSender(token) nonReentrant;
Withdraws a single Deposit.
token
address
Address of ERC20 being Withdrawn.
stem
int96
Stem of the Deposit to Withdraw.
amount
uint256
Tokens to be Withdrawn.
mode
To
function withdrawDeposits(
address token,
int96[] calldata stems,
uint256[] calldata amounts,
LibTransfer.To mode
) external payable mowSender(token) nonReentrant;
Withdraws multiple Deposits.
token
address
Address of ERC20 being Withdrawn.
stems
int96[]
Stems of the Deposits to Withdraw.
amounts
uint256[]
Array of token amounts to Withdraw from corresponding stems
.
mode
To
function transferDeposit(
address sender,
address recipient,
address token,
int96 stem,
uint256 amount
) public payable nonReentrant returns (uint256 bdv);
Transfers single Farmer's Deposit.
sender
address
Source of Deposit.
recipient
address
Destination of Deposit.
token
address
Address of Deposited ERC20 being transferred.
stem
int96
Stem of Deposit to Transfer.
amount
uint256
Amount of tokens to transfer.
bdv
uint256
BDV now owned by recipient
.
function transferDeposits(
address sender,
address recipient,
address token,
int96[] calldata stem,
uint256[] calldata amounts
) public payable nonReentrant returns (uint256[] memory bdvs);
Transfers multiple Farmer Deposits.
sender
address
Source of Deposit.
recipient
address
Destination of Deposit.
token
address
Address of ERC20 being transferred.
stem
int96[]
Stems of Deposits to transfer.
amounts
uint256[]
Array of token amounts to transfer based on corresponding stems
.
bdvs
uint256[]
Array of BDVs of each Deposit transferred.
function safeTransferFrom(
address sender,
address recipient,
uint256 depositId,
uint256 amount,
bytes calldata
) external;
Transfer a single Deposit, conforming to the ERC1155 standard.
sender
address
Source of Deposit.
recipient
address
Destination of Deposit.
depositId
uint256
ID of Deposit to transfer.
amount
uint256
Amount of ERC1155 to transfer.
function safeBatchTransferFrom(
address sender,
address recipient,
uint256[] calldata depositIds,
uint256[] calldata amounts,
bytes calldata
) external;
Transfer a single Deposit, conforming to the ERC1155 standard.
sender
address
Source of Deposit.
recipient
address
Destination of Deposit.
depositIds
uint256[]
Array of IDs of Deposits to transfer.
amounts
uint256[]
Array of amounts of ERC1155 to transfer, corresponding to depositIds
.
Yield Distribution
function mow(address account, address token) external payable;
Claim Grown Stalk for an account for a particular whitelisted asset.
account
address
Address to Mow for.
token
address
Address of ERC20 Deposit to Mow for.
function mowMultiple(address account, address[] calldata tokens) external payable;
Mow for multiple whitelisted assets for an account.
account
address
Address to Mow for.
tokens
address[]
Array of addresses of ERC20 Deposits to Mow for.
function plant()
external payable returns (uint256 beans, int96 stem);
Claim Earned Beans and their associated Stalk and Plantable Seeds for msg.sender
.
beans
uint256
Amount of Earned Beans given.
stem
int96
Stem of the new Deposit.
function claimPlenty() external payable;
Claims rewards from a Flood (Season of Plenty) for msg.sender
.
View Functions
Utilities
function lastUpdate(address account) public view returns (uint32);
Get the last Season in which account
updated their Silo.
uint32
Last Season account
updated their Silo.
Silo Totals
function totalStalk() public view returns (uint256);
Returns the total supply of Stalk. Does NOT include Grown Stalk.
uint256
Total supply of Stalk.
function totalRoots() public view returns (uint256);
Returns the total supply of Roots.
uint256
The total supply of Roots.
function totalEarnedBeans() public view returns (uint256);
Returns the total supply of Earned Beans.
uint256
Total supply of Earned Beans.
Silo Account Balances
function balanceOfStalk(address account) public view returns (uint256);
Returns the balance of Stalk for a particular Farmer. Does NOT include Grown Stalk; does include Earned Stalk.
account
address
Farmer to get the Stalk balance for.
uint256
Stalk balance of account
.
function balanceOfRoots(address account) public view returns (uint256);
Returns the balance of Roots for a particular Farmer.
account
address
Farmer to get the Roots balance for.
uint256
Roots balance of account
.
function balanceOfGrownStalk(address account, address token)
public
view
returns (uint256);
Returns the balance of Grown Stalk for account
. Grown Stalk is earned each Season from BDV and must be Mown to add it to a user's Stalk balance.
account
address
Farmer to get the Grown Stalk balance for.
uint256
Grown Stalk balance of account
.
function grownStalkForDeposit(
address account,
address token,
int96 stem
)
public
view
returns (uint grownStalk);
Returns the balance of Grown Stalk for a single deposit of token
in stem
for account
.
account
address
Farmer that owns the Deposit to get the Grown Stalk balance for.
token
address
ERC20 token address of the Deposit.
stem
int96
Stem of the Deposit.
grownStalk
uint
Grown Stalk for Deposit.
function balanceOfEarnedBeans(address account)
public
view
returns (uint256 beans);
Returns the balance of Earned Beans for a Farmer.
account
address
Farmer to get the Earned Bean balance for.
beans
uint256
Earned Bean balance of account
.
function balanceOfEarnedStalk(address account)
public
view
returns (uint256)
Return the account
balance of Earned Stalk, the Stalk associated with Earned Beans.
account
address
Farmer to get the Earned Stalk balance for.
uint256
Earned Stalk balance of account
.
function balanceOfDepositedBdv(address account, address token)
external
view
returns (uint256 depositedBdv);
Return the balance of Deposited BDV of a whitelisted asset for a given Farmer.
account
address
Farmer to get the Deposited BDV balance for.
token
address
Whitelisted asset to get the balance of Deposited BDV for.
depositedBdv
uint256
Balance of Deposited BDV given account
and token
.
function getLastMowedStem(address account, address token)
external
view
returns (int96 lastStem);
Return the Stem at the time that a Farmer last Mowed a particular whitelisted asset.
account
address
Farmer to get the last Mowed Stem for.
token
address
Whitelisted asset to get the last Mowed Stem for.
lastStem
int96
Last Mowed Stem for token
given account
.
function getMowStatus(address account, address token)
external
view
returns (Account.MowStatus memory mowStatus);
Return the Mow Status struct of token
for a given account
.
account
address
Farmer to get the Mow Status of.
token
address
Token to get the Mow Status of account
for.
Account.MowStatus
Season of Plenty (Flood)
function lastSeasonOfPlenty() public view returns (uint32);
Returns the last Season that a Season of Plenty started.
uint32
The last Season it started Flooding.
function balanceOfPlenty(address account)
public
view
returns (uint256 plenty);
Returns the Farmer's balance of unclaimed 3CRV earned from the Season of Plenty.
account
address
Farmer to get the unclaimed 3CRV balance for.
plenty
uint256
Unclaimed 3CRV balance of account
.
function balanceOfRainRoots(address account) public view returns (uint256);
Returns the account
balance of Roots the last time it was Raining during a Silo update.
account
address
Farmer to get "Rain Roots" balance for.
uint256
Root balance last time it was Raining for account
.
function balanceOfSop(address account)
external
view
returns (AccountSeasonOfPlenty memory sop);
Returns the account
Season of Plenty related state variables.
account
address
Farmer to get SOP related state variables for.
sop
AccountSeasonOfPlenty
Struct containing SOP related state variables.
Stems
function stemTipForToken(address token)
public
view
returns (int96 _stemTip);
Returns the "stemTip", or cumulative Grown Stalk Per BDV of a given Deposited asset since whitelist, for a given whitelisted token.
token
address
ERC20 token to get the Stem tip for.
_stemTip
int96
Returns the Stem tip for token
.
function seasonToStem(address token, uint32 season)
public
view
returns (int96 stem);
Get the Stem associated with a particular Deposit (via its token and Season). Kept for legacy reasons.
token
address
ERC20 token of the Deposit.
season
uint32
Season of the Deposit.
stem
int96
Stem of the Deposit.
function getSeedsPerToken(address token) public view virtual returns (uint256);
Gets the Seeds per token for legacy whitelisted assets. Calling with an non-legacy token will return 0, even after the token is whitelisted. Kept for legacy reasons.
token
address
Legacy token to get the Seeds for.
uint256
Seeds for the legacy token.
function stemStartSeason() public view virtual returns (uint16);
Returns the Season in which Beanstalk initialized Silo V3, i.e., the Season in which Stems were initialized.
uint16
Season in which Stems were initialized.
function migrationNeeded(address account) public view returns (bool);
Returns whether or not a Farmer needs to migrate to Silo V3.
account
address
Farmer to check if migration is needed for.
bool
Whether or not account
needs to migrate to Silo V3.
function inVestingPeriod() public view returns (bool);
Returns if Earned Beans from the previous gm
call are still vesting. Vesting Earned Beans cannot be received via plant
until the Vesting Period is over, and will be forfeited if a Farmer Withdraws during the Vesting Period.
bool
Whether or not Earned Beans from the previous gm
function call are still vesting.
Getters
function getDeposit(
address account,
address token,
int96 stem
) external view returns (uint256, uint256)
Find the amount and BDV of token
that a Farmer has Deposited in a given Stem.
account
address
Farmer to get Deposit data for.
token
address
ERC20 token of the Deposit.
stem
int96
Stem of the Deposit.
uint256
Number of tokens in the Deposit.
uint256
BDV of the Deposit.
function getTotalDeposited(address token) external view returns (uint256);
Get the total amount of token
currently Deposited in the Silo across all Farmers.
token
address
Whitelisted token address.
uint256
Total number of token
Deposited in the Silo.
function getTotalDepositedBdv(address token) external view returns (uint256);
Get the total BDV of token
currently Deposited in the Silo across all Farmers.
token
address
Whitelisted token address.
uint256
Total BDV of token
Deposited in the Silo.
function tokenSettings(address token)
external
view
returns (Storage.SiloSettings memory);
Get the Storage.SiloSettings
for a whitelisted token.
token
address
Whitelisted token address.
Storage.SiloSettings
Struct with Silo variables for token
.
function bdv(address token, uint256 amount)
external
view
returns (uint256 _bdv);
Returns the total BDV of a number of tokens on the Deposit Whitelist.
token
address
The whitelisted token address.
amount
uint256
The number of tokens.
uint256
ERC-1155
function balanceOf(
address account,
uint256 depositId
) external view returns (uint256 amount);
Gets the amount of tokens in a Deposit type for a given Farmer.
account
address
Farmer to get Deposit amount for.
depositId
uint256
Deposit ID corresponding to account
.
amount
Amount of tokens in a Deposit type for account
.
function balanceOfBatch(
address[] calldata accounts,
uint256[] calldata depositIds
) external view returns (uint256[] memory);
Gets an array of amounts corresponding to Deposits.
accounts
address[]
List of Farmers.
depositIds
uint256[]
List of Deposit IDs corresponding to accounts
.
uint256[]
Array of amounts corresponding to the list of Deposits.
function getDepositId(
address token,
int96 stem
) external pure returns (uint256);
Gets the Deposit ID given an whitelisted token address and Stem.
token
address
Whitelisted token address.
stem
int96
Stem of the Deposit.
uint256
Deposit ID of token
with stem
.
Events
event Plant(
address indexed account,
uint256 beans
);
Emitted when the deposit associated with the Earned Beans of account
are Planted.
account
address
Farmer that Planted their Earned Beans.
beans
uint256
The amount of Earned Beans claimed.
event ClaimPlenty(
address indexed account,
uint256 plenty
);
Emitted when 3CRV paid to account
during a Flood is claimed.
account
address
Farmer that claimed the assets.
plenty
uint256
The amount of 3CRV claimed by account
.
event StalkBalanceChanged(
address indexed account,
int256 delta,
int256 deltaRoots
);
Emitted when account
gains or loses Stalk.
account
address
The Farmer whose Stalk balance changed.
delta
int256
The change in Stalk.
deltaRoots
int256
The change in Roots.
event AddDeposit(
address indexed account,
address indexed token,
int96 stem,
uint256 amount,
uint256 bdv
);
Emitted when account
adds a single Deposit to the Silo. There is no AddDeposits
event because there is currently no operation in which Beanstalk creates multiple Deposits in different Stems.
account
address
The Farmer that added a Deposit to Beanstalk.
token
address
Whitelisted token address.
stem
int96
The Stem of the Deposit.
amount
uint256
Token amount of the Deposit.
bdv
uint256
The BDV associated with amount
of token
at the time of Deposit.
event RemoveDeposit(
address indexed account,
address indexed token,
int96 stem,
uint256 amount,
uint256 bdv
);
Emitted when account
removes a single Deposit from the Silo. Occurs during Withdraw and Convert.
account
address
The Farmer whose Deposit was removed.
token
address
Whitelisted token address.
stem
int96
The Stem of the Deposit.
amount
uint256
The token amount of the Deposit.
bdv
uint256
The BDV associated with the Deposit.
event RemoveDeposits(
address indexed account,
address indexed token,
int96[] stems,
uint256[] amounts,
uint256 amount,
uint256[] bdvs
);
Emitted when account
removes multiple Deposits from the Silo. Occurs during Withdraw and Convert.
account
address
The Farmer whose Deposit was removed.
token
address
Whitelisted token address.
stems
uint32[]
Stems of the Deposits.
amounts
uint256[]
The token amounts of the Deposits, corresponding to stems
.
amount
uint256
Sum of amounts
.
bdvs
uint256[]
The BDVs associated with the Deposits, corresponding to stems
and amounts
.
event TransferSingle(
address indexed operator,
address indexed from,
address indexed to,
uint256 id,
uint256 value
);
ERC-1155 event. Emitted when a Deposit is created, removed, or transferred.
operator
address
The address that performed the operation.
from
address
The address the Deposit is being transferred from.
to
address
The address the Deposit is being transferred to.
id
uint256
The Deposit ID of the Deposit.
value
uint256
The amount of the Deposit.
event TransferBatch(
address indexed operator,
address indexed from,
address indexed to,
uint256[] ids,
uint256[] values
);
ERC-1155 event. Emitted when multiple deposits are withdrawn or transferred.
operator
address
The address that performed the operation.
from
address
The address the Deposit is being transferred from.
to
address
The address the Deposit is being transferred to.
ids
uint256[]
The Deposit IDs of the Deposits.
values
uint256[]
The amounts of the Deposits.
event RemoveWithdrawals(
address indexed account,
address indexed token,
uint32[] seasons,
uint256 amount
);
Legacy event. This event is kept for backwards compatibility in order for the ABI to generate properly.
account
address
Farmer that claimed the Withdrawals.
token
address
Whitelisted token address.
seasons
uint32[]
Seasons of claimed Withdrawn assets.
amount
uint256
Amount of claimed asset.
event RemoveWithdrawal(
address indexed account,
address indexed token,
uint32 season,
uint256 amount
);
Legacy event. This event is kept for backwards compatibility in order for the ABI to generate properly.
account
address
Farmer that claimed the Withdrawal.
token
address
Whitelisted token address.
season
uint32
Seasons of claimed Withdrawn asset.
amount
uint256
Amount of claimed asset.
Last updated