create-offramp-app
v0.1.16
Published
Scaffold starter apps for @usdctofiat/offramp integrations
Downloads
1,042
Maintainers
Readme
create-offramp-app
Scaffold starter integrations for @usdctofiat/offramp.
Usage
npx create-offramp-app my-offramp --template=nextTemplates:
nextvitetelegram-bot
The scaffolder prompts for integratorId and wires it into the template.
Each template is pinned to the current SDK line, exposes OFFRAMP_DEVELOPER_RESOURCES
in the generated app or bot, and includes a local README with run, customize,
and deploy notes.
INTEGRATOR_ID and REFERRAL_ID are free-form attribution tags (≤64 chars of [a-zA-Z0-9_-]) you choose to track your own offramp traffic — they are not secrets or API keys. The scaffolder fills INTEGRATOR_ID; each template leaves a TODO_SET_REFERRAL_ID placeholder for you to replace with your own partner-specific value. Manage your developer setup at https://usdctofiat.xyz/developers.
Before you ship
- [ ] Replace
REFERRAL_ID(TODO_SET_REFERRAL_ID) with your own attribution tag inapp/page.tsx,src/App.tsx, orsrc/index.ts. - [ ] Confirm
INTEGRATOR_IDmatches the value you want attributed (re-run with--integratorId=<id>if not). - [ ] Fill the secrets in
.env.example(Privy app id for the web templates;TELEGRAM_BOT_TOKEN,MAKER_PRIVATE_KEY, and the operator allowlist for the bot). - [ ] Read the SDK Fees section:
cashout({ mode: "best" })delegates to the Delegate vault (10 bps).fastis 0 bps. - [ ] Test with a small (1 USDC) mainnet deposit before going live — there is no sandbox.
