Glossary
The words this documentation uses precisely — one line each, no ambiguity.
The words this documentation uses precisely — one line each. If a term is missing, open an issue.
Glossary
| term | meaning |
|---|---|
| MAIN | the defended currency: bought on pumps, absorbed from sells, delivered to the recipient |
| SECONDARY | the buyback currency: the only asset the pot holds and donate accepts |
| pot | a pool's permissionless war chest, denominated in secondary |
| pump | the pot buying more main inside a buy's own transaction (afterSwap) |
| shield | the pot absorbing a sell at the pool's exact execution price (beforeSwap) |
| burn cascade | burn() → 0xdEaD → held forever; how burn-intent main leaves circulation |
| LP program | the pool's single hook-held liquidity position plus its split rules |
| harvest | collecting the program's fees and running the split (auto in-swap, or manual) |
| compound | the share of harvested fees re-minted into the position itself |
| carry | compound budget the mint couldn't place yet — retried at every next harvest |
| pot admin | the pool's initializer: declares roles, moves the recipient, creates the program |
| owner | the program's property holder: liquidity, harvest, transfer; 0x0 = locked forever |
| operator | the program's settings editor; 0x0 = rules frozen forever |
| owed ledger | refused harvest pushes, booked per (recipient, asset), claimable any time |
| parked | a refused pot delivery, retryable by anyone via flushDirect |
| held | unburnable burn-intent main held on the hook forever — custody is the burn |
| WAD | the 1e18 fixed-point scale: 1e18 = 100% |
FAQ
Why does the doc insist on MAIN vs SECONDARY?+
Because every rule is asymmetric: pumps buy MAIN with SECONDARY, the pot holds only SECONDARY, burn shares exist only on MAIN. Mixing the two words up makes every sentence wrong.
Is "pot" the same as the LP program?+
No — the pot is the buyback war chest (secondary only); the program is the hook-held liquidity position with its split rules. They cooperate but have separate balances and roles.
What's the difference between carry and owed?+
Carry is compound budget waiting to be minted into liquidity. Owed is a payout a recipient refused, waiting to be claimed. Both are custody-backed, neither expires.
What does WAD mean in configs?+
The 1e18 fixed-point scale: 5e17 = 50%, 1e18 = 100%. All shares in ProgramConfig are WADs; amounts everywhere else are raw token units.
What is "held forever" exactly?+
Burn-intent tokens that refused both burn() and 0xdEaD, kept on the hook with no withdrawal path, counted per asset by heldOf. Custody with no exit is the burn of last resort.