@gala-chain/launchpad-sdk 3.31.2 → 4.0.1-beta.0

package/dist/src/types/eip712-types.d.ts

@@ -0,0 +1,140 @@
+/**
+ * Centralized EIP-712 Type Definitions for Bundler Operations
+ *
+ * These type definitions are used for EIP-712 signing with ethers.js for all bundler operations.
+ * They are manually defined (not auto-generated) because SigningClient auto-generation incorrectly
+ * uses uint256 for ALL numeric fields, which rejects negative tick values. These definitions
+ * use int256 for tick values to properly support negative ticks.
+ *
+ * EIP-712 Specification: https://eips.ethereum.org/EIPS/eip-712
+ * GalaChain Bundler Documentation: https://docs.galachain.com/bundler/signing (when available)
+ * GalaChain API Reference: https://docs.galachain.com/bundler/api
+ *
+ * Integration Points:
+ * - Used by GSwapService.sendAddLiquidityToBundler()
+ * - Used by GSwapService.sendRemoveLiquidityToBundler()
+ * - Used by GSwapService.sendCollectPositionFeesToBundler()
+ * - Used by GSwapService.sendSwapToBundler()
+ *
+ * Key Design Decisions:
+ * - Token field order (additionalKey, category, collection, type) must be consistent across all types
+ *   to ensure proper token identification in bundler state locking
+ * - All tick boundaries (tickLower, tickUpper) use int256 to support negative Uniswap V3 ticks
+ *   (UQ64.96 encoding requires int256, not uint256)
+ * - String amounts (not numeric) to preserve decimal precision across JavaScript/Solidity boundary
+ * - Unique domain configuration: { name: 'ethereum', chainId: 1 } for GalaChain compatibility
+ * - All operations require prefix field added by calculatePersonalSignPrefix() for bundler validation
+ */
+/**
+ * EIP-712 types for AddLiquidity operation
+ *
+ * Used when creating a new liquidity position with price or tick boundaries.
+ * Creates a concentrated liquidity position in a Uniswap V3 pool.
+ *
+ * Reference: GalaChain Bundler API - AddLiquidity
+ * See: https://docs.galachain.com/bundler/api (when available)
+ */
+export declare const ADD_LIQUIDITY_EIP712_TYPES: {
+    AddLiquidity: {
+        name: string;
+        type: string;
+    }[];
+    token0: {
+        name: string;
+        type: string;
+    }[];
+    token1: {
+        name: string;
+        type: string;
+    }[];
+};
+/**
+ * EIP-712 types for RemoveLiquidity operation
+ *
+ * Used when closing a liquidity position and withdrawing tokens.
+ * Removes liquidity from a Uniswap V3 position and returns the underlying tokens.
+ *
+ * Reference: GalaChain Bundler API - RemoveLiquidity
+ * See: https://docs.galachain.com/bundler/api (when available)
+ */
+export declare const REMOVE_LIQUIDITY_EIP712_TYPES: {
+    RemoveLiquidity: {
+        name: string;
+        type: string;
+    }[];
+    token0: {
+        name: string;
+        type: string;
+    }[];
+    token1: {
+        name: string;
+        type: string;
+    }[];
+};
+/**
+ * EIP-712 types for CollectPositionFees operation
+ *
+ * Used when collecting accumulated trading fees from a liquidity position.
+ * Extracts protocol fees earned by the position during trades without modifying liquidity.
+ *
+ * Reference: GalaChain Bundler API - CollectPositionFees
+ * See: https://docs.galachain.com/bundler/api (when available)
+ */
+export declare const COLLECT_FEES_EIP712_TYPES: {
+    CollectPositionFees: {
+        name: string;
+        type: string;
+    }[];
+    token0: {
+        name: string;
+        type: string;
+    }[];
+    token1: {
+        name: string;
+        type: string;
+    }[];
+};
+/**
+ * EIP-712 types for Swap operation
+ *
+ * Used when swapping tokens on GalaSwap DEX.
+ * Executes a token swap on a Uniswap V3 pool with slippage protection.
+ *
+ * Reference: GalaChain Bundler API - Swap
+ * See: https://docs.galachain.com/bundler/api (when available)
+ */
+export declare const SWAP_EIP712_TYPES: {
+    Swap: {
+        name: string;
+        type: string;
+    }[];
+    token0: {
+        name: string;
+        type: string;
+    }[];
+    token1: {
+        name: string;
+        type: string;
+    }[];
+};
+/**
+ * Standard EIP-712 domain configuration
+ *
+ * Used consistently across all bundler operations for signature validation.
+ * Domain identifies the signing context (application name and chain).
+ *
+ * Configuration:
+ * - name: 'ethereum' - Identifies as Ethereum domain (GalaChain convention)
+ * - chainId: 1 - References Ethereum mainnet chainId (GalaChain signing context)
+ *
+ * This domain ensures that signatures cannot be replayed across different networks
+ * or applications. All bundler operations must use this exact domain.
+ *
+ * Reference: EIP-712 Domain Separator
+ * See: https://eips.ethereum.org/EIPS/eip-712#definition-of-domainseparator
+ */
+export declare const EIP712_DOMAIN: {
+    name: string;
+    chainId: number;
+};
+//# sourceMappingURL=eip712-types.d.ts.map

package/dist/src/types/eip712-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"eip712-types.d.ts","sourceRoot":"","sources":["../../../src/types/eip712-types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH;;;;;;;;GAQG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;CA2BtC,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,6BAA6B;;;;;;;;;;;;;CAyBzC,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;CAwBrC,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;CAwB7B,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,aAAa;;;CAAmC,CAAC"}

package/dist/src/types/galachain-api.types.d.ts

@@ -0,0 +1,216 @@
+/**
+ * GalaChain Gateway and DEX Backend API Type Definitions
+ *
+ * Comprehensive, fully-typed definitions for all API responses from:
+ * - GalaChain Gateway (DEX contract endpoints)
+ * - DEX Backend API
+ *
+ * Zero `any` types, complete type safety across all API operations.
+ */
+import BigNumber from 'bignumber.js';
+/**
+ * GalaChain Gateway response wrapper
+ * All Gateway responses wrap the actual data in this structure
+ */
+export interface GalaChainGatewayResponse<T> {
+    Data: T;
+    Status: number;
+    Message?: string;
+}
+/**
+ * Token class key structure used in API responses
+ */
+export interface TokenClassKey {
+    collection: string;
+    category: string;
+    type: string;
+    additionalKey: string;
+}
+/**
+ * Pool data from GetPoolData endpoint
+ * Complete Uniswap V3 pool state including tick, liquidity, fees
+ */
+export interface GalaChainPoolData {
+    token0: string;
+    token1: string;
+    token0ClassKey: TokenClassKey;
+    token1ClassKey: TokenClassKey;
+    fee: number;
+    tickSpacing: number;
+    liquidity: string;
+    sqrtPrice: string;
+    tick: number;
+    feeGrowthGlobal0: string;
+    feeGrowthGlobal1: string;
+    bitmap?: Record<string, string>;
+    creator?: string;
+    grossPoolLiquidity?: string;
+    isPrivate?: boolean;
+    maxLiquidityPerTick?: string;
+    protocolFees?: number;
+    protocolFeesToken0?: string;
+    protocolFeesToken1?: string;
+    whitelist?: unknown[];
+    observations?: Array<{
+        blockTimestamp: number;
+        tickCumulative: number;
+        secondsPerLiquidityCumulativeX128: string;
+        initialized: boolean;
+    }>;
+    currentPrice?: string;
+    token0Decimals?: number;
+    token1Decimals?: number;
+    initialized?: boolean;
+    poolAddress?: string;
+}
+/**
+ * Individual position data from GetPositions endpoint
+ * Represents a concentrated liquidity position in a pool
+ */
+export interface GalaChainPosition {
+    positionId: string;
+    owner: string;
+    token0: TokenClassKey;
+    token1: TokenClassKey;
+    fee: number;
+    tickLower: number;
+    tickUpper: number;
+    liquidity: string;
+    feeGrowthInside0LastX128: string;
+    feeGrowthInside1LastX128: string;
+    tokensOwed0: string;
+    tokensOwed1: string;
+    amount0?: string;
+    amount1?: string;
+    feeAmount0?: string;
+    feeAmount1?: string;
+    createdAt?: number;
+    updatedAt?: number;
+    operator?: string;
+}
+/**
+ * Response from GetPositions endpoint
+ * Can return multiple positions for a wallet/criteria
+ */
+export interface GalaChainGetPositionsResponse {
+    positions: GalaChainPosition[];
+    count: number;
+    totalLiquidity?: string;
+    totalValue?: string;
+    nextBookMark?: string;
+}
+/**
+ * Estimated amounts when removing liquidity
+ * From GetRemoveLiquidityEstimation endpoint
+ */
+export interface GalaChainRemoveLiquidityEstimation {
+    amount0: string;
+    amount1: string;
+    fee0: string;
+    fee1: string;
+    liquidity: string;
+    tickLower: number;
+    tickUpper: number;
+    currentPrice?: string;
+    token0Symbol?: string;
+    token1Symbol?: string;
+}
+/**
+ * User asset from DEX Backend API
+ * Represents a token in a user's wallet on the DEX
+ */
+export interface DexBackendUserAsset {
+    tokenId: TokenClassKey | string;
+    symbol: string;
+    name: string;
+    decimals: number;
+    balance: string | BigNumber;
+    contractAddress?: string;
+    imageUrl?: string;
+    verified?: boolean;
+    trading?: boolean;
+    walletAddress?: string;
+}
+/**
+ * Response from DEX Backend getUserAssets endpoint
+ * List of all tokens user holds on the DEX
+ */
+export interface DexBackendUserAssetsResponse {
+    tokens: DexBackendUserAsset[];
+    count: number;
+    totalValue?: string;
+}
+/**
+ * Request to GetPoolData endpoint
+ */
+export interface GalaChainGetPoolDataRequest {
+    token0: TokenClassKey;
+    token1: TokenClassKey;
+    fee: number;
+}
+/**
+ * Request to GetPositions endpoint
+ * Multiple query filters supported
+ */
+export interface GalaChainGetPositionsRequest {
+    owner?: string;
+    tokenA?: TokenClassKey | string;
+    tokenB?: TokenClassKey | string;
+    feeTier?: number;
+    positionId?: string;
+    limit?: number;
+    bookmark?: string;
+}
+/**
+ * Request to GetRemoveLiquidityEstimation endpoint
+ */
+export interface GalaChainGetRemoveLiquidityEstimationRequest {
+    tokenA: TokenClassKey | string;
+    tokenB: TokenClassKey | string;
+    fee: number;
+    tickLower: number;
+    tickUpper: number;
+    liquidity: string;
+}
+/**
+ * Request to DEX Backend getUserAssets endpoint
+ */
+export interface DexBackendGetUserAssetsRequest {
+    walletAddress: string;
+    limit?: number;
+    offset?: number;
+}
+/**
+ * Standard API error response
+ */
+export interface ApiErrorResponse {
+    Status: number;
+    Message: string;
+    Data?: Record<string, unknown>;
+}
+/**
+ * Parsed error with context
+ */
+export declare class ApiError extends Error {
+    readonly status: number;
+    readonly message: string;
+    readonly details?: Record<string, unknown> | undefined;
+    constructor(status: number, message: string, details?: Record<string, unknown> | undefined);
+}
+/**
+ * Check if value is a TokenClassKey
+ */
+export declare function isTokenClassKey(value: unknown): value is TokenClassKey;
+/**
+ * Check if value is a GalaChainPoolData response
+ */
+export declare function isGalaChainPoolData(value: unknown): value is GalaChainPoolData;
+/**
+ * Check if value is a GalaChainPosition
+ */
+export declare function isGalaChainPosition(value: unknown): value is GalaChainPosition;
+/**
+ * Check if value is a DexBackendUserAsset
+ */
+export declare function isDexBackendUserAsset(value: unknown): value is DexBackendUserAsset;
+//# sourceMappingURL=galachain-api.types.d.ts.map

package/dist/src/types/galachain-api.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"galachain-api.types.d.ts","sourceRoot":"","sources":["../../../src/types/galachain-api.types.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,SAAS,MAAM,cAAc,CAAC;AAErC;;;GAGG;AACH,MAAM,WAAW,wBAAwB,CAAC,CAAC;IACzC,IAAI,EAAE,CAAC,CAAC;IACR,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;CACvB;AAMD;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAEhC,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,aAAa,CAAC;IAC9B,cAAc,EAAE,aAAa,CAAC;IAG9B,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,CAAC;IAGpB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,gBAAgB,EAAE,MAAM,CAAC;IACzB,gBAAgB,EAAE,MAAM,CAAC;IAGzB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,SAAS,CAAC,EAAE,OAAO,EAAE,CAAC;IAEtB,YAAY,CAAC,EAAE,KAAK,CAAC;QACnB,cAAc,EAAE,MAAM,CAAC;QACvB,cAAc,EAAE,MAAM,CAAC;QACvB,iCAAiC,EAAE,MAAM,CAAC;QAC1C,WAAW,EAAE,OAAO,CAAC;KACtB,CAAC,CAAC;IAGH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAMD;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAEhC,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IAGd,MAAM,EAAE,aAAa,CAAC;IACtB,MAAM,EAAE,aAAa,CAAC;IAGtB,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAGlB,SAAS,EAAE,MAAM,CAAC;IAClB,wBAAwB,EAAE,MAAM,CAAC;IACjC,wBAAwB,EAAE,MAAM,CAAC;IACjC,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IAGpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,6BAA6B;IAC5C,SAAS,EAAE,iBAAiB,EAAE,CAAC;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAMD;;;GAGG;AACH,MAAM,WAAW,kCAAkC;IAEjD,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAGhB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IAGb,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAGlB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAMD;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAElC,OAAO,EAAE,aAAa,GAAG,MAAM,CAAC;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IAGb,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IAG5B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC3C,MAAM,EAAE,mBAAmB,EAAE,CAAC;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAMD;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,MAAM,EAAE,aAAa,CAAC;IACtB,MAAM,EAAE,aAAa,CAAC;IACtB,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC3C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,aAAa,GAAG,MAAM,CAAC;IAChC,MAAM,CAAC,EAAE,aAAa,GAAG,MAAM,CAAC;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,4CAA4C;IAC3D,MAAM,EAAE,aAAa,GAAG,MAAM,CAAC;IAC/B,MAAM,EAAE,aAAa,GAAG,MAAM,CAAC;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAMD;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAChC;AAED;;GAEG;AACH,qBAAa,QAAS,SAAQ,KAAK;aAEf,MAAM,EAAE,MAAM;aACd,OAAO,EAAE,MAAM;aACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;gBAFjC,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,YAAA;CAKpD;AAMD;;GAEG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,aAAa,CAatE;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,iBAAiB,CAqB9E;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,iBAAiB,CAc9E;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,mBAAmB,CAYlF"}