Skip to content

docs: README archetype fills — table, run & test, license #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
anil-rome merged 1 commit into from
Jul 23, 2026
Merged

docs: README archetype fills — table, run & test, license #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,13 @@ Live at **https://appia.devnet.romeprotocol.xyz**. Built with Next.js 15, TypeSc

In Rome's terms, Appia is the **"from home"** pattern: reach a Rome app from your home chain and get to Solana without moving.

| You can | Where it lands on Solana |
|---|---|
| Pay USDC from your L2 → buy + stake SOL | Marinade (mSOL position in **your** PDA) |
| Swap | Meteora DAMM, via Rome CPI |
| Lend | Mango |
| Recover / claim positions | your key, always — no custody surface |

## What's in the repo

```
Expand All @@ -41,6 +48,21 @@ appia/

Nothing is hard-coded: chain id, RPC, program id, token mints, and bridge addresses all resolve from the public [`@rome-protocol/registry`](https://github.com/rome-protocol/rome-registry) via `scripts/build-chain-config.mts` into a committed `src/rome/chain-config.generated.json`. Point it at another Rome chain and rebuild.

## Run & test

```bash
npm install
npm run build:chain-config # regenerate chain config from @rome-protocol/registry
npm run dev # http://localhost:4700
npm test # vitest (resolver, encoders, guards)
npm run typecheck
npx playwright test # e2e journeys (e2e/)
```

## License

Apache-2.0 — see [LICENSE](LICENSE). Appia is an original app; third-party protocol attributions (Marinade, Mango, Meteora, Wormhole, CCTP) are in [NOTICE](NOTICE).

## Learn more

- **[Rome Protocol documentation](https://docs.rome.builders)** — how EVM execution and CPI work inside Solana, and the four ways to build.
Expand Down
Loading