Links

createFlow

Lets a sender create a stream to a receiver.
//load the token you'd like to use like this
//note that tokens may be loaded by symbol or by address
const daix = await sf.loadSuperToken("DAIx");
let flowOp = daix.createFlow({
sender: string,
receiver: string,
flowRate: string,
userData?: string
});
await flowOp.exec( <<ethers signer>> ); // should have same address as `sender`

Parameters

Parameter
Type
Description
sender
string
Address of sender
receiver
string
Address of receiver
flowRate
string
Desired wei/second flow rate at which the sender wants to start streaming to the receiver
userData
string
Optional user data

Example Usage