Skip to content

README.md

Latest commit

 

History

History
79 lines (59 loc) · 1.74 KB

README.md

File metadata and controls

79 lines (59 loc) · 1.74 KB
Raw

Gateway Module

Unified balance and payments across multiple chains via Circle's Gateway.

Quick Start

import { gateway } from 'arcpay';

// Get unified balance across all chains
const balance = await gateway.getUnifiedBalance('0x...');
console.log(balance);
// { total: '1500', chains: { ethereum: '500', arc: '1000' } }

// Pay from any chain (gateway handles routing)
await gateway.payFrom({
  recipient: '0x...',
  amount: '100',
  preferredChain: 'cheapest'
});

Features

  • Unified View - See all chain balances at once
  • Smart Routing - Automatically picks best chain
  • Gas Optimization - Route to cheapest chain
  • Multi-chain Wallet - One interface, all chains

API

Function Description
gateway.getUnifiedBalance(address) Get balance across chains
gateway.payFrom(params) Pay with smart routing
gateway.getPreferredChain(amount) Find optimal chain
gateway.rebalance(config) Redistribute across chains

Routing Options

preferredChain: 'arc'       // Use specific chain
preferredChain: 'cheapest'  // Minimize gas
preferredChain: 'fastest'   // Minimize time
preferredChain: 'auto'      // SDK decides

Circle Gateway API

Endpoint

GET /api/circle/gateway

Response

{
  "success": true,
  "balances": {
    "arc": "150.00",
    "ethereum": "500.00",
    "arbitrum": "250.00"
  },
  "totalBalance": "900.00"
}

Integration

The Gateway module connects to Circle's unified balance service to aggregate USDC holdings across all supported chains. This enables seamless multi-chain payment experiences.

Use Cases

  • Multi-chain dApps
  • Cross-chain payments
  • Portfolio rebalancing
  • Chain-agnostic services