Field Facet

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

The Field Facet is where Beans are Sown.

Call Functions

Sow

function sow(
    uint256 beans,
    uint256 minTemperature,
    LibTransfer.From mode
)
    external
    payable
    returns (uint256 pods);

Sow Beans in exchange for Pods.

Parameter	Type	Description
beans	uint256	The number of Beans to Sow.
minTemperature	uint256	The minimum Temperature at which to Sow.
mode	From	The balance to transfer Beans from; see LibTransfer.From.

Return Value	Type	Description
pods	uint256	The number of Pods received.

Sow With Min

function sowWithMin(
    uint256 beans,
    uint256 minTemperature,
    uint256 minSoil,
    LibTransfer.From mode
) public payable returns (uint256 pods);

Sow Beans in exchange for Pods. Use at least minSoil.

Parameter	Type	Description
beans	uint256	The number of Beans to Sow.
minTemperature	uint256	The minimum Temperature at which to Sow.
minSoil	uint256	The minimum amount of Soil to use; reverts if there is less than this much Soil available upon execution.
mode	From	The balance to transfer Beans from; see LibTransfer.From.

Return Value	Type	Description
pods	uint256	The number of Pods received.

Harvest

function harvest(uint256[] calldata plots, LibTransfer.To mode)
    external
    payable;

Harvest Pods from the Field.

Parameter	Type	Description
plots	uint256[]	List of Plot IDs to Harvest.
mode	To	The balance to transfer Beans to; see LibTransfer.To.

View Functions

Pod Index

function podIndex() public view returns (uint256);

Returns the total number of Pods ever minted.

Return Type	Description
uint256	The total number of Pods ever minted.

Harvestable Index

function harvestableIndex() public view returns (uint256);

Returns the index below which Pods are Harvestable.

Return Type	Description
uint256	The index below which Pods are Harvestable.

Total Pods

function totalPods() public view returns (uint256);

Returns the number of outstanding Pods. Includes Pods that are currently Harvestable but have not yet been Harvested.

Return Type	Description
uint256	The number of outstanding Pods.

Total Harvested

function totalHarvested() public view returns (uint256);

Returns the number of Pods that have ever been Harvested.

Return Type	Description
uint256	The number of Pods that have ever been Harvested.

Total Harvestable

function totalHarvestable() public view returns (uint256);

Returns the number of Pods that are currently Harvestable but have not yet been Harvested.

Return Type	Description
uint256	The number of Pods that are currently Harvestable but have not yet been Harvested.

Total Unharvestable

function totalUnharvestable() public view returns (uint256);

Returns the number of Pods that are not yet Harvestable.

Return Type	Description
uint256	The number of Pods that are not yet Harvestable.

Plot

function plot(address account, uint256 index)
    public
    view
    returns (uint256);

Returns the number of Pods remaining in a Plot.

Parameter	Type	Description
account	address	The account that owns a Plot.
index	uint256	The ID of a Plot.

Return Type	Description
uint256	The number of Pods remaining in a Plot.

Total Soil

function totalSoil() external view returns (uint256);

Returns the total available Soil.

Return Type	Description
uint256	The total available Soil.

Yield

function yield() external view returns (uint32);

Returns the current yield (aka "Temperature") offered by Beanstalk when burning Beans in exchange for Pods.

Return Type	Description
uint32	The current yield offered by Beanstalk when burning Beans in exchange for Pods.

Temperature

function temperature() external view returns (uint256);

Returns the current Temperature, the interest rate offered by Beanstalk in exchange for Sowing Beans.

Return Value	Description
uint256	The current Temperature.

Max Temperature

function maxTemperature() external view returns (uint256);

Returns the Maximum Temperature that Beanstalk is willing to offer this Season.

Return Type	Description
uint256	The Maximum Temperature.

Remaining Pods

function remainingPods() external view returns (uint256);

Returns the remaining Pods that could be issued this Season.

Return Value	Description
uint256	The remaining Pods that could be issued this Season.

Events

Sow

event Sow(
    address indexed account,
    uint256 index,
    uint256 beans,
    uint256 pods
);

Emitted from LibDibbler.sowNoSoil when an account creates a Plot. A Plot is a set of Pods created in from a single sow or fund call.

Parameter	Type	Description
account	address	The account that Sowed Beans for Pods.
index	uint256	The Place in Line of the Plot.
beans	uint256	The amount of Beans burnt to create the Plot.
pods	uint256	The amount of Pods associated with the created Plot.

Harvest

event Harvest(address indexed account, uint256[] plots, uint256 beans);

Emitted when account claims the Beans associated with Harvestable Pods.

Parameter	Type	Description
account	address	The account that owns the plots.
plots	uint256[]	The indices of Plots that were Harvested.
beans	uint256	The amount of Beans transferred to account.

Pod Listing Cancelled

event PodListingCancelled(address indexed account, uint256 index);

Emitted when a Pod Listing is Cancelled.

Parameter	Type	Description
account	address	The account that created the Pod Listing.
index	uint256	The index of the Plot listed.