@usdctofiat/offramp は、関数を1回呼び出すだけでUSDCオフランプを追加します。
このSDKは、自前のアプリからUSDCを売却する最短の経路です。1回の呼び出しで、入力の検証、USDCの承認、売り手の登録、Base上での入金作成、価格決定の委任までを行います。Baseメインネットを対象とし、入金作成はパーミッションレスです。
インストールして入金を作成する
- 1パッケージをインストール: bun add @usdctofiat/offramp（npmやpnpmも利用可能）。
- 2viemのWalletClientを渡す: ユーザーのウォレット、サーバーウォレット、またはボットウォレット。
- 3offramp(walletClient, { amount, platform, currency, identifier }) を呼び出す。
- 4返される depositId と txHash を読み取るか、npx create-offramp-app@latest でプロジェクトを足場立てする。
SDKのサーフェス
| エクスポート | 機能 |
|---|---|
| offramp(walletClient, params) | { depositId, txHash, resumed, otcLink? } を返す、1回呼び出しのUSDC売却フロー |
| deposits(address) | プロトコル状態をインデックスせずに、あるアドレスの入金を一覧表示 |
| close(walletClient, depositId) | 既存の入金から未約定のUSDCを引き出す |
| enableOtc / disableOtc / getOtcLink | 入金に対する一買い手限定のプライベート制限を管理 |
| useOfframp() / usePeerExtensionRegistration() | @usdctofiat/offramp/react のReactフック |
| PLATFORMS, CURRENCIES | 識別子・検証・通貨リストを備えた型付きconstマップ |
設計段階から再開可能
入金の作成は複数のオンチェーンステップにまたがります。前回の呼び出しで入金が途中の状態のまま残っている場合、offramp() を再度呼び出すと、重複を作成するのではなく中断したところから再開します。既存の未委任の入金が作成ではなく引き継がれた場合、結果の resumed フラグが true になります。
これにより、サーバーやボットからの再試行も安全です。クリーンな状態を前提にするのではなく、オンチェーンの状態と照合する、冪等性に優しいエントリーポイントです。
エラー処理
| 関心事 | SDKが知らせる方法 |
|---|---|
| 型付きエラー | OfframpError は OFFRAMP_ERROR_CODES のコードを持つ |
| PayPalまたはWiseのセットアップ | ハンドルが未登録の場合は EXTENSION_REGISTRATION_REQUIRED |
| 検証 | PLATFORMS と CURRENCIES が識別子と通貨の検証を提供 |
| 鍵の保管なし | SDKはあなたの WalletClient で署名し、秘密鍵を保存することはない |
Keep exploring
Common questions
@usdctofiat/offramp は無料ですか？
はい。SDKのインストールと統合は無料で、署名はあなたのウォレットが行うため、入金の作成にAPIキーは不要です。Peerlyticsの分析、APIクレジット、署名付きWebhook管理は、Peerlyticsを通じて別途ご利用いただけます。
SDKは鍵を保管したり法定通貨を動かしたりしますか？
どちらもしません。あなたが提供するviemのWalletClientで署名し、秘密鍵を保持することはありません。法定通貨は選択した決済アプリ上で買い手と売り手の間で直接移動し、SDKはオンチェーンのUSDCと入金のライフサイクルのみを扱います。
統合をテストするにはどうすればよいですか？
公開サンドボックスはありません。SDKはBaseメインネットを対象とするため、テスト用の入金も実物であり、公開オーダーブック上で発見可能です。最小1 USDCを使い、OTC入金として制限する（otcTaker を渡してあなたのウォレットだけが約定できるようにする）か、すぐに close() してください。オンチェーンと deposits() で確認しましょう。