vesting

forceRemoveVestingSchedule(target: MultiAddress, schedule_index: u32)

• interface: - vesting.forceRemoveVestingSchedule

• summary: Force remove a vesting schedule

  The dispatch origin for this call must be Root.

  • target: An account that has a vesting schedule

  • schedule_index: The vesting schedule index that should be removed

forceVestedTransfer(source: MultiAddress, target: MultiAddress, schedule: PalletVestingVestingInfo)

• interface: - vesting.forceVestedTransfer

• summary: Force a vested transfer.

  The dispatch origin for this call must be Root.

  • source: The account whose funds should be transferred.

  • target: The account that should be transferred the vested funds.

  • schedule: The vesting schedule attached to the transfer.

  Emits VestingCreated.

  NOTE: This will unlock all schedules through the current block.

• Complexity : O(1).

mergeSchedules(schedule1_index: u32, schedule2_index: u32)

• interface: - vesting.mergeSchedules

• summary: Merge two vesting schedules together, creating a new vesting schedule that unlocks over the highest possible start and end blocks. If both schedules have already started the current block will be used as the schedule start; with the caveat that if one schedule is finished by the current block, the other will be treated as the new merged schedule, unmodified.

  NOTE: If schedule1_index == schedule2_index this is a no-op. NOTE: This will unlock all schedules through the current block prior to merging. NOTE: If both schedules have ended by the current block, no new schedule will be created and both will be removed.

  Merged schedule attributes:

  • starting_block: MAX(schedule1.starting_block, scheduled2.starting_block, current_block).

  • ending_block: MAX(schedule1.ending_block, schedule2.ending_block).

  • locked: schedule1.locked_at(current_block) + schedule2.locked_at(current_block).

  The dispatch origin for this call must be Signed.

  • schedule1_index: index of the first schedule to merge.

  • schedule2_index: index of the second schedule to merge.

vest()

• interface: - vesting.vest

• summary: Unlock any vested funds of the sender account.

  The dispatch origin for this call must be Signed and the sender must have funds still locked under this pallet.

  Emits either VestingCompleted or VestingUpdated.

• Complexity : O(1).

vestOther(target: MultiAddress)

• interface: - vesting.vestOther

• summary: Unlock any vested funds of a target account.

  The dispatch origin for this call must be Signed.

  • target: The account whose vested funds should be unlocked. Must have funds still locked under this pallet.

  Emits either VestingCompleted or VestingUpdated.

• Complexity : O(1).

vestedTransfer(target: MultiAddress, schedule: PalletVestingVestingInfo)

• interface: - vesting.vestedTransfer

• summary: Create a vested transfer.

  The dispatch origin for this call must be Signed.

  • target: The account receiving the vested funds.

  • schedule: The vesting schedule attached to the transfer.

  Emits VestingCreated.

  NOTE: This will unlock all schedules through the current block.

• Complexity : O(1).