Skip to content

Commit 76b421f

Browse files
committed
docs: fix Cash bill vs Kik Code definitions
These were conflated in the glossary. They are distinct: - Kik Code is the scannable, animated circular code itself — the device-to-device transport. It is surface-agnostic: currently displayed on cash bills, soon on digital gold bars, and could later back other flows such as merchant payments. - Cash bill is a digital representation of "cash" (like a US dollar), modeled as Bill.Cash; it carries a token (launchpad currency or USDF) and displays a Kik Code for the recipient to scan — one of the surfaces the code rides on. Rewrites the two glossary rows and aligns the README overview line and the features scanner row to match. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01JRVfsXp4HDrDMy7Pbmw9fD
1 parent 7f654c5 commit 76b421f

3 files changed

Lines changed: 6 additions & 6 deletions

File tree

docs/architecture/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ users create, buy, sell, and share **launchpad currencies** — custom on-chain
1919
**backed by USDF reserves** (think memecoins backed by USDC on Solana). Launchpad
2020
currencies are the unit that circulates socially; USDF is what they're priced in and
2121
redeemable for. The signature interaction is a **device-to-device cash bill** (which
22-
can carry a launchpad currency or USDF): one phone renders an animated circular Kik
23-
Code on screen, another phone scans it, and a peer-to-peer handshake settles the
24-
payment. The app also supports contact/username sends, on-ramp funding (Coinbase,
22+
can carry a launchpad currency or USDF): one phone renders a cash bill displaying an
23+
animated circular **Kik Code** on screen, another phone scans the code, and a
24+
peer-to-peer handshake settles the payment. The app also supports contact/username sends, on-ramp funding (Coinbase,
2525
in-app purchase), buying/selling launchpad currencies against USDF, and on-chain
2626
withdrawals.
2727

docs/architecture/features/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Two recurring shapes show up in the **Pattern** column:
3333
| Feature | Purpose | Screen / ViewModel | Pattern & integration |
3434
|---------|---------|--------------------|-----------------------|
3535
| **cash** | Amount entry for a device-to-device cash bill (sends the selected token — a launchpad currency or USDF) | `cash/CashScreen.kt` · `…/internal/CashScreenViewModel` | **VM-driven**; combines token + balance + rate flows, emits `PresentBill`, calls `SessionController.showBill` |
36-
| **scanner** | Camera capture of a peer's cash bill / QR | `scanner/ScannerScreen.kt` | Screen-local; uses `:ui:scanner`, routes scans through `Router.classify` |
36+
| **scanner** | Camera capture of a peer's Kik Code (e.g. on a cash bill) | `scanner/ScannerScreen.kt` | Screen-local; uses `:ui:scanner`, routes scans through `Router.classify` |
3737
| **direct-send** | Send to a contact / phone number | `directsend/SendFlowScreen.kt` · `…/internal/SendFlowViewModel` | **Flow**; contact list + phone gate steps |
3838
| **withdrawal** | Withdraw funds on-chain | `withdrawal/WithdrawalFlowScreen.kt` · `withdrawal/WithdrawalViewModel` | **Flow** (`AppRoute.Transfers.Withdrawal`); entry → destination → confirmation |
3939
| **deposit** | Add funds via on-ramp / deposit address | `deposit/DepositFlowScreen.kt` · `…/internal/DepositViewModel` | **Flow** (`FlowRouteWithResult<DepositResult>`); USDC deposit info, Coinbase on-ramp |

docs/architecture/glossary.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ full story.
1414
| **Bonding curve** | The on-chain formula that sets a launchpad currency's price from its circulating supply (`price = f(supply)`, in USDF). | [06](06-payments-and-operations.md) |
1515
| **Liquidity pool / `coreMintVault`** | A launchpad currency's bonding-curve pool; its `coreMintVault` holds the **USDF reserves** backing the token (vs `mintVault`, which holds the token). | [06](06-payments-and-operations.md) |
1616
| **Reserves** | Two senses: (1) on-chain USDF backing a token in its `coreMintVault`; (2) the **user's own USDF balance** (`observeReservesBalance()`) spent to buy launchpad currencies. | [06](06-payments-and-operations.md) |
17-
| **Cash bill** | The animated, circular on-screen code that represents a payment for **device-to-device** transfer — one phone shows it, another scans it. Carries any token (a launchpad currency or USDF). | [README](README.md), [features](features/README.md) |
18-
| **Kik Code** | The scannable code format rendered as a cash bill (captured via the camera scanner). | [07](07-design-system.md) |
17+
| **Cash bill** | A digital representation of "cash" — a note/denomination, like a US dollar — used for device-to-device transfers. Modeled as `Bill.Cash`; carries a token (a launchpad currency or USDF) and **displays a Kik Code** for the recipient to scan. One of the surfaces a Kik Code rides on. | [06](06-payments-and-operations.md), [features](features/README.md) |
18+
| **Kik Code** | The scannable, animated **circular code** itself — the device-to-device transfer transport. It is **surface-agnostic**: today it's displayed on cash bills, soon on digital gold bars, and could later back other flows such as merchant payments. Captured via the camera scanner (`:ui:scanner`). | [07](07-design-system.md) |
1919
| **On-ramp** | Funding the wallet with fiat (Coinbase) or in-app purchase. | [04](04-networking.md), [06](06-payments-and-operations.md) |
2020
| **Swap** | Buying or selling a launchpad currency **against USDF** (`SwapPurpose.Buy`/`Sell`); sells charge a ~1% fee. | [03](03-navigation.md), [06](06-payments-and-operations.md) |
2121
| **Withdrawal** | Moving funds on-chain to an external Solana address. | [features](features/README.md) |

0 commit comments

Comments
 (0)