Subline

⚠️ This product is in early development. Expect rapid changes and potential breaking changes. ⚠️

The subscription protocol for Farcaster Miniapps.

It provides:

• A minimal on-chain registry for app subscriptions (contracts/)
• A TypeScript SDK for frontend/backend/solidity integrations (@subline/sdk)
• A creator miniapp to define plans and generate “Subscribe” frames

---

Repo structure

src/
  contracts/           # On-chain primitive
  packages/
    sdk/               # @subline/sdk
    creator-miniapp/   # Subline miniapp
    demo/              # example integration app(s)

Each package has its own README with more details.

Getting started

1. Install dependencies

pnpm install

2. Build & test everything

# run all tests
pnpm -r test

# build all packages
pnpm -r build

3. Contracts

cd src/contracts

# run contract tests
forge test

# build contracts
forge build

Contracts are compiled and tested using Foundry.

---

SDK (@subline/sdk)

The SDK is in src/packages/sdk.

It exposes:

• backend helpers (server-side subscription checks) (must have)
• frontend helpers (Farcaster miniapp + wagmi/viem integrations) (should have)
• solidity helpers (on-chain subscription checks) (could have)

See src/packages/sdk/README.md for:

• installation instructions
• API reference
• integration examples

---

Creator Miniapp

The creator miniapp lives in src/packages/creator-miniapp. It lets creators:

• register their miniapp,
• define subscription plans,
• generate a shareable “Subscribe” frame.

Development:

cd src/packages/creator-miniapp
pnpm dev

Build:

pnpm build

See src/packages/creator-miniapp/README.md for details.

---

Examples

src/packages/examples contains example integrations using @subline/sdk. Useful as a reference for how to wire Subline into your own app.

---

Publishing the SDK

From the repo root:

cd src/packages/sdk
pnpm build
npm publish --access public

Make sure tests pass (pnpm -r test) before creating a PR.

---

License

MIT