Skip to main content

FlowStream

No description

type FlowStream {
  id: String!
  alias: String!
  chainId: BigInt!
  subgraphId: BigInt!
  tokenId: BigInt!
  hash: Bytes!
  timestamp: BigInt!
  actions(
    skip: Int = 0
    first: Int = 100
    orderBy: FlowAction_orderBy
    orderDirection: OrderDirection
    where: FlowAction_filter
  ): [FlowAction!]!
  asset: Asset!
  assetDecimalsValue: BigInt!
  batch: FlowBatch!
  category: FlowStreamCategory!
  contract: Bytes!
  position: BigInt!
  recipient: Bytes!
  sender: Bytes!
  startTime: BigInt!
  transferable: Boolean!
  version: String!
  withdrawnAmount: BigInt!
  availableAmount: BigInt!
  creator: Bytes!
  depletionTime: BigInt!
  depositedAmount: BigInt!
  forgivenDebt: BigInt!
  lastAdjustmentAction: FlowAction
  lastAdjustmentTimestamp: BigInt!
  paused: Boolean!
  pausedAction: FlowAction
  pausedTime: BigInt
  ratePerSecond: BigInt!
  refundedAmount: BigInt!
  snapshotAmount: BigInt!
  voided: Boolean!
  voidedAction: FlowAction
  voidedTime: BigInt
}

Fields​

FlowStream.id ● String! non-null scalar​

Unique identifier: \{contractAddress\}-\{chainId\}-\{tokenId\}

FlowStream.alias ● String! non-null scalar​

Like the id: {contractAlias}-{chainId}-{tokenId}

FlowStream.chainId ● BigInt! non-null scalar​

The chain ID where the stream was created (e.g., 137 for Polygon).

FlowStream.subgraphId ● BigInt! non-null scalar​

Unique global id as tracked by the Watcher entity. ኆ80 This may change if new data sources are added and the chronological order of streams changes.

FlowStream.tokenId ● BigInt! non-null scalar​

The id provided by the NFT contract. It's the ERC-721 tokenId.

FlowStream.hash ● Bytes! non-null scalar​

Hash of the Ethereum transaction that created this stream.

FlowStream.timestamp ● BigInt! non-null scalar​

Unix timestamp of the Ethereum transaction that created this stream.

FlowStream.actions ● [FlowAction!]! non-null object​

Actions triggered by this stream.

FlowStream.actions.skip ● Int scalar​
FlowStream.actions.first ● Int scalar​
FlowStream.actions.orderBy ● FlowAction_orderBy enum​
FlowStream.actions.orderDirection ● OrderDirection enum​
FlowStream.actions.where ● FlowAction_filter input​

FlowStream.asset ● Asset! non-null object​

ERC-20 token distributed via this stream.

FlowStream.assetDecimalsValue ● BigInt! non-null scalar​

ERC-20 token decimals. Stored here to avoid loading the asset entity on each stream. Note: the "Value" suffix is added because of a bug in GraphQL Code Generator.

FlowStream.batch ● FlowBatch! non-null object​

The batch the stream may be part of. Note: this is available only when created within a batch create transaction.

FlowStream.category ● FlowStreamCategory! non-null enum​

Category used for sorting.

FlowStream.contract ● Bytes! non-null scalar​

The address of the contract the stream originates from.

FlowStream.position ● BigInt! non-null scalar​

Position in the batch, if available.

FlowStream.recipient ● Bytes! non-null scalar​

Current recipient of the stream, with permission to withdraw funds to any third-party address. Note: the recipient can change on NFT transfer.

FlowStream.sender ● Bytes! non-null scalar​

Manager of the stream, with ability to cancel the stream.

FlowStream.startTime ● BigInt! non-null scalar​

Unix timestamp for the start of the stream.

FlowStream.transferable ● Boolean! non-null scalar​

Flag indicating the transferability of the stream. This is set when the stream is created, and cannot be changed later.

FlowStream.version ● String! non-null scalar​

Version of contract, e.g., v1.0.

FlowStream.withdrawnAmount ● BigInt! non-null scalar​

The sum of all withdrawn amounts.

FlowStream.availableAmount ● BigInt! non-null scalar​

This is equivalent to the value returned by ERC20.balanceOf, and it changes after deposit and withdrawal.

FlowStream.creator ● Bytes! non-null scalar​

The account that created the stream, which can be different from the sender.

FlowStream.depletionTime ● BigInt! non-null scalar​

Unix timestamp indicating the time when the stream will become insolvent.

FlowStream.depositedAmount ● BigInt! non-null scalar​

The sum of all deposits.

FlowStream.forgivenDebt ● BigInt! non-null scalar​

The amount of debt forgiven by a void action.

FlowStream.lastAdjustmentAction ● FlowAction object​

Action in which the payment rate was adjusted.

FlowStream.lastAdjustmentTimestamp ● BigInt! non-null scalar​

Unix timestamp for when the payment rate was adjusted.

FlowStream.paused ● Boolean! non-null scalar​

Flag indicating if a stream is paused.

FlowStream.pausedAction ● FlowAction object​

Action in which the stream was paused.

FlowStream.pausedTime ● BigInt scalar​

Unix timestamp for when the stream was paused.

FlowStream.ratePerSecond ● BigInt! non-null scalar​

Current payment rate per second, denominated in 18 decimals.

FlowStream.refundedAmount ● BigInt! non-null scalar​

The sum of all refunds.

FlowStream.snapshotAmount ● BigInt! non-null scalar​

The amount streamed up until the time of the last adjustment, denominated in 18 decimals.

FlowStream.voided ● Boolean! non-null scalar​

Flag indicating if a stream is voided.

FlowStream.voidedAction ● FlowAction object​

Action in which the stream was voided.

FlowStream.voidedTime ● BigInt scalar​

Unix timestamp for when the stream was voided.