OneClickClient
SIP Protocol API Reference v0.7.0
SIP Protocol API Reference / OneClickClient
Class: OneClickClient
Section titled “Class: OneClickClient”Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:1172
HTTP client for NEAR 1Click API
Example
Section titled “Example”const client = new OneClickClient({ jwtToken: process.env.NEAR_INTENTS_JWT,})
// Get available tokensconst tokens = await client.getTokens()
// Request a quoteconst quote = await client.quote({ swapType: OneClickSwapType.EXACT_INPUT, originAsset: 'near:mainnet:wrap.near', destinationAsset: 'eth:1:native', amount: '1000000000000000000000000', refundTo: 'user.near', recipient: '0x742d35Cc...', depositType: 'near', refundType: 'near', recipientType: 'eth',})
// Check statusconst status = await client.getStatus(quote.depositAddress)Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new OneClickClient(
config?):OneClickClient
Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:1177
Parameters
Section titled “Parameters”config?
Section titled “config?”Returns
Section titled “Returns”OneClickClient
Methods
Section titled “Methods”getTokens()
Section titled “getTokens()”getTokens():
Promise<OneClickToken[]>
Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:1183
Get all supported tokens
Returns
Section titled “Returns”Promise<OneClickToken[]>
Array of supported tokens with metadata
quote()
Section titled “quote()”quote(
request):Promise<OneClickQuoteResponse>
Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:1192
Request a swap quote
Parameters
Section titled “Parameters”request
Section titled “request”Quote request parameters
Returns
Section titled “Returns”Promise<OneClickQuoteResponse>
Quote response with deposit address and amounts
Throws
Section titled “Throws”On API errors
Throws
Section titled “Throws”On invalid parameters
dryQuote()
Section titled “dryQuote()”dryQuote(
request):Promise<OneClickQuoteResponse>
Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:1201
Request a dry quote (preview without deposit address)
Useful for UI price estimates without committing to a swap.
Parameters
Section titled “Parameters”request
Section titled “request”Omit<OneClickQuoteRequest, "dry">
Quote request parameters (dry flag set automatically)
Returns
Section titled “Returns”Promise<OneClickQuoteResponse>
Quote preview without deposit address
submitDeposit()
Section titled “submitDeposit()”submitDeposit(
deposit):Promise<OneClickQuoteResponse>
Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:1210
Submit deposit transaction notification
Call this after depositing to the depositAddress to speed up detection.
Parameters
Section titled “Parameters”deposit
Section titled “deposit”OneClickDepositSubmit
Deposit submission details
Returns
Section titled “Returns”Promise<OneClickQuoteResponse>
Updated quote response
getStatus()
Section titled “getStatus()”getStatus(
depositAddress,depositMemo?):Promise<OneClickStatusResponse>
Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:1218
Get swap status
Parameters
Section titled “Parameters”depositAddress
Section titled “depositAddress”string
Deposit address from quote
depositMemo?
Section titled “depositMemo?”string
Optional memo for memo-based deposits
Returns
Section titled “Returns”Promise<OneClickStatusResponse>
Current swap status with normalized transaction hashes
waitForStatus()
Section titled “waitForStatus()”waitForStatus(
depositAddress,options?):Promise<OneClickStatusResponse>
Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:1226
Poll status until terminal state or timeout
Parameters
Section titled “Parameters”depositAddress
Section titled “depositAddress”string
Deposit address from quote
options?
Section titled “options?”Polling options
interval?
Section titled “interval?”number
Polling interval in ms (default: 3000)
timeout?
Section titled “timeout?”number
Maximum wait time in ms (default: 300000 = 5 minutes)
onStatus?
Section titled “onStatus?”(status) => void
Callback on each status check
Returns
Section titled “Returns”Promise<OneClickStatusResponse>
Final status when terminal state reached
getWithdrawals()
Section titled “getWithdrawals()”getWithdrawals(
depositAddress,depositMemo?,options?):Promise<OneClickWithdrawal[]>
Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:1242
Get withdrawals for ANY_INPUT deposits
Parameters
Section titled “Parameters”depositAddress
Section titled “depositAddress”string
Deposit address
depositMemo?
Section titled “depositMemo?”string
Optional deposit memo
options?
Section titled “options?”Pagination options
timestampFrom?
Section titled “timestampFrom?”string
number
limit?
Section titled “limit?”number
sortOrder?
Section titled “sortOrder?”"asc" | "desc"
Returns
Section titled “Returns”Promise<OneClickWithdrawal[]>
Array of withdrawals