Links

getNetFlow

Get the net flow rate value for an account
//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.getNetFlow({
account: string,
providerOrSigner: ethers.providers.Provider | ethers.Signer
});

Parameters

Parameter
Type
Description
account
string
Address of account you're getting net flow rate for
providerOrSigner
ethers.providers.Provider or ethers.Signer
ethers provider or ethers signer object

Return Value(s)

Returns a string with the below info:
Type
Description
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.

Example Usage