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!
  canceledAction: Action
  renounceAction: Action
  cancelable: Boolean!
  canceled: Boolean!
  canceledTime: BigInt
  depositAmount: BigInt!
  duration: BigInt!
  endTime: BigInt!
  funder: Bytes!
  intactAmount: BigInt!
  parties: [Bytes!]!
  proxender: Bytes
  proxied: Boolean!
  renounceTime: BigInt
  shape: String
  cliff: Boolean
  cliffAmount: BigInt
  cliffTime: BigInt
  initial: Boolean
  initialAmount: BigInt
  segments(
    skip: Int = 0
    first: Int = 100
    orderBy: Segment_orderBy
    orderDirection: OrderDirection
    where: Segment_filter
  ): [Segment!]!
  tranches(
    skip: Int = 0
    first: Int = 100
    orderBy: Tranche_orderBy
    orderDirection: OrderDirection
    where: Tranche_filter
  ): [Tranche!]!
}

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.canceledAction` ● `Action` object

Action in which the stream was canceled.

`Stream.renounceAction` ● `Action` object

Action in which the stream was made non-cancelable. Note: if the stream was made non-cancelable from the get-go, this is the same as the Create action.

`Stream.cancelable` ● `Boolean!` non-null scalar

Flag indicating the cancelability of the stream.

`Stream.canceled` ● `Boolean!` non-null scalar

Flag indicating if the stream was canceled.

`Stream.canceledTime` ● `BigInt` scalar

Unix timestamp for the when the stream was canceled.

`Stream.depositAmount` ● `BigInt!` non-null scalar

The amount deposited when the stream was created.

`Stream.duration` ● `BigInt!` non-null scalar

Snapshot of the duration in seconds (the difference between end and start time).

`Stream.endTime` ● `BigInt!` non-null scalar

Unix timestamp for the end of the stream.

`Stream.funder` ● `Bytes!` non-null scalar

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

`Stream.intactAmount` ● `BigInt!` non-null scalar

The amount that is still held by the stream regardless of whether if was fully vested or not. This is the difference between the deposit amount and all withdrawn amounts.

`Stream.parties` ● `[Bytes!]!` non-null scalar

Users associated with the stream: recipient, sender, possibly the sender's proxy.

`Stream.proxender` ● `Bytes` scalar

Owner of the proxy when the stream is created through a PRBProxy (https://github.com/PaulRBerg/prb-proxy) Note that proxy = stream sender, and proxender = owner of proxy