@stablechain/sdk 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,169 @@
+import { Account, Transport, WalletClient, Address, BaseError } from 'viem';
+
+interface StableConfig {
+    /** Target network — defaults to Network.Mainnet */
+    network?: Network;
+    /** Optional RPC override — defaults to the public RPC for the selected network */
+    rpc?: string;
+    /** Server-side signing: pass a viem Account, e.g. privateKeyToAccount("0x...") */
+    account?: Account;
+    /** Browser-wallet signing: pass a viem Transport, e.g. custom(window.ethereum) */
+    transport?: Transport;
+    /** Pre-configured viem WalletClient — takes precedence over account/transport. */
+    walletClient?: WalletClient;
+}
+/**
+ * Unified result for transfer, bridge, and swap.
+ * `toAmount` is the destination-side amount in human units; omitted when no
+ * conversion happens (e.g. a same-asset transfer).
+ */
+interface OperationResult {
+    txHash: string;
+    toAmount?: number;
+}
+interface TransferParams {
+    from: string;
+    to: string;
+    amount: number;
+    /** ERC-20 token address. Omit to transfer native USDT0. */
+    token?: string;
+    /** Token decimals — fetched on-chain when omitted */
+    tokenDecimals?: number;
+}
+interface SwapParams {
+    /** Token address or symbol to swap from */
+    fromToken: string;
+    /** Token address or symbol to swap to */
+    toToken: string;
+    /** Human-readable amount */
+    amount: number;
+    /** Decimals of the source token (default: 6 for USDT0) */
+    fromDecimals?: number;
+    /** Recipient address — defaults to the signer */
+    toAddress?: string;
+    /** Pre-fetched quote from quoteSwap(). When provided, swap() skips the LI.FI quote call. */
+    quote?: SwapQuote;
+}
+interface SwapQuote {
+    /** Expected output amount (human-readable, formatted with toToken decimals) */
+    toAmount: number;
+    /** Source amount in raw units (used for ERC-20 approval) */
+    fromAmount: bigint;
+    /** Source token address — the ERC-20 to approve (or native sentinel) */
+    fromToken: string;
+    /** ERC-20 spender that needs approval — omitted for native sources */
+    approvalAddress?: string;
+    /** Pre-built transaction to execute */
+    transactionRequest: {
+        to: string;
+        data: string;
+        value: string;
+        gasLimit: string;
+        chainId: number;
+    };
+}
+declare enum Chain {
+    Sepolia = "sepolia",
+    StableTestnet = "stable-testnet",
+    Stable = "stable",
+    Ethereum = "ethereum",
+    Arbitrum = "arbitrum",
+    Ink = "ink",
+    Bera = "bera",
+    MegaETH = "megaeth",
+    Base = "base",
+    BSC = "bsc",
+    HyperEVM = "hyperevm"
+}
+declare enum Network {
+    Mainnet = "mainnet",
+    Testnet = "testnet"
+}
+interface BridgeQuote {
+    /** Estimated output amount on the destination chain */
+    toAmount?: number;
+    /** LayerZero native fee — only present for USDT0→USDT0 routes */
+    nativeFee?: bigint;
+    lzTokenFee?: bigint;
+}
+interface BridgeParams {
+    fromChain: Chain;
+    toChain: Chain;
+    /** Source token contract address */
+    fromToken: string;
+    /** Destination token contract address */
+    toToken: string;
+    amount: number;
+    /** Source token decimals (default: 6) */
+    fromDecimals?: number;
+    /** Recipient address — defaults to the signer */
+    recipient?: string;
+    /** Pre-fetched quote from quoteBridge() — skips the LayerZero quoteSend for USDT0 routes */
+    quote?: BridgeQuote;
+}
+
+interface StableClient {
+    transfer(params: TransferParams): Promise<OperationResult>;
+    quoteBridge(params: BridgeParams): Promise<BridgeQuote>;
+    bridge(params: BridgeParams): Promise<OperationResult>;
+    quoteSwap(params: SwapParams): Promise<SwapQuote>;
+    swap(params: SwapParams): Promise<OperationResult>;
+}
+declare function createStable({ network, rpc: rpcOverride, account, transport, walletClient, }: StableConfig): StableClient;
+
+interface ChainConfig {
+    id: number;
+    rpc: string;
+    usdt: Address;
+    /** Decimals of the USDT token on this chain */
+    decimals: number;
+}
+declare const CHAIN_CONFIGS: Partial<Record<Chain, ChainConfig>>;
+
+declare class StableError extends BaseError {
+}
+declare class StableValidationError extends StableError {
+    field: string;
+    value: unknown;
+    constructor(field: string, value: unknown, reason: string, opts?: {
+        cause?: Error;
+    });
+}
+declare class StableQuoteError extends StableError {
+    provider: "layerzero" | "lifi";
+    httpStatus?: number;
+    providerCode?: string;
+    body?: unknown;
+    constructor(args: {
+        provider: "layerzero" | "lifi";
+        shortMessage: string;
+        httpStatus?: number;
+        providerCode?: string;
+        body?: unknown;
+        cause?: Error;
+    });
+}
+declare class StableTransactionError extends StableError {
+    phase: "approve" | "send" | "receipt" | "switch_chain";
+    txHash?: `0x${string}`;
+    chainId?: number;
+    revertReason?: string;
+    constructor(args: {
+        phase: "approve" | "send" | "receipt" | "switch_chain";
+        shortMessage: string;
+        txHash?: `0x${string}`;
+        chainId?: number;
+        revertReason?: string;
+        cause?: Error;
+    });
+}
+declare class StableNetworkError extends StableError {
+    url?: string;
+    constructor(args: {
+        shortMessage: string;
+        url?: string;
+        cause?: Error;
+    });
+}
+
+export { type BridgeParams, type BridgeQuote, CHAIN_CONFIGS, Chain, type ChainConfig, Network, type OperationResult, type StableClient, type StableConfig, StableError, StableNetworkError, StableQuoteError, StableTransactionError, StableValidationError, type SwapParams, type SwapQuote, type TransferParams, createStable };

package/dist/index.d.ts

@@ -0,0 +1,169 @@
+import { Account, Transport, WalletClient, Address, BaseError } from 'viem';
+
+interface StableConfig {
+    /** Target network — defaults to Network.Mainnet */
+    network?: Network;
+    /** Optional RPC override — defaults to the public RPC for the selected network */
+    rpc?: string;
+    /** Server-side signing: pass a viem Account, e.g. privateKeyToAccount("0x...") */
+    account?: Account;
+    /** Browser-wallet signing: pass a viem Transport, e.g. custom(window.ethereum) */
+    transport?: Transport;
+    /** Pre-configured viem WalletClient — takes precedence over account/transport. */
+    walletClient?: WalletClient;
+}
+/**
+ * Unified result for transfer, bridge, and swap.
+ * `toAmount` is the destination-side amount in human units; omitted when no
+ * conversion happens (e.g. a same-asset transfer).
+ */
+interface OperationResult {
+    txHash: string;
+    toAmount?: number;
+}
+interface TransferParams {
+    from: string;
+    to: string;
+    amount: number;
+    /** ERC-20 token address. Omit to transfer native USDT0. */
+    token?: string;
+    /** Token decimals — fetched on-chain when omitted */
+    tokenDecimals?: number;
+}
+interface SwapParams {
+    /** Token address or symbol to swap from */
+    fromToken: string;
+    /** Token address or symbol to swap to */
+    toToken: string;
+    /** Human-readable amount */
+    amount: number;
+    /** Decimals of the source token (default: 6 for USDT0) */
+    fromDecimals?: number;
+    /** Recipient address — defaults to the signer */
+    toAddress?: string;
+    /** Pre-fetched quote from quoteSwap(). When provided, swap() skips the LI.FI quote call. */
+    quote?: SwapQuote;
+}
+interface SwapQuote {
+    /** Expected output amount (human-readable, formatted with toToken decimals) */
+    toAmount: number;
+    /** Source amount in raw units (used for ERC-20 approval) */
+    fromAmount: bigint;
+    /** Source token address — the ERC-20 to approve (or native sentinel) */
+    fromToken: string;
+    /** ERC-20 spender that needs approval — omitted for native sources */
+    approvalAddress?: string;
+    /** Pre-built transaction to execute */
+    transactionRequest: {
+        to: string;
+        data: string;
+        value: string;
+        gasLimit: string;
+        chainId: number;
+    };
+}
+declare enum Chain {
+    Sepolia = "sepolia",
+    StableTestnet = "stable-testnet",
+    Stable = "stable",
+    Ethereum = "ethereum",
+    Arbitrum = "arbitrum",
+    Ink = "ink",
+    Bera = "bera",
+    MegaETH = "megaeth",
+    Base = "base",
+    BSC = "bsc",
+    HyperEVM = "hyperevm"
+}
+declare enum Network {
+    Mainnet = "mainnet",
+    Testnet = "testnet"
+}
+interface BridgeQuote {
+    /** Estimated output amount on the destination chain */
+    toAmount?: number;
+    /** LayerZero native fee — only present for USDT0→USDT0 routes */
+    nativeFee?: bigint;
+    lzTokenFee?: bigint;
+}
+interface BridgeParams {
+    fromChain: Chain;
+    toChain: Chain;
+    /** Source token contract address */
+    fromToken: string;
+    /** Destination token contract address */
+    toToken: string;
+    amount: number;
+    /** Source token decimals (default: 6) */
+    fromDecimals?: number;
+    /** Recipient address — defaults to the signer */
+    recipient?: string;
+    /** Pre-fetched quote from quoteBridge() — skips the LayerZero quoteSend for USDT0 routes */
+    quote?: BridgeQuote;
+}
+
+interface StableClient {
+    transfer(params: TransferParams): Promise<OperationResult>;
+    quoteBridge(params: BridgeParams): Promise<BridgeQuote>;
+    bridge(params: BridgeParams): Promise<OperationResult>;
+    quoteSwap(params: SwapParams): Promise<SwapQuote>;
+    swap(params: SwapParams): Promise<OperationResult>;
+}
+declare function createStable({ network, rpc: rpcOverride, account, transport, walletClient, }: StableConfig): StableClient;
+
+interface ChainConfig {
+    id: number;
+    rpc: string;
+    usdt: Address;
+    /** Decimals of the USDT token on this chain */
+    decimals: number;
+}
+declare const CHAIN_CONFIGS: Partial<Record<Chain, ChainConfig>>;
+
+declare class StableError extends BaseError {
+}
+declare class StableValidationError extends StableError {
+    field: string;
+    value: unknown;
+    constructor(field: string, value: unknown, reason: string, opts?: {
+        cause?: Error;
+    });
+}
+declare class StableQuoteError extends StableError {
+    provider: "layerzero" | "lifi";
+    httpStatus?: number;
+    providerCode?: string;
+    body?: unknown;
+    constructor(args: {
+        provider: "layerzero" | "lifi";
+        shortMessage: string;
+        httpStatus?: number;
+        providerCode?: string;
+        body?: unknown;
+        cause?: Error;
+    });
+}
+declare class StableTransactionError extends StableError {
+    phase: "approve" | "send" | "receipt" | "switch_chain";
+    txHash?: `0x${string}`;
+    chainId?: number;
+    revertReason?: string;
+    constructor(args: {
+        phase: "approve" | "send" | "receipt" | "switch_chain";
+        shortMessage: string;
+        txHash?: `0x${string}`;
+        chainId?: number;
+        revertReason?: string;
+        cause?: Error;
+    });
+}
+declare class StableNetworkError extends StableError {
+    url?: string;
+    constructor(args: {
+        shortMessage: string;
+        url?: string;
+        cause?: Error;
+    });
+}
+
+export { type BridgeParams, type BridgeQuote, CHAIN_CONFIGS, Chain, type ChainConfig, Network, type OperationResult, type StableClient, type StableConfig, StableError, StableNetworkError, StableQuoteError, StableTransactionError, StableValidationError, type SwapParams, type SwapQuote, type TransferParams, createStable };