Skip to content

superfluid:vest

Vest a total SuperToken amount to a receiver over a duration through the VestingScheduler (V3), executed by Superfluid's keeper network. With --cliff, everything accrued up to the cliff is transferred at once when it passes, then the rest streams. Automatically grants the scheduler flow-operator rights and the SuperToken allowance it needs; execution is permissionless but not guaranteed if the grants are revoked.

⚗️ Experimental — available at next.evmcrispr.com.

Supports runtime fields inside smart blocks. Use explicit @helper! expressions or captured outputs; other fields are evaluated at build time.

superfluid:vest <amount> <token> <to> <receiver> <over> <duration>
NameTypeEvaluationDescription
amountnumberRuntime in smart blocksTotal amount to vest, in base units (18 decimals)
tokensupertokenBuild timeSuperToken symbol (e.g. USDCx) or address
tocommandBuild timeKeyword to
receiveraddressRuntime in smart blocksVesting receiver
overcommandBuild timeKeyword over
durationnumberRuntime in smart blocksTotal vesting duration, e.g. 1y or 730d
NameTypeEvaluationDescription
--startnumberRuntime in smart blocksUnix timestamp at which vesting starts (defaults to now)
--cliffnumberRuntime in smart blocksCliff period from the start (e.g. 90d): nothing until it passes, then the accrued amount at once
--claimable-fornumberRuntime in smart blocksMake the schedule claimable: the receiver must claim within this period after the start or it never begins
--no-approveboolBuild timeSkip the automatic permission grant and allowance actions
# Vest 12,000 xDAIx to a contributor over a year with a 3-month cliff (scheduler permissions and allowance are granted automatically)
superfluid:vest 12000e18 xDAIx to 0x8790B75cF2BD36a2502A24e0E16AA1B23eBeBC71 over 1y --cliff 90d