Cookbook

import { sdk } from '@avail-project/nexus';
 
// 1. Simulate a bridge
const bridgeSimulation = await sdk.simulateBridge({
  token: 'USDC',
  amount: BigInt(100),
  toChainId: 421614,
});
 
// 2. Simulate a bridgeAndExecute (bridge + contract call)
const bridgeAndExecuteSimulation = await sdk.simulateBridgeAndExecute({
  token: 'USDC',
  amount: BigInt(1_000_000),
  toChainId: 421614,
  execute: {
    to: '0xContractAddress',
    data: encodedCalldata,
    tokenApproval: {
      token: 'USDC',
      amount: BigInt(1_000_000),
      spender: '0xContractAddress',
    },
  },
});
 
// 3. Simulate a bridgeAndTransfer (cross-chain send)
const bridgeAndTransferSimulation = await sdk.simulateBridgeAndTransfer({
  token: 'USDC',
  amount: BigInt(1_000_000),
  toChainId: 421614,
  recipient: '0xRecipientAddress',
});
 

const sim = await sdk.simulateBridge({
  token: 'USDC',
  amount: BigInt(100),
  toChainId: 421614,
});
 
// Sources chosen by the solver
sim.intent.sources.forEach((source) => {
  console.log(source.chainName);        // "Arbitrum Sepolia"
  console.log(source.chainID);          // 421614
  console.log(source.chainLogo);        // "https://..."
  console.log(source.amount);           // "100"
  console.log(source.contractAddress);  // "0x..."
});
 
// All chains that had balance (superset of sources)
console.log(sim.intent.allSources);
 
// Destination chain info
console.log(sim.intent.destination.chainName);
console.log(sim.intent.destination.chainID);
 
// Total amount pulled across all sources
console.log(sim.intent.sourcesTotal);
 
// ─── Alternative: use the intent hook during execution ───
sdk.setOnIntentHook(({ intent, allow, deny, refresh }) => {
  // Same ReadableIntent structure as the simulation
  console.log(intent.sources);
  console.log(intent.destination);
  allow(); // or deny() to cancel
});
 

import {
  TOKEN_METADATA,
  CHAIN_METADATA,
} from '@avail-project/nexus';
 
// ─── A: From a simulation result ───
const sim = await sdk.simulateBridge({ token: 'USDC', amount: BigInt(100), toChainId: 421614 });
 
sim.intent.token.name;      // "USD Coin"
sim.intent.token.symbol;    // "USDC"
sim.intent.token.decimals;  // 6
sim.intent.token.logo;      // "https://..."
 
// Source chain logos
sim.intent.sources[0].chainLogo;  // "https://..."
sim.intent.sources[0].chainName;  // "Base Sepolia"
 
/*----------------------------------------*/
 
// ─── B: From static metadata constants ───
TOKEN_METADATA['USDC'];
// { symbol: "USDC", name: "USD Coin", decimals: 6, icon: "https://...", coingeckoId: "usd-coin" }
 
CHAIN_METADATA[421614];
// { id: 421614, name: "Arbitrum Sepolia", logo: "https://...", nativeCurrency: {...}, ... }
 
/*----------------------------------------*/
 
// ─── C: getSupportedChains — chains with their token lists ───
const chains = sdk.utils.getSupportedChains();
// [{ id: 421614, name: "Arbitrum Sepolia", logo: "...", tokens: [{ symbol, name, logo, ... }] }]

const sim = await sdk.simulateBridge({
  token: 'USDC',
  amount: BigInt(100),
  toChainId: 421614,
});
 
const { fees } = sim.intent;
 
console.log(fees.total);        // Total fee in token units (e.g. "0.05")
console.log(fees.protocol);     // Protocol fee
console.log(fees.solver);       // Solver / fulfillment fee
console.log(fees.caGas);        // Chain-abstraction gas fee
console.log(fees.gasSupplied);  // Gas supplied by the solver
 

// Fetch the first page of intents
const intents = await sdk.getMyIntents();
 
// Paginate
const page2 = await sdk.getMyIntents(2);
 
// Check status
intents.forEach((intent) => {
  if (intent.fulfilled) console.log(`Intent #${intent.id}: fulfilled`);
  else if (intent.refunded) console.log(`Intent #${intent.id}: refunded`);
  else console.log(`Intent #${intent.id}: pending (expires ${new Date(intent.expiry * 1000)})`);
});
 
// Each intent (RFF) has this shape:
// {
//   id: 42,
//   explorerUrl: "https://...",
//   deposited: true,
//   fulfilled: true,
//   refunded: false,
//   expiry: 1706000000,
//   destinationChain: { id: 421614, name: "Arbitrum Sepolia", logo: "...", universe: "..." },
//   destinations: [{
//     token: { address: "0x...", symbol: "USDC", decimals: 6 },
//     value: "1.0",
//     valueRaw: 1000000n,
//   }],
//   sources: [{
//     chain: { id: 84532, name: "Base Sepolia", logo: "...", universe: "..." },
//     token: { address: "0x...", symbol: "USDC", decimals: 6 },
//     value: "1.05",
//     valueRaw: 1050000n,
//   }],
// }