Nhà phát triển · SDK

@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 từ npmSao chép mẫu khởi đầu
01

Cài đặt và tạo deposit

  1. 01Cài gói: bun add @usdctofiat/offramp (npm và pnpm cũng dùng được).
  2. 02Truyền một viem WalletClient: ví của người dùng, ví máy chủ, hoặc ví bot.
  3. 03Gọi offramp(walletClient, { amount, platform, currency, identifier }).
  4. 04Đọc depositId và txHash trả về, hoặc dựng khung dự án bằng npx create-offramp-app@latest.
02

Bề mặt của SDK

ExportChứ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 / getOtcLinkQuả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, CURRENCIESBản đồ hằng số có kiểu với định danh, kiểm tra hợp lệ và danh sách tiền tệ
03

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ẽ.

04

Xử lý lỗi

Vấn đềCách SDK báo hiệu
Lỗi có kiểuOfframpError mang theo một mã từ OFFRAMP_ERROR_CODES
Thiết lập PayPal hoặc WiseEXTENSION_REGISTATION_REQUIRED chỉ thiết lập kỹ thuật tín hiệu; thực thi chính sách nhà cung cấp riêng biệt
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óaSDK ký bằng WalletClient của bạn và không bao giờ lưu khóa riêng tư
05

Bước tiếp theo

Mẫu khởi đầu

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

Peerlytics API

Fetch route, orderbook, deposit, and intent context.

OTC riêng tư trong code

Giới hạn một deposit cho duy nhất một ví người mua được phê duyệt và chia sẻ một liên kết.

Tiếp tục khám phá

API PeerlyticsTrung tâm nhà phát triển

Câu hỏi thường gặp

@usdctofiat/offramp có miễn phí không?

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 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().