Geliştiriciler · SDK

@usdctofiat/offramp, tek bir fonksiyon çağrısıyla USDC off-ramp ekler.

SDK, kendi uygulamanızdan USDC satmanın hızlı yoludur. Tek bir çağrı girişi doğrular, USDC'yi onaylar, satıcıyı kaydeder, Base üzerinde mevduatı oluşturur ve fiyatlandırmayı devreder. Base ana ağını hedefler ve mevduat oluşturma için izin gerektirmez.

npm'den yükleBir starter klonla
01

Yükleyin ve bir mevduat oluşturun

  1. 01Paketi yükleyin: bun add @usdctofiat/offramp (npm ve pnpm de çalışır).
  2. 02Bir viem WalletClient geçirin: kullanıcının cüzdanı, bir sunucu cüzdanı veya bir bot cüzdanı.
  3. 03offramp(walletClient, { amount, platform, currency, identifier }) çağrısını yapın.
  4. 04Dönen depositId ve txHash değerlerini okuyun veya npx create-offramp-app@latest ile bir proje iskelesi oluşturun.
02

SDK yüzeyi

ExportNe yapar
offramp(walletClient, params){ depositId, txHash, resumed, otcLink? } döndüren tek çağrılık USDC satış akışı
deposits(address)Protokol durumunu indekslemeden bir adres için mevduatları listele
close(walletClient, depositId)Mevcut bir mevduattan doldurulmamış USDC'yi çek
enableOtc / disableOtc / getOtcLinkBir mevduatta özel tek-alıcı kısıtlamasını yönet
useOfframp() / usePeerExtensionRegistration()@usdctofiat/offramp/react'tan React hook'ları
PLATFORMS, CURRENCIESTanımlayıcılar, doğrulama ve para birimi listeleri içeren tipli sabit haritalar
03

Tasarım gereği devam ettirilebilir

Bir mevduat oluşturmak birkaç onchain adıma yayılır. Önceki bir çağrı bir mevduatı yarım bıraktıysa, offramp()'i tekrar çağırmak yeni bir kopya oluşturmak yerine kaldığı yerden devam eder. Mevcut, devredilmemiş bir mevduat oluşturmak yerine benimsendiğinde sonucun resumed bayrağı true olur.

Bu, SDK'yı bir sunucudan veya bottan yeniden denemek için güvenli kılar: temiz bir başlangıç varsaymak yerine onchain duruma karşı mutabakat sağlayan, idempotency dostu bir giriş noktası.

04

Hata yönetimi

KonuSDK nasıl bildirir
Tipli hatalarOfframpError, OFFRAMP_ERROR_CODES'tan bir kod taşır
PayPal veya Wise kurulumuEXTENSION_REGISTRATION_REQUIRED yalnızca teknik kurulumu belirtir; sağlayıcı politikasını ayrı olarak uygula
DoğrulamaPLATFORMS ve CURRENCIES, tanımlayıcı ve para birimi doğrulamasını sunar
Anahtar saklamasızSDK, sizin WalletClient'ınızla imzalar ve asla özel anahtar saklamaz
05

Bundan sonra nereye

Starter şablonları

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

Peerlytics API

Fetch route, orderbook, deposit, and intent context.

Kodda özel OTC

Bir mevduatı tek bir onaylı alıcı cüzdanına kısıtlayın ve bir bağlantı paylaşın.

Keşfetmeye devam edin

Peerlytics APIGeliştirici merkezi

Sık sorulan sorular

@usdctofiat/offramp ücretsiz mi?

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.

SDK anahtar saklar mı veya fiat hareket ettirir mi?

İkisine de hayır. Sağladığınız viem WalletClient ile imzalar ve asla özel anahtar tutmaz. Fiat, seçilen ödeme uygulamasında alıcı ile satıcı arasında doğrudan hareket eder; SDK yalnızca onchain USDC ve mevduat yaşam döngüsünü yönetir.

Bir entegrasyonu nasıl test ederim?

Genel bir sandbox yoktur; SDK, Base ana ağını hedefler, dolayısıyla bir test mevduatı gerçektir ve açık emir defterinde keşfedilebilir. 1 USDC minimumunu kullanın ve onu ya bir OTC mevduatı olarak kısıtlayın (yalnızca sizin cüzdanınız doldurabilsin diye otcTaker geçirin) ya da hızlıca close() yapın. Onchain ve deposits() ile doğrulayın.