Unripe Facet

The Unripe Facet handles logic for the vesting of Unripe assets.

Call Functions

Chop

function chop(
    address unripeToken,
    uint256 amount,
    LibTransfer.From fromMode,
    LibTransfer.To toMode
) external payable nonReentrant returns (uint256 underlyingAmount);

WIP

Parameter	Type	Description
unripeToken	address	WIP
amount	uint256	WIP
fromMode	From	WIP
toMode	To	WIP

Return Value	Type	Description
underlyingAmount	uint256	WIP

Pick

function pick(
    address token,
    uint256 amount,
    bytes32[] memory proof,
    LibTransfer.To mode
) external payable nonReentrant;

WIP

Parameter	Type	Description
token	address	WIP
amount	uint256	WIP
proof	bytes32[]	WIP
mode	To	WIP

Add Unripe Token

function addUnripeToken(
    address unripeToken,
    address underlyingToken,
    bytes32 root
) external payable nonReentrant;

WIP

Parameter	Type	Description
unripeToken	address	WIP
underlyingToken	address	WIP
root	bytes32	WIP

View Functions

Picked

function picked(address account, address token)
    public
    view
    returns (bool);

WIP

Parameter	Type	Description
account	address	WIP
token	address	WIP

Return Type	Description
bool	WIP

Get Underlying

function getUnderlying(address unripeToken, uint256 amount)
    public
    view
    returns (uint256 redeem);

WIP

Parameter	Type	Description
unripeToken	address	WIP
amount	uint256	WIP

Return Value	Type	Description
redeem	uint256	WIP

Get Penalty

function getPenalty(address unripeToken)
    external
    view
    returns (uint256 penalty);

WIP

Parameter	Type	Description
unripeToken	address	WIP

Return Value	Type	Description
penalty	uint256	WIP

Get Penalized Underlying

function getPenalizedUnderlying(address unripeToken, uint256 amount)
    public
    view
    returns (uint256 redeem);

WIP

Parameter	Type	Description
unripeToken	address	WIP
amount	uint256	WIP

Return Value	Type	Description
redeem	uint256	WIP

_Get Penalized Underlying

function _getPenalizedUnderlying(address unripeToken, uint256 amount, uint256 supply)
    public
    view
    returns (uint256 redeem);

WIP

Parameter	Type	Description
unripeToken	address	WIP
amount	uint256	WIP
supply	uint256	WIP

Return Value	Type	Description
redeem	uint256	WIP

Is Unripe

function isUnripe(address unripeToken) public view returns (bool unripe);

WIP

Parameter	Type	Description
unripeToken	address	WIP

Return Value	Type	Description
unripe	bool	WIP

Balance Of Underlying

function balanceOfUnderlying(address unripeToken, address account)
    external
    view
    returns (uint256 underlying);

WIP

Parameter	Type	Description
unripeToken	address	WIP
account	address	WIP

Return Value	Type	Description
underlying	uint256	WIP

Balance Of Penalized Underlying

function balanceOfPenalizedUnderlying(address unripeToken, address account)
    external
    view
    returns (uint256 underlying);

WIP

Parameter	Type	Description
unripeToken	address	WIP
account	address	WIP

Return Value	Type	Description
underlying	uint256	WIP

Get Recap Funded Percent

function getRecapFundedPercent(address unripeToken)
    public
    view
    returns (uint256 percent);

WIP

Parameter	Type	Description
unripeToken	address	WIP

Return Value	Type	Description
percent	uint256	WIP

Get Percent Penalty

function getPercentPenalty(address unripeToken)
    external
    view
    returns (uint256 penalty);

WIP

Parameter	Type	Description
unripeToken	address	WIP

Return Value	Type	Description
penalty	uint256	WIP

Get Recap Paid Percent

function getRecapPaidPercent() external view returns (uint256 penalty);

WIP

Return Value	Type	Description
penalty	uint256	WIP

Get Recap Paid Percent Amount

function getRecapPaidPercentAmount(uint256 amount)
    private
    view
    returns (uint256 penalty);

WIP

Parameter	Type	Description
amount	uint256	WIP

Return Value	Type	Description
penalty	uint256	WIP

Get Underlying Per Unripe Token

function getUnderlyingPerUnripeToken(address unripeToken)
    external
    view
    returns (uint256 underlyingPerToken);

WIP

Parameter	Type	Description
unripeToken	address	WIP

Return Value	Type	Description
underlyingPerToken	uint256	WIP

Get Total Underlying

function getTotalUnderlying(address unripeToken)
    external
    view
    returns (uint256 underlying);

WIP

Parameter	Type	Description
unripeToken	address	WIP

Return Value	Type	Description
underlying	uint256	WIP

Get Underlying Token

function getUnderlyingToken(address unripeToken)
    external
    view
    returns (address underlyingToken)

WIP

Parameter	Type	Description
unripeToken	address	WIP

Return Value	Type	Description
underlyingToken	address	WIP

Events

Add Unripe Token

event AddUnripeToken(
    address indexed unripeToken,
    address indexed underlyingToken,
    bytes32 merkleRoot
);

WIP

Parameter	Type	Description
unripeToken	address	WIP
underlyingToken	address	WIP
merkleRoot	bytes32	WIP

Change Underlying

event ChangeUnderlying(address indexed token, int256 underlying);

WIP

Parameter	Type	Description
token	address	WIP
underlying	int256	WIP

Chop

event Chop(
    address indexed account,
    address indexed token,
    uint256 amount,
    uint256 underlying
);

WIP

Parameter	Type	Description
account	address	WIP
token	address	WIP
amount	uint256	WIP
underlying	uint256	WIP

Pick

event Pick(
    address indexed account,
    address indexed token,
    uint256 amount
);

WIP

Parameter	Type	Description
account	address	WIP
token	address	WIP
amount	uint256	WIP