streamflow-sdk

Crates.iostreamflow-sdk
lib.rsstreamflow-sdk
version0.6.5
sourcesrc
created_at2022-02-04 21:40:31.554814
updated_at2024-05-26 11:23:05.552912
descriptionRust SDK to interact with Streamflow protocol
homepage
repositoryhttps://github.com/streamflow-finance/rust-sdk
max_upload_size
id527106
size39,195
(Yolley)

documentation

https://docs.rs/streamflow-sdk

README

streamflow-sdk

SDK for Rust on-chain solana programs to interact with streamflow protocol

Usage

Declare a dependency in your program's Cargo.toml

streamflow_sdk = {version = "0.6", features = ["cpi"]}

To use protocol on mainnet add sdk with mainnet feature

streamflow_sdk = {version = "0.6", features = ["cpi", "mainnet"]}

Example anchor program invoking streamflow create instruction:

use anchor_lang::{prelude::*};
use anchor_spl::{
    associated_token::AssociatedToken,
    token::{Mint, Token, TokenAccount},
};

use streamflow_sdk;
use streamflow_sdk::cpi::accounts::Create;

let accs = Create {
    sender: ctx.accounts.sender.to_account_info(),
    sender_tokens: ctx.accounts.sender_tokens.to_account_info(),
    recipient: ctx.accounts.recipient.to_account_info(),
    recipient_tokens: ctx.accounts.recipient_tokens.to_account_info(),
    metadata: ctx.accounts.metadata.to_account_info(),
    escrow_tokens: ctx.accounts.escrow_tokens.to_account_info(),
    streamflow_treasury: ctx.accounts.streamflow_treasury.to_account_info(),
    streamflow_treasury_tokens: ctx.accounts.streamflow_treasury_tokens.to_account_info(),
    withdrawor: ctx.accounts.withdrawor.to_account_info(),
    partner: ctx.accounts.partner.to_account_info(),
    partner_tokens: ctx.accounts.partner_tokens.to_account_info(),
    mint: ctx.accounts.mint.to_account_info(),
    fee_oracle: ctx.accounts.fee_oracle.to_account_info(),
    rent: ctx.accounts.rent.to_account_info(),
    timelock_program: ctx.accounts.streamflow_program.to_account_info(),
    token_program: ctx.accounts.token_program.to_account_info(),
    associated_token_program: ctx.accounts.associated_token_program.to_account_info(),
    system_program: ctx.accounts.system_program.to_account_info(),
};

let cpi_ctx = CpiContext::new(ctx.accounts.streamflow_program.to_account_info(), accs);

streamflow_sdk::cpi::create(
    cpi_ctx,
    start_time,
    net_amount_deposited,
    period,
    amount_per_period,
    cliff,
    cliff_amount,
    cancelable_by_sender,
    cancelable_by_recipient,
    automatic_withdrawal,
    transferable_by_sender,
    transferable_by_recipient,
    can_topup,
    stream_name,
    withdraw_frequency,
    pausable,
    can_update_rate
)

Example program using sdk

For a more detailed example, check ./programs/example/lib.rs

Adresses

parameter address
program_id strmRqUCoQUgGUan5YhzUZa6KqdzwX5L6FpUxfmKg5m
fees_oracle addr
streamflow_treasury 5SEpbdjFK5FxwTvfsGMXVQTD2v4M2c5tyRTxhdsPkgDw
withdrawor wdrwhnCv4pzW8beKsbPa4S2UDZrXenjg16KJdKSpb5u

Streamflow protocol

Rust program that provides SPL timelock functionalities

Functionalities are:

  • create a vesting contract.
  • update a vesting contract
  • withdraw from a vesting contract.
  • cancel a vesting contract.
  • transfer_recipient of a vesting contract.

High level overview

Overview

Fees

Streamflow protocol transfer 0.25% of contract total amount (net_amount_deposit) to streamflow treasury to cover costs of building and maintaining protocl.

Registering as partner on streamflow protocol

Streamflow protocol supports integrating partner fees for other protocols built on top of streamflow. For more information, reach us out on discord. link

Commit count: 39

cargo fmt