LogoLogo
  • ๐ŸŒŠSuperfluid
  • Protocol Overview
    • ๐Ÿ’กWhat is Superfluid?
    • ๐Ÿ“„In-Depth Overview
      • Super Tokens
      • Super Agreements
        • ๐ŸšฐMoney Streaming (CFA)
        • โœณ๏ธDistributions (IDA)
        • ๐ŸŒŠStreaming Distributions
      • Super Apps
      • Superfluid Host
    • ๐Ÿง Use Cases
      • Recurring Payments
      • DeFi
      • Social & Community
      • Gaming
    • ๐Ÿ“”Glossary of Terms
  • Developers
    • ๐ŸƒQuickstart
    • ๐Ÿช™Super Tokens
      • Super Tokens - Solidity
      • Super Tokens - SDK Core
      • Super Tokens - Frontend Examples
      • Types of Super Tokens
      • Deploy a Super Token
        • Deploying a Wrapper Super Token
        • Deploying a Self Governed Super Token
        • Deploying a Pure Super Token
      • In-Depth
        • Tracking Super Token Balances
        • ERC777 in Super Tokens
      • Test Super Token Faucet
    • ๐ŸŒŠMoney Streaming (CFA)
      • Solidity
        • Read Methods
          • getFlowInfo
          • getFlowRate
          • getNetFlowRate
        • Write Methods
          • createFlow
          • updateFlow
          • deleteFlow
          • With User Data
          • With Context
      • SDK Core
        • Read Methods
          • getFlow
          • getNetFlow
          • getAccountFlowInfo
        • Write Methods
          • createFlow
          • updateFlow
          • deleteFlow
      • Access Control List (ACL)
        • Solidity
          • createFlowFrom
          • updateFlowFrom
          • deleteFlowFrom
          • setFlowPermissions
          • setMaxFlowPermissions
          • revokeFlowPermissions
          • increaseFlowRateAllowanceWithPermissions
          • decreaseFlowRateAllowanceWithPermissions
          • getFlowPermissions
        • SDK Core
          • createFlowByOperator
          • updateFlowByOperator
          • deleteFlowByOperator
          • updateFlowOperatorPermissions
          • revokeFlowOperatorPermissions
          • increaseFlowRateAllowanceWithPermissions
          • getFlowOperatorData
      • Frontend Examples
      • More...
        • Flow Rate Time Frames
        • Building Batched Streams in Safe
        • Flow NFTs
    • โœณ๏ธDistributions (IDA)
      • IDA - Solidity
      • IDA - SDK Core
      • IDA - Frontend Examples
    • ๐Ÿค–Super Apps
      • Super Apps in Depth
      • Super App Callbacks
        • Calling Agreements In Super Apps
      • User Data
        • NFT Billboard Example
      • SuperAppBaseFlow
      • Super App Examples
      • Super App Deployment Guide
    • ๐ŸงบBatch Calls
      • Batch Calls - SDK Core
      • Batch Calls - Frontend Examples
    • โš™๏ธAutomations
      • Auto-Wrap
        • Dev Guide
      • Stream Scheduler
        • Dev Guide
      • Vesting Scheduler
        • Dev Guide
      • Stream Accounting API
        • Dev Guide
      • Automation Subgraphs
        • Stream Scheduler Subgraph
        • Vesting Scheduler Subgraph
        • Auto Wrap Subgraph
    • ๐Ÿ—๏ธIntegration Guides
      • For Your Integration: The Basics
        • Supporting Super Tokens
        • Supporting Money Streams
        • Supporting Instant Distributions
      • Gating with Superfluid Subscriptions & Guild.xyz
      • Displaying Token Balances
      • Useful Queries for Your Integration
        • Instant Distribution Events
        • Money Streaming Events
        • Super Token Events
        • Other Helpful Queries
      • Constructing Links to The Superfluid Dashboard
    • ๐Ÿ”Superfluid Subscriptions
      • Superfluid Checkout Widget
      • Implementing Subscriptions in your App
    • SDK Core General
      • Initialization
      • Functionality
      • Getting Data
      • Resolver
      • Reference Docs
    • Solidity General
      • Calling Super Agreements
      • Libraries
      • Resolver
    • Testing Guide
      • Hardhat Testing
      • Foundry Testing
      • In-Depth
        • Hardhat Mainnet Fork Testing
        • Super App Testing on Mainnet Forks
    • Subgraph
    • Reference
      • Deploying The Framework
      • EVM Contracts
      • SDK Redux
      • Superfluid Console
      • Superfluid Protocol Addresses
    • Contract Addresses
  • Sentinels
    • ๐Ÿฅ…Liquidations & TOGA
    • ๐Ÿค–Running a Sentinel
    • ๐Ÿ—บ๏ธSolvency Dashboard
  • Resources
    • ๐ŸŒŠSuperfluid Wave Pool
    • ๐Ÿ“œSuperfluid on Ethereum Mainnet
    • ๐Ÿ’ฐBounty Program
    • ๐Ÿ›ก๏ธSecurity & Bug Bounties
    • ๐Ÿ’กProject Ideas
    • ๐Ÿ—ณ๏ธToken Dashboard Submission
    • ๐ŸŽฅVideos
    • Superfluid Deployment Guide
    • Learn about Ethereum
    • Code of Conduct
Powered by GitBook
On this page
  • Parameters
  • Return Value(s)
  • Example Usage

Was this helpful?

  1. Developers
  2. Money Streaming (CFA)
  3. SDK Core
  4. Read Methods

getFlow

Get information regarding a stream going from a sender to a receiver for 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.getFlow({
  sender: string,
  receiver: string,
  providerOrSigner: ethers.providers.Provider | ethers.Signer
});

Parameters

Parameter
Type
Description

sender

string

Address of sender

receiver

string

Address of receiver

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:

Key
Value Type
Value Description

timestamp

Date

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

flowRate

string

Flow rate (wei/second) of the stream. Always zero or positive.

deposit

string

owedDeposit

string

Example Usage

PreviousRead MethodsNextgetNetFlow

Last updated 1 year ago

Was this helpful?

held for the stream

if the stream is to a Super App

๐ŸŒŠ
Buffer deposit
Additional deposit
Logosuper-examples/EmploymentLoan.test.js at 311e5a95d3505dc8c5d8afd420e9edc8b5a57426 ยท superfluid-finance/super-examplesGitHub