Interface ClaimScheduleAllocation

A Genesis-native vesting lock (on-chain ClaimScheduleBucketV2), the replacement for the retired Streamflow lock. Tokens accrue on a linear curve (plus an optional cliff) and — for a launchpool launch — only become claimable once the launch graduates (the TGE). The SDK collects the schedule in human units and converts to the on-chain seconds/basis-points wire shape.

Hierarchy

  • ClaimScheduleAllocation

Properties

cancelable? cancelableByRecipient? cliff? name pausable? recipient tokenAmount transferable? transferableByRecipient? unlockSchedule vestingDuration vestingStartTime

Properties

Optional cancelable

cancelable?: boolean

Whether the launch creator (sender) can cancel the lock. Defaults to false.

Optional cancelableByRecipient

cancelableByRecipient?: boolean

Whether the recipient can cancel the lock. Defaults to false.

Optional cliff

cliff?: {
    duration: {
        unit: TimeUnit;
        value: number;
    };
    unlockAmount?: CliffUnlockAmount;
}

Optional cliff configuration

Type declaration

  • duration: {
        unit: TimeUnit;
        value: number;
    }

    Duration from vestingStartTime until the cliff releases

  • Optional unlockAmount?: CliffUnlockAmount

    Amount released at the cliff instant.

    • Omitted / 'linear': the proportional (linear) share for the cliff window.
    • number (or { type: 'custom', value }): an explicit token amount, converted to a basis-point share of tokenAmount.

    The resolved cliff share must be greater than 0.

name

name: string

Human-readable name (e.g., 'Team', 'Advisors') for this lock (max 64 chars)

Optional pausable

pausable?: boolean

Whether the Genesis authority can pause/resume vesting. Defaults to false.

recipient

recipient: string | PublicKey<string>

Recipient wallet address

tokenAmount

tokenAmount: number

Total number of tokens in the vesting schedule

Optional transferable

transferable?: boolean

Whether the launch creator (sender) can transfer the lock. Defaults to false.

Optional transferableByRecipient

transferableByRecipient?: boolean

Whether the recipient can transfer the lock. Defaults to false.

unlockSchedule

unlockSchedule: TimeUnit

How frequently tokens unlock (the release period)

vestingDuration

vestingDuration: {
    unit: TimeUnit;
    value: number;
}

Length of the linear vesting leg

Type declaration

vestingStartTime

vestingStartTime: string | Date

When the linear vesting curve begins accruing (wall-clock). For a launchpool launch the tokens still cannot be CLAIMED until the launch graduates, even if accrual starts earlier.

Settings

Member Visibility

Theme

Generated using TypeDoc