Skip to content

docs(streaming): add struct and field doc comments to CreateStreamParams (#473) #581

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

Merged
Austinaminu2 merged 1 commit into from
Aug 24, 2026
Merged

docs(streaming): add struct and field doc comments to CreateStreamParams (#473) #581

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 10 additions & 5 deletions contracts/streaming/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,13 +147,18 @@ pub struct StreamMetadata {

#[contracttype]
#[derive(Clone, Debug)]
/// Parameters required to initialize and start a stream.
pub struct CreateStreamParams {
/// Unique identifier for the stream recipient.
pub recipient: Address,
pub token: Address,
/// Total amount of tokens allocated for the stream duration.
pub total_amount: i128,
/// Unix timestamp marking when token streaming begins.
pub start_time: u64,
pub end_time: u64,
pub cliff_time: u64,
/// Amount of tokens unlocked immediately at start_time.
pub cliff_amount: i128,
}

Expand Down Expand Up @@ -281,8 +286,6 @@ pub struct UnpauseEvent {
pub timestamp: u64,
}



// ─── Contract ────────────────────────────────────────────────────────────────

#[contract]
Expand Down Expand Up @@ -358,7 +361,11 @@ impl StreamingContract {
/// Upgrade the contract wasm. Only callable by the admin.
pub fn upgrade(env: Env, admin: Address, new_wasm_hash: BytesN<32>) -> Result<(), StreamError> {
admin.require_auth();
let stored_admin: Address = env.storage().instance().get(&DataKey::Admin).ok_or(StreamError::NotInitialized)?;
let stored_admin: Address = env
.storage()
.instance()
.get(&DataKey::Admin)
.ok_or(StreamError::NotInitialized)?;
if admin != stored_admin {
return Err(StreamError::Unauthorized);
}
Expand Down Expand Up @@ -976,8 +983,6 @@ impl StreamingContract {
Ok(())
}



// ── Read: Stream data ────────────────────────────────────────────────────

/// Get a stream by ID.
Expand Down
Loading