@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.
Yükleyin ve bir mevduat oluşturun
- 1Paketi yükleyin: bun add @usdctofiat/offramp (npm ve pnpm de çalışır).
- 2Bir viem WalletClient geçirin: kullanıcının cüzdanı, bir sunucu cüzdanı veya bir bot cüzdanı.
- 3offramp(walletClient, { amount, platform, currency, identifier }) çağrısını yapın.
- 4Dönen depositId ve txHash değerlerini okuyun veya npx create-offramp-app@latest ile bir proje iskelesi oluşturun.
SDK yüzeyi
| Export | Ne 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 / getOtcLink | Bir mevduatta özel tek-alıcı kısıtlamasını yönet |
| useOfframp() / usePeerExtensionRegistration() | @usdctofiat/offramp/react'tan React hook'ları |
| PLATFORMS, CURRENCIES | Tanımlayıcılar, doğrulama ve para birimi listeleri içeren tipli sabit haritalar |
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ı.
Hata yönetimi
| Konu | SDK nasıl bildirir |
|---|---|
| Tipli hatalar | OfframpError, OFFRAMP_ERROR_CODES'tan bir kod taşır |
| PayPal veya Wise kurulumu | Tanıtıcı henüz kaydedilmemişse EXTENSION_REGISTRATION_REQUIRED |
| Doğrulama | PLATFORMS ve CURRENCIES, tanımlayıcı ve para birimi doğrulamasını sunar |
| Anahtar saklamasız | SDK, sizin WalletClient'ınızla imzalar ve asla özel anahtar saklamaz |
Bundan sonra nereye
Keep exploring
Common questions
@usdctofiat/offramp ücretsiz mi?
Evet. SDK'yı yüklemek ve entegre etmek ücretsizdir ve cüzdanınız imzaladığı için mevduat oluşturmak hiçbir API anahtarı gerektirmez. Peerlytics analitiği, API kredileri ve imzalı webhook yönetimi Peerlytics aracılığıyla ayrıca sunulur.
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.