Perform swaps

Please contact sales for additional pricing information on using the Swaps integrations at partner@portalhq.io

Swaps in the React Native SDK are a two-part flow:

Fetch a quote from a trading integration on your Portal instance — portal.trading.zeroX for same-chain swaps, or portal.trading.lifi for cross-chain swaps and bridges.
Execute the quote’s transaction — either with portal.request(...), or with the execute() helper in the @portal-hq/swaps package.

The legacy quote and liquidity-source methods on @portal-hq/swaps — swaps.getQuote() and swaps.getSources(), along with the QuoteArgs and QuoteResponse types — have been removed. Use portal.trading.zeroX.getQuote() and portal.trading.zeroX.getSources() instead. See the 0x guide for the full quote, price, and liquidity-source API.

Installing Swaps support

The @portal-hq/swaps package is only needed for its execute() helper. If you send the swap transaction with portal.request(...) directly, you can skip this step. Run the following in your project directory.

yarn
npm

yarn add @portal-hq/swaps

npm install --save @portal-hq/swaps

Initializing Swaps

Initializing Swaps requires an existing Portal instance.

import Swaps from '@portal-hq/swaps'

const swaps = new Swaps('', portal)

The constructor still accepts a first apiKey argument so that existing new Swaps(apiKey, portal) call sites keep compiling, but the SDK no longer uses it — you can pass an empty string. The parameter will be removed in the next major version.Quotes are authenticated with the Portal client API key you already pass to the Portal constructor, and 0x credentials are configured in the Portal Dashboard (see the 0x integration guide).

Fetching a swap quote

Use portal.trading.zeroX.getQuote() to fetch an executable quote. The response wraps the quote in data.rawResponse, whose transaction field holds the transaction to broadcast.

import Portal from '@portal-hq/core'
import type { ZeroExQuoteRequest, ZeroExTransaction } from '@portal-hq/core'

const fetchSwapTransaction = async (
  portal: Portal,
): Promise<ZeroExTransaction | undefined> => {
  const request: ZeroExQuoteRequest = {
    chainId: 'eip155:1',
    sellToken: 'ETH',
    buyToken: 'USDC',
    sellAmount: '100000000000000', // 0.0001 ETH, in base units
  }

  const response = await portal.trading.zeroX.getQuote(request)

  if (response.error) {
    console.error('0x error:', response.error)
    return
  }

  return response.data?.rawResponse.transaction
}

To list the liquidity sources available on a chain, use portal.trading.zeroX.getSources('eip155:1'). Both methods are documented in full in the 0x guide.

Executing a swap

If you’re selling ERC20 tokens, the token must have an allowance for the 0x spender contract of at least the amount you’re selling before the swap transaction will succeed. If you’re selling the chain’s native asset (for example ETH), this step is not necessary. When you’re ready to execute the swap, send the quote’s transaction with the Provider on your existing Portal instance.

import Swaps from '@portal-hq/swaps'
import type { ZeroExTransaction } from '@portal-hq/core'

const swaps = new Swaps('', portal)

const executeSwap = async (
  transaction: ZeroExTransaction,
  chainId: string = 'eip155:1', // Default to Ethereum mainnet
): Promise<string> => {
  return await swaps.execute([transaction], chainId)
}

execute() sends an eth_sendTransaction request through the provider and resolves with the transaction hash. You can send the same transaction without the @portal-hq/swaps package by calling portal.request(...) directly, which also lets you pass request options such as a signature approval memo.

import { PortalRequestMethod } from '@portal-hq/core'
import type { ZeroExTransaction } from '@portal-hq/core'

const executeSwap = async (
  transaction: ZeroExTransaction,
  chainId: string = 'eip155:1', // Default to Ethereum mainnet
) => {
  return await portal.request(
    PortalRequestMethod.EthSendTransaction,
    [transaction],
    chainId, // Use the appropriate chain ID for the swap
    { signatureApprovalMemo: 'Execute swap' }, // Optional memo
  )
}

Next steps

Swap tokens with 0x — quotes, indicative prices, liquidity sources, and the high-level tradeAsset() flow
Swap and bridge tokens with Li.Fi — cross-chain routes

Getting Started

SDKs

APIs

Integrations

Resources

Installing Swaps support

Initializing Swaps

Fetching a swap quote

Executing a swap

Next steps

​Installing Swaps support

​Initializing Swaps

​Fetching a swap quote

​Executing a swap

​Next steps

Installing Swaps support

Initializing Swaps

Fetching a swap quote

Executing a swap

Next steps