Saffron Pool v2

Introduction

Saffron Pool V2

Miscellaneous State Variables

Source Code

Type	Visibility	Name	Description
address	public	governance	Governance address
address	public	new_governance	Pending governance address if accepted
bool	public	deposits_disabled	Deposit enabled switch (true=disabled; false=allowed)
bool	public	shut_down	Pool shutdown switch (true=shutdown; false=online)
IERC20	public	base_asset	Base asset token address
address	public	adapter	Saffron Adapter contract address
address	public	fee_manager	Fee manager contract address
string	public	pool_name	Pool name (for frontends)
uint256	public	senior_token_supply	Senior tranche SaffronPositionToken totalSupply
uint256	public	senior_exchange_rate	Exchange rate from senior tranche tokens to base assets
uint256	public	fee_holdings	Fee yield receiver balance
SaffronPositionToken	public	position_token	User holdings SaffronPositionToken (ERC20)
SaffronPositionNFT	public	NFT	User holdings SaffronPositionNFT (Insurance Fund NFT)

Constructor

Source Code

constructor(address _adapter, address _base_asset, string memory name, string memory symbol, string memory _pool_name)

Type	Name	Description
address	_adapter	Address of Saffron Adapter to interface with underlying platform
address	_base_asset	Address of Base Asset token to be managed
string	name	Symbol of provided LP token
string	symbol	Name of provided LP token
string	_pool_name	Name of the pool

deposit()

Source Code

Deposit base assets to the pool

function deposit(uint256 amount) external nonReentrant

Type	Name	Description
uint256	amount	Amount (wei) of Insurance Assets to be deposited

withdraw()

Source Code

Withdraw capital from the pool by burning SAFF-LP tokens

function withdraw(uint256 lp_amount) external nonReentrant

Type	Name	Description
uint256	lp_amount	Amount (wei) of Insurance Assets to be deposited

begin_unfreeze_NFT()

Source Code

Begin to unfreeze an NFT so it may be withdrawn

function begin_unfreeze_NFT(uint256 token_id) external

Type	Name	Description
uint256	token_id	Position NFT ID to be unfrozen

update_exchange_rate()

Source Code

Updates senior exchange rate based on current Auto Compounded earnings, if any. Also update the total supply for each tranche

function update_exchange_rate() public non_reentrant_update

get_latest_pool_holdings()

Source Code

Updates senior exchange rate based on current Auto Compounded earnings, if any. Also update the total supply for each tranche

function get_latest_pool_holdings() internal returns (uint256)

get_update_exchange_rate_vars()

Source Code

Get internal state variables

function get_update_exchange_rate_vars() internal returns (UpdateExchangeRateVars memory uv)

get_yield_receiver_supply()

Source Code

Get the calculated base asset holdings of all yield receivers by multiplying their token supplies by their exchange rates

function get_yield_receiver_supply() public view returns (uint256)

set_exchange_rate()

Source Code

Set values for yield receivers for waterfall mode (only valid while pool is in a shut-down state)

function set_exchange_rate(uint256 yield_receiver, uint256 value) external

Type	Name	Description
uint256	yield_receiver	Yield receiver to be updated ( =0 senior tranche; !=0 fees)
uint256	value	New exchange rate for specified yield receiver

set_fee_manager()

Source Code

Set fee manager (usually insurance fund)

function set_fee_manager(address to) external

Type	Name	Description
address	to	Address of fee manager

withdraw_fees()

Source Code

Withdraw protocol fees

function withdraw_fees(address to) external nonReentrant

Type	Name	Description
address	_pool	Address of new pool

shut_down_pool()

Source Code

Set the shut-down state of the pool

function shut_down_pool(bool _shut_down) external

Type	Name	Description
bool	_shut_down	true shut-down; false not shut-down

disable_deposits()

Source Code

Disable deposits (waterfall mode)

function disable_deposits(bool _deposits_disabled) external

Type	Name	Description
bool	_deposits_disabled	true disable deposits; false allow deposits

propose_governance()

Source Code

Propose transfer of governance to new address

function propose_governance(address to) external override

Type	Name	Description
address	to	Address of proposed new governance

accept_governance()

Source Code

Accept the role of governance (must be called by previously proposed candidate)

function accept_governance() external override

set_adapter()

Source Code

Set a new Saffron Adapter to interface with underlying platform

function set_adapter(address to) external

Type	Name	Description
address	_adapter	Address of Saffron Adapter to interface with underlying platform

sweep_erc()

Source Code

Transfer LP assets to Mojito Staking

function sweep_erc(address _token, address _to) external

Type	Name	Description
address	amount_qlp	Amount (wei) of LP Assets to be staked in Mojito
address	to	Address to receive swept assets