Skip to main content

Skill Spec Summary

This page normalizes the essentials from STAKR skill documents for quick implementation.

Source Skills​

Key Behavior Rules​

  • Rewards are linear over startTime -> endTime.
  • Max active reward tokens per vault: 25.
  • modifyRewardToken can extend active rewards; once ended, it can reschedule with a new window.
  • owner == address(0) enables permissionless add/modify behavior.
  • Plugins are strict-mode: hook revert means vault action revert.

Core Agent Calls​

  • Deploy (no plugin): createStakrVault(underlying, name, symbol, description, owner)
  • Deploy (with plugin): createStakrVault(underlying, name, symbol, description, owner, plugin)
  • Start reward: addRewardToken(...)
  • Stream/extend: modifyRewardToken(...)
  • Participant flows: depositAndLock, harvest, unlock, unlockAndRedeem

Plugin Hook Families​

  • Deposit hooks: beforeDeposit, afterDeposit
  • Lock/unlock hooks: beforeLock, afterLock, beforeUnlock, afterUnlock
  • Redeem hooks: beforeRedeem, afterRedeem
  • Reward hooks: beforeAddReward, afterAddReward, beforeModifyReward, afterModifyReward, beforeRemoveReward, afterRemoveReward
  • Harvest hooks: beforeHarvest, afterHarvest

Revert Classes to Handle​

  • Invalid reward state.
  • Invalid time settings.
  • Not allowed caller.
  • Insufficient locked balance.

Next Step​