Skip to main content

Entities

info

For an introduction into the Sablier primitives and our architectural choices, check out the Lockup subgraph before reading about the Merkle subgraph.

Entity Architecture

Inside the Merkle subgraph, the schema.graphql file is responsible of defining the following Sablier entities:

Primary

EntityDescription
FactoryInstances of SablierV2MerkleLockupFactory
CampaignInstances of SablierV2MerkleLL, the primary entity tracking the up to date state of an Airstream/Merkle campaign
ActionEmitted events transformed into historical entries (e.g. Claim, Create, Clawback)
ActivityAn entity tracking daily usage (one item per day) for each campaign (e.g. amount claimed per day)
AssetThe ERC20 asset that is being streamed

Secondary

EntityDescription
WatcherA singleton data store for subgraph-level unique indexes such as the campaign or action index

Structure

The structure of these entities is built on the same rules and mindset which was applied on the lockup entities.

Identifying

Airstreams will be assigned a unique contract address once they are deployed by the Merkle Factory. While this makes it easy to identify items at the contract level, we need to consider the following for both subgraphs and client interfaces:

  • items should be uniquely identifiable across multiple chains
  • items should be identifiable with short, easy to digest names (TBD)

To address the first observation, the subgraph uses the following identifier for an Airstream.

TypeDescriptionExample
Airstream.idA self-explanatory structure built using the following structure: contractAddress-chainId0xAB..12-1115511

The example from the table above translates to: a stream on Sepolia (chain id 1115511), with the contract address 0xAB..12.

info

We've chosen not to apply aliases to Airstreams for now. In the future, we may ask the campaign creator to provide a name or an alias to be used in the URL.

Architecture and Data Flow

The data flow applied to this subgraph is identical to the one used in the lockup subgraph.