SDK methods

import { OneSwap } from '@oneswap/sdk'

const oneswap = new OneSwap({ apiKey: 'sk_live_...' })

// Point at devnet for integration testing
const oneswap = new OneSwap({
  apiKey: 'sk_live_...',
  environment: 'devnet',
})

oneswap.swaps.createSwap(args: {
  userRef: string
  inSymbol: string
  amountIn: number
  outSymbol: string
  poolId?: string
  minOut?: number
  slippageBps?: number
}): Promise<Swap>

const swap = await oneswap.swaps.createSwap({
  userRef: 'user-1042',
  inSymbol: 'CBTC',
  amountIn: 0.01,
  outSymbol: 'HTEST',
  poolId: 'rt-...',
  minOut: 0.95,
  slippageBps: 100,
})

console.log(swap.id)           // 'esc_...'
console.log(swap.status)       // 'awaiting_deposit'
console.log(swap.depositParty) // the party the user must fund
console.log(swap.deadline)     // ISO timestamp

oneswap.swaps.getSwap(id: string): Promise<Swap>

const swap = await oneswap.swaps.getSwap('esc_...')
console.log(swap.status)

oneswap.swaps.waitForSwap(id: string, opts?: {
  pollMs?: number
  timeoutMs?: number
}): Promise<Swap>

const done = await oneswap.swaps.waitForSwap('esc_...', {
  pollMs: 3000,
  timeoutMs: 900000,
})

if (done.status === 'returned') {
  console.log(`Returned ${done.amountOut} ${done.outSymbol} to ${done.senderParty}`)
}

oneswap.swaps.getOpenSwap(userRef: string): Promise<Swap | null>

const open = await oneswap.swaps.getOpenSwap('user-123')

if (open) {
  console.log(`${open.id} is ${open.status}`)
}

oneswap.swaps.cancel(id: string): Promise<Swap>

import { OpenSwapExistsError } from '@oneswap/sdk'

try {
  swap = await oneswap.swaps.createSwap({
    userRef: 'user-123',
    inSymbol: 'CC',
    amountIn: 100,
    outSymbol: 'CBTC',
  })
} catch (err) {
  if (!(err instanceof OpenSwapExistsError)) throw err

  const open = await oneswap.swaps.getOpenSwap('user-123')

  if (open?.status === 'awaiting_deposit') {
    await oneswap.swaps.cancel(open.id) // nothing was deposited — release and retry
  } else if (open) {
    await oneswap.swaps.waitForSwap(open.id) // funds are in flight — let it finish
  }
}

oneswap.quotes.get(args: {
  from: string
  to: string
  amount: number
  poolId?: string
  walletId?: string
}): Promise<QuoteResult>

const quote = await oneswap.quotes.get({ from: 'CC', to: 'CBTC', amount: 100 })

console.log(quote.amountOut)      // expected output in CBTC
console.log(quote.priceImpactPct) // price impact of this trade size
console.log(quote.effFeeBps)      // effective pool fee after any discount
console.log(quote.networkFeeIn)   // network fee carved from the input
console.log(quote.poolId)         // the pool the pair resolved to
console.log(quote.xToY)           // direction within that pool

oneswap.pools.list(): Promise<Pool[]>

const pools = await oneswap.pools.list()
for (const p of pools) {
  console.log(`${p.id}: ${p.assetX.symbol}/${p.assetY.symbol}`, p.reserveX, p.reserveY)
}

oneswap.pools.get(poolId: string): Promise<PoolDetail>  // { pool, swaps }

const { pool, swaps } = await oneswap.pools.get('rt-...')
console.log(pool.feeBps, swaps.length)

oneswap.pools.getTicker(poolId: string): Promise<PoolTicker>

const ticker = await oneswap.pools.getTicker('rt-...')

console.log(ticker.pair)                 // 'CC/CBTC'
console.log(ticker.base)                 // the asset being priced, e.g. 'CBTC'
console.log(ticker.price.usd)            // e.g. '61462.225'
console.log(ticker.priceChange24h.pct)   // e.g. '1.8342' — or null during warm-up
console.log(ticker.volume24h.usd)        // 24h volume in USD
console.log(ticker.volume24h.swaps)      // number of swaps in the window

oneswap.tokens.list(): Promise<Token[]>

const tokens = await oneswap.tokens.list()
console.log(tokens.map((t) => t.symbol)) // ['CC', 'CBTC', ...]