ISablierV2LockupLinear

Git Source

Inherits: ISablierV2Lockup

Creates and manages Lockup streams with linear streaming functions.

Functions

getCliffTime

Retrieves the stream's cliff time, which is a Unix timestamp.

Reverts if streamId references a null stream.

function getCliffTime(uint256 streamId) external view returns (uint40 cliffTime);

Parameters

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

getRange

Retrieves the stream's range, which is a struct containing (i) the stream's start time, (ii) cliff time, and (iii) end time, all as Unix timestamps.

Reverts if streamId references a null stream.

function getRange(uint256 streamId) external view returns (LockupLinear.Range memory range);

Parameters

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

getStream

Retrieves the stream entity.

Reverts if streamId references a null stream.

function getStream(uint256 streamId) external view returns (LockupLinear.Stream memory stream);

Parameters

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

streamedAmountOf

Calculates the amount streamed to the recipient, denoted in units of the asset's decimals. When the stream is warm, the streaming function is:

$$f(x) = x * d + c$$

Where:

• $x$ is the elapsed time divided by the stream's total duration.
• $d$ is the deposited amount.
• $c$ is the cliff amount. Upon cancellation of the stream, the amount streamed is calculated as the difference between the deposited amount and the refunded amount. Ultimately, when the stream becomes depleted, the streamed amount is equivalent to the total amount withdrawn.

Reverts if streamId references a null stream.

function streamedAmountOf(uint256 streamId) external view returns (uint128 streamedAmount);

Parameters

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

createWithDurations

Creates a stream by setting the start time to block.timestamp, and the end time to the sum of block.timestamp and params.durations.total. The stream is funded by msg.sender and is wrapped in an ERC-721 NFT.

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

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

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

Parameters

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

Returns

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

createWithRange

Creates a stream with the provided start time and end time as the range. The stream is funded by msg.sender and is wrapped in an ERC-721 NFT.

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

• As long as the times are ordered, it is not an error for the start or the cliff time 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_FEE.
• params.range.start must be less than or equal to params.range.cliff.
• params.range.cliff must be less than params.range.end.
• params.range.end must be in the future.
• params.recipient must not be the zero address.
• msg.sender must have allowed this contract to spend at least params.totalAmount assets.

function createWithRange(LockupLinear.CreateWithRange calldata params) external returns (uint256 streamId);

Parameters

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

Returns

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

Events

CreateLockupLinearStream

Emitted when a stream is created.

event CreateLockupLinearStream(
    uint256 streamId,
    address funder,
    address indexed sender,
    address indexed recipient,
    Lockup.CreateAmounts amounts,
    IERC20 indexed asset,
    bool cancelable,
    bool transferable,
    LockupLinear.Range range,
    address broker
);

Parameters

Name	Type	Description
streamId	uint256	The id of the newly created stream.
funder	address	The address which funded the stream.
sender	address	The address streaming the assets, with the ability to cancel the stream.
recipient	address	The address receiving the assets.
amounts	Lockup.CreateAmounts	Struct containing (i) the deposit amount, (ii) the protocol fee amount, and (iii) the broker fee amount, all denoted in units of the asset's decimals.
asset	IERC20	The contract address of the ERC-20 asset used for streaming.
cancelable	bool	Boolean indicating whether the stream will be cancelable or not.
transferable	bool	Boolean indicating whether the stream NFT is transferable or not.
range	LockupLinear.Range	Struct containing (i) the stream's start time, (ii) cliff time, and (iii) end time, all as Unix timestamps.
broker	address	The address of the broker who has helped create the stream, e.g. a front-end website.