Desarrolladores · SDK

@usdctofiat/offramp añade un off-ramp de USDC en una sola llamada de función.

El SDK es la vía rápida para vender USDC desde tu propia app. Una sola llamada valida la entrada, aprueba el USDC, registra al vendedor, crea el depósito en Base y delega el precio. Apunta a Base mainnet y es permissionless para la creación de depósitos.

Instalar desde npmClonar un starter
01

Instalar y crear un depósito

  1. 01Instala el paquete: bun add @usdctofiat/offramp (npm y pnpm también funcionan).
  2. 02Pasa un WalletClient de viem: la wallet del usuario, una server wallet o una wallet de bot.
  3. 03Llama a offramp(walletClient, { amount, platform, currency, identifier }).
  4. 04Lee el depositId y el txHash devueltos, o genera un proyecto con npx create-offramp-app@latest.
02

La superficie del SDK

ExportQué hace
offramp(walletClient, params)Flujo de venta de USDC en una llamada que devuelve { depositId, txHash, resumed, otcLink? }
deposits(address)Lista los depósitos de una dirección sin indexar el estado del protocolo
close(walletClient, depositId)Retira el USDC no rellenado de un depósito existente
enableOtc / disableOtc / getOtcLinkGestiona la restricción privada a un único comprador en un depósito
useOfframp() / usePeerExtensionRegistration()Hooks de React desde @usdctofiat/offramp/react
PLATFORMS, CURRENCIESMapas const tipados con identificadores, validación y listas de divisas
03

Reanudable por diseño

Crear un depósito abarca varios pasos onchain. Si una llamada anterior dejó un depósito a medias, volver a llamar a offramp() retoma donde se quedó en lugar de crear un duplicado. El flag resumed del resultado es true cuando se adoptó un depósito sin delegar existente en lugar de crear uno nuevo.

Eso hace que el SDK sea seguro de reintentar desde un servidor o un bot: un punto de entrada compatible con idempotencia que se reconcilia contra el estado onchain en lugar de asumir un punto de partida limpio.

04

Gestión de errores

AspectoCómo lo señala el SDK
Errores tipadosOfframpError lleva un code de OFFRAMP_ERROR_CODES
Configuración de PayPal o WiseEXTENSION_REGISTRATION_REQUIRED signals technical setup only; enforce provider policy separately
ValidaciónPLATFORMS y CURRENCIES exponen validación de identificador y de divisa
Sin custodia de clavesEl SDK firma con tu WalletClient y nunca almacena claves privadas
05

Adónde ir después

Plantillas starter

Next.js, Vite, and Telegram-bot starters plus runnable scripts.

Peerlytics API

Fetch route, orderbook, deposit, and intent context.

OTC privado en código

Restringe un depósito a una única wallet de comprador aprobada y comparte un enlace.

Sigue explorando

API de PeerlyticsCentro para desarrolladores

Preguntas frecuentes

¿Es gratuito @usdctofiat/offramp?

Yes. The SDK is free to install and integrate, and creating deposits needs no API key because your wallet signs. Peerlytics analytics and API credits are available separately through Peerlytics.

¿El SDK custodia claves o mueve fiat?

No a ambas. Firma con el WalletClient de viem que tú proporcionas y nunca custodia claves privadas. El fiat se mueve directamente entre comprador y vendedor en la app de pago elegida; el SDK solo gestiona el USDC onchain y el ciclo de vida del depósito.

¿Cómo pruebo una integración?

No hay sandbox público; el SDK apunta a Base mainnet, así que un depósito de prueba es real y visible en el orderbook abierto. Usa el mínimo de 1 USDC y o bien restríngelo como depósito OTC (pasa otcTaker para que solo tu wallet pueda rellenarlo) o ciérralo con close() rápidamente. Confírmalo onchain y mediante deposits().