​

OneSwap SDK

import { OneSwap } from '@oneswap/sdk'

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

// Quote it first: how much HTEST for 0.01 CBTC?
const quote = await oneswap.quotes.get({ from: 'CBTC', to: 'HTEST', amount: 0.01 })
console.log(`~${quote.amountOut} HTEST (price impact ${quote.priceImpactPct}%)`)

// 1. Create a swap for your end-user
const swap = await oneswap.swaps.createSwap({
  userRef: 'user-1042',
  inSymbol: 'CBTC',
  amountIn: 0.01,
  outSymbol: 'HTEST',
})

// 2. Tell the user to send `amountIn` of `inSymbol` to this Canton party
console.log(swap.depositParty)

// 3. Wait for OneSwap to detect the deposit, swap, and return the output
const done = await oneswap.swaps.waitForSwap(swap.id)
if (done.status === 'returned') {
  console.log(`Returned ${done.amountOut} ${done.outSymbol} to ${done.senderParty}`)
}

​

How swaps work

1. Your backend calls swaps.createSwap and gets back a per-user depositParty (a Canton party id) and a deadline.
2. You tell your end-user to send amountIn of inSymbol to depositParty.
3. OneSwap detects the deposit, performs the atomic swap, and returns the output token to the depositing party.
4. You poll swaps.getSwap (or await swaps.waitForSwap) until the swap reaches a terminal status.

​

Market data and quotes

• quotes.get({ from, to, amount }) — a full quote for a pair: expected output, price impact, and the fee breakdown. The SDK resolves which pool trades the pair and the direction for you.
• pools.list() / pools.get(id) — every visible pool with live reserves and fee configuration, or one pool with its settled-swap history.
• pools.getTicker(id) — live USD price, 24h change, and 24h volume for a pool.
• tokens.list() — the tokens OneSwap can settle.

​

Who it’s for

• Apps and wallets whose users can transfer tokens but cannot sign a Canton DvP transaction.
• Integrators who want a swap embedded in their product without building settlement logic.
• Any backend that can call an HTTP API and hold a stable id for each of its users.

​

What you get

• Swaps — create a swap, hand the user a deposit party, poll to completion.
• Return-to-sender — output is always paid back to the party that funded the swap.
• Atomic DvP — the swap completes and returns output, or the input is refunded.
• No gas for your users — the per-swap network fee is taken from the input token, so the end-user’s wallet needs no CC.
• Quotes and market data — price a swap before creating it, and read pools, tickers, and tokens.