Sablier Documentation

website·Indexed 34 days ago

https://docs.sablier.com

Technical documentation for the Sablier Protocol, covering token distribution via Lockup and Flow streams, price-gated Bob vaults, and Airdrops. Includes API references for GraphQL indexers (The Graph and Envio), the Merkle API, and guides for integrating with the Sablier Interface.

Tokens: 196.1K
Snippets: 973
Records: 1.3K
Agent score: 63%

What's inside Sablier

Overview of ILidoWithdrawalQueue interface
The ILidoWithdrawalQueue is a minimal interface for Lido's WithdrawalQueueERC721 contract. In the Sablier ecosystem, it serves as a fallback unstaking path for stETH when the Curve pool is unavailable.
https://docs.sablier.com/reference/bob/contracts/interfaces/external/interface.IStETHwebsitellms
Overview of ISablierMerkleExecute airdrop distribution
ISablierMerkleExecute enables an airdrop model where eligible users claim tokens and immediately execute a call on a target contract (e.g., for staking or lending pool deposits). The process works by approving the target contract to spend the user's claimed tokens, executing a call using a predefined function selector and user-provided arguments, and then revoking the approval.
https://docs.sablier.com/reference/airdrops/contracts/interfaces/interface.ISablierMerkleInstantwebsitellms
Overview of ISablierFactoryMerkleInstant
ISablierFactoryMerkleInstant is a factory contract used to deploy MerkleInstant campaign contracts. These campaigns are designed for the instant distribution of tokens to a set of recipients based on a Merkle tree.
https://docs.sablier.com/reference/airdrops/contracts/interfaces/interface.ISablierFactoryMerkleLLwebsitellms
Overview of BobVaultShare ERC-20 tokens
BobVaultShare is an ERC-20 token representing shares in a Bob vault. Each vault has its own dedicated BobVaultShare deployment. The tokens are used to track vault ownership, and the SablierBob contract is the only entity authorized to mint and burn these tokens. When shares are transferred, wstETH attribution is updated proportionally via an adapter.
https://docs.sablier.com/reference/bob/contracts/contract.SablierBobwebsitellms
Overview of SablierBobState contract
The SablierBobState contract manages the global state for Bob vaults, including the mapping of vault IDs to vault data, token-specific default adapters, and tracking of the next available vault ID. It implements the ISablierBobState interface.
https://docs.sablier.com/reference/bob/contracts/contract.BobVaultSharewebsitellms
Overview of ISablierLockupDynamic
The ISablierLockupDynamic interface is used to create token lockup streams that follow a dynamic distribution model. These streams are funded by the sender, wrapped as ERC-721 NFTs, and distribute tokens based on defined segments.
https://docs.sablier.com/reference/lockup/contracts/interfaces/interface.ISablierLockupLinearwebsitellms
Overview of SVGElements library
The SVGElements library provides a collection of SVG constants and helper functions used to generate dynamic SVG graphics (such as hourglasses, progress circles, and cards) within smart contracts. It includes predefined SVG paths for branding, layout elements, and utility functions for calculating text dimensions and formatting SVG components.
https://docs.sablier.com/reference/lockup/contracts/types/library.BatchLockupwebsitellms
Overview of Sablier Lockup program functionality
The sablier_lockup program manages token streaming and locking on Solana. Its primary functionalities include initializing the program, creating streams, canceling streams, withdrawing streamed tokens, and renouncing ownership. Stream creation is handled via two instructions: create_with_timestamps_ll and create_with_durations_ll. While they differ in required input, both result in the same on-chain data and account structures.
https://docs.sablier.com/solana/architecture-and-diagrams/merkle-instantwebsitellms
Overview of SablierComptroller
The SablierComptroller contract manages fees for various Sablier protocols. It inherits from ERC165Upgradeable, ISablierComptroller, RoleAdminable, and UUPSUpgradeable. It is designed to be used behind an ERC1967Proxy for upgradeability.
https://docs.sablier.com/reference/utils/contracts/interfaces/interface.ISablierComptrollerwebsitellms
Overview of the IWstETH Interface
IWstETH is a minimal interface for Lido's wrapped staked ETH (wstETH). It inherits from IERC20 and provides utility functions for wrapping, unwrapping, and calculating the exchange rates between stETH and wstETH.
https://docs.sablier.com/reference/bob/contracts/interfaces/interface.IBobVaultSharewebsitellms
Overview of ISablierLidoAdapter
The ISablierLidoAdapter is an interface for the Lido yield adapter. It enables the staking of WETH as wstETH and supports unstaking through either Curve pools or native Lido withdrawal queues. It extends the base ISablierBobAdapter interface.
https://docs.sablier.com/reference/bob/contracts/libraries/library.Errorswebsitellms
Overview of Variable Claim Amount (VCA) Airdrop Model
The Variable Claim Amount (VCA) is an airdrop model where the claimable amount increases linearly over time. If a user claims early, they forgo a portion of their allocation. If they claim after the vesting period ends, they receive the full allocated amount.
https://docs.sablier.com/reference/airdrops/contracts/libraries/library.Errorswebsitellms