ISablierV2LockupTranched

Git Source

Inherits: ISablierV2Lockup

Creates and manages Lockup streams with a tranched distribution function.

Functions

getStream

Retrieves the full stream details.

Reverts if streamId references a null stream.

function getStream(uint256 streamId) external view returns (LockupTranched.StreamLT memory stream);

Parameters

Name	Type	Description
streamId	uint256	The stream ID for the query.

Returns

Name	Type	Description
stream	LockupTranched.StreamLT	See the documentation in {DataTypes}.

getTimestamps

Retrieves the stream's start and end timestamps.

Reverts if streamId references a null stream.

function getTimestamps(uint256 streamId) external view returns (LockupTranched.Timestamps memory timestamps);

Parameters

Name	Type	Description
streamId	uint256	The stream ID for the query.

Returns

Name	Type	Description
timestamps	LockupTranched.Timestamps	See the documentation in {DataTypes}.

getTranches

Retrieves the tranches used to compose the tranched distribution function.

Reverts if streamId references a null stream.

function getTranches(uint256 streamId) external view returns (LockupTranched.Tranche[] memory tranches);

Parameters

Name	Type	Description
streamId	uint256	The stream ID for the query.

MAX_TRANCHE_COUNT

The maximum number of tranches allowed in a stream.

This is initialized at construction time and cannot be changed later.

function MAX_TRANCHE_COUNT() external view returns (uint256);

createWithDurations

Creates a stream by setting the start time to block.timestamp, and the end time to the sum of block.timestamp and all specified time durations. The tranche timestamps are derived from these durations. The stream is funded by msg.sender and is wrapped in an ERC-721 NFT.

Emits a {Transfer} and {CreateLockupTrancheStream} event. Requirements:

• All requirements in {createWithTimestamps} must be met for the calculated parameters.

function createWithDurations(LockupTranched.CreateWithDurations calldata params) external returns (uint256 streamId);

Parameters

Name	Type	Description
params	LockupTranched.CreateWithDurations	Struct encapsulating the function parameters, which are documented in {DataTypes}.

Returns

Name	Type	Description
streamId	uint256	The ID of the newly created stream.

createWithTimestamps

Creates a stream with the provided tranche timestamps, implying the end time from the last timestamp. The stream is funded by msg.sender and is wrapped in an ERC-721 NFT.

Emits a {Transfer} and {CreateLockupTrancheStream} event. Notes:

• As long as the tranche timestamps are arranged in ascending order, it is not an error for some of them to be in the past. Requirements:
• Must not be delegate called.
• params.totalAmount must be greater than zero.
• If set, params.broker.fee must not be greater than MAX_BROKER_FEE.
• params.startTime must be greater than zero and less than the first tranche's timestamp.
• params.tranches must have at least one tranche, but not more than MAX_TRANCHE_COUNT.
• The tranche timestamps must be arranged in ascending order.
• The last tranche timestamp (i.e. the stream's end time) must be in the future.
• The sum of the tranche amounts must equal the deposit amount.
• params.recipient must not be the zero address.
• msg.sender must have allowed this contract to spend at least params.totalAmount assets.

function createWithTimestamps(LockupTranched.CreateWithTimestamps calldata params)
    external
    returns (uint256 streamId);

Parameters

Name	Type	Description
params	LockupTranched.CreateWithTimestamps	Struct encapsulating the function parameters, which are documented in {DataTypes}.

Returns

Name	Type	Description
streamId	uint256	The ID of the newly created stream.

Events

CreateLockupTranchedStream

Emitted when a stream is created.

event CreateLockupTranchedStream(
    uint256 streamId,
    address funder,
    address indexed sender,
    address indexed recipient,
    Lockup.CreateAmounts amounts,
    IERC20 indexed asset,
    bool cancelable,
    bool transferable,
    LockupTranched.Tranche[] tranches,
    LockupTranched.Timestamps timestamps,
    address broker
);

Parameters

Name	Type	Description
streamId	uint256	The ID of the newly created stream.
funder	address	The address which has funded the stream.
sender	address	The address distributing the assets, which will have the ability to cancel the stream.
recipient	address	The address toward which to stream the assets.
amounts	Lockup.CreateAmounts	Struct containing (i) the deposit amount, and (ii) the broker fee amount, both denoted in units of the asset's decimals.
asset	IERC20	The contract address of the ERC-20 asset to be distributed.
cancelable	bool	Boolean indicating whether the stream will be cancelable or not.
transferable	bool	Boolean indicating whether the stream NFT is transferable or not.
tranches	LockupTranched.Tranche[]	The tranches the protocol uses to compose the tranched distribution function.
timestamps	LockupTranched.Timestamps	Struct containing (i) the stream's start time and (ii) end time, both as Unix timestamps.
broker	address	The address of the broker who has helped create the stream, e.g. a front-end website.