IBobVaultShare

Git Source

Inherits: IERC20Metadata

Title: IBobVaultShare

Interface for the ERC-20 token representing shares in a Bob vault.

Functions

SABLIER_BOB

Returns the address of the Bob contract with the authority to mint and burn tokens.

This is an immutable state variable.

function SABLIER_BOB() external view returns (address);

VAULT_ID

Returns the vault ID this share token represents.

This is an immutable state variable.

function VAULT_ID() external view returns (uint256);

mint

Mints amount tokens to to.

Emits a {Transfer} event. Requirements:

• The caller must be the SablierBob contract.
• vaultId must be equal to the VAULT_ID.

function mint(uint256 vaultId, address to, uint256 amount) external;

Parameters

Name	Type	Description
vaultId	uint256	The vault ID that this share token represents.
to	address	The address to mint tokens to.
amount	uint256	The amount of tokens to mint.

burn

Burns amount tokens from from.

Emits a {Transfer} event. Requirements:

• The caller must be the SablierBob contract.
• vaultId must be equal to the VAULT_ID.
• from must have at least amount tokens.

function burn(uint256 vaultId, address from, uint256 amount) external;

Parameters

Name	Type	Description
vaultId	uint256	The vault ID that this share token represents.
from	address	The address to burn tokens from.
amount	uint256	The amount of tokens to burn.