IWhitelabeledUnit

Git Source

Interface for whitelabeled unit tokens that wrap underlying value units

This interface defines the core functionality for wrapping and unwrapping unit tokens within the Generic Protocol ecosystem.

Functions

wrap

Wraps underlying unit tokens into whitelabeled tokens for a specified owner

Transfers amount of underlying unit tokens from the caller to this contract and mints an equivalent amount of whitelabeled tokens to the owner address. This maintains 1:1 parity between underlying units and whitelabeled tokens.

function wrap(address owner, uint256 amount) external;

unwrap

Unwraps whitelabeled tokens back to underlying unit tokens

Burns amount of whitelabeled tokens from the owner's balance and transfers an equivalent amount of underlying unit tokens to the recipient. This maintains the 1:1 parity in reverse direction. If the caller is not the owner, the caller must have sufficient allowance to burn the owner's tokens.

function unwrap(address owner, address recipient, uint256 amount) external;

genericUnit

Returns the address of the underlying Generic unit token that this contract wraps

This is the ERC20 token address of the Generic units that back the whitelabeled tokens. The underlying token typically represents claims on protocol vault positions and may accrue yield over time through vault strategy operations.

function genericUnit() external view returns (address);

Events

Wrapped

Emitted when underlying unit tokens are wrapped into whitelabeled tokens

event Wrapped(address indexed owner, uint256 amount);

Unwrapped

Emitted when whitelabeled tokens are unwrapped back to underlying unit tokens

event Unwrapped(address indexed owner, address indexed recipient, uint256 amount);