LogoLogo
  • 🌊Superfluid
  • Protocol Overview
    • 💡What is Superfluid?
    • 📄In-Depth Overview
      • Super Tokens
      • Super Agreements
        • 🚰Money Streaming (CFA)
        • ✳️Distributions (IDA)
        • 🌊Streaming Distributions
      • Super Apps
      • Superfluid Host
    • 🧠Use Cases
      • Recurring Payments
      • DeFi
      • Social & Community
      • Gaming
    • 📔Glossary of Terms
  • Developers
    • 🏃Quickstart
    • 🪙Super Tokens
      • Super Tokens - Solidity
      • Super Tokens - SDK Core
      • Super Tokens - Frontend Examples
      • Types of Super Tokens
      • Deploy a Super Token
        • Deploying a Wrapper Super Token
        • Deploying a Self Governed Super Token
        • Deploying a Pure Super Token
      • In-Depth
        • Tracking Super Token Balances
        • ERC777 in Super Tokens
      • Test Super Token Faucet
    • 🌊Money Streaming (CFA)
      • Solidity
        • Read Methods
          • getFlowInfo
          • getFlowRate
          • getNetFlowRate
        • Write Methods
          • createFlow
          • updateFlow
          • deleteFlow
          • With User Data
          • With Context
      • SDK Core
        • Read Methods
          • getFlow
          • getNetFlow
          • getAccountFlowInfo
        • Write Methods
          • createFlow
          • updateFlow
          • deleteFlow
      • Access Control List (ACL)
        • Solidity
          • createFlowFrom
          • updateFlowFrom
          • deleteFlowFrom
          • setFlowPermissions
          • setMaxFlowPermissions
          • revokeFlowPermissions
          • increaseFlowRateAllowanceWithPermissions
          • decreaseFlowRateAllowanceWithPermissions
          • getFlowPermissions
        • SDK Core
          • createFlowByOperator
          • updateFlowByOperator
          • deleteFlowByOperator
          • updateFlowOperatorPermissions
          • revokeFlowOperatorPermissions
          • increaseFlowRateAllowanceWithPermissions
          • getFlowOperatorData
      • Frontend Examples
      • More...
        • Flow Rate Time Frames
        • Building Batched Streams in Safe
        • Flow NFTs
    • ✳️Distributions (IDA)
      • IDA - Solidity
      • IDA - SDK Core
      • IDA - Frontend Examples
    • 🤖Super Apps
      • Super Apps in Depth
      • Super App Callbacks
        • Calling Agreements In Super Apps
      • User Data
        • NFT Billboard Example
      • SuperAppBaseFlow
      • Super App Examples
      • Super App Deployment Guide
    • 🧺Batch Calls
      • Batch Calls - SDK Core
      • Batch Calls - Frontend Examples
    • ⚙️Automations
      • Auto-Wrap
        • Dev Guide
      • Stream Scheduler
        • Dev Guide
      • Vesting Scheduler
        • Dev Guide
      • Stream Accounting API
        • Dev Guide
      • Automation Subgraphs
        • Stream Scheduler Subgraph
        • Vesting Scheduler Subgraph
        • Auto Wrap Subgraph
    • 🏗️Integration Guides
      • For Your Integration: The Basics
        • Supporting Super Tokens
        • Supporting Money Streams
        • Supporting Instant Distributions
      • Gating with Superfluid Subscriptions & Guild.xyz
      • Displaying Token Balances
      • Useful Queries for Your Integration
        • Instant Distribution Events
        • Money Streaming Events
        • Super Token Events
        • Other Helpful Queries
      • Constructing Links to The Superfluid Dashboard
    • 🔁Superfluid Subscriptions
      • Superfluid Checkout Widget
      • Implementing Subscriptions in your App
    • SDK Core General
      • Initialization
      • Functionality
      • Getting Data
      • Resolver
      • Reference Docs
    • Solidity General
      • Calling Super Agreements
      • Libraries
      • Resolver
    • Testing Guide
      • Hardhat Testing
      • Foundry Testing
      • In-Depth
        • Hardhat Mainnet Fork Testing
        • Super App Testing on Mainnet Forks
    • Subgraph
    • Reference
      • Deploying The Framework
      • EVM Contracts
      • SDK Redux
      • Superfluid Console
      • Superfluid Protocol Addresses
    • Contract Addresses
  • Sentinels
    • 🥅Liquidations & TOGA
    • 🤖Running a Sentinel
    • 🗺️Solvency Dashboard
  • Resources
    • 🌊Superfluid Wave Pool
    • 📜Superfluid on Ethereum Mainnet
    • 💰Bounty Program
    • 🛡️Security & Bug Bounties
    • 💡Project Ideas
    • 🗳️Token Dashboard Submission
    • 🎥Videos
    • Superfluid Deployment Guide
    • Learn about Ethereum
    • Code of Conduct
Powered by GitBook
On this page
  • What’s the Vesting Scheduler?
  • Why Automate Vesting with Superfluid?
  • Example:
  • Setting Up Vesting Scheduling

Was this helpful?

  1. Developers
  2. Automations

Vesting Scheduler

PreviousStream SchedulerNextStream Accounting API

Last updated 2 years ago

Was this helpful?

What’s the Vesting Scheduler?

The Vesting Scheduler smart contract allows you to set up a vesting schedule of tokens for a specific recipient. The Vesting Scheduler contract is non-custodial, it does not hold any tokens, rather it uses permissions to move them from your wallet (or Safe).

The Vesting Scheduler comes with the option to add a cliff date (and amount), after which it vests tokens linearly sending them to the recipient via a by-the-second Superfluid stream (the receiver does not need to claim as these tokens will appear directly in their wallet).

Setting up vesting schedules via the Vesting Scheduled contract will soon be possible directly on the Superfluid Dashboard, however you can already do so now by interacting with the contract directly in conjunction with off-chain automations (detailed in documentation ).

Why Automate Vesting with Superfluid?

Superfluid Protocol allows you to set up a linear vesting schedule with (or without) a cliff while keeping all the to-be-vested tokens in your wallet or Safe (to limit any exposure to our protocol smart contracts).

In a nutshell:

  • Set up linear vesting with (or without a cliff)

  • Specify both a custom cliff date/time and a custom cliff amount

  • Specify your custom total vesting amount and its time framework

  • Keep all tokens in your wallet (or Safe) until they are sent directly to the recipient

  • I.e. “I’d like to set up a 4 years vesting schedule, that sends 4000 AMZNx linearly with a cliff of 1 year for 1000 AMZNx”

Example:

1. It’s January 1st. You are essentially looking to vest 400 AMZNx to Alice from February 1st to June 1st, with linear vesting and a one month cliff.

To do so, you schedule vesting for an employee with the below details:

To: Alice’s account Start Date: February 1st Cliff Date: March 1st End Date: June 1st Cliff Amount: 100 AMZNx Flow Rate: 100 AMZNx/mo.

2. It’s March 1st - the cliff amount is transferred to Alice and the vesting stream begins

Note: there were no actions to be taken on the Feb. 1st start date as a cliff date was provided

3. It’s June 1st and the vesting is complete - the stream is cancelled.

Setting Up Vesting Scheduling

⚙️
here
https://www.notion.so/superfluidhq/Setting-Up-Automated-Vesting-f3e11a257a2d4b0b89210def54a59278www.notion.so