Skip to content

Commit 929b597

Browse files
committed
docs(streaming): add struct and field-level doc comments to CreateStreamParams (closes #473)
1 parent 7174450 commit 929b597

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

‎contracts/streaming/src/lib.rs‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,20 @@ pub struct StreamMetadata {
147147

148148
#[contracttype]
149149
#[derive(Clone, Debug)]
150+
/// Parameters required to initialize and start a stream.
150151
pub struct CreateStreamParams {
152+
/// Unique identifier for the stream recipient.
153+
pub recipient: Address,
154+
/// Total amount of tokens allocated for the stream duration.
155+
pub total_amount: i128,
156+
/// Unix timestamp marking when token streaming begins.
157+
pub start_time: u64,
158+
/// Unix timestamp marking when token streaming ends.
159+
pub stop_time: u64,
160+
/// Amount of tokens unlocked immediately at start_time.
161+
pub cliff_amount: i128,
162+
/// Address of the token contract used for payments.
163+
pub token_address: Address,
151164
pub recipient: Address,
152165
pub token: Address,
153166
pub total_amount: i128,

0 commit comments

Comments
 (0)