This package allows you to create
, createMultiple
, withdraw
, cancel
, topup
, transfer
, update
a token stream.
You can also getOne
stream and get
multiple streams.
npm i -s @streamflow/stream
or
yarn add @streamflow/stream
Most common imports:
import { BN } from "bn.js";
import { Types, GenericStreamClient, getBN, getNumberFromBN } from "@streamflow/stream";
Check the SDK for other types and utility functions.
Before creating and manipulating streams chain specific or generic StreamClient instance must be created. All streams functions are methods on this instance.
import {
StreamflowSolana,
Types,
} from "@streamflow/stream";
const solanaClient = new StreamflowSolana.SolanaStreamClient(
"https://api.mainnet-beta.solana.com"
);
import {
StreamflowAptos,
Types,
} from "@streamflow/stream";
const aptosClient = new StreamflowAptos.AptosStreamClient(
"https://fullnode.mainnet.aptoslabs.com/v1"
);
import {
StreamflowEVM,
Types,
} from "@streamflow/stream";
const ethereumClient = new StreamflowEVM.EvmStreamClient(
"YOUR_ETHEREUM_NODE_URL",
Types.IChain.Ethereum,
signer // will be sender in a stream and authority for all stream related transactions
);
import {
StreamflowEVM,
Types,
} from "@streamflow/stream";
const polygonClient = new StreamflowEVM.EvmStreamClient(
"YOUR_POLYGON_NODE_URL",
Types.IChain.Polygon,
signer // will be sender in a stream and authority for all stream related transactions
);
import {
StreamflowEVM,
Types,
} from "@streamflow/stream";
const bnbClient = new StreamflowEVM.EvmStreamClient(
"https://bsc-dataseed1.binance.org/",
Types.IChain.BNB,
signer // will be sender in a stream and authority for all stream related transactions
);
import {
StreamflowSui,
Types,
} from "@streamflow/stream";
const suiClient = new StreamflowSui.SuiStreamClient(
"https://fullnode.testnet.sui.io:443"
);
GenericStreamClient provides isomorphic interface to work with streams agnostic of chain.
import { GenericStreamClient, Types } from "@streamflow/stream";
const client =
new GenericStreamClient<Types.IChain.Solana>({
chain: Types.IChain.Solana, // Blockchain
clusterUrl: "https://api.mainnet-beta.solana.com", // RPC cluster URL
cluster: Types.ICluster.Mainnet, // (optional) (default: Mainnet)
// ...rest chain specific params e.g. commitment for Solana
});
All the examples below will contain generic method options descriptions and chain specific params.
NOTE: All timestamp parameters are in seconds.
const createStreamParams: Types.ICreateStreamData = {
recipient: "4ih00075bKjVg000000tLdk4w42NyG3Mv0000dc0M00", // Recipient address.
tokenId: "DNw99999M7e24g99999999WJirKeZ5fQc6KY999999gK", // Token mint address.
start: 1643363040, // Timestamp (in seconds) when the stream/token vesting starts.
amount: getBN(100, 9), // depositing 100 tokens with 9 decimals mint.
period: 1, // Time step (period) in seconds per which the unlocking occurs.
cliff: 1643363160, // Vesting contract "cliff" timestamp in seconds.
cliffAmount: new BN(10), // Amount unlocked at the "cliff" timestamp.
amountPerPeriod: getBN(5, 9), // Release rate: how many tokens are unlocked per each period.
name: "Transfer to Jane Doe.", // The stream name or subject.
canTopup: false, // setting to FALSE will effectively create a vesting contract.
cancelableBySender: true, // Whether or not sender can cancel the stream.
cancelableByRecipient: false, // Whether or not recipient can cancel the stream.
transferableBySender: true, // Whether or not sender can transfer the stream.
transferableByRecipient: false, // Whether or not recipient can transfer the stream.
automaticWithdrawal: true, // Whether or not a 3rd party (e.g. cron job, "cranker") can initiate a token withdraw/transfer.
withdrawalFrequency: 10, // Relevant when automatic withdrawal is enabled. If greater than 0 our withdrawor will take care of withdrawals. If equal to 0 our withdrawor will skip, but everyone else can initiate withdrawals.
partner: null, // (optional) Partner's wallet address (string | null).
};
const solanaParams = {
sender: wallet, // SignerWalletAdapter or Keypair of Sender account
isNative: // [optional] [WILL CREATE A wSOL STREAM] Wether Stream or Vesting should be paid with Solana native token or not
};
const aptosParams = {
senderWallet: wallet, // AptosWalletAdapter Wallet of sender
};
const suiParams = {
senderWallet: wallet, // WalletContextState | Keypair
};
const ethereumParams = undefined;
try {
const { ixs, tx, metadata } = await client.create(createStreamParams, solanaParams); // second argument differ depending on a chain
} catch (exception) {
// handle exception
}
const recipients = [
{
recipient: "4ih00075bKjVg000000tLdk4w42NyG3Mv0000dc0M00", // Solana recipient address.
amount: getBN(100, 9), // depositing 100 tokens with 9 decimals mint.
name: "January Payroll", // The stream name/subject.
cliffAmount: getBN(10, 9), // amount released on cliff for this recipient
amountPerPeriod: getBN(1, 9), //amount released every specified period epoch
},
];
const createStreamParams: Types.ICreateMultipleStreamData = {
recipients: recipients, // Solana recipient address.
tokenId: "DNw99999M7e24g99999999WJirKeZ5fQc6KY999999gK", // SPL Token mint.
start: 1643363040, // Timestamp (in seconds) when the stream/token vesting starts.
period: 1, // Time step (period) in seconds per which the unlocking occurs.
cliff: 1643363160, // Vesting contract "cliff" timestamp in seconds.
canTopup: false, // setting to FALSE will effectively create a vesting contract.
cancelableBySender: true, // Whether or not sender can cancel the stream.
cancelableByRecipient: false, // Whether or not recipient can cancel the stream.
transferableBySender: true, // Whether or not sender can transfer the stream.
transferableByRecipient: false, // Whether or not recipient can transfer the stream.
automaticWithdrawal: true, // Whether or not a 3rd party (e.g. cron job, "cranker") can initiate a token withdraw/transfer.
withdrawalFrequency: 10, // Relevant when automatic withdrawal is enabled. If greater than 0 our withdrawor will take care of withdrawals. If equal to 0 our withdrawor will skip, but everyone else can initiate withdrawals.
partner: null, // (optional) Partner's wallet address (string | null).
};
const solanaParams = {
sender: wallet, // SignerWalletAdapter or Keypair of Sender account
isNative: // [optional] [WILL CREATE A wSOL STREAM] Wether Stream or Vesting should be paid with Solana native token or not
};
const aptosParams = {
senderWallet: wallet, // AptosWalletAdapter Wallet of sender
};
const suiParams = {
senderWallet: wallet, // WalletContextState | Keypair
};
const ethereumParams = undefined;
try {
const { txs } = await client.createMultiple(createMultiStreamsParams, solanaParams);
} catch (exception) {
// handle exception
}
Please note that transaction fees for the scheduled transfers are paid upfront by the stream creator (sender).
All Stream Clients return Types.ICreateResult
object (createdMultiple
returns an Array) that has the following structure
interface ICreateResult {
ixs: (TransactionInstruction | Types.TransactionPayload)[];
txId: string;
metadataId: MetadataId;
}
metadataId
is the id of the created stream.
const withdrawStreamParams: Types.IWithdrawData = {
id: "AAAAyotqTZZMAAAAmsD1JAgksT8NVAAAASfrGB5RAAAA", // Identifier of a stream to be withdrawn from.
amount: getBN(100, 9), // Requested amount to withdraw. If stream is completed, the whole amount will be withdrawn.
};
const solanaParams = {
invoker: wallet, // SignerWalletAdapter or Keypair signing the transaction
};
const aptosParams = {
senderWallet: wallet, // AptosWalletAdapter Wallet of wallet signing the transaction
tokenId: "0x1::aptos_coin::AptosCoin", // Aptos Coin type
};
const suiParams = {
senderWallet: wallet, // WalletContextState | Keypair
tokenId: "0x2::sui::SUI"
};
const ethereumParams = undefined;
try {
const { ixs, tx } = await client.withdraw(withdrawStreamParams, solanaParams);
} catch (exception) {
// handle exception
}
const topupStreamParams: Types.ITopUpData = {
id: "AAAAyotqTZZMAAAAmsD1JAgksT8NVAAAASfrGB5RAAAA", // Identifier of a stream to be topped up.
amount: getBN(100, 9), // Specified amount to topup (increases deposited amount).
};
const solanaParams = {
invoker: wallet, // SignerWalletAdapter or Keypair signing the transaction
isNative: // [ONLY FOR wSOL STREAMS] [optional] Wether topup is with Native Solanas
};
const aptosParams = {
senderWallet: wallet, // AptosWalletAdapter Wallet of wallet signing the transaction
tokenId: "0x1::aptos_coin::AptosCoin", // Aptos Coin type
};
const suiParams = {
senderWallet: wallet, // WalletContextState | Keypair
tokenId: "0x2::sui::SUI"
};
const ethereumParams = undefined;
try {
const { ixs, tx } = await client.topup(topupStreamParams, solanaParams);
} catch (exception) {
// handle exception
}
const data: Types.ITransferData = {
id: "AAAAyotqTZZMAAAAmsD1JAgksT8NVAAAASfrGB5RAAAA",
newRecipient: "99h00075bKjVg000000tLdk4w42NyG3Mv0000dc0M99", // Identifier of a stream to be transferred.
};
const solanaParams = {
invoker: wallet, // SignerWalletAdapter or Keypair signing the transaction
};
const aptosParams = {
senderWallet: wallet, // AptosWalletAdapter Wallet of wallet signing the transaction
tokenId: "0x1::aptos_coin::AptosCoin", // Aptos Coin type
};
const suiParams = {
senderWallet: wallet, // WalletContextState | Keypair
tokenId: "0x2::sui::SUI"
};
const ethereumParams = undefined;
try {
const { tx } = await client.transfer(data, solanaParams);
} catch (exception) {
// handle exception
}
const cancelStreamParams: Types.ICancelData = {
id: "AAAAyotqTZZMAAAAmsD1JAgksT8NVAAAASfrGB5RAAAA", // Identifier of a stream to be canceled.
};
const solanaParams = {
invoker: wallet, // SignerWalletAdapter or Keypair signing the transaction
};
const aptosParams = {
senderWallet: wallet, // AptosWalletAdapter Wallet of wallet signing the transaction
tokenId: "0x1::aptos_coin::AptosCoin", // Aptos Coin type
};
const suiParams = {
senderWallet: wallet, // WalletContextState | Keypair
tokenId: "0x2::sui::SUI"
};
const ethereumParams = undefined;
try {
const { ixs, tx } = await client.cancel(cancelStreamParams, solanaParams);
} catch (exception) {
// handle exception
}
const data: Types.IGetOneData = {
id: "AAAAyotqTZZMAAAAmsD1JAgksT8NVAAAASfrGB5RAAAA", // Identifier of a stream
};
try {
const stream = await client.getOne(data);
} catch (exception) {
// handle exception
}
const stream = await client.getOne({
id: "AAAAyotqTZZMAAAAmsD1JAgksT8NVAAAASfrGB5RAAAA",
});
const unlocked = stream.unlocked(tsInSeconds); // bn amount unlocked at the tsInSeconds
console.log(getNumberFromBN(unlocked, 9));
- Note: unlocked amount is determined based on configuration set on creation, no dynamic data is involved.
const stream = await client.getOne({
id: "AAAAyotqTZZMAAAAmsD1JAgksT8NVAAAASfrGB5RAAAA",
});
const withdrawn = stream.withdrawnAmount; // bn amount withdrawn already
console.log(getNumberFromBN(wihtdrawn, 9));
const remaining = stream.remaining(9); // amount of remaining funds
console.log(remaining);
const data: Types.IGetAllData = {
address: "99h00075bKjVg000000tLdk4w42NyG3Mv0000dc0M99",
type: Types.StreamType.All,
direction: Types.StreamDirection.All,
};
try {
const streams = client.get(data);
} catch (exception) {
// handle exception
}
GenericStreamClient
wraps all errors when making on-chain calls with ContractError
error class:
- this class inherits original traceback
- error may optionally contain
contractErrorCode
property that can be further mapped to a specific Contract error - for
createMultiple
method errors are wrapped individually for every recipient address - please check documentation for common enums
ContractErrorCode
andSolanaContractErrorCode
to see short description for each error
A public map of protocol errors is available here.
Streamflow protocol program IDs
Solana | |
---|---|
Devet | HqDGZjaVRXJ9MGRQEw7qDc2rAr6iH1n1kAQdCZaCMfMZ |
Mainnet | strmRqUCoQUgGUan5YhzUZa6KqdzwX5L6FpUxfmKg5m |
EVM | Ethereum(Goerli on Tesnet),Polygon,BNB |
---|---|
Testnet | 0x5Db7a43D20De64E3a3BC765334a477026FD13E7d |
Mainnet | 0x94d4646Bd307Bf91CB1893BC64d976BF9E60D9B2 |
Aptos | |
---|---|
Testnet | 0xc6737de143d91b2f99a7e490d4f8348fdfa3bdd1eb8737a27d0455f8a3625688 |
Mainnet | 0x9009d93d52576bf9ac6dc6cf10b870610bcb316342fef6eff80662fbbfce51b0 |
Sui | |
---|---|
Testnet | 0xf1916c119a6c917d4b36f96ffc0443930745789f3126a716e05a62223c48993a |
Mainnet | 0xa283fd6b45f1103176e7ae27e870c89df7c8783b15345e2b13faa81ec25c4fa6 |
All BN amounts are denominated in their smallest units.
E.g, if the amount is 1 SOL than this amount in lamports is 1000 \* 10^9 = 1_000_000_000.
And new BN(1_000_000_000)
is used.
Use getBN
and getNumberFromBN
utility functions for conversions between BN
and Number
types.