Skip to main content

Staking System

ParameterDescription
/staking-setupRunning this command will send a detailed message explaining how to enable staking for your server.
/staking-statsSends a message containing the stats of your staking
/staking-summaryShows your total staking rewards accumulated.
/staking-leaderboardShows a leaderboard of the top stakers.
/staking-reportGets a report for your staking based on your criteria which your provide within the bot.

Trait-based rewards

Reward stakers more for holding NFTs with specific traits (e.g. rare backgrounds).

Command: /staking-traits add

ParameterDescriptionRequired
collectionCollection address the trait belongs to.yes
trait-nameName of the trait (e.g. Background).yes
trait-valueValue of the trait (e.g. Gold).yes
rewardDaily reward amount for NFTs with this trait.yes
  • /staking-traits list — list every configured trait reward.
  • /staking-traits remove — remove a trait reward.

Reward history & maintenance

Command: /view-user-rewards-history

ParameterDescriptionRequired
userThe Discord user whose reward history you want to view.yes
periodTime period to view.no

Command: /unstakes-all — unstakes every NFT and pays out all accrued rewards to members. Use this to wind down a staking program.

ParameterDescriptionRequired
dry-runSimulate the unstaking without actually executing it, so you can preview the payouts.no
warning

/unstakes-all pays out and unstakes everyone. Run it with dry-run set to true first to preview the result.

Creating the staking token

To mint the SPL token your staking rewards are paid in, see SPL-Token creation (/token-create).