@usdctofiat/offramp menambahkan off-ramp USDC dalam satu pemanggilan fungsi.
SDK ini adalah jalur tercepat untuk menjual USDC dari aplikasi Anda sendiri. Satu panggilan memvalidasi input, menyetujui USDC, mendaftarkan penjual, membuat deposit di Base, dan mendelegasikan penetapan harga. SDK menargetkan mainnet Base dan tidak memerlukan izin untuk pembuatan deposit.
Instal dan buat deposit
- 1Instal paket: bun add @usdctofiat/offramp (npm dan pnpm juga bisa digunakan).
- 2Sertakan viem WalletClient: wallet pengguna, wallet server, atau wallet bot.
- 3Panggil offramp(walletClient, { amount, platform, currency, identifier }).
- 4Baca depositId dan txHash yang dikembalikan, atau buat proyek dengan npx create-offramp-app@latest.
Permukaan SDK
| Ekspor | Fungsinya |
|---|---|
| offramp(walletClient, params) | Alur jual USDC dalam satu panggilan yang mengembalikan { depositId, txHash, resumed, otcLink? } |
| deposits(address) | Daftarkan deposit untuk sebuah alamat tanpa mengindeks state protokol |
| close(walletClient, depositId) | Tarik USDC yang belum terisi dari deposit yang ada |
| enableOtc / disableOtc / getOtcLink | Kelola pembatasan satu pembeli pada sebuah deposit |
| useOfframp() / usePeerExtensionRegistration() | React hooks dari @usdctofiat/offramp/react |
| PLATFORMS, CURRENCIES | Peta const bertipe dengan identifier, validasi, dan daftar mata uang |
Dirancang untuk bisa dilanjutkan
Membuat deposit mencakup beberapa langkah onchain. Jika panggilan sebelumnya meninggalkan deposit di tengah jalan, memanggil offramp() lagi akan melanjutkan dari titik terakhir daripada membuat duplikat. Flag resumed pada hasil bernilai true ketika deposit yang belum didelegasikan diadopsi alih-alih dibuat baru.
Ini membuat SDK aman untuk dicoba ulang dari server atau bot: titik masuk yang ramah idempotency yang merekonsiliasi dengan state onchain alih-alih mengasumsikan kondisi awal yang bersih.
Penanganan error
| Permasalahan | Cara SDK menandainya |
|---|---|
| Error bertipe | OfframpError membawa kode dari OFFRAMP_ERROR_CODES |
| Pengaturan PayPal atau Wise | EXTENSION_REGISTRATION_REQUIRED ketika handle belum terdaftar |
| Validasi | PLATFORMS dan CURRENCIES mengekspos validasi identifier dan mata uang |
| Tidak ada penyimpanan kunci | SDK menandatangani dengan WalletClient Anda dan tidak pernah menyimpan kunci privat |
Langkah selanjutnya
Keep exploring
Common questions
Apakah @usdctofiat/offramp gratis?
Ya. SDK ini gratis untuk diinstal dan diintegrasikan, dan membuat deposit tidak memerlukan API key karena wallet Anda yang menandatangani. Analitik Peerlytics, kredit API, dan manajemen webhook bertanda tangan tersedia secara terpisah melalui Peerlytics.
Apakah SDK menyimpan kunci atau memindahkan fiat?
Tidak untuk keduanya. SDK menandatangani dengan viem WalletClient yang Anda sediakan dan tidak pernah menyimpan kunci privat. Fiat berpindah langsung antara pembeli dan penjual melalui aplikasi pembayaran yang dipilih; SDK hanya menangani siklus hidup USDC onchain dan deposit.
Bagaimana cara menguji integrasi?
Tidak ada sandbox publik; SDK menargetkan mainnet Base, sehingga deposit uji coba bersifat nyata dan dapat ditemukan di orderbook terbuka. Gunakan minimum 1 USDC dan batasi sebagai deposit OTC (sertakan otcTaker agar hanya wallet Anda yang bisa mengisinya) atau tutup dengan close() dengan cepat. Konfirmasikan onchain dan melalui deposits().