Interface LockedAllocation

Hierarchy

  • LockedAllocation

Properties

cancelableByRecipient? cancelableBySender? cliff? name recipient tokenAmount transferableByRecipient? transferableBySender? unlockSchedule vestingDuration vestingStartTime

Properties

Optional cancelableByRecipient

cancelableByRecipient?: boolean

Whether the recipient can cancel the vesting stream. Defaults to false.

Optional cancelableBySender

cancelableBySender?: boolean

Whether the sender can cancel the vesting stream. Defaults to false.

Optional cliff

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

Optional cliff configuration

Type declaration

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

    Duration until the cliff

  • Optional unlockAmount?: CliffUnlockAmount

    Tokens released at cliff.

    • Omitted: defaults to linear vesting
    • number: custom token amount (backward compatible shorthand)
    • 'linear': linear vesting calculation
    • { type: 'linear' }: linear vesting calculation
    • { type: 'custom', value: number }: explicit custom token amount

name

name: string

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

recipient

recipient: string | PublicKey<string>

Recipient wallet address

tokenAmount

tokenAmount: number

Total number of tokens in the vesting schedule

Optional transferableByRecipient

transferableByRecipient?: boolean

Whether the recipient can transfer the vesting stream. Defaults to false.

Optional transferableBySender

transferableBySender?: boolean

Whether the sender can transfer the vesting stream. Defaults to false.

unlockSchedule

unlockSchedule: TimeUnit

How frequently tokens are released

vestingDuration

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

Duration of the full vesting period

Type declaration

vestingStartTime

vestingStartTime: string | Date

When the vesting stream starts

Settings

Member Visibility

Theme

Generated using TypeDoc