Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: status temperature #984

Merged
merged 2 commits into from
Jul 26, 2024
Merged

docs: status temperature #984

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b576320
docs: status temperature
PaulRBerg Jul 25, 2024
6e32474
Update src/types/DataTypes.sol
PaulRBerg Jul 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/types/DataTypes.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,14 +53,19 @@ library Lockup {
}

/// @notice Enum representing the different statuses of a stream.
/// @dev The status can have a "temperature":
/// 1. Warm: Pending, Streaming. The passage of time alone can change the status.
/// 2. Cold: Settled, Canceled, Depleted. The passage of time alone cannot change the status.
/// @custom:value0 PENDING Stream created but not started; assets are in a pending state.
/// @custom:value1 STREAMING Active stream where assets are currently being streamed.
/// @custom:value2 SETTLED All assets have been streamed; recipient is due to withdraw them.
/// @custom:value3 CANCELED Canceled stream; remaining assets await recipient's withdrawal.
/// @custom:value4 DEPLETED Depleted stream; all assets have been withdrawn and/or refunded.
enum Status {
// Warm
PENDING,
STREAMING,
// Cold
SETTLED,
CANCELED,
DEPLETED
Expand Down