updateFlow

Lets a sender update an existing stream to a receiver to a new flow rate
//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.updateFlow({
  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
New desired wei/second flow rate at which the sender wants to be streaming to the receiver
userData
string
Optional user data​
Example Usage
super-examples/EmploymentLoan.test.js at main · superfluid-finance/super-examples
GitHub
Additional Considerations
If updateFlow is called with a flowRate that is the same as the current flow rate, it will not revert.

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

createFlow

deleteFlow

Last modified 1mo ago