@usdctofiat/offramp thêm cổng off-ramp USDC chỉ với một lệnh gọi hàm.
SDK là con đường nhanh nhất để bán USDC từ chính ứng dụng của bạn. Một lệnh gọi sẽ kiểm tra đầu vào, phê duyệt USDC, đăng ký người bán, tạo deposit trên Base và ủy quyền định giá. Nó nhắm tới Base mainnet và không cần cấp phép để tạo deposit.
Cài đặt và tạo deposit
- 1Cài gói: bun add @usdctofiat/offramp (npm và pnpm cũng dùng được).
- 2Truyền một viem WalletClient: ví của người dùng, ví máy chủ, hoặc ví bot.
- 3Gọi offramp(walletClient, { amount, platform, currency, identifier }).
- 4Đọc depositId và txHash trả về, hoặc dựng khung dự án bằng npx create-offramp-app@latest.
Bề mặt của SDK
| Export | Chức năng |
|---|---|
| offramp(walletClient, params) | Luồng bán USDC một lệnh gọi, trả về { depositId, txHash, resumed, otcLink? } |
| deposits(address) | Liệt kê deposit cho một địa chỉ mà không cần lập chỉ mục trạng thái giao thức |
| close(walletClient, depositId) | Rút phần USDC chưa được khớp khỏi một deposit hiện có |
| enableOtc / disableOtc / getOtcLink | Quản lý giới hạn riêng tư một-người-mua trên một deposit |
| useOfframp() / usePeerExtensionRegistration() | React hook từ @usdctofiat/offramp/react |
| PLATFORMS, CURRENCIES | Bản đồ hằng số có kiểu với định danh, kiểm tra hợp lệ và danh sách tiền tệ |
Có thể tiếp tục theo thiết kế
Việc tạo một deposit trải qua nhiều bước onchain. Nếu một lệnh gọi trước đó để lại một deposit dang dở, việc gọi lại offramp() sẽ tiếp tục từ chỗ đã dừng thay vì tạo bản trùng lặp. Cờ resumed trong kết quả có giá trị true khi một deposit chưa được ủy quyền đang tồn tại được tiếp nhận thay vì tạo mới.
Điều đó khiến SDK an toàn để thử lại từ máy chủ hoặc bot: một điểm vào thân thiện với tính bất biến, đối soát với trạng thái onchain thay vì giả định khởi đầu sạch sẽ.
Xử lý lỗi
| Vấn đề | Cách SDK báo hiệu |
|---|---|
| Lỗi có kiểu | OfframpError mang theo một mã từ OFFRAMP_ERROR_CODES |
| Thiết lập PayPal hoặc Wise | EXTENSION_REGISTRATION_REQUIRED khi handle chưa được đăng ký |
| Kiểm tra hợp lệ | PLATFORMS và CURRENCIES cung cấp việc kiểm tra hợp lệ định danh và tiền tệ |
| Không lưu ký khóa | SDK ký bằng WalletClient của bạn và không bao giờ lưu khóa riêng tư |
Bước tiếp theo
Keep exploring
Common questions
@usdctofiat/offramp có miễn phí không?
Có. SDK miễn phí cài đặt và tích hợp, và việc tạo deposit không cần API key vì ví của bạn ký giao dịch. Phân tích Peerlytics, tín dụng API và quản lý webhook ký số được cung cấp riêng thông qua Peerlytics.
SDK có lưu ký khóa hay chuyển fiat không?
Không, cả hai đều không. Nó ký bằng viem WalletClient mà bạn cung cấp và không bao giờ giữ khóa riêng tư. Fiat di chuyển trực tiếp giữa người mua và người bán trên ứng dụng thanh toán đã chọn; SDK chỉ xử lý USDC onchain và vòng đời của deposit.
Làm sao để kiểm thử một tích hợp?
Không có sandbox công khai; SDK nhắm tới Base mainnet, nên một deposit kiểm thử là thật và có thể tra cứu trên orderbook mở. Hãy dùng mức tối thiểu 1 USDC và hoặc giới hạn nó thành một deposit OTC (truyền otcTaker để chỉ ví của bạn có thể khớp) hoặc close() nó nhanh chóng. Xác nhận onchain và qua deposits().