Intent Types

Intent and hook data structures for user approvals

Intent types represent operations that require user approval, including bridge intents, swap intents, and token allowances.

ReadableIntent

Human-readable representation of a bridge intent, including source routing, destination details, and fee breakdown.

Top-level fields

sources · object[] · required

Selected source chains and amounts (funds that will be pulled)

Show properties

amount · string · required

Amount from this source (human-readable)

amountRaw · bigint · required

Amount in atomic units

chain · object · required

Source chain information

Show properties

id · number

Chain ID

name · string

Chain name (e.g., “Ethereum”, “Polygon”)

logo · string

Chain logo URL

token · object · required

Token information

Show properties

decimals · number

Token decimals

symbol · string

Token symbol (e.g., “USDC”, “ETH”)

logo · string

Token logo URL

contractAddress · Hex

Token contract address

chainID · number · deprecated

Use chain.id instead

chainName · string · deprecated

Use chain.name instead

chainLogo · string | undefined · deprecated

Use chain.logo instead

contractAddress · Hex · deprecated

Use token.contractAddress instead

allSources · object[] · required

All available source options before user selection. Same structure as sources

destination · object · required

Destination chain and amount details

Show properties

amount · string · required

Destination amount (human-readable)

chainID · number · required

Destination chain ID

chainName · string · required

Destination chain name

chainLogo · string | undefined

Destination chain logo URL

fees · object · required

Comprehensive fee breakdown

Show properties

caGas · string · required

Chain abstraction gas fee

gasSupplied · string · required

Gas supplied to destination chain

protocol · string · required

Protocol fee

solver · string · required

Solver fee

total · string · required

Total fees (sum of all fee components)

token · object · required

Token being bridged

Show properties

decimals · number · required

Token decimals

logo · string | undefined

Token logo URL

name · string · required

Token name (e.g., “USD Coin”)

symbol · string · required

Token symbol (e.g., “USDC”)

sourcesTotal · string · required

Total amount from all sources combined (human-readable)

Example usage

Displaying intent

sdk.setOnIntentHook(({ intent, allow, deny }) => {
  console.log('Bridge Intent:');
  console.log(`Token: ${intent.token.symbol}`);
  console.log(`To: ${intent.destination.chainName}`);
  console.log(`Amount: ${intent.destination.amount}`);
  
  console.log('\nSources:');
  intent.sources.forEach((source) => {
    console.log(`  ${source.chain.name}: ${source.amount} ${source.token.symbol}`);
  });
  
  console.log('\nFees:');
  console.log(`  Protocol: ${intent.fees.protocol}`);
  console.log(`  Solver: ${intent.fees.solver}`);
  console.log(`  CA Gas: ${intent.fees.caGas}`);
  console.log(`  Total: ${intent.fees.total}`);
  
  if (userApproves) {
    allow();
  } else {
    deny();
  }
});

---

SwapIntent

Human-readable representation of a swap operation.

sources · object[] · required

Source tokens and amounts to swap

Show properties

amount · string · required

Source amount (human-readable)

chain · object · required

Source chain information

Show properties

id · number

Chain ID

name · string

Chain name

logo · string

Chain logo URL

token · object · required

Source token information

Show properties

contractAddress · Hex

Token contract address

decimals · number

Token decimals

symbol · string

Token symbol

destination · object · required

Destination token and amount details

Show properties

amount · string · required

Output amount (human-readable)

chain · object · required

Destination chain information (same structure as source chain)

token · object · required

Output token information (same structure as source token)

gas · object · required

Gas supplied for destination

Show properties

amount · string

Gas amount (human-readable)

token · object

Gas token information (same structure as source token)

Example usage

sdk.setOnSwapIntentHook(async ({ intent, allow, deny, refresh }) => {
  console.log('Swap Intent:');
  
  console.log('\nFrom:');
  intent.sources.forEach((source) => {
    console.log(`  ${source.chain.name}: ${source.amount} ${source.token.symbol}`);
  });
  
  console.log('\nTo:');
  const dest = intent.destination;
  console.log(`  ${dest.chain.name}: ${dest.amount} ${dest.token.symbol}`);
  console.log(`  Gas: ${dest.gas.amount} ${dest.gas.token.symbol}`);
  
  if (userApproves) {
    allow();
  } else {
    deny();
  }
});

---

Hook data structures

OnIntentHookData

Data passed to the intent hook for bridge operations.

intent · ReadableIntent · required

The intent awaiting user approval. See ReadableIntent

allow · () => void · required

Function to approve the intent and proceed with the operation

deny · () => void · required

Function to reject the intent. Throws USER_DENIED_INTENT error

refresh · (selectedSources?: number[]) => Promise<ReadableIntent> · required

Function to refresh the intent, optionally with different source chains

Parameters:

• selectedSources - Optional array of chain IDs to use as sources

Returns: Updated ReadableIntent with new routing and fees

type OnIntentHook = (data: OnIntentHookData) => void;

sdk.setOnIntentHook(({ intent, allow, deny, refresh }) => {
  // Your approval UI logic
});

OnSwapIntentHookData

Data passed to the swap intent hook.

intent · SwapIntent · required

The swap intent awaiting user approval. See SwapIntent

allow · () => void · required

Function to approve the swap and proceed

deny · () => void · required

Function to reject the swap. Throws USER_DENIED_INTENT error

refresh · () => Promise<SwapIntent> · required

Function to refresh the swap quote with updated market rates

type OnSwapIntentHook = (data: OnSwapIntentHookData) => void;

sdk.setOnSwapIntentHook(({ intent, allow, deny, refresh }) => {
  // Your swap approval UI logic
});

OnAllowanceHookData

Data passed to the allowance hook for token approvals.

sources · AllowanceHookSources · required

Array of tokens requiring approval

Show properties

allowance · object · required

Current and required allowance amounts

Show properties

current · string

Current allowance (human-readable)

currentRaw · bigint

Current allowance (atomic units)

minimum · string

Minimum required allowance (human-readable)

minimumRaw · bigint

Minimum required allowance (atomic units)

chain · object · required

Chain information

Show properties

id · number

Chain ID

name · string

Chain name

logo · string

Chain logo URL

token · object · required

Token information

Show properties

contractAddress · Hex

Token contract address

decimals · number

Token decimals

logo · string

Token logo URL

name · string

Token name

symbol · string

Token symbol

allow · (amounts: Array<'max' | 'min' | bigint | string>) => void · required

Function to approve allowances. Pass an array with one value per source:

• 'max' - Approve unlimited (type(uint256).max)
• 'min' - Approve exact minimum required
• bigint or string - Approve specific amount

deny · () => void · required

Function to reject the allowance request. Throws USER_DENIED_ALLOWANCE error

Allowance examples

Display allowance request

sdk.setOnAllowanceHook(({ sources, allow, deny }) => {
  console.log('Allowance Required:');
  
  sources.forEach((source) => {
    console.log(`\n${source.chain.name}:`);
    console.log(`  Token: ${source.token.symbol}`);
    console.log(`  Current: ${source.allowance.current}`);
    console.log(`  Required: ${source.allowance.minimum}`);
  });
  
  if (userApproves) {
    allow(['min']); // Approve minimum for all sources
  } else {
    deny();
  }
});