IApyUSD

Title: IApyUSD

Interface for apyUSD ERC4626 synchronous tokenized vault

Defines events for the sync vault implementation

Events

Emitted when the CommitToken contract is updated

event UnlockTokenUpdated(address indexed oldUnlockToken, address indexed newUnlockToken);

Parameters

Name	Type	Description
`oldUnlockToken`	`address`	Previous CommitToken contract address
`newUnlockToken`	`address`	New CommitToken contract address

Emitted when the deposit to UnlockToken fails

event UnlockTokenDepositError(uint256 assets, uint256 unlockTokenShares);

Parameters

Name	Type	Description
`assets`	`uint256`	Amount of assets deposited
`unlockTokenShares`	`uint256`	Amount of unlockToken shares received

Emitted when the Vesting contract is updated

event VestingUpdated(address indexed oldVesting, address indexed newVesting);

Parameters

Name	Type	Description
`oldVesting`	`address`	Previous Vesting contract address
`newVesting`	`address`	New Vesting contract address

Emitted when the unlocking fee is updated

event UnlockingFeeUpdated(uint256 oldFee, uint256 newFee);

Parameters

Name	Type	Description
`oldFee`	`uint256`	Previous unlocking fee
`newFee`	`uint256`	New unlocking fee

Emitted when the fee wallet is updated

event FeeWalletUpdated(address indexed oldFeeWallet, address indexed newFeeWallet);

Parameters

Name	Type	Description
`oldFeeWallet`	`address`	Previous fee wallet address
`newFeeWallet`	`address`	New fee wallet address

Error thrown when the deposit to UnlockToken fails

error UnlockTokenError(string reason);

Parameters

Name	Type	Description
`reason`	`string`	Reason for the error

Error thrown when slippage protection is violated

error SlippageExceeded(uint256 expected, uint256 actual);

Parameters

Name	Type	Description
`expected`	`uint256`	Expected amount
`actual`	`uint256`	Actual amount

Error thrown when fee exceeds maximum allowed

error FeeExceedsMax(uint256 fee);

Parameters

Name	Type	Description
`fee`	`uint256`	The fee that was attempted to be set