> For the complete documentation index, see [llms.txt](https://docs.familio.trade/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.familio.trade/reference/glossary.md).

# Glossary

**Allow-list.** Wallets that skip the join *mode* (still subject to joins lock, member cap, protocol pause). The head is allow-listed at creation.

**Auto-send.** On-chain flag (`setAutoSend`). Off: payouts wait as **claimable** in the vault. On: a keeper may push them via `claimFor`. One transaction to flip.

**Handle / profile.** Permanent `@name` at `/u/<handle>`, claimed with one free signature on first connect. Never reused. Generated avatar included.

**Bag.** A tracked ERC-20 the vault holds, other than quote. Capped at 30.

**Co-pilot.** Extra trader. Can `swap`, `distribute`, `pinNote`, `setLocks`. Cannot change rules, evict, or block exits.

**Cost basis.** Quote spent to acquire a bag, reduced pro-rata on sells and exits. Used to compute realised profit.

**Crew.** Head + co-pilots (and, loosely, mods). Shown on the door.

**Crew lock.** One-way: no new co-pilots ever; headship only to an existing co-pilot. Removing co-pilots still allowed. Mods are outside the lock.

**Distribute.** Move free quote into the payout accumulator. Not a fee.

**Door.** Join policy: open, approval, invite, holder-gated.

**Escrow.** Quote sitting in `pendingDeposit` during approval-mode, not yet shares.

**Empty pool.** Vault with outstanding shares but zero value (everything distributed). Joins revert until the head refills quote.

**Evict.** Head-triggered full in-kind exit of a member. The member is paid; nothing is seized.

**Family.** One `FamilyVault` clone. Shared non-custodial vault.

**Founding deposit.** First quote in, minted 1:1 (18-decimal shares). Rides in the create transaction via `found`.

**Free quote.** Quote in the vault that is not reserved as head fees, join escrow, or unclaimed payouts.

**Head.** The address in `head`. Opens the family, sets rules, trades, can transfer the seat.

**Heads board.** Top strip on `/leaderboard`: one row per head, stats aggregated across all their families. Closed families drop off the families board but stay in the head's career totals.

**Holder-gated.** Join mode: wallet must hold `gateMin` of `gateToken`.

**Ignored.** Bag excluded from the join ratio, still paid on exit. For dead tokens.

**In-kind.** Exit pays tokens, not a cash-out swap inside the vault.

**Invite code.** EIP-712 struct signed by the head (`codeId`, `maxUses`, `expiry`, `bound`).

**Join / ape in.** Deposit quote, optionally mirror-buy bags, mint shares.

**Joins lock.** Vault switch: no new members, no top-ups. Exits still work.

**Leave / take my slice.** Burn shares, receive the mix.

**`leaveWith`.** Leave plus skip-mask (frozen bags) and/or untracked `extra` tokens.

**Loss carry.** Realised losses that must be earned back before fees apply.

**Member.** Address with shares > 0.

**Mirror entry.** Join path that buys the current mix so the newcomer enters at today's bags.

**Mod.** Door operator: approve, decline, allow-list. No trading power.

**Note / thesis.** Off-chain text, on-chain `noteHash`.

**Performance fee.** Head's cut of fee-able realised profit, max 30%, only ever lowered.

**PonsAdapter.** Allow-listed adapter for Pons curves and graduated Uniswap v4 pools.

**Private family.** Listed everywhere; amounts, wallets and txs blurred for outsiders on the website. Not on-chain privacy.

**Protocol fee.** Factory cut of fee-able realised profit, max 5%, currently 1%.

**Quote.** The family's cash asset: WETH (ETH in the UI) or USDG.

**Realised profit.** `quoteOut − cost basis of the amount sold`, after loss carry.

**Router allow-list.** Factory list of contracts a vault may call for swaps.

**Session key.** Browser-generated wallet used in **turbo mode**. Stored locally; signs swaps without wallet popups. Swap powers only — cannot withdraw, change rules, or take other actions.

**Shares.** Non-transferable internal accounting. Mint on join, burn on leave.

**Skin / min head share.** Minimum fraction of `totalShares` the current head must hold to trade.

**Stray.** ERC-20 (or wrapped ETH on a non-WETH family) the vault holds but does not track. Members take it with `leaveWith`.

**Trading lock.** No swaps. Head and co-pilots included.

**Turbo mode.** Optional popup-free trading for the head and co-pilots. A browser session key trades on the trader's behalf, funded with gas, signing swaps locally. Anyone with browser access can trade while it is on. Turn off to sweep gas and revoke the key.

**Verified handle.** X or Telegram @ confirmed by the platform (X via OAuth; Telegram by opening our bot from a one-time link and pressing Start — no phone number), never typed — verification is the only way a handle gets onto a profile. Green checkmark on the profile. One account per platform per profile. Changeable until a wallet on the profile has run a family (head, co-pilot or mod); permanent after that — re-verifying the same account refreshes a renamed @, a different account is refused.

**Value.** Bags + free quote marked at last snapshot prices.

**7D return.** Change in value-per-share over \~7 days, payouts added back.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.familio.trade/reference/glossary.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.