Desenvolvedores · SDK

@usdctofiat/offramp adiciona um off-ramp de USDC em uma única chamada de função.

O SDK é o caminho rápido para vender USDC a partir do seu próprio app. Uma chamada valida a entrada, aprova o USDC, registra o vendedor, cria o depósito na Base e delega a precificação. Ele tem como alvo a mainnet da Base e é permissionless para a criação de depósitos.

Instalar pelo npmClonar um starter
01

Instale e crie um depósito

  1. 01Instale o pacote: bun add @usdctofiat/offramp (npm e pnpm também funcionam).
  2. 02Passe um viem WalletClient: a carteira do usuário, uma carteira de servidor ou uma carteira de bot.
  3. 03Chame offramp(walletClient, { amount, platform, currency, identifier }).
  4. 04Leia o depositId e o txHash retornados, ou crie a estrutura de um projeto com npx create-offramp-app@latest.
02

A superfície do SDK

ExportO que faz
offramp(walletClient, params)Fluxo de venda de USDC em uma chamada que retorna { depositId, txHash, resumed, otcLink? }
deposits(address)Lista os depósitos de um endereço sem indexar o estado do protocolo
close(walletClient, depositId)Saca o USDC não preenchido de um depósito existente
enableOtc / disableOtc / getOtcLinkGerencia a restrição privada de comprador único em um depósito
useOfframp() / usePeerExtensionRegistration()Hooks React de @usdctofiat/offramp/react
PLATFORMS, CURRENCIESMapas const tipados com identificadores, validação e listas de moedas
03

Retomável por design

Criar um depósito envolve várias etapas onchain. Se uma chamada anterior deixou um depósito no meio do fluxo, chamar offramp() novamente retoma de onde parou, em vez de criar um duplicado. O campo resumed do resultado é true quando um depósito não delegado já existente foi adotado em vez de criado.

Isso torna o SDK seguro para retentativas a partir de um servidor ou bot: um ponto de entrada idempotency-friendly que reconcilia com o estado onchain em vez de presumir um ponto de partida limpo.

04

Tratamento de erros

AspectoComo o SDK sinaliza
Erros tipadosOfframpError carrega um code de OFFRAMP_ERROR_CODES
Configuração de PayPal ou WiseEXTENSION_REGISTRATION_REQUIRED sinaliza apenas configuração técnica; aplicar a política do provedor separadamente
ValidaçãoPLATFORMS e CURRENCIES expõem validação de identificador e de moeda
Sem custódia de chavesO SDK assina com seu WalletClient e nunca armazena chaves privadas
05

Para onde ir em seguida

Templates starter

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

Peerlytics API

Fetch route, orderbook, deposit, and intent context.

OTC privado em código

Restrinja um depósito a uma carteira de comprador aprovada e compartilhe um link.

Continue explorando

Peerlytics APICentro do desenvolvedor

Perguntas comuns

O @usdctofiat/offramp é gratuito?

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.

O SDK custodia chaves ou movimenta fiat?

Não, para ambos. Ele assina com o viem WalletClient que você fornece e nunca guarda chaves privadas. O fiat se move diretamente entre comprador e vendedor no app de pagamento escolhido; o SDK só cuida do USDC onchain e do ciclo de vida do depósito.

Como faço para testar uma integração?

Não há sandbox público; o SDK tem como alvo a mainnet da Base, então um depósito de teste é real e descobrível no orderbook aberto. Use o mínimo de 1 USDC e restrinja-o como depósito OTC (passe otcTaker para que só sua carteira possa preenchê-lo) ou faça close() rapidamente. Confirme onchain e via deposits().