@usdctofiat/offramp는 단 하나의 함수 호출로 USDC 출금 기능을 추가합니다.
SDK는 자체 앱에서 USDC를 판매하는 가장 빠른 경로입니다. 하나의 호출로 입력값 검증, 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? }를 반환하는 단일 호출 USDC 판매 플로우 |
| deposits(address) | 인덱서 프로토콜 상태 없이 주소에 대한 예치금 목록 조회 |
| close(walletClient, depositId) | 기존 예치금에서 미체결 USDC 인출 |
| enableOtc / disableOtc / getOtcLink | 예치금에 대한 단일 구매자 제한 관리 |
| useOfframp() / usePeerExtensionRegistration() | @usdctofiat/offramp/react의 React 훅 |
| PLATFORMS, CURRENCIES | 식별자, 유효성 검사, 통화 목록이 포함된 타입 지정 상수 맵 |
설계상 재시작 가능
예치금 생성은 여러 온체인 단계를 거칩니다. 이전 호출로 인해 예치금이 중간 단계에 남아 있는 경우, offramp()를 다시 호출하면 중복 생성 없이 중단된 지점부터 재개됩니다. 기존 미위임 예치금이 새로 생성되지 않고 채택된 경우, 결과의 resumed 플래그가 true로 설정됩니다.
이를 통해 SDK를 서버 또는 봇에서 안전하게 재시도할 수 있습니다. 빈 상태를 가정하지 않고 온체인 상태에 대해 조정하는 멱등성 친화적인 진입점입니다.
오류 처리
| 항목 | SDK 신호 방식 |
|---|---|
| 타입 지정 오류 | OfframpError는 OFFRAMP_ERROR_CODES의 코드를 전달합니다 |
| PayPal 또는 Wise 설정 | 핸들이 아직 등록되지 않은 경우 EXTENSION_REGISTRATION_REQUIRED |
| 유효성 검사 | PLATFORMS와 CURRENCIES는 식별자 및 통화 유효성 검사를 제공합니다 |
| 키 비보관 | SDK는 WalletClient로 서명하며 개인 키를 저장하지 않습니다 |
Keep exploring
Common questions
@usdctofiat/offramp는 무료인가요?
네. SDK는 무료로 설치 및 통합할 수 있으며, 지갑이 서명하기 때문에 예치금 생성에 API 키가 필요하지 않습니다. Peerlytics 애널리틱스, API 크레딧, 서명된 웹훅 관리는 Peerlytics를 통해 별도로 이용하실 수 있습니다.
SDK가 키를 보관하거나 법정통화를 이동시키나요?
둘 다 아닙니다. 제공하신 viem WalletClient로 서명하며 개인 키를 보유하지 않습니다. 법정통화는 선택한 결제 앱에서 구매자와 판매자 사이에서 직접 이동하며, SDK는 온체인 USDC 및 예치금 라이프사이클만 처리합니다.
통합을 어떻게 테스트하나요?
공개 샌드박스는 없으며 SDK는 Base 메인넷을 대상으로 합니다. 따라서 테스트 예치금은 실제이며 오픈 오더북에서 조회됩니다. 최소 1 USDC를 사용하고 OTC 예치금으로 제한(자신의 지갑만 체결할 수 있도록 otcTaker 전달)하거나 빠르게 close()하세요. 온체인 및 deposits()를 통해 확인하세요.