1 of 5

Diamond

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

The Diamond module contains various functions that require ownership of Beanstalk to execute in Beanstalk. This includes Pausing and Unpausing Beanstalk and upgrading Beanstalk via Diamond Cuts.

See EIP-2535 Diamond to read more about Beanstalk's upgradable proxy implementation.

The Diamond consists of 4 facets:

Diamond Cut Facet
Diamond Loupe Facet
Ownership Facet
Pause Facet

Diamond Cut Facet

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

The Diamond Cut Facet is used by the owner to upgrade Beanstalk.

Call Functions

Add, replace, and/or remove any number of functions and optionally execute a function with delegatecall. Can only be called by the owner of Beanstalk.

Parameter

Type

Description

View Functions

None.

Events

None.

Diamond Loupe Facet

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

The Diamond Loupe Facet allows anyone to see the available functions within Beanstalk.

Call Functions

None.

View Functions

Facets

function facets() external view override returns (Facet[] memory facets_);

Returns facet info for all facets of Beanstalk

Return Value

Type

Description

facets_

Facet[]

Array of facet info.

Facet Function Selectors

function facetFunctionSelectors(address _facet)
    external
    view
    override
    returns (bytes4[] memory facetFunctionSelectors_);

Returns all the function selectors provided by a facet.

Parameter

Type

Description

_facet

address

Facet to get selectors for.

Return Value

Type

Description

facetFunctionSelectors_

bytes4[]

Selectors on _facet.

Facet Addresses

function facetAddresses() 
    external 
    view 
    override 
    returns (address[] memory facetAddresses_);

Get all the facet addresses used by the Beanstalk Diamond.

Return Value

Type

Description

facetAddresses_

address[]

All facet addresses used by Beanstalk.

Facet Address

function facetAddress(bytes4 _functionSelector)
    external
    view
    override
    returns (address facetAddress_);

Gets the facet that supports the given selector.

Parameter

Type

Description

_functionSelector

bytes4

Selector to get the corresponding facet for.

Return Value

Type

Description

facetAddress_

address

Facet that has _functionSelector.

Supports Interface

function supportsInterface(bytes4 _interfaceId) 
    external 
    view 
    override 
    returns (bool);

Returns if a contract implements an interface. Implements ERC-165.

Parameter

Type

Description

_interfaceId

bytes4

The interface ID, as specified in ERC-165.

Return Type

Description

bool

True if the contract implements _interfaceId, false otherwise.

Events

None.

Ownership Facet

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

The Ownership Facet handles the ownership of Beanstalk.

Call Functions

Transfer Ownership

function transferOwnership(address _newOwner) external;

Transfers ownership of Beanstalk to a new address. Can only be called by the owner of Beanstalk.

Parameter

Type

Description

_newOwner

address

The address to transfer ownership to.

Claim Ownership

function claimOwnership() external;

Callable by candidate for ownership after a successful transferOwnership function call.

View Functions

Owner

function owner() external view returns (address owner_);

Returns the address of the owner of Beanstalk.

Return Value

Type

Description

owner_

address

The address of the owner of Beanstalk.

Owner Candidate

function ownerCandidate() external view returns (address ownerCandidate_);

Returns the owner candidate of Beanstalk.

Return Value

Type

Description

ownerCandidate_

address

The owner candidate of Beanstalk.

Events

Ownership Transferred

event OwnershipTransferred(
    address indexed previousOwner, 
    address indexed newOwner
);

Emitted when ownership of Beanstalk is transferred.

Parameter

Type

Description

previousOwner

address

The previous owner of Beanstalk.

newOwner

address

The new owner of Beanstalk.

Pause Facet

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

The Pause Facet handles the Pausing and Unpausing of Beanstalk.

Call Functions

Pause

function pause() external payable;

Pause Beanstalk, which makes it such that the gm function cannot be successfully called. Only callable by the owner of Beanstalk.

Unpause

function unpause() external payable;

Unpause Beanstalk, which allows the gm function to be successfully called at the top of the 2nd hour. The TWAP oracle and Season timer are reset as well.

View Functions

None.

Events

Pause

event Pause(uint256 timestamp);

Emitted when Beanstalk is Paused.

Parameter

Type

Description

timestamp

uint256

Timestamp of the current block when Beanstalk is Paused.

Unpause

event Unpause(uint256 timestamp, uint256 timePassed);

Emitted when Beanstalk is Unpaused.

Parameter

Type

Description

timestamp

uint256

Timestamp of the current block when Beanstalk is Unpaused.

timePassed

uint256

How much time passed while Beanstalk was Paused.

Diamond Loupe Facet

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

The Diamond Loupe Facet allows anyone to see the available functions within Beanstalk.

Call Functions

None.

View Functions

Facets

function facets() external view override returns (Facet[] memory facets_);

Returns facet info for all facets of Beanstalk

Return Value

Type

Description

facets_

Facet[]

Array of facet info.

Facet Function Selectors

function facetFunctionSelectors(address _facet)
    external
    view
    override
    returns (bytes4[] memory facetFunctionSelectors_);

Returns all the function selectors provided by a facet.

Parameter

Type

Description

_facet

address

Facet to get selectors for.

Return Value

Type

Description

facetFunctionSelectors_

bytes4[]

Selectors on _facet.

Facet Addresses

function facetAddresses() 
    external 
    view 
    override 
    returns (address[] memory facetAddresses_);

Get all the facet addresses used by the Beanstalk Diamond.

Return Value

Type

Description

facetAddresses_

address[]

All facet addresses used by Beanstalk.

Facet Address

function facetAddress(bytes4 _functionSelector)
    external
    view
    override
    returns (address facetAddress_);

Gets the facet that supports the given selector.

Parameter

Type

Description

_functionSelector

bytes4

Selector to get the corresponding facet for.

Return Value

Type

Description

facetAddress_

address

Facet that has _functionSelector.

Supports Interface

function supportsInterface(bytes4 _interfaceId) 
    external 
    view 
    override 
    returns (bool);

Returns if a contract implements an interface. Implements ERC-165.

Parameter

Type

Description

_interfaceId

bytes4

The interface ID, as specified in ERC-165.

Return Type

Description

bool

True if the contract implements _interfaceId, false otherwise.

Events

None.

Pause Facet

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

The Pause Facet handles the Pausing and Unpausing of Beanstalk.

Call Functions

Pause

function pause() external payable;

Pause Beanstalk, which makes it such that the gm function cannot be successfully called. Only callable by the owner of Beanstalk.

Unpause

function unpause() external payable;

Unpause Beanstalk, which allows the gm function to be successfully called at the top of the 2nd hour. The TWAP oracle and Season timer are reset as well.

View Functions

None.

Events

Pause

event Pause(uint256 timestamp);

Emitted when Beanstalk is Paused.

Parameter

Type

Description

timestamp

uint256

Timestamp of the current block when Beanstalk is Paused.

Unpause

event Unpause(uint256 timestamp, uint256 timePassed);

Emitted when Beanstalk is Unpaused.

Parameter

Type

Description

timestamp

uint256

Timestamp of the current block when Beanstalk is Unpaused.

timePassed

uint256

How much time passed while Beanstalk was Paused.

Ownership Facet

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

The Ownership Facet handles the ownership of Beanstalk.

Call Functions

Transfer Ownership

function transferOwnership(address _newOwner) external;

Transfers ownership of Beanstalk to a new address. Can only be called by the owner of Beanstalk.

Parameter

Type

Description

_newOwner

address

The address to transfer ownership to.

Claim Ownership

function claimOwnership() external;

Callable by candidate for ownership after a successful transferOwnership function call.

View Functions

Owner

function owner() external view returns (address owner_);

Returns the address of the owner of Beanstalk.

Return Value

Type

Description

owner_

address

The address of the owner of Beanstalk.

Owner Candidate

function ownerCandidate() external view returns (address ownerCandidate_);

Returns the owner candidate of Beanstalk.

Return Value

Type

Description

ownerCandidate_

address

The owner candidate of Beanstalk.

Events

Ownership Transferred

event OwnershipTransferred(
    address indexed previousOwner, 
    address indexed newOwner
);

Emitted when ownership of Beanstalk is transferred.

Parameter

Type

Description

previousOwner

address

The previous owner of Beanstalk.

newOwner

address

The new owner of Beanstalk.