Skip to content

Latest commit

 

History

History
182 lines (132 loc) · 7.34 KB

fundraiser-facet.md

File metadata and controls

182 lines (132 loc) · 7.34 KB
Raw

Fundraiser Facet

{% hint style="warning" %} Note that this page has not been updated to reflect the current state of Beanstalk, but is left here as a reference. {% endhint %}

The Fundraiser Facet dandles the creation, funding, and completion of Fundraisers.

Call Functions

Fund

function fund(
    uint32 id,
    uint256 amount,
    LibTransfer.From mode
) external payable nonReentrant returns (uint256);

Fund a Fundraiser in exchange for Pods.

Parameter Type Description
id uint32 The Fundraiser ID.
amount uint256 Amount of fundraisers[id].token to provide.
mode From Balance to spend tokens from; see LibTransfer.From.
Return Type Description
uint256 The number of Pods received.

Create Fundraiser

function createFundraiser(
    address payee,
    address token,
    uint256 amount
) external payable;

Creates a Fundraiser. Can only be called by the owner of Beanstalk.

Parameter Type Description
payee address The address to which funds are delivered at the end of the Fundraiser.
token address The address of the token that can be sent to the Fundraiser in exchange for Pods.
amount uint256 The amount of token that is being raised.

View Functions

Remaining Funding

function remainingFunding(uint32 id) public view returns (uint256);

Returns the remaining number of tokens to raise.

Parameter Type Description
id uint32 The Fundraiser ID.
Return Type Description
uint256 The remaining number of tokens to raise.

Total Funding

function totalFunding(uint32 id) public view returns (uint256);

Returns the total amount of tokens raised so far.

Parameter Type Description
id uint32 The Fundraiser ID.
Return Type Description
uint256 The total amount of tokens raised so far.

Funding Token

function fundingToken(uint32 id) public view returns (address);

Returns the address of the token that can be sent to the Fundraiser.

Parameter Type Description
id uint32 The Fundraiser ID.
Return Type Description
address The address of the token that can be sent to the Fundraiser.

Fundraiser

function fundraiser(uint32 id)
    public
    view
    returns (Storage.Fundraiser memory);

Returns the Fundraiser struct.

Parameter Type Description
id uint32 The Fundraiser ID.
Return Type Description
Fundraiser Returns the Fundraiser struct in App Storage.

Number Of Fundraisers

function numberOfFundraisers() public view returns (uint32);

Returns the number of Fundraisers.

Return Type Description
uint32 The number of Fundraisers.

Events

Create Fundraiser 

event CreateFundraiser(
    uint32 indexed id,
    address fundraiser,
    address token,
    uint256 amount
);

Emitted when a Fundraiser is created.

Parameter Type Description
id uint32 The Fundraiser ID.
fundraiser address The address to which funds are delivered.
token address The address of the token that can be sent to the Fundraiser in exchange for Pods.
amount uint256 The amount of token that is being raised.

Fund Fundraiser 

event FundFundraiser(
    address indexed account,
    uint32 indexed id,
    uint256 amount
);

Emitted when a Farmer calls fund.

Parameter Type Description
account address The address of the Farmer.
id uint32 The Fundraiser ID.
amount uint256 The amount of token that account provided.

Complete Fundraiser 

event CompleteFundraiser(uint32 indexed id);

Emitted when a Fundraiser is fully funded.

Parameter Type Description
id uint32 The Fundraiser ID.