Skip to main content

Entities

Token

Description: Generic type for ERC-20 tokens.

FieldTypeDescription
idID!The contract address
decimalsIntThe ERC-20 decimals
nameStringThe ERC-20 name
symbolStringThe ERC-20 symbol

Cancellation

Description: Generic type for Sablier cancellations

FieldTypeDescription
idID!The same as the stream id
recipientBalanceBigInt!Amount of tokens the recipient was distributed
senderBalanceBigInt!Amount of tokens the sender was distributed
timestampBigInt!The time when the cancellation was made
tokenTokenThe token used for payment
txhashString!Transaction hash

Stream

Description: Generic type for Sablier streams.

FieldTypeDescription
cancellationCancellationDetails about cancellation time and the distributed amounts
depositBigInt!The address of the recipient account
idID!The salary id in v1.0.0 and the actual stream id in v1.1.0
ratePerSecondBigInt!How much is being streamed every second
recipientBytes!The address of the recipient account
senderBytes!The address of the sender account, who created the streamed
startTimeBigInt!The time when the stream commences
stopTimeBigInt!The time when the stream stops
timestampBigInt!The time when the stream was created
tokenTokenThe token used for payment
txs[StreamTransaction!]@derivedFrom(field: "stream")Exhaustive list of all transactions that interacted with the stream
withdrawals[Withdrawal!]Exhaustive list of all withdrawals made from the stream

StreamToSalary

Description: Needed for retroactively indexing cancellations and withdrawals for v1.0.0 streams.

FieldTypeDescription
idID!The stream id
salaryIdBigInt!The salary id

StreamTransaction

Description: Transaction that interacted with a stream.

FieldTypeDescription
idID!Transaction hash concatenated with log index
blockInt!Block number
eventString!The name of the event emitted
fromBytes!The caller, or msg.sender
streamStream!The stream entity associated with this transaction
timestampBigInt!Block timestamp
toBytesThe contract address
txhashString!Transaction hash

Withdrawal

Description: Generic type for Sablier withdrawals.

FieldTypeDescription
idID!Transaction hash concatenated with log index
amountBigInt!How many tokens were withdrawn
streamStream!The stream entity associated with this withdrawal
timestampBigInt!The time when the cancellation was made
txhashString!Transaction hash