Segments
Definition
A Lockup Dynamic stream can be composed of multiple segments, which are separate partitions with different streaming amount and rates. The protocol uses these segments to enable custom streaming curves, which power exponential streams, cliff streams, etc.
A segment is a struct with three fields:
Field | Type | Description |
---|---|---|
Amount | uint128 | The amount of assets to be streamed in this segment, denoted in units of the asset's decimals. |
Exponent | UD2x18 | The exponent of this segment, denoted as a fixed-point number. |
Milestone | uint40 | The Unix timestamp indicating this segment's end. |
Each segment has its own streaming function:
Where:
- is the elapsed time divided by the total time in the current segment.
- is the current segment exponent.
- is the current segment amount.
- is the sum of all elapsed segments' amounts.
info
Segments can be used to represent any monotonic increasing function.
caution
Because x is a percentage, the streaming rate is inversely proportional to the exponent. For example, if the exponent is 0.5, the rate is quadratically faster compared to the baseline when the exponent is 1. Conversely, if exponent is 2, the rate is quadratically slower compared to baseline.
Requirements
- The sum of all segment amounts must equal the deposit amount.
- There is a limit to how many segments there can be in a stream, and that is 300 segments. This requirement is due to the block gas limit. If it didn't exist and someone created a stream with an excessively large number of segments, the transaction would revert as it wouldn't fit within a block.
- The milestones must be sorted in ascending order. It's not possible for the
i-1
th milestone to be greater thani
th milestone (given we are dealing with increasing monotonic functions).