Docs

Documentation

Worked examples

Every Root, worked through with real numbers. One coin, one lock and three holders, so you can see exactly what each Root pays and to whom. All figures use the default settings, and every one of them can be changed when setting up Roots.

Setup

Every example uses one coin, $CAT: 1B supply at a $1M market cap, so 1 CAT = $0.001. The dev locks 200M (20% of supply) and splits it across the Roots below. The other 800M sits with holders. The dev's own wallet never earns from its own lock.

RootShare of lockPool (CAT)Value at $1M mcap
Holder35%70M$70,000
Swap15%30M$30,000
Frenzy10%20M$20,000
Burn10%20M$20,000
Milestone10%20M$20,000
Lottery5%10M$10,000
Dip Defender5%10M$10,000
Duel5%10M$10,000
Referral2%4M$4,000
Alliance1%2M$2,000
Bucket Scout1%2M$2,000
Meme Forge1%2M$2,000
Total100%200M$200,000

Three holders appear throughout. “Share of holders” is their slice of the 800M held outside the lock, which is what shared payouts split by.

HolderCAT heldShare of supplyShare of holdersValue
Alice2M0.2%0.25%$2,000
Bob10M1%1.25%$10,000
Cara40M4%5%$40,000

All payouts are in CAT. Dollar values assume CAT stays at a $1M market cap unless an example says otherwise. In practice the 800M changes as people buy, sell and swap in, so treat shares as a snapshot.

Holder

The 70M pool pays out every 6 hours over the duration the dev picks, split by share of holdings. Over 7 days that's 28 payouts of 2.5M, and every holder ends the week with 8.75% more CAT.

HolderShare of holdersPer 6-hour payoutOver 7 daysBag growthValue
Alice (2M)0.25%6,250175,000+8.75%$175
Bob (10M)1.25%31,250875,000+8.75%$875
Cara (40M)5%125,0003,500,000+8.75%$3,500

Selling cuts the payout. Each payout uses a wallet's lowest balance during those 6 hours. If Alice sells half her bag on day 4, every payout after that pays her 3,125 instead of 6,250.

Holding the whole time counts up to 2×. Each wallet's weight grows from 1× when it starts holding to 2× by the end of the run. If Bob holds all 7 days while the average holder only held for the second half, Bob counts at 2× in the last payout and the average holder at about 1.5×. His share goes from 1.25% to about 1.66%, so that payout pays him about 41,500 instead of 31,250.

The dev picks the pace. The total is the same; only the speed changes.

DurationPayoutsEach payoutBob per payoutBob in total
1 day417.5M218,750875,000
2 days88.75M109,375875,000
7 days282.5M31,250875,000
30 days120≈583,333≈7,292875,000

Swap

A holder of a vamp in $CAT's bucket swaps into CAT through Root and gets a 5% bonus on the CAT they receive, capped at 500K CAT (0.05% of supply). The vamp is sold for SOL and the SOL buys CAT. Each wallet can swap once per bucket.

The vamp is $KAT: same meme, 1B supply, $400K market cap, so 1 KAT = $0.0004. KAT qualifies because $400K is at least 25% of CAT's $1M and above the $15K floor. Swaps lose some value to fees and price impact; these examples assume about 4% on a small swap and 10% on a large one.

Dave (small bag)Erin (large bag)
KAT held5M (0.5% of KAT)100M (10% of KAT)
Value at $400K mcap$2,000$40,000
Lost to fees and impact≈$80 (4%)≈$4,000 (10%)
CAT bought at $0.0011,920,00036,000,000
5% bonus96,0001,800,000
Cap (0.05% of supply)500,000500,000
Bonus paid96,000 ($96)500,000 ($500)
New CAT holding2,016,00036,500,000
Bonus as % of new holding4.76%1.37%
Also burned (1% swap-burn)19,200360,000

Two more limits keep one vamp from draining the pool:

  • Max per vamp: bonuses for KAT holders stop at 20% of the 30M Swap pool, so 6M CAT in total. That covers about 62 swaps the size of Dave's, or 12 at Erin's cap.
  • Only vamps in range count: a holder of $CATT, another vamp at $150K (15% of CAT), can't swap yet. CATT has to reach $250K (25% of CAT) first.

The swap also helps $CAT win the bucket. Erin selling 10% of KAT's supply pushes KAT down and CAT up, bringing KAT closer to dying and triggering Frenzy.

Frenzy

When a vamp that reached range dies while $CAT is ahead, 10% of what's left in the 20M Frenzy pool is split among CAT holders by share of holdings. When every such vamp is dead, Last Coin Standing pays 25% of what's left.

A vamp dies when it's down 85% from its peak and stays under the $15K floor for an hour. KAT peaked at $400K, so it dies once it falls below $60K and holds under $15K for an hour. Each holder's share uses their lowest balance through the battle, so buying right before a vamp dies earns nothing.

EventPool beforePaid outAlice (0.25%)Bob (1.25%)Cara (5%)
KAT dies20M2M (10%)5,00025,000100,000
CATT dies (it had reached range)18M1.8M (10%)4,50022,50090,000
Last Coin Standing16.2M4.05M (25%)10,12550,625202,500
Total7.85M19,625 (+0.98%)98,125 (+0.98%)392,500 (+0.98%)

The percentages are growth of each holder's bag. Dave and Erin, who swapped in, share in these payouts too once they've held through the battle, which slightly shrinks everyone else's share.

Duel

Two rooted coins in the same bucket each wager part of their lock on a timer. At the end, the loser's wager is sold and the SOL buys the winner, and those bought tokens are burned. Each side can wager at most 5% of its locked supply.

CAT ($1M, 200M locked) challenges $DOG ($800K, 150M locked) to a 24-hour duel in “Same %” mode, where both sides wager the same share of their lock. The winner is the stronger coin: Root scores each on its final 30-minute average market cap and its 24-hour volume together (the square root of the two multiplied), so a coin can't win on a market cap nobody trades.

CATDOG
Locked200M150M
Wager (5% of locked)10M CAT7.5M DOG
Wager value at the start$10,000$6,000
Market cap at the end (30-min average)$1.2M$700K
24-hour volume$400K$150K
Strength≈$693K≈$324K
ResultWinsLoses

DOG's 7.5M wager is worth $5,250 at the end. After about 5% price impact, roughly $5,000 buys CAT at $0.0012, about 4.17M CAT, which is burned. CAT's own 10M wager stays in its Duel pool.

HolderCAT heldShare of supply beforeShare after the burnValue at $1.2M mcap
Alice2M0.2000%0.2008%$2,410
Bob10M1.0000%1.0042%$12,050
Cara40M4.0000%4.0167%$48,200

Holders gain from a won duel through the burn and the buying pressure, not a direct payout. In “SOL value” mode both sides wager the same dollar amount instead, for example $5,000 each. If the two strengths end within 1% of each other, it's a draw and both wagers stay where they are.

Milestone

The first time CAT's 1-hour average market cap crosses a rung, that rung's share of the 20M pool is split among everyone who held for the 24 hours before, by share of holdings.

RungShare of poolPaid outAlice (0.25%)Bob (1.25%)Cara (5%)Bob in $ at that mcap
$100K10%2M5,00025,000100,000$2.50
$500K20%4M10,00050,000200,000$25
$1M30%6M15,00075,000300,000$75
$10M40%8M20,000100,000400,000$1,000
All four100%20M50,000 (+2.5%)250,000 (+2.5%)1,000,000 (+2.5%)

Dip Defender

When CAT's 15-minute average falls 40% below its 24-hour high, a dip window opens. Wallets that buy during it and keep what they bought for 2 days earn 5% of it as a bonus. The window closes once price recovers halfway.

CAT's 24-hour high is $1M. It falls to $600K (1 CAT = $0.0006), so the window opens, and it closes when CAT is back to $800K.

Gina (new buyer)Cara (existing holder)
Holding before the dip040M
Spent in the dip$1,200$6,000
CAT bought at $0.00062M10M
Still held after 2 days2M6M of the new 10M (sold 4M)
Bonus (5% of what was kept)100,000300,000
New holding2.1M46.3M
Bonus as % of new holding4.76%0.65%

One dip can pay at most 25% of the 10M pool, so 2.5M in total, or 25 buyers the size of Gina.

Lottery

Every day, 10% of what's left in the 10M Lottery pool is split evenly between 10 winners. Tickets are each wallet's time-weighted balance for the day, and the ticket list is committed on-chain before the draw.

HolderTickets (share of holders)Chance of winning on a dayPrize on day 1Prize as % of bag
Alice0.25%about 2.5%100,000+5%
Bob1.25%about 12%100,000+1%
Cara5%about 40%100,000+0.25%

The prize shrinks with the pool: day 1 pays 1M (100K per winner), day 2 pays 900K (90K each), and after 7 days about 4.8M is still left. Smaller holders win less often but gain far more relative to their bag.

Burn

The 20M Burn pool is burned every 6 hours over the duration the dev picks, 7 days here: about 714,286 CAT per burn, taking supply from 1B to 980M. Nobody receives tokens, but every holder owns 2.04% more of the coin.

HolderCAT heldShare of supply beforeShare after 7 days
Alice2M0.200%0.204%
Bob10M1.000%1.020%
Cara40M4.000%4.082%

Swap-burns come out of the same pool: Dave's swap burned 19,200 and Erin's 360,000. Each scheduled burn is what's left divided by the burns remaining, so the pool still burns exactly 20M and finishes on schedule.

Creator fees

Creator fees aren't a Root of their own. Any SOL that reaches CAT's own buyback address buys CAT, and the tokens bought are split across CAT's Roots exactly like the locked supply. See Creator fees for how to send them.

The dev adds CAT's buyback address as a fee recipient on pump.fun, and a week of creator fees brings in 10 SOL. At an assumed $180 per SOL that's $1,800, and after about 3% price impact it buys roughly 1.75M CAT. It's added to the lock and split by CAT's allocation:

RootShare of lockCAT added
Holder35%611,100
Swap15%261,900
Frenzy10%174,600
Burn10%174,600 (burned on the Burn timer)
Milestone10%174,600
Lottery5%87,300
Dip Defender5%87,300
Duel5%87,300
Referral2%34,920
Alliance, Bucket Scout, Meme Forge1% each17,460 each
Total100%1,746,000

Bob's share of the Holder top-up, once it pays out, is 1.25% of 611,100: about 7,639 CAT. The buy itself also adds $1,800 of buying pressure.

Referral

A buyer purchases CAT through someone's referral link on Root. After a 3-day hold, the sharer earns 2% and the buyer 1% of what the buyer still holds. Each sharer can earn at most 1M CAT (0.1% of supply) in total.

Bob shares his link. Hana buys 5M CAT ($5,000) through it.

Hana holds all 5M for 3 daysHana sells 1M on day 2
Counted (lowest balance over the hold)5M4M
Bob gets (2%)100,00080,000
Hana gets (1%)50,00040,000
Hana's bonus as % of her new holding0.99%0.99%

Bob's 1M cap covers 50M CAT of referred buys, about $50,000 at a $1M market cap.

Alliance

CAT and DOG team up for 7 days. Each dev funds an Alliance pool from their own lock, and each pool pays out every 6 hours to wallets holding both coins. A wallet's weight is the dollar value of its smaller position.

CAT puts in 2M CAT and DOG puts in 1.5M DOG, so each payout is 71,429 CAT and 53,571 DOG. Say all wallets holding both coins add up to $50,000 of smaller positions.

HolderCAT positionDOG positionWeight (smaller)ShareCAT over 7 daysDOG over 7 days
Ivy$500 (500K CAT)$2,000$5001%20,000 (+4% of her CAT)15,000
Bob$10,000 (10M CAT)$1,000$1,0002%40,000 (+0.4% of his CAT)30,000

A large bag of one coin with a token amount of the other earns little. The payout follows whichever position is smaller.

Bucket Scout

Anyone can report a coin they think belongs in CAT's bucket. If it's accepted and later qualifies as a competitor (at least 25% of CAT's market cap and above $15K), the first reporter earns 5% of what's left in the 2M Scout pool. At most 3 finds are paid per day.

FindPool beforeBounty
Jack reports $KITTY; it reaches $300K2M100,000 ($100)
Second qualified find1.9M95,000
Third qualified find1.805M90,250

Meme Forge

Each week holders submit memes and vote, and 20% of what's left in the 2M Forge pool goes to the top three, split 50 / 30 / 20. Vote weight is each holder's balance, fixed before voting opens, so Cara's vote counts 20× Alice's.

WeekPrize1st2nd3rd
1400,000200,000 ($200)120,00080,000
2320,000160,00096,00064,000
3256,000128,00076,80051,200

Summary

Shared payouts grow every holder's bag by the same percentage. Fixed prizes and bonuses favor smaller holders relative to their bag.

RootWhenAlice (2M)Bob (10M)Cara (40M)
Holder7-day run+175,000 (+8.75%)+875,000 (+8.75%)+3,500,000 (+8.75%)
MilestoneAll four rungs hit+50,000 (+2.5%)+250,000 (+2.5%)+1,000,000 (+2.5%)
Burn7-day run+2.04% of supply owned+2.04% of supply owned+2.04% of supply owned
FrenzyTwo vamps die, then Last Coin Standing+19,625 (+0.98%)+98,125 (+0.98%)+392,500 (+0.98%)
LotteryOne win+100,000 (+5%)+100,000 (+1%)+100,000 (+0.25%)
DuelOne win+0.42% of supply owned+0.42% of supply owned+0.42% of supply owned

The action-based Roots pay whoever takes the action:

RootExampleBonus% of new holding
SwapDave swaps $2,000 of KAT96,0004.76%
SwapErin swaps $40,000 of KAT (capped)500,0001.37%
Dip DefenderGina buys $1,200 in the dip100,0004.76%
ReferralHana buys 5M through Bob's linkHana 50,000, Bob 100,0000.99% (Hana)
AllianceIvy holds $500 CAT and $2,000 DOG20,000 CAT + 15,000 DOG4% of her CAT
Bucket ScoutJack's report qualifies100,000—
Meme ForgeWeekly winner200,000—

Shill isn't shown here: its payout depends on views and engagement on each post rather than a fixed share, so there's no single example that fits. See Shill in the docs.