getAccountFlowInfo

Get net stream information for an account pertaining to a specified Super Token

//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 res = await daix.getAccountFlowInfo({
  account: string,
  providerOrSigner: ethers.providers.Provider | ethers.Signer
});

Parameters

ParameterTypeDescription

account

string

Address of account you're getting stream information for

providerOrSigner

ethers.providers.Provider or ethers.Signer

ethers provider or ethers signer object

Return Value(s)

Returns a JSON object literal with the below info:

KeyValue TypeDescription

timestamp

Date

Timestamp when a stream of superToken was last updated by the account

flowRate

string

Net flow rate (wei/second) of account for the specified superToken.

Can be positive or negative as it's the sum of the account's inbound and outbound CFA flow rates.

deposit

string

Total buffer deposits of all streams being sent by account

owedDeposit

string

Total additional deposits for all streams to Super Apps

Last updated