Skip to content
Solana

Docs · Revenue tokens

Holding a revenue token

Coming

What staking a reel revenue token gives you, what you can check on chain before you buy one, and how the tokenizer answers hookr's design questions.

Not live yet: this runs in a reel-vaults module that is built and tested but not in the deployed build. The page describes it so integrators can see where it fits; details can change before it ships.

What a staker gets

A share of the income of the fee rights the token locks, in proportion to the staked supply, claimed per income mint whenever the staker likes. The supply is fixed at Init. Income streams over the tokenizer's release period (up to 14 days; the SDK defaults to 1 day), and a stake earns the share of each second it is staked. Tokens left in a wallet or a pool earn nothing.

What you can check today

Every fee right a revenue token holds is readable on chain without trusting the token:

  1. The launch. Read the Launch account: owner, beneficiary and lock_until. A launch held for a token shows the tokenizer's authority as its owner.
  2. The positions. Read each Position: owner, shares and lock_until. A permanent lock is i64::MAX.
  3. The royalty and payee. Read the Pool: royalty_to and payee were frozen at PoolInit, and aren't part of a tokenizer's rights.
  4. The income so far. Pool keeps lp_fees_total and fees_by_block; a ClaimLedger keeps lifetime per category and claimed.

reel's own pages show these reads with their source, and a dash where a read fails. Read Where the numbers come from.

How the tokenizer answers hookr's questions

hookr decides these on its own design; reel-vaults' tokenizer answers them this way (PROGRAM.md §19):

  • Accounting across transfers. Only staked tokens earn, so transfers stay plain SPL Token transfers with no hook and no fee. A stake → sync → unstake in one second earns nothing.
  • Release period. Fixed at Init, up to 14 days. A period of 0 books each arrival at the next second against whoever is staked then; the SDK defaults to 1 day.
  • Several assets. Up to 4 income mints, one per quote of the rights; stakers claim each separately.
  • Syncing. Anyone runs Sync, untipped.
  • Drops. Income is booked by balance, so anything sent to an income account reaches stakers at the next sync.
  • Where not to send it. Revenue tokens held outside the stake vault, in a pool or a program, earn nothing.

Claims on reel today

Ledger income, such as a royalty, a King of the Pool prize, a referral or a recapture share, is claimed with Claim(amount) from the wallet's ClaimLedger for that mint, where 0 claims everything owed. The claims vault always holds at least what every ledger of that mint is owed, because each credit moves tokens in the same instruction. A revenue token sits on top of these paths; it doesn't replace them.