Skip to content

Refresh app package README#9

Open
sedge-bot wants to merge 1 commit intofielding:mainfrom
sedge-bot:sedge/app-readme-refresh
Open

Refresh app package README#9
sedge-bot wants to merge 1 commit intofielding:mainfrom
sedge-bot:sedge/app-readme-refresh

Conversation

@sedge-bot
Copy link
Copy Markdown

Summary

  • replace the create-next-app boilerplate in packages/app/README.md with RipGuard-specific app docs
  • document Node 22, root-level pnpm commands, key public env vars, and the main app surfaces

Validation

  • docs-only change; verified git diff/commit locally

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 24, 2026

Someone is attempting to deploy a commit to the Fielding Johnston's projects Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Copy Markdown
Owner

@fielding fielding left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for picking up the stale create-next-app boilerplate — this was explicitly flagged in .handoff/CONTEXT.md as scaffold noise to replace. Most of the content checks out (Node 22 / Node 24 SSR caveat, env vars, zero-address treasury behavior, framework versions, "no custom custody contracts" all match the code and decisions docs).

One factual fix and one nit before merge.

Fix: Misleading "Main surfaces" pointers

Wallet, chain, and Sablier transaction plumbing is in lib/ and related hooks/components.

src/lib/ actually contains og-image.tsx, fonts/, schedule.ts, errors.ts, retry.ts, analytics.ts — OG card rendering, schedule math, and retry helpers. None of the wallet/chain/tx code lives there. There is also no hooks/ directory. A reader following this pointer will poke around lib/ looking for the approve/lock flow and come up empty.

The actual layout:

  • Wallet/chain config → src/config/ (wagmi.ts, chains.ts, contracts.ts, abis.ts) and src/providers.tsx
  • Sablier approve/lock/claim state machines → inline in src/app/create/page.tsx and src/app/vaults/page.tsx

Nit: /vaults is missing from the surfaces list

"Landing and lock creation live under app/" omits the vault dashboard at /vaults, which is a major surface (claim flow, stream queries, share card).

Suggested replacement for the whole "Main surfaces" section

## Main surfaces

- Landing (`/`), lock creation (`/create`), and vault dashboard (`/vaults`) live under `src/app/`.
- Chain config, contract addresses, and wagmi/RainbowKit setup live in `src/config/` and `src/providers.tsx`.
- Sablier approve / lock / claim transaction flows are inline in the `/create` and `/vaults` page components.
- The app uses wagmi, viem, RainbowKit, Tailwind 4, and Next.js 16.

Otherwise LGTM — happy to approve once that section is corrected.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants