Stream

No description

type Stream {
  id: String!
  alias: String!
  chainId: BigInt!
  subgraphId: BigInt!
  tokenId: BigInt!
  hash: Bytes!
  timestamp: BigInt!
  actions(
    skip: Int = 0
    first: Int = 100
    orderBy: Action_orderBy
    orderDirection: OrderDirection
    where: Action_filter
  ): [Action!]!
  asset: Asset!
  assetDecimals: BigInt!
  batch: Batch!
  category: StreamCategory!
  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: Action
  lastAdjustmentTimestamp: BigInt!
  paused: Boolean!
  pausedAction: Action
  pausedTime: BigInt
  ratePerSecond: BigInt!
  refundedAmount: BigInt!
  snapshotAmount: BigInt!
  voided: Boolean!
  voidedAction: Action
  voidedTime: BigInt
}

Fields

Stream.id ● String! non-null scalar

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

Stream.alias ● String! non-null scalar

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

Stream.chainId ● BigInt! non-null scalar

The id of the chain, e.g., 137 for Polygon.

Stream.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.

Stream.tokenId ● BigInt! non-null scalar

The id provided by the Lockup contract. This is the ERC-721 tokenId.

Stream.hash ● Bytes! non-null scalar

Hash of the Ethereum transaction that created this stream.

Stream.timestamp ● BigInt! non-null scalar

Unix timestamp of the Ethereum transaction that created this stream.

Stream.actions ● [Action!]! non-null object

Actions triggered by this stream.

Stream.actions.skip ● Int scalar

Stream.actions.first ● Int scalar

Stream.actions.orderBy ● Action_orderBy enum

Stream.actions.orderDirection ● OrderDirection enum

Stream.actions.where ● Action_filter input

Stream.asset ● Asset! non-null object

ERC-20 token distributed via this stream.

Stream.assetDecimals ● BigInt! non-null scalar

ERC-20 token decimals. Stored here to avoid loading the asset entity on each stream.

Stream.batch ● Batch! non-null object

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

Stream.category ● StreamCategory! non-null enum

Category used for sorting.

Stream.contract ● Bytes! non-null scalar

The contract the stream originates from.

Stream.position ● BigInt! non-null scalar

Position in the batch, if available.

Stream.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.

Stream.sender ● Bytes! non-null scalar

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

Stream.startTime ● BigInt! non-null scalar

Unix timestamp for the start of the stream.

Stream.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.

Stream.version ● String! non-null scalar

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

Stream.withdrawnAmount ● BigInt! non-null scalar

The sum of all withdrawn amounts.

Stream.availableAmount ● BigInt! non-null scalar

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

Stream.creator ● Bytes! non-null scalar

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

Stream.depletionTime ● BigInt! non-null scalar

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

Stream.depositedAmount ● BigInt! non-null scalar

The sum of all deposits.

Stream.forgivenDebt ● BigInt! non-null scalar

The amount of debt forgiven by a void action.

Stream.lastAdjustmentAction ● Action object

Action in which the payment rate was adjusted.

Stream.lastAdjustmentTimestamp ● BigInt! non-null scalar

Unix timestamp for when the payment rate was adjusted.

Stream.paused ● Boolean! non-null scalar

Flag indicating if a stream is paused.

Stream.pausedAction ● Action object

Action in which the stream was paused.

Stream.pausedTime ● BigInt scalar

Unix timestamp for when the stream was paused.

Stream.ratePerSecond ● BigInt! non-null scalar

Current payment rate per second, denominated in 18 decimals.

Stream.refundedAmount ● BigInt! non-null scalar

The sum of all refunds.

Stream.snapshotAmount ● BigInt! non-null scalar

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

Stream.voided ● Boolean! non-null scalar

Flag indicating if a stream is voided.

Stream.voidedAction ● Action object

Action in which the stream was voided.

Stream.voidedTime ● BigInt scalar

Unix timestamp for when the stream was voided.