SDK Reference

npm install @circle-fin/x402-batching

import { GatewayClient } from "@circle-fin/x402-batching/client";

new GatewayClient(config: GatewayClientConfig)

interface DepositResult {
  approvalTxHash?: Hex;
  depositTxHash: Hex;
  amount: bigint;
  formattedAmount: string;
}

interface PayResult<T> {
  data: T;
  amount: bigint;
  formattedAmount: string;
  transaction: string;
  status: number;
}

interface WithdrawResult {
  mintTxHash: Hex;
  amount: bigint;
  formattedAmount: string;
  sourceChain: string;
  destinationChain: string;
  recipient: Address;
}

interface Balances {
  wallet: { balance: bigint; formatted: string };
  gateway: GatewayBalance;
}

interface GatewayBalance {
  total: bigint;
  available: bigint;
  withdrawing: bigint;
  withdrawable: bigint;
  formattedTotal: string;
  formattedAvailable: string;
}

interface SupportsResult {
  supported: boolean;
  requirements?: Record<string, unknown>;
  error?: string;
}

type TransferStatus =
  | "received"
  | "batched"
  | "confirmed"
  | "completed"
  | "failed";

interface TransferResponse {
  id: string;
  status: TransferStatus;
  token: "USDC";
  sendingNetwork: string;
  recipientNetwork: string;
  fromAddress: string;
  toAddress: string;
  amount: string;
  createdAt: string;
  updatedAt: string;
}

interface SearchTransfersResponse {
  transfers: TransferResponse[];
  pagination?: CursorPagination;
}

interface CursorPagination {
  self?: string;
  first?: string;
  prev?: string;
  next?: string;
  pageAfter?: string;
  pageBefore?: string;
}

import { BatchEvmScheme } from "@circle-fin/x402-batching/client";

new BatchEvmScheme(signer: BatchEvmSigner)

import { CompositeEvmScheme } from "@circle-fin/x402-batching/client";

new CompositeEvmScheme(batchScheme: BatchEvmScheme, fallbackScheme: SchemeNetworkClient)

import { ExactEvmScheme } from "@x402/evm/exact/client";
import {
  CompositeEvmScheme,
  BatchEvmScheme,
} from "@circle-fin/x402-batching/client";

const composite = new CompositeEvmScheme(
  new BatchEvmScheme(signer),
  new ExactEvmScheme(signer),
);

client.register("eip155:*", composite);

import { registerBatchScheme } from "@circle-fin/x402-batching/client";

registerBatchScheme(client, { signer: account });

import { createGatewayMiddleware } from "@circle-fin/x402-batching/server";

createGatewayMiddleware(config: GatewayMiddlewareConfig)

interface PaymentInfo {
  verified: boolean;
  payer: string;
  amount: string;
  network: string;
  transaction?: string;
}

import { BatchFacilitatorClient } from "@circle-fin/x402-batching/server";

new BatchFacilitatorClient(config?: BatchFacilitatorConfig)

interface VerifyResponse {
  isValid: boolean;
  invalidReason?: string;
  payer?: string;
}

interface SettleResponse {
  success: boolean;
  errorReason?: string;
  payer?: string;
  transaction: string;
}

interface SupportedResponse {
  kinds: Array<{
    x402Version: number;
    scheme: string;
    network: string;
    extra?: { verifyingContract?: string };
  }>;
}

import { GatewayEvmScheme } from "@circle-fin/x402-batching/server";

new GatewayEvmScheme();

import { x402ResourceServer } from "@x402/express";
import {
  BatchFacilitatorClient,
  GatewayEvmScheme,
} from "@circle-fin/x402-batching/server";

const server = new x402ResourceServer([new BatchFacilitatorClient()]);
server.register("eip155:*", new GatewayEvmScheme());
await server.initialize();

import { supportsBatching } from "@circle-fin/x402-batching";

import { isBatchPayment } from "@circle-fin/x402-batching/server";

import { getVerifyingContract } from "@circle-fin/x402-batching";

import {
  CIRCLE_BATCHING_NAME,
  CIRCLE_BATCHING_VERSION,
  CIRCLE_BATCHING_SCHEME,
} from "@circle-fin/x402-batching";

import {
  CHAIN_CONFIGS,
  GATEWAY_DOMAINS,
} from "@circle-fin/x402-batching/client";