PreDepositVault

Inherits: AccessManagedUpgradeable, MakinaContext, IPreDepositVault

State Variables

PreDepositVaultStorageLocation

bytes32 private constant PreDepositVaultStorageLocation =
    0x88ccda4670a9221204e56c6b7ced9d52994799751a70ced770588fb180e5dd00;

Functions

_getPreDepositVaultStorage

function _getPreDepositVaultStorage() private pure returns (PreDepositVaultStorage storage $);

constructor

constructor(address _registry) MakinaContext(_registry);

initialize

Initializer of the contract.

function initialize(
    PreDepositVaultInitParams calldata params,
    address _shareToken,
    address _depositToken,
    address _accountingToken
) external override initializer;

Parameters

Name	Type	Description
`params`	`PreDepositVaultInitParams`	The initialization parameters.
`_shareToken`	`address`
`_depositToken`	`address`
`_accountingToken`	`address`

onlyRiskManager

modifier onlyRiskManager();

notMigrated

modifier notMigrated();

migrated

True if the vault has migrated to a machine instance, false otherwise.

function migrated() external view override returns (bool);

machine

Address of the machine, set during migration.

function machine() external view override returns (address);

riskManager

Address of the risk manager.

function riskManager() external view override returns (address);

whitelistMode

True if the vault is in whitelist mode, false otherwise.

function whitelistMode() external view override returns (bool);

isWhitelistedUser

User => Whitelisting status.

function isWhitelistedUser(address user) external view override returns (bool);

depositToken

Address of the deposit token.

function depositToken() external view override returns (address);

accountingToken

Address of the accounting token.

function accountingToken() external view override returns (address);

shareToken

Address of the share token.

function shareToken() external view override returns (address);

shareLimit

Share token supply limit that cannot be exceeded by new deposits.

function shareLimit() external view override returns (uint256);

maxDeposit

Maximum amount of deposit tokens that can currently be deposited in the vault.

function maxDeposit() public view override returns (uint256);

totalAssets

Total amount of deposit tokens managed by the vault.

function totalAssets() external view override returns (uint256);

previewDeposit

Amount of shares minted against a given amount of deposit tokens.

function previewDeposit(uint256 assets) public view override notMigrated returns (uint256);

Parameters

Name	Type	Description
`assets`	`uint256`	The amount of deposit tokens to be deposited.

previewRedeem

Amount of deposit tokens that can be withdrawn against a given amount of shares.

function previewRedeem(uint256 shares) public view override notMigrated returns (uint256);

Parameters

Name	Type	Description
`shares`	`uint256`

deposit

Deposits a given amount of deposit tokens and mints shares to the receiver.

function deposit(uint256 assets, address receiver, uint256 minShares) external override notMigrated returns (uint256);

Parameters

Name	Type	Description
`assets`	`uint256`	The amount of deposit tokens to be deposited.
`receiver`	`address`	The receiver of the shares.
`minShares`	`uint256`	The minimum amount of shares to be minted.

Returns

Name	Type	Description
`<none>`	`uint256`	shares The amount of shares minted.

redeem

Burns exactly shares from caller and transfers the corresponding amount of deposit tokens to the receiver.

function redeem(uint256 shares, address receiver, uint256 minAssets) external override notMigrated returns (uint256);

Parameters

Name	Type	Description
`shares`	`uint256`	The amount of shares to be redeemed.
`receiver`	`address`	The receiver of withdrawn deposit tokens.
`minAssets`	`uint256`	The minimum amount of deposit tokens to be transferred.

Returns

Name	Type	Description
`<none>`	`uint256`	assets The amount of deposit tokens transferred.

migrateToMachine

Migrates the pre-deposit vault to the machine.

function migrateToMachine() external override notMigrated;

setPendingMachine

Sets the machine address to migrate to.

function setPendingMachine(address _machine) external override notMigrated;

Parameters

Name	Type	Description
`_machine`	`address`

setShareLimit

Sets the new share token supply limit that cannot be exceeded by new deposits.

function setShareLimit(uint256 newShareLimit) external override onlyRiskManager notMigrated;

Parameters

Name	Type	Description
`newShareLimit`	`uint256`	The new share limit

setRiskManager

Sets the risk manager address.

function setRiskManager(address _riskManager) external override restricted notMigrated;

Parameters

Name	Type	Description
`_riskManager`	`address`

setWhitelistedUsers

Whitelist or unwhitelist a list of users.

function setWhitelistedUsers(address[] calldata users, bool whitelisted)
    external
    override
    onlyRiskManager
    notMigrated;

Parameters

Name	Type	Description
`users`	`address[]`	The addresses of the users to update.
`whitelisted`	`bool`	True to whitelist the users, false to unwhitelist.

setWhitelistMode

Sets the whitelist mode for the vault.

In whitelist mode, only whitelisted users can deposit.

function setWhitelistMode(bool enabled) external override onlyRiskManager notMigrated;

Parameters

Name	Type	Description
`enabled`	`bool`	True to enable whitelist mode, false to disable.

Structs