SOCKET Protocol

https://docs.socket.tech/
Admin
SOCKET Protocol is the first chain-abstraction protocol that enables developers to build...
Tokens:38,917
Snippets:328
Trust Score:8.7
Update:2 months ago
Show doc for...
Tokens:
Raw
### Complete Integration Example for the Deposit flow

Source: https://docs.socket.tech/integrate/integration-guides/deposit-addresses

A comprehensive JavaScript example demonstrating the setup and helper functions for managing cross-chain deposits using various SDKs.

```javascript
import dotenv from "dotenv";
import { TronWeb } from "tronweb";
import { createPublicClient, createWalletClient, http } from "viem";
import { privateKeyToAccount } from "viem/accounts";
import { base, arbitrum, optimism, tempo } from "viem/chains";
import * as StellarSdk from "@stellar/stellar-sdk";
import StellarHDWallet from "stellar-hd-wallet";
import {
  Keypair,
  Connection,
  Transaction as SolanaTransaction,
  VersionedTransaction,
} from "@solana/web3.js";
import bs58 from "bs58";

dotenv.config();

const BUNGEE_API_BASE_URL = "https://public-backend.bungee.exchange";
const TRON_FULL_HOST = "https://api.trongrid.io";
const SOLANA_RPC_URL = "https://api.mainnet-beta.solana.com";
const STELLAR_HORIZON_URL = "https://horizon.stellar.org";

const SOLANA_CHAIN_ID = 89999;

// Tron only accepts direct deposit from USDT0 OFT chains to USDT on Tron
// No other tokens or source chain swaps are supported at the moment
const TRON_CHAIN_ID = 728126428;
const TRON_USDT_CONTRACT = "TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t";

// Stellar only supports Base USDC from/to USDC on Stellar at the moment
// No other tokens or source chain swaps are supported at the moment
const STELLAR_CHAIN_ID = 1110002;
const STELLAR_USDC_ISSUER = "GA5ZSEJYB37JRC5AVCIA5MOP4RHTM335X2KGX3IHOJAPP5RE34K4KZVN";
const STELLAR_USDC_ASSET = `USDC-${STELLAR_USDC_ISSUER}`;

// Tempo tokens
const TEMPO_PATH_USD = '0x20c0000000000000000000000000000000000000';
const TEMPO_USDCe = '0x20c000000000000000000000b9537d11c60e8b50';

let cachedEvmAccount = undefined;
let cachedTronContext = undefined;
let cachedSolanaContext = undefined;
let cachedStellarContextPromise = null;

// Parameters to edit for each deposit
const originChainId = SOLANA_CHAIN_ID;
const destinationChainId = 8453;
const inputAmount = "80000000";
const inputToken = "0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee";
const outputToken = "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913";

if (!process.env.BUNGEE_API_KEY) {
  console.error("Error: BUNGEE_API_KEY environment variable is not set");
  process.exit(1);
}

if (!process.env.BUNGEE_AFFILIATE_ID) {
  console.error("Error: BUNGEE_AFFILIATE_ID environment variable is not set");
  process.exit(1);
}

function getApiHeaders() {
  return {
    "x-api-key": process.env.BUNGEE_API_KEY,
    affiliate: process.env.BUNGEE_AFFILIATE_ID,
  };
}

function sanitizePrivateKey(value) {
  if (!value) return null;
  return value.startsWith("0x") ? value : `0x${value}`;
}

function parseSolanaKeypair(value) {
  if (!value) return null;

  let privateKeyBytes;
  try {
    privateKeyBytes = bs58.decode(value);
  } catch {
    try {
      privateKeyBytes = Uint8Array.from(JSON.parse(value));
    } catch {
      privateKeyBytes = Uint8Array.from(value.split(",").map(Number));
    }
  }

  return Keypair.fromSecretKey(privateKeyBytes);
}

function getEvmAccount() {
  if (cachedEvmAccount !== undefined) {
    return cachedEvmAccount;
  }

  const evmPrivateKey = sanitizePrivateKey(process.env.PRIVATE_KEY?.trim());
  cachedEvmAccount = evmPrivateKey ? privateKeyToAccount(evmPrivateKey) : null;
  return cachedEvmAccount;
}

function getTronContext() {
  if (cachedTronContext !== undefined) {
    return cachedTronContext;
  }

  const tronPrivateKey = process.env.TRON_PRIVATE_KEY?.replace(/^0x/, "");
  if (!tronPrivateKey) {
    cachedTronContext = null;
    return cachedTronContext;
  }

  const tronWeb = new TronWeb({
    fullHost: TRON_FULL_HOST,
    privateKey: tronPrivateKey,
  });
  const tronAddress = tronWeb.address.fromPrivateKey(tronPrivateKey);
```

--------------------------------

### GET /v3/swap/quote

Source: https://docs.socket.tech/skill.md

Fetch executable routes with pricing, gas, and execution details.

```APIDOC
## GET /v3/swap/quote

### Description
Fetch executable routes with pricing, gas, and execution details.

### Method
GET

### Endpoint
/v3/swap/quote

### Parameters
#### Query Parameters
- **userOps** (string) - Required - tx for direct routes, deposit for deposit addresses, cex-withdraw for CEX withdrawals
- **originChainId** (string) - Required - Source chain ID (required for tx and deposit)
- **destinationChainId** (string) - Required - Destination chain ID
- **inputToken** (string) - Required - Source token address (native: 0xEeeeeEeeeEeEeeEeEeEeeEEeeeeEeeeeeeeEEeE)
- **inputAmount** (string) - Required - Amount in smallest units (wei for EVM)
- **outputToken** (string) - Required - Destination token address
- **receiverAddress** (string) - Required - Destination wallet address
- **userAddress** (string) - Required - Source wallet signing the transaction (required for tx)
- **slippage** (number) - Optional - Slippage tolerance (e.g., 0.5 for 0.5%)
- **feeBps** (number) - Optional - Integrator fee in basis points (requires feeTakerAddress)
- **feeTakerAddress** (string) - Optional - Address receiving fees (requires feeBps)
- **includeProvider** (string) - Optional - Comma-separated provider IDs to include
- **excludeProvider** (string) - Optional - Comma-separated provider IDs to exclude
- **refuel** (boolean) - Optional - Request gas refuel on destination chain
- **contractCaller** (string) - Optional - Intermediate contract address if routing through your contract
- **refundAddress** (string) - Optional - Refund address for deposit/CEX flows

### Response
#### Success Response (200)
- **quoteId** (string) - Stable route ID for status polling
- **expiresAt** (number) - Unix timestamp; discard if expired
- **output.amount** (string) - Expected destination amount (net of fees)
- **output.minAmountOut** (string) - Minimum acceptable output
- **routeTags** (array) - SUGGESTED, FASTEST, MAX_OUTPUT
- **approval** (object) - Present if ERC20 approval needed; approve spenderAddress first
- **txData.object** (object) - Transaction to submit from userAddress
- **gasFee.estimatedFee** (string) - Estimated gas cost in native token
- **statusCheck.endpoint** (string) - Suggested polling endpoint
```

--------------------------------

### Setup React Query Provider

Source: https://docs.socket.tech/integrate/socket-widget

Mount the QueryClientProvider above the SocketWidget component to manage state.

```tsx
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";

const queryClient = new QueryClient();

root.render(
  <QueryClientProvider client={queryClient}>
    <App />
  </QueryClientProvider>
);
```

--------------------------------

### GET /v3/swap/supported-chains

Source: https://docs.socket.tech/api-reference/supported-chains-%26-token-list/get-supported-chains

Retrieves a list of supported chains and their associated metadata for V3 swaps.

```APIDOC
## GET /v3/swap/supported-chains

### Description
Retrieves the list of supported chains and providers for the V3 swap service.

### Method
GET

### Endpoint
https://public-backend.socket.tech/v3/swap/supported-chains

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **statusCode** (integer) - The HTTP status code.
- **result** (array) - List of supported chains.
- **message** (string|null) - Any additional messages.

#### Response Example
{
  "success": true,
  "statusCode": 200,
  "result": [
    {
      "chainId": 42161,
      "name": "Arbitrum",
      "icon": "https://media.socket.tech/networks/arbitrum.svg",
      "currency": {
        "address": "0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee",
        "name": "Arbitrum Ether",
        "symbol": "ETH",
        "decimals": 18,
        "icon": "https://media.socket.tech/networks/ethereum.svg",
        "minNativeCurrencyForGas": "900000000000000"
      },
      "explorers": ["https://arbiscan.io"],
      "sendingEnabled": true,
      "receivingEnabled": true,
      "isAutoEnabled": true,
      "isManualEnabled": true,
      "isDepositEnabled": true,
      "dexes": ["zeroxv2", "openocean", "kyberswap"],
      "bridges": ["across", "relay", "cctp-v2-slow"]
    }
  ],
  "message": null
}
```

--------------------------------

### OpenAPI Specification for Supported Chains

Source: https://docs.socket.tech/api-reference/supported-chains-%26-token-list/get-supported-chains

Defines the GET endpoint for retrieving supported chains and provides an example response structure.

```yaml
openapi: 3.0.0
info:
  title: Socket V3 Swap API Explorer
  description: V3 swap quote, status, and metadata endpoints
  version: '1.0'
  contact: {}
servers:
  - url: https://public-backend.socket.tech
    description: Production
security: []
tags: []
paths:
  /v3/swap/supported-chains:
    get:
      tags:
        - Supported Chains & Token List
      summary: Get supported chains
      operationId: V3SwapMetadataController_supportedChains
      parameters: []
      responses:
        '200':
          description: Supported chains and providers for v3 swap.
          content:
            application/json:
              examples:
                supportedChains:
                  summary: Supported chains
                  value:
                    success: true
                    statusCode: 200
                    result:
                      - chainId: 42161
                        name: Arbitrum
                        icon: https://media.socket.tech/networks/arbitrum.svg
                        currency:
                          address: '0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee'
                          name: Arbitrum Ether
                          symbol: ETH
                          decimals: 18
                          icon: https://media.socket.tech/networks/ethereum.svg
                          minNativeCurrencyForGas: '900000000000000'
                        explorers:
                          - https://arbiscan.io
                        sendingEnabled: true
                        receivingEnabled: true
                        isAutoEnabled: true
                        isManualEnabled: true
                        isDepositEnabled: true
                        dexes:
                          - zeroxv2
                          - openocean
                          - kyberswap
                        bridges:
                          - across
                          - relay
                          - cctp-v2-slow
                    message: null
```

--------------------------------

### Requesting a Quote with Fees

Source: https://docs.socket.tech/integrate/integration-guides/additional-guides/charging-fees

Examples for requesting a swap quote with fee parameters included via cURL and JavaScript.

```bash
curl -G "https://dedicated-backend.socket.tech/v3/swap/quote" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "affiliate: YOUR_AFFILIATE_ID" \
  --data-urlencode "userOps=tx" \
  --data-urlencode "originChainId=1" \
  --data-urlencode "destinationChainId=10" \
  --data-urlencode "inputToken=0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48" \
  --data-urlencode "outputToken=0x7F5c764cBc14f9669B88837ca1490cCa17c31607" \
  --data-urlencode "inputAmount=1000000" \
  --data-urlencode "userAddress=0xYourUsersAddress" \
  --data-urlencode "receiverAddress=0xYourUsersAddress" \
  --data-urlencode "feeTakerAddress=0xYourFeeCollectionAddress" \
  --data-urlencode "feeBps=50"
```

```javascript
const SOCKET_API_BASE_URL = "https://dedicated-backend.socket.tech";
const SOCKET_AFFILIATE_ID = "YOUR_AFFILIATE_ID";

async function getQuoteWithFees() {
  const quoteParams = {
    userOps: "tx",
    userAddress: "0xYourUsersAddress",
    originChainId: "1",   // Ethereum
    destinationChainId: "10", // Optimism
    inputToken: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", // USDC on Ethereum
    outputToken: "0x7F5c764cBc14f9669B88837ca1490cCa17c31607", // USDC on Optimism
    inputAmount: "1000000", // 1 USDC (6 decimals)
    receiverAddress: "0xYourUsersAddress",
    feeTakerAddress: "0xYourFeeCollectionAddress",
    feeBps: "50", // 0.5% fee (50 basis points)
  };

  const url = `${SOCKET_API_BASE_URL}/v3/swap/quote`;
  const queryParams = new URLSearchParams(quoteParams);
  const fullUrl = `${url}?${queryParams}`;

  const response = await fetch(fullUrl, {
    headers: {
      affiliate: SOCKET_AFFILIATE_ID,
    },
  });
  const data = await response.json();
  const serverReqId = response.headers.get("server-req-id");

  if (!data.success) {
    throw new Error(
      `Quote error: ${data.statusCode}: ${data.message}. server-req-id: ${serverReqId}`
    );
  }

  return data.result;
}
```

--------------------------------

### Example Executor Contract Implementation

Source: https://docs.socket.tech/integrate/integration-guides/additional-guides/destination-payload

A sample implementation of an executor contract that transfers received tokens to a specified recipient.

```solidity
// SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.28;

import {SafeTransferLib} from "solady/utils/SafeTransferLib.sol";

interface IBungeeExecutor {
    function executeData(bytes32 quoteId, uint256 amount, address token, bytes calldata callData) external;
}

contract MyExecutor is IBungeeExecutor {
    address constant NATIVE = 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE;

    function executeData(bytes32, uint256 amount, address token, bytes calldata callData) external override {
        address recipient = abi.decode(callData, (address));
        if (token == NATIVE) {
            SafeTransferLib.safeTransferETH(recipient, amount);
        } else {
            SafeTransferLib.safeTransfer(token, recipient, amount);
        }
    }

    receive() external payable {}
}
```

--------------------------------

### GET /v3/swap/tokens/list

Source: https://docs.socket.tech/integrate/integration-guides/socket-api

Retrieves a list of all tokens supported by the Socket Swap V3 API.

```APIDOC
## GET /v3/swap/tokens/list

### Description
List supported tokens.

### Method
GET

### Endpoint
/v3/swap/tokens/list
```

--------------------------------

### Install Socket Widget dependencies

Source: https://docs.socket.tech/integrate/introduction

Required packages for integrating the Socket Widget into a React application.

```bash
pnpm install @socket.tech/widget react react-dom viem @tanstack/react-query
```

--------------------------------

### GET /v3/swap/status

Source: https://docs.socket.tech/integrate/integration-guides/socket-api

Retrieves the execution state of a swap using the quote ID.

```APIDOC
## GET /v3/swap/status

### Description
The v3 status endpoint looks up execution state by `quoteId`.

### Method
GET

### Endpoint
/v3/swap/status

### Parameters
#### Query Parameters
- **quoteId** (string) - Required - Quote ID returned by `/v3/swap/quote`.
- **includeQuoteDetails** (boolean) - Optional - Set to `true` to include stored quote row details in the response.

### Response
#### Success Response (200)
- **quoteId** (string) - The quote ID.
- **userOp** (string) - The user operation type.
- **status** (string) - The current status of the route.
- **statusCode** (string) - The status code.
- **origin** (object) - Details about the source chain transaction.
- **destination** (object) - Details about the destination chain transaction.
- **routeDetails** (object) - Information about the bridge or route used.
- **refund** (object|null) - Refund details if applicable.

### Response Example
{
  "quoteId": "0x...",
  "userOp": "tx",
  "status": "IN_PROGRESS",
  "statusCode": "PENDING",
  "origin": {
    "chainId": 42161,
    "status": "COMPLETED",
    "txHash": "0x...",
    "userAddress": "0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266"
  },
  "destination": {
    "chainId": 10,
    "status": "PENDING",
    "txHash": null,
    "receiverAddress": "0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266"
  },
  "routeDetails": {
    "name": "Across",
    "logoURI": "https://media.socket.tech/bridges/across.png"
  },
  "refund": null
}
```

--------------------------------

### Public API Quote Request

Source: https://docs.socket.tech/integrate/get-api-access

Example curl request for the public endpoint.

```bash
curl "https://public-backend.socket.tech/v3/swap/quote?userOps=tx&originChainId=42161&..."
```

--------------------------------

### Load and Get Stellar Wallet Context

Source: https://docs.socket.tech/integrate/integration-guides/deposit-addresses

Loads the Stellar wallet from a mnemonic, verifies the XLM balance, and ensures a USDC trustline exists.

```javascript
async function loadStellarWalletContext() {
    if (!process.env.STELLAR_SEED_PHRASE) {
      throw new Error(
        "STELLAR_SEED_PHRASE is required when Stellar chain is used"
      );
    }

    let wallet;
    try {
      wallet = StellarHDWallet.fromMnemonic(process.env.STELLAR_SEED_PHRASE);
    } catch (error) {
      throw new Error(`Failed to parse STELLAR_SEED_PHRASE: ${error.message}`);
    }

    const secretKey = wallet.getSecret(0);
    const walletAddress = wallet.getPublicKey(0);
    const signer = StellarSdk.Keypair.fromSecret(secretKey);
    const server = new StellarSdk.Horizon.Server(STELLAR_HORIZON_URL);
    const networkPassphrase = StellarSdk.Networks.PUBLIC;

    let account;
    try {
      account = await server.loadAccount(walletAddress);
    } catch (error) {
      throw new Error(`Failed to load Stellar account ${walletAddress}: ${error.message}`);
    }

    const xlm = account.balances.find((b) => b.asset_type === "native");
    const xlmBalance = Number(xlm?.balance ?? "0");

    console.log("Stellar Address:    ", walletAddress);
    console.log("Stellar XLM Balance:", xlm ? xlm.balance : "0");

    if (!Number.isFinite(xlmBalance) || xlmBalance <= 0) {
      throw new Error("No XLM balance in Stellar wallet");
    }

    let hasUsdcTrustline = account.balances.find(
      (b) => b.asset_code === "USDC" && b.asset_issuer === STELLAR_USDC_ISSUER
    );

    console.log("Stellar USDC Trustline:", hasUsdcTrustline ? "YES" : "NO");

    if (!hasUsdcTrustline) {
      await addStellarUsdcTrustline(account, signer, server, networkPassphrase);
      const updatedAccount = await server.loadAccount(walletAddress);

      hasUsdcTrustline = updatedAccount.balances.find(
        (b) => b.asset_code === "USDC" && b.asset_issuer === STELLAR_USDC_ISSUER
      );

      if (!hasUsdcTrustline) {
        throw new Error("Failed to create USDC trustline on Stellar wallet");
      }
    }

    return {
      walletAddress,
      signer,
      server,
      networkPassphrase,
    };
  }

  async function getStellarWalletContext() {
    if (!cachedStellarContextPromise) {
      cachedStellarContextPromise = loadStellarWalletContext();
    }

    return cachedStellarContextPromise;
  }
```

--------------------------------

### Backend API Quote Request

Source: https://docs.socket.tech/integrate/get-api-access

Example curl request for the backend endpoint, requiring an affiliate header.

```bash
curl "https://backend.socket.tech/v3/swap/quote?userOps=tx&originChainId=42161&..." \
  --header "affiliate: YOUR_AFFILIATE_ID"
```

--------------------------------

### Same-chain transaction route response

Source: https://docs.socket.tech/api-reference/swap/get-quotes

Example JSON response for a successful same-chain swap quote request.

```json
{
  "success": true,
  "statusCode": 200,
  "result": {
    "originChainId": 42161,
    "destinationChainId": 42161,
    "userAddress": "0x3e8cb4bd04d81498ab4b94a392c334f5328b237b",
    "receiverAddress": "0x3e8cb4bd04d81498ab4b94a392c334f5328b237b",
    "input": {
      "token": {
        "chainId": 42161,
        "address": "0xaf88d065e77c8cc2239327c5edb3a432268e5831",
        "name": "USDC",
        "symbol": "USDC",
        "decimals": 6,
        "logoURI": "https://assets.coingecko.com/coins/images/6319/large/USDC.png?1769615602",
        "icon": "https://assets.coingecko.com/coins/images/6319/large/USDC.png?1769615602"
      },
      "amount": "100000",
      "priceInUsd": 1,
      "valueInUsd": 0.1
    },
    "routes": [
      {
        "userOp": "tx",
        "quoteId": "0x759a82929538535f6186da129b49e42f3fa22539cde911a2f394bf9d1e3732b4",
        "expiresAt": 1781000089,
        "output": {
          "token": {
            "chainId": 42161,
            "address": "0xfd086bc7cd5c481dcc9c85ebe478a1c0b69fcbb9",
            "name": "USDT0",
            "symbol": "USDT0",
            "decimals": 6,
            "logoURI": "https://assets.coingecko.com/coins/images/6319/large/USDC.png?1769615602"
          }
        }
      }
    ]
  }
}
```

--------------------------------

### GET /v3/swap/tokens/list

Source: https://docs.socket.tech/api-reference/supported-chains-%26-token-list/get-token-list

Fetches a list of supported tokens, optionally filtered by chain IDs and list type (full or trending).

```APIDOC
## GET /v3/swap/tokens/list

### Description
Retrieves a list of tokens supported by the Socket V3 Swap API, grouped by chain ID. You can filter by specific chain IDs or request a 'full' or 'trending' list.

### Method
GET

### Endpoint
https://public-backend.socket.tech/v3/swap/tokens/list

### Parameters
#### Query Parameters
- **userAddress** (string) - Optional - User wallet address.
- **chainIds** (string) - Optional - Comma-separated chain IDs to include.
- **list** (string) - Optional - Set the list type: 'full' or 'trending'.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **statusCode** (integer) - The HTTP status code.
- **result** (object) - Tokens grouped by chain ID.
- **message** (string|null) - Additional message information.

#### Response Example
{
  "success": true,
  "statusCode": 200,
  "result": {
    "8453": [
      {
        "chainId": 8453,
        "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
        "name": "USDC",
        "symbol": "USDC",
        "decimals": 6,
        "logoURI": "https://assets.coingecko.com/coins/images/6319/large/USDC.png?1769615602",
        "isShortListed": false,
        "tags": [],
        "trendingRank": 4,
        "marketCap": 75987436982,
        "totalVolume": 14895044788,
        "balance": "0",
        "balanceInUsd": 0,
        "isVerified": true
      }
    ]
  },
  "message": null
}
```

--------------------------------

### OpenAPI Specification for Get Token List

Source: https://docs.socket.tech/api-reference/supported-chains-%26-token-list/get-token-list

Defines the /v3/swap/tokens/list endpoint, including query parameters for user address, chain IDs, and list type filtering.

```yaml
openapi: 3.0.0
info:
  title: Socket V3 Swap API Explorer
  description: V3 swap quote, status, and metadata endpoints
  version: '1'
  contact: {}
servers:
  - url: https://public-backend.socket.tech
    description: Production
security: []
tags: []
paths:
  /v3/swap/tokens/list:
    get:
      tags:
        - Supported Chains & Token List
      summary: Get token list
      operationId: V3SwapMetadataController_tokenList
      parameters:
        - name: userAddress
          required: false
          in: query
          description: User wallet address
          schema:
            example: '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045'
            type: string
            default: '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045'
        - name: chainIds
          required: false
          in: query
          description: Comma-separated chain IDs to include.
          schema:
            example: 42161,8453
            type: string
            default: 42161,8453
        - name: list
          required: false
          in: query
          description: 'Set the list type you want: full or trending'
          schema:
            default: trending
            example: trending
            type: string
            enum:
              - full
              - trending
      responses:
        '200':
          description: V3 swap tokens grouped by chain ID.
          content:
            application/json:
              examples:
                tokenList:
                  summary: Token list
                  value:
                    success: true
                    statusCode: 200
                    result:
                      '8453':
                        - chainId: 8453
                          address: '0x833589fcd6edb6e08f4c7c32d4f71b54bda02913'
                          name: USDC
                          symbol: USDC
                          decimals: 6
                          logoURI: >-
                            https://assets.coingecko.com/coins/images/6319/large/USDC.png?1769615602
                          isShortListed: false
                          tags: []
                          trendingRank: 4
                          marketCap: 75987436982
                          totalVolume: 14895044788
                          balance: '0'
                          balanceInUsd: 0
                          isVerified: true
                      '42161':
                        - chainId: 42161
                          address: '0xaf88d065e77c8cc2239327c5edb3a432268e5831'
                          name: USDC
                          symbol: USDC
                          decimals: 6
                          logoURI: >-
                            https://assets.coingecko.com/coins/images/6319/large/USDC.png?1769615602
                          icon: >-
                            https://assets.coingecko.com/coins/images/6319/large/USDC.png?1769615602
                          isShortListed: false
                          tags: []
                          trendingRank: 4
                          marketCap: 75987436982
                          totalVolume: 14895044788
                          balance: '0'
                          balanceInUsd: 0
                          isVerified: true
                    message: null
```

--------------------------------

### Execute Bungee Deposit Flow

Source: https://docs.socket.tech/integrate/integration-guides/deposit-addresses

Main function to initiate a Bungee deposit flow by applying constraints, getting a quote, and preparing for transaction submission.

```javascript
async function main() {
    try {
      const constrainedAssets = applyStellarAssetConstraint({
        originChainId,
        destinationChainId,
        inputToken,
        outputToken,
      });
      const originWalletAddress = await getWalletAddressForChain(originChainId);
      const destinationWalletAddress = await getWalletAddressForChain(destinationChainId);
      const quoteParams = {
        originChainId: String(originChainId),
        destinationChainId: String(destinationChainId),
        inputAmount,
        inputToken: constrainedAssets.inputToken,
        outputToken: constrainedAssets.outputToken,
        userAddress: originWalletAddress,
        receiverAddress: destinationWalletAddress,
        refundAddress: originWalletAddress,
        enableDepositAddress: "true",
        disableAuto: "true",
      };

      console.log("Starting Bungee Deposit flow...");
      console.log(`Origin Chain: ${originChainId}`);
      console.log(`Destination Chain: ${destinationChainId}`);
      console.log(`User Address: ${quoteParams.userAddress}`);
      console.log(`Receiver Address: ${quoteParams.receiverAddress}`);

      console.log("\n1. Getting quote...");
      const quoteResponse = await getQuote(quoteParams);

      const txData = quoteResponse.txData;
      if (!txData || !txData.type) {
        throw new Error("No txData.type available in deposit response");
      }

      let submission;
```

--------------------------------

### OpenAPI Specification for Token Search

Source: https://docs.socket.tech/api-reference/supported-chains-%26-token-list/search-tokens

Defines the GET /v3/swap/tokens/search endpoint, including required query parameters and the structure of the JSON response.

```yaml
openapi: 3.0.0
info:
  title: Socket V3 Swap API Explorer
  description: V3 swap quote, status, and metadata endpoints
  version: '1.0'
  contact: {}
servers:
  - url: https://public-backend.socket.tech
    description: Production
security: []
tags: []
paths:
  /v3/swap/tokens/search:
    get:
      tags:
        - Supported Chains & Token List
      summary: Search tokens
      operationId: V3SwapMetadataController_searchToken
      parameters:
        - name: q
          required: true
          in: query
          description: >-
            Search query for token address, name or symbol. Does partial
            matching too
          schema:
            example: ETH
            type: string
            default: ETH
        - name: userAddress
          required: false
          in: query
          description: User wallet address
          schema:
            example: '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045'
            type: string
            default: '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045'
        - name: address
          required: false
          in: query
          description: >-
            Alias for userAddress. Kept for clients that pass the wallet address
            as address.
          schema:
            example: '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045'
            type: string
            default: '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045'
      responses:
        '200':
          description: V3 swap token search results grouped by chain ID.
          content:
            application/json:
              examples:
                tokenSearch:
                  summary: Token search
                  value:
                    success: true
                    statusCode: 200
                    result:
                      tokens:
                        '8453':
                          - chainId: 8453
                            address: '0x833589fcd6edb6e08f4c7c32d4f71b54bda02913'
                            name: USDC
                            symbol: USDC
                            decimals: 6
                            logoURI: >-
                              https://assets.coingecko.com/coins/images/6319/large/USDC.png?1769615602
                            isShortListed: false
                            tags: []
                            trendingRank: 4
                            marketCap: 75987436982
                            totalVolume: 14895044788
                            balance: '0'
                            balanceInUsd: 0
                            isVerified: true
                        '42161':
                          - chainId: 42161
                            address: '0xaf88d065e77c8cc2239327c5edb3a432268e5831'
                            name: USDC
                            symbol: USDC
                            decimals: 6
                            logoURI: >-
                              https://assets.coingecko.com/coins/images/6319/large/USDC.png?1769615602
                            icon: >-
                              https://assets.coingecko.com/coins/images/6319/large/USDC.png?1769615602
                            isShortListed: false
                            tags: []
                            trendingRank: 4
                            marketCap: 75987436982
                            totalVolume: 14895044788
                            balance: '0'
                            balanceInUsd: 0
                            isVerified: true
                    message: null
```

--------------------------------

### GET /v3/swap/tokens/search

Source: https://docs.socket.tech/api-reference/supported-chains-%26-token-list/search-tokens

Search for tokens by name, symbol, or address. Supports partial matching and optional user wallet address for balance retrieval.

```APIDOC
## GET /v3/swap/tokens/search

### Description
Search for tokens by address, name, or symbol. The search supports partial matching and can return user-specific balance data if a wallet address is provided.

### Method
GET

### Endpoint
/v3/swap/tokens/search

### Parameters
#### Query Parameters
- **q** (string) - Required - Search query for token address, name or symbol.
- **userAddress** (string) - Optional - User wallet address.
- **address** (string) - Optional - Alias for userAddress.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **statusCode** (number) - HTTP status code.
- **result** (object) - Contains the search results grouped by chain ID.

#### Response Example
{
  "success": true,
  "statusCode": 200,
  "result": {
    "tokens": {
      "8453": [
        {
          "chainId": 8453,
          "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
          "name": "USDC",
          "symbol": "USDC",
          "decimals": 6,
          "logoURI": "https://assets.coingecko.com/coins/images/6319/large/USDC.png?1769615602",
          "isShortListed": false,
          "tags": [],
          "trendingRank": 4,
          "marketCap": 75987436982,
          "totalVolume": 14895044788,
          "balance": "0",
          "balanceInUsd": 0,
          "isVerified": true
        }
      ]
    }
  },
  "message": null
}
```

--------------------------------

### Fetch Socket machine-readable documentation

Source: https://docs.socket.tech/for-agents/intro

Use these commands to retrieve capability summaries, documentation maps, or full site context for agent grounding.

```bash
curl https://docs.socket.tech/skill.md
```

```bash
curl https://docs.socket.tech/llms.txt
```

```bash
curl https://docs.socket.tech/llms-full.txt
```

--------------------------------

### GET /v3/swap/status

Source: https://docs.socket.tech/skill.md

Poll transaction status by quoteId.

```APIDOC
## GET /v3/swap/status

### Description
Poll transaction status by quoteId.

### Method
GET

### Endpoint
/v3/swap/status
```

--------------------------------

### Compare Execution Flows

Source: https://docs.socket.tech/integrate/migration-guide

Outlines the steps for executing swaps, noting the removal of EIP-712 signing and the submit endpoint in V3.

```text
1. GET /api/v1/bungee/quote → get autoRoute
2. Approve approvalData.spenderAddress if needed
3. Sign autoRoute.signTypedData with PermitWitnessTransferFrom
4. POST /api/v1/bungee/submit with signature → get requestHash
5. Poll GET /api/v1/bungee/status?requestHash=...
```

```text
1. GET /v3/swap/quote?userOps=tx → get routes[]
2. Approve route.approval.spenderAddress if route.approval is present
3. Submit route.txData.object as a transaction from userAddress
4. Poll GET /v3/swap/status?quoteId=...
```

--------------------------------

### LLM Migration Prompt

Source: https://docs.socket.tech/integrate/migration-guide

Use this prompt to assist coding agents in migrating existing Bungee API integrations to the Socket Swap V3 API.

```txt
Migrate my Bungee API integration to the Socket Swap V3 API.
Use https://docs.socket.tech/llms-full.txt for full context and follow https://docs.socket.tech/integrate/migration-guide.
```

--------------------------------

### GET /v3/swap/status

Source: https://docs.socket.tech/integrate/integration-guides/socket-api

Polls the status of a previously submitted route.

```APIDOC
## GET /v3/swap/status

### Description
Polls the status of a submitted route.

### Method
GET

### Endpoint
/v3/swap/status
```

--------------------------------

### LLM Migration Prompt

Source: https://docs.socket.tech/integrate/migration-guide-v2

Use this prompt to assist coding agents in migrating existing v2 integrations to the v3 API.

```txt
Migrate my Socket API v2 integration to the Socket Swap V3 API.
Use https://docs.socket.tech/llms-full.txt for full context and follow https://docs.socket.tech/integrate/migration-guide-v2.
```

--------------------------------

### openQrDeposit(quoteId: string)

Source: https://docs.socket.tech/integrate/socket-widget

Opens the QR deposit screen for a specific quote.

```APIDOC
## openQrDeposit(quoteId: string)

### Description
Opens the QR deposit screen for a quote.

### Parameters
- **quoteId** (string) - Required - The ID of the quote to display.
```

--------------------------------

### GET /quote

Source: https://docs.socket.tech/api-reference/swap/get-quotes

Retrieves swap quotes based on provided query parameters.

```APIDOC
## GET /quote

### Description
Retrieves available swap routes for a given transaction request. Supports filtering by providers, gas refuel options, and destination execution payloads.

### Method
GET

### Endpoint
/quote

### Parameters
#### Query Parameters
- **affiliateAddress** (string) - Optional - Address that receives the affiliate fee.
- **feeBps** (string) - Optional - Affiliate fee in basis points.
- **refuel** (string) - Optional - Whether to request gas refuel (true/false).
- **destinationPayload** (string) - Optional - Hex payload to execute on the destination receiver.
- **destinationGasLimit** (string) - Optional - Gas limit for destination payload execution.
- **includeProvider** (string) - Optional - Comma-separated provider IDs to include.
- **excludeProvider** (string) - Optional - Comma-separated provider IDs to exclude.
- **exchange** (string) - Optional - CEX exchange ID.
- **includeQuoteRejections** (string) - Optional - Include per-provider rejection reasons (true/false).
- **private** (string) - Optional - Only quote privacy-capable direct tx providers (true/false).
- **simulatedQuotesRequired** (string) - Optional - Return only routes that passed on-chain simulation (true/false).
- **solanaSponsorAddress** (string) - Optional - Solana sponsor address for gasless same-chain swaps.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **statusCode** (integer) - HTTP status code.
- **result** (object) - The swap quote route details.

#### Response Example
{
  "success": true,
  "statusCode": 200,
  "result": {
    "originChainId": 42161,
    "destinationChainId": 42161,
    "userAddress": "0x3e8cb4bd04d81498ab4b94a392c334f5328b237b",
    "routes": [
      {
        "userOp": "tx",
        "quoteId": "0x759a82929538535f6186da129b49e42f3fa22539cde911a2f394bf9d1e3732b4",
        "expiresAt": 1781000089
      }
    ]
  }
}
```

--------------------------------

### GET /v3/swap/status

Source: https://docs.socket.tech/api-reference/swap/get-status

Fetches the status of a swap route. You can query by quoteId or srcTxHash.

```APIDOC
## GET /v3/swap/status

### Description
Retrieves the status of a swap route. This can be used to monitor the progress of a transaction.

### Method
GET

### Endpoint
https://public-backend.socket.tech/v3/swap/status

### Parameters
#### Query Parameters
- **quoteId** (string) - Optional - Quote ID returned by /v3/swap/quote.
- **srcTxHash** (string) - Optional - Source transaction hash for direct-route status lookup. Does not resolve deposit routes.
- **includeQuoteDetails** (string) - Optional - Whether to include stored quote row details in the response. Enum: 'true', 'false'.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **statusCode** (number) - The status code of the response.
- **result** (object) - The detailed status object containing origin, destination, and route information.

#### Response Example
{
  "success": true,
  "statusCode": 200,
  "result": {
    "quoteId": "0x759a82929538535f6186da129b49e42f3fa22539cde911a2f394bf9d1e3732b4",
    "status": "PENDING",
    "origin": { "chainId": 42161, "status": "PENDING" },
    "destination": { "chainId": 42161, "status": "PENDING" }
  }
}
```

--------------------------------

### GET /v3/swap/quote

Source: https://docs.socket.tech/integrate/integration-guides/socket-api

Retrieves a swap quote based on the provided source and destination parameters.

```APIDOC
## GET /v3/swap/quote

### Description
Retrieves a swap quote for specified tokens and chains.

### Method
GET

### Endpoint
/v3/swap/quote

### Parameters
#### Query Parameters
- **userOps** (string) - Required - Comma-separated route types. Use `tx` for OpenRouter transaction routes. Also supports `deposit` and `cex-withdraw`.
- **originChainId** (string) - Required - Required for `tx` and `deposit`. Source chain ID.
- **destinationChainId** (string) - Required - Destination chain ID.
- **inputToken** (string) - Required - Source token address.
- **inputAmount** (string) - Required - Source amount in smallest units.
- **outputToken** (string) - Required - Destination token address.
- **receiverAddress** (string) - Required - Destination receiver address.
- **userAddress** (string) - Required - Required for `tx`. Source wallet that will sign the transaction.
```
Tokens:
Raw