@eth-optimism/actions-sdk 0.1.0 → 0.3.0

package/dist/swap/__mocks__/MockSwapProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MockSwapProvider.d.ts","sourceRoot":"","sources":["../../../src/swap/__mocks__/MockSwapProvider.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,cAAc,EAAM,MAAM,QAAQ,CAAA;AAEhD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAA;AAEtE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAA;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAC1D,OAAO,KAAK,EACV,mBAAmB,EACnB,oBAAoB,EACpB,kBAAkB,EAClB,UAAU,EACV,SAAS,EACT,eAAe,EACf,kBAAkB,EAClB,eAAe,EAChB,MAAM,uBAAuB,CAAA;AAE9B,MAAM,WAAW,sBAAsB;IACrC,eAAe,EAAE,gBAAgB,EAAE,CAAA;IACnC,YAAY,EAAE,MAAM,CAAA;IACpB,kBAAkB,EAAE,MAAM,CAAA;CAC3B;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,YAAY,CAAC,kBAAkB,CAAC;IAC7D,WAAW,EAAE,cAAc,CAChC,CAAC,MAAM,EAAE,kBAAkB,KAAK,OAAO,CAAC,eAAe,CAAC,CACzD,CAAA;IACM,YAAY,EAAE,cAAc,CACjC,CAAC,MAAM,EAAE,eAAe,KAAK,OAAO,CAAC,SAAS,CAAC,CAChD,CAAA;IACM,aAAa,EAAE,cAAc,CAClC,CAAC,MAAM,EAAE,mBAAmB,KAAK,OAAO,CAAC,UAAU,CAAC,CACrD,CAAA;IACM,cAAc,EAAE,cAAc,CACnC,CAAC,MAAM,EAAE,oBAAoB,KAAK,OAAO,CAAC,UAAU,EAAE,CAAC,CACxD,CAAA;IAED,OAAO,CAAC,gBAAgB,CAAoB;IAC5C,OAAO,CAAC,kBAAkB,CAAwB;gBAGhD,MAAM,CAAC,EAAE,kBAAkB,EAC3B,UAAU,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,EAC5C,YAAY,CAAC,EAAE,YAAY;IA+B7B,iBAAiB,IAAI,gBAAgB,EAAE;IAIvC,KAAK,IAAI,IAAI;IAKN,yBAAyB,CAC9B,OAAO,EAAE,GAAG,EACZ,QAAQ,EAAE,GAAG,EACb,OAAO,EAAE,gBAAgB,GACxB,IAAI;cAIS,QAAQ,CACtB,MAAM,EAAE,kBAAkB,GACzB,OAAO,CAAC,eAAe,CAAC;cAIX,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,SAAS,CAAC;cAItD,UAAU,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,CAAC;cAI5D,WAAW,CACzB,MAAM,EAAE,oBAAoB,GAC3B,OAAO,CAAC,UAAU,EAAE,CAAC;IAIxB,OAAO,CAAC,yBAAyB;IAyBjC,OAAO,CAAC,eAAe;IAkCvB,OAAO,CAAC,gBAAgB;IAuBxB,OAAO,CAAC,iBAAiB;CAQ1B;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CACpC,MAAM,CAAC,EAAE,kBAAkB,EAC3B,UAAU,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,GAC3C,gBAAgB,CAElB"}

package/dist/swap/__mocks__/MockSwapProvider.js

@@ -0,0 +1,138 @@
+import { vi } from 'vitest';
+import { MockChainManager } from '../../services/__mocks__/MockChainManager.js';
+import { SwapProvider } from '../core/SwapProvider.js';
+/**
+ * Mock Swap Provider for testing
+ */
+export class MockSwapProvider extends SwapProvider {
+    constructor(config, mockConfig, chainManager) {
+        super(config || {}, chainManager || new MockChainManager());
+        this._supportedChains = mockConfig?.supportedChains ?? [
+            84532,
+        ];
+        this.mockProviderConfig = {
+            supportedChains: this._supportedChains,
+            defaultPrice: mockConfig?.defaultPrice ?? '1.5',
+            defaultPriceImpact: mockConfig?.defaultPriceImpact ?? 0.001,
+        };
+        // Create mocked functions
+        this.mockExecute = vi
+            .fn()
+            .mockImplementation(this.createMockSwapTransaction.bind(this));
+        this.mockGetPrice = vi
+            .fn()
+            .mockImplementation(this.createMockPrice.bind(this));
+        this.mockGetMarket = vi
+            .fn()
+            .mockImplementation(this.createMockMarket.bind(this));
+        this.mockGetMarkets = vi
+            .fn()
+            .mockImplementation(this.createMockMarkets.bind(this));
+    }
+    supportedChainIds() {
+        return this._supportedChains;
+    }
+    reset() {
+        vi.clearAllMocks();
+    }
+    // Expose protected methods for testing
+    testValidateMarketAllowed(assetIn, assetOut, chainId) {
+        return this.validateMarketAllowed(assetIn, assetOut, chainId);
+    }
+    async _execute(params) {
+        return this.mockExecute(params);
+    }
+    async _getPrice(params) {
+        return this.mockGetPrice(params);
+    }
+    async _getMarket(params) {
+        return this.mockGetMarket(params);
+    }
+    async _getMarkets(params) {
+        return this.mockGetMarkets(params);
+    }
+    createMockSwapTransaction(params) {
+        const amountIn = params.amountInWei ?? 1000000n;
+        const amountOut = 1500000000000000000n;
+        return {
+            amountIn: 1.0,
+            amountOut: 1.5,
+            amountInWei: amountIn,
+            amountOutWei: amountOut,
+            assetIn: params.assetIn,
+            assetOut: params.assetOut,
+            price: this.mockProviderConfig.defaultPrice,
+            priceImpact: this.mockProviderConfig.defaultPriceImpact,
+            transactionData: {
+                swap: {
+                    to: '0x492e6456d9528771018deb9e87ef7750ef184104',
+                    data: '0x1234',
+                    value: 0n,
+                },
+            },
+        };
+    }
+    createMockPrice(params) {
+        const amountIn = params.amountIn !== undefined
+            ? BigInt(Math.floor(params.amountIn * 10 ** params.assetIn.metadata.decimals))
+            : BigInt(10 ** params.assetIn.metadata.decimals);
+        const amountOut = (amountIn * 15n) / 10n;
+        return {
+            price: this.mockProviderConfig.defaultPrice,
+            priceInverse: '0.666666',
+            amountIn: 1.0,
+            amountOut: 1.5,
+            amountInWei: amountIn,
+            amountOutWei: amountOut,
+            priceImpact: this.mockProviderConfig.defaultPriceImpact,
+            route: {
+                path: [params.assetIn, params.assetOut],
+                pools: [
+                    {
+                        address: '0x1234',
+                        fee: 500,
+                        version: 'v4',
+                    },
+                ],
+            },
+            gasEstimate: 150000n,
+        };
+    }
+    createMockMarket(params) {
+        return {
+            marketId: {
+                poolId: params.poolId,
+                chainId: params.chainId,
+            },
+            assets: [
+                {
+                    type: 'erc20',
+                    address: { [params.chainId]: '0x1111' },
+                    metadata: { name: 'USDC', symbol: 'USDC', decimals: 6 },
+                },
+                {
+                    type: 'erc20',
+                    address: { [params.chainId]: '0x2222' },
+                    metadata: { name: 'WETH', symbol: 'WETH', decimals: 18 },
+                },
+            ],
+            fee: 500,
+            provider: 'uniswap',
+        };
+    }
+    createMockMarkets(_params) {
+        return [
+            this.createMockMarket({
+                poolId: '0xpool1',
+                chainId: 84532,
+            }),
+        ];
+    }
+}
+/**
+ * Create a mock swap provider
+ */
+export function createMockSwapProvider(config, mockConfig) {
+    return new MockSwapProvider(config, mockConfig);
+}
+//# sourceMappingURL=MockSwapProvider.js.map

package/dist/swap/__mocks__/MockSwapProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MockSwapProvider.js","sourceRoot":"","sources":["../../../src/swap/__mocks__/MockSwapProvider.ts"],"names":[],"mappings":"AACA,OAAO,EAAuB,EAAE,EAAE,MAAM,QAAQ,CAAA;AAGhD,OAAO,EAAE,gBAAgB,EAAE,MAAM,0CAA0C,CAAA;AAE3E,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAkB1D;;GAEG;AACH,MAAM,OAAO,gBAAiB,SAAQ,YAAgC;IAiBpE,YACE,MAA2B,EAC3B,UAA4C,EAC5C,YAA2B;QAE3B,KAAK,CACH,MAAM,IAAI,EAAE,EACZ,YAAY,IAAK,IAAI,gBAAgB,EAA8B,CACpE,CAAA;QAED,IAAI,CAAC,gBAAgB,GAAG,UAAU,EAAE,eAAe,IAAI;YACrD,KAAyB;SAC1B,CAAA;QACD,IAAI,CAAC,kBAAkB,GAAG;YACxB,eAAe,EAAE,IAAI,CAAC,gBAAgB;YACtC,YAAY,EAAE,UAAU,EAAE,YAAY,IAAI,KAAK;YAC/C,kBAAkB,EAAE,UAAU,EAAE,kBAAkB,IAAI,KAAK;SAC5D,CAAA;QAED,0BAA0B;QAC1B,IAAI,CAAC,WAAW,GAAG,EAAE;aAClB,EAAE,EAAE;aACJ,kBAAkB,CAAC,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;QAChE,IAAI,CAAC,YAAY,GAAG,EAAE;aACnB,EAAE,EAAE;aACJ,kBAAkB,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;QACtD,IAAI,CAAC,aAAa,GAAG,EAAE;aACpB,EAAE,EAAE;aACJ,kBAAkB,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;QACvD,IAAI,CAAC,cAAc,GAAG,EAAE;aACrB,EAAE,EAAE;aACJ,kBAAkB,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;IAC1D,CAAC;IAED,iBAAiB;QACf,OAAO,IAAI,CAAC,gBAAgB,CAAA;IAC9B,CAAC;IAED,KAAK;QACH,EAAE,CAAC,aAAa,EAAE,CAAA;IACpB,CAAC;IAED,uCAAuC;IAChC,yBAAyB,CAC9B,OAAY,EACZ,QAAa,EACb,OAAyB;QAEzB,OAAO,IAAI,CAAC,qBAAqB,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAA;IAC/D,CAAC;IAES,KAAK,CAAC,QAAQ,CACtB,MAA0B;QAE1B,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;IACjC,CAAC;IAES,KAAK,CAAC,SAAS,CAAC,MAAuB;QAC/C,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAA;IAClC,CAAC;IAES,KAAK,CAAC,UAAU,CAAC,MAA2B;QACpD,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAA;IACnC,CAAC;IAES,KAAK,CAAC,WAAW,CACzB,MAA4B;QAE5B,OAAO,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAA;IACpC,CAAC;IAEO,yBAAyB,CAC/B,MAA0B;QAE1B,MAAM,QAAQ,GAAG,MAAM,CAAC,WAAW,IAAI,QAAQ,CAAA;QAC/C,MAAM,SAAS,GAAG,oBAAoB,CAAA;QAEtC,OAAO;YACL,QAAQ,EAAE,GAAG;YACb,SAAS,EAAE,GAAG;YACd,WAAW,EAAE,QAAQ;YACrB,YAAY,EAAE,SAAS;YACvB,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,KAAK,EAAE,IAAI,CAAC,kBAAkB,CAAC,YAAY;YAC3C,WAAW,EAAE,IAAI,CAAC,kBAAkB,CAAC,kBAAkB;YACvD,eAAe,EAAE;gBACf,IAAI,EAAE;oBACJ,EAAE,EAAE,4CAAuD;oBAC3D,IAAI,EAAE,QAAyB;oBAC/B,KAAK,EAAE,EAAE;iBACV;aACF;SACF,CAAA;IACH,CAAC;IAEO,eAAe,CAAC,MAAuB;QAC7C,MAAM,QAAQ,GACZ,MAAM,CAAC,QAAQ,KAAK,SAAS;YAC3B,CAAC,CAAC,MAAM,CACJ,IAAI,CAAC,KAAK,CACR,MAAM,CAAC,QAAQ,GAAG,EAAE,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CACzD,CACF;YACH,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;QAEpD,MAAM,SAAS,GAAG,CAAC,QAAQ,GAAG,GAAG,CAAC,GAAG,GAAG,CAAA;QAExC,OAAO;YACL,KAAK,EAAE,IAAI,CAAC,kBAAkB,CAAC,YAAY;YAC3C,YAAY,EAAE,UAAU;YACxB,QAAQ,EAAE,GAAG;YACb,SAAS,EAAE,GAAG;YACd,WAAW,EAAE,QAAQ;YACrB,YAAY,EAAE,SAAS;YACvB,WAAW,EAAE,IAAI,CAAC,kBAAkB,CAAC,kBAAkB;YACvD,KAAK,EAAE;gBACL,IAAI,EAAE,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,QAAS,CAAC;gBACxC,KAAK,EAAE;oBACL;wBACE,OAAO,EAAE,QAAmB;wBAC5B,GAAG,EAAE,GAAG;wBACR,OAAO,EAAE,IAAI;qBACd;iBACF;aACF;YACD,WAAW,EAAE,OAAO;SACrB,CAAA;IACH,CAAC;IAEO,gBAAgB,CAAC,MAA2B;QAClD,OAAO;YACL,QAAQ,EAAE;gBACR,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,OAAO,EAAE,MAAM,CAAC,OAAO;aACxB;YACD,MAAM,EAAE;gBACN;oBACE,IAAI,EAAE,OAAO;oBACb,OAAO,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,QAAmB,EAAE;oBAClD,QAAQ,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,EAAE;iBACxD;gBACD;oBACE,IAAI,EAAE,OAAO;oBACb,OAAO,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,QAAmB,EAAE;oBAClD,QAAQ,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE;iBACzD;aACF;YACD,GAAG,EAAE,GAAG;YACR,QAAQ,EAAE,SAAS;SACpB,CAAA;IACH,CAAC;IAEO,iBAAiB,CAAC,OAA6B;QACrD,OAAO;YACL,IAAI,CAAC,gBAAgB,CAAC;gBACpB,MAAM,EAAE,SAAS;gBACjB,OAAO,EAAE,KAAyB;aACnC,CAAC;SACH,CAAA;IACH,CAAC;CACF;AAED;;GAEG;AACH,MAAM,UAAU,sBAAsB,CACpC,MAA2B,EAC3B,UAA4C;IAE5C,OAAO,IAAI,gBAAgB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;AACjD,CAAC"}

package/dist/swap/core/SwapProvider.d.ts

@@ -0,0 +1,56 @@
+import type { Address } from 'viem';
+import type { SupportedChainId } from '../../constants/supportedChains.js';
+import type { ChainManager } from '../../services/ChainManager.js';
+import type { Asset } from '../../types/asset.js';
+import type { GetSwapMarketParams, GetSwapMarketsParams, ResolvedSwapParams, SwapExecuteParams, SwapMarket, SwapMarketConfig, SwapPrice, SwapPriceParams, SwapProviderConfig, SwapTransaction } from '../../types/swap/index.js';
+import type { TransactionData } from '../../types/transaction.js';
+/**
+ * Abstract base class for swap providers.
+ * Public methods handle validation and conversion,
+ * protected abstract methods implement provider-specific logic.
+ */
+export declare abstract class SwapProvider<TConfig extends SwapProviderConfig = SwapProviderConfig> {
+    protected readonly _config: TConfig;
+    protected readonly chainManager: ChainManager;
+    constructor(config: TConfig, chainManager: ChainManager);
+    get config(): TConfig;
+    get defaultSlippage(): number;
+    /**
+     * Execute a token swap
+     * @param params - Swap parameters including assets, amounts, and chain
+     * @returns Swap transaction data ready for execution
+     */
+    execute(params: SwapExecuteParams): Promise<SwapTransaction>;
+    /** Get price quote for a swap */
+    getPrice(params: SwapPriceParams): Promise<SwapPrice>;
+    /** Get a specific swap market by ID */
+    getMarket(params: GetSwapMarketParams): Promise<SwapMarket>;
+    /** Get available swap markets, optionally filtered by chainId or asset */
+    getMarkets(params?: GetSwapMarketsParams): Promise<SwapMarket[]>;
+    isChainSupported(chainId: SupportedChainId): boolean;
+    protected validateMarketAllowed(assetIn: Asset, assetOut: Asset, chainId: SupportedChainId): void;
+    protected resolveMarketConfig(assetIn: Asset, assetOut: Asset, chainId: SupportedChainId): SwapMarketConfig | undefined;
+    /**
+     * Build Permit2 approval transactions for an ERC20 swap input.
+     * Skipped for native assets. Checks both ERC20→Permit2 and Permit2→spender allowances in parallel.
+     * @param params - Resolved swap params (wallet address, asset info, chain)
+     * @param requiredAmount - Amount in wei that must be approved
+     * @param permit2Address - Permit2 contract address
+     * @param permit2Spender - The router/contract that Permit2 should approve (e.g. Universal Router)
+     * @param permit2ExpirySeconds - Optional custom expiry for the Permit2 approval
+     */
+    protected buildPermit2Approvals(params: ResolvedSwapParams, requiredAmount: bigint, permit2Address: Address, permit2Spender: Address, permit2ExpirySeconds?: number): Promise<{
+        tokenApproval: TransactionData | undefined;
+        permit2Approval: TransactionData | undefined;
+    }>;
+    private executeValidations;
+    private resolveParams;
+    private findMatchingConfig;
+    private containsPairByAddress;
+    abstract supportedChainIds(): SupportedChainId[];
+    protected abstract _execute(params: ResolvedSwapParams): Promise<SwapTransaction>;
+    protected abstract _getPrice(params: SwapPriceParams): Promise<SwapPrice>;
+    protected abstract _getMarket(params: GetSwapMarketParams): Promise<SwapMarket>;
+    protected abstract _getMarkets(params: GetSwapMarketsParams): Promise<SwapMarket[]>;
+}
+//# sourceMappingURL=SwapProvider.d.ts.map

package/dist/swap/core/SwapProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SwapProvider.d.ts","sourceRoot":"","sources":["../../../src/swap/core/SwapProvider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAEnC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAA;AACtE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAA;AAC9D,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAA;AAC7C,OAAO,KAAK,EACV,mBAAmB,EACnB,oBAAoB,EACpB,kBAAkB,EAClB,iBAAiB,EACjB,UAAU,EACV,gBAAgB,EAChB,SAAS,EACT,eAAe,EACf,kBAAkB,EAClB,eAAe,EAChB,MAAM,uBAAuB,CAAA;AAC9B,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAA;AA2B7D;;;;GAIG;AACH,8BAAsB,YAAY,CAChC,OAAO,SAAS,kBAAkB,GAAG,kBAAkB;IAEvD,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IACnC,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAA;gBAEjC,MAAM,EAAE,OAAO,EAAE,YAAY,EAAE,YAAY;IAKvD,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED,IAAI,eAAe,IAAI,MAAM,CAE5B;IAED;;;;OAIG;IACG,OAAO,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,eAAe,CAAC;IAUlE,iCAAiC;IAC3B,QAAQ,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,SAAS,CAAC;IAK3D,uCAAuC;IACjC,SAAS,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,CAAC;IAKjE,0EAA0E;IACpE,UAAU,CAAC,MAAM,GAAE,oBAAyB,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAO1E,gBAAgB,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO;IAQpD,SAAS,CAAC,qBAAqB,CAC7B,OAAO,EAAE,KAAK,EACd,QAAQ,EAAE,KAAK,EACf,OAAO,EAAE,gBAAgB,GACxB,IAAI;IAgCP,SAAS,CAAC,mBAAmB,CAC3B,OAAO,EAAE,KAAK,EACd,QAAQ,EAAE,KAAK,EACf,OAAO,EAAE,gBAAgB,GACxB,gBAAgB,GAAG,SAAS;IAU/B;;;;;;;;OAQG;cACa,qBAAqB,CACnC,MAAM,EAAE,kBAAkB,EAC1B,cAAc,EAAE,MAAM,EACtB,cAAc,EAAE,OAAO,EACvB,cAAc,EAAE,OAAO,EACvB,oBAAoB,CAAC,EAAE,MAAM,GAC5B,OAAO,CAAC;QACT,aAAa,EAAE,eAAe,GAAG,SAAS,CAAA;QAC1C,eAAe,EAAE,eAAe,GAAG,SAAS,CAAA;KAC7C,CAAC;IAkDF,OAAO,CAAC,kBAAkB;IAgB1B,OAAO,CAAC,aAAa;IAiBrB,OAAO,CAAC,kBAAkB;IAsB1B,OAAO,CAAC,qBAAqB;IAmB7B,QAAQ,CAAC,iBAAiB,IAAI,gBAAgB,EAAE;IAEhD,SAAS,CAAC,QAAQ,CAAC,QAAQ,CACzB,MAAM,EAAE,kBAAkB,GACzB,OAAO,CAAC,eAAe,CAAC;IAE3B,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,SAAS,CAAC;IAEzE,SAAS,CAAC,QAAQ,CAAC,UAAU,CAC3B,MAAM,EAAE,mBAAmB,GAC1B,OAAO,CAAC,UAAU,CAAC;IAEtB,SAAS,CAAC,QAAQ,CAAC,WAAW,CAC5B,MAAM,EAAE,oBAAoB,GAC3B,OAAO,CAAC,UAAU,EAAE,CAAC;CACzB"}

package/dist/swap/core/SwapProvider.js

@@ -0,0 +1,177 @@
+import { getAssetAddress, isNativeAsset, parseAssetAmount, } from '../../utils/assets.js';
+import { buildPermit2ApprovalTx, buildTokenApprovalTx, checkPermit2Allowance, checkTokenAllowance, } from '../../utils/permit2.js';
+import { validateAmountPositiveIfExists, validateAmountProvided, validateAssetOnChain, validateChainSupported, validateNotBothAmounts, validateNotSameAsset, validateNotZeroAddress, validateSlippage, } from '../../utils/validation.js';
+const DEFAULT_SLIPPAGE = 0.005;
+const DEFAULT_DEADLINE_OFFSET = 60;
+const DEFAULT_MAX_SLIPPAGE = 0.5;
+/**
+ * Abstract base class for swap providers.
+ * Public methods handle validation and conversion,
+ * protected abstract methods implement provider-specific logic.
+ */
+export class SwapProvider {
+    constructor(config, chainManager) {
+        this._config = config;
+        this.chainManager = chainManager;
+    }
+    get config() {
+        return this._config;
+    }
+    get defaultSlippage() {
+        return this._config.defaultSlippage ?? DEFAULT_SLIPPAGE;
+    }
+    /**
+     * Execute a token swap
+     * @param params - Swap parameters including assets, amounts, and chain
+     * @returns Swap transaction data ready for execution
+     */
+    async execute(params) {
+        this.executeValidations(params);
+        const resolvedParams = this.resolveParams(params);
+        validateSlippage(resolvedParams.slippage, this._config.maxSlippage ?? DEFAULT_MAX_SLIPPAGE);
+        return this._execute(resolvedParams);
+    }
+    /** Get price quote for a swap */
+    async getPrice(params) {
+        validateChainSupported(params.chainId, this.supportedChainIds());
+        return this._getPrice(params);
+    }
+    /** Get a specific swap market by ID */
+    async getMarket(params) {
+        validateChainSupported(params.chainId, this.supportedChainIds());
+        return this._getMarket(params);
+    }
+    /** Get available swap markets, optionally filtered by chainId or asset */
+    async getMarkets(params = {}) {
+        if (params.chainId) {
+            validateChainSupported(params.chainId, this.supportedChainIds());
+        }
+        return this._getMarkets(params);
+    }
+    isChainSupported(chainId) {
+        return this.supportedChainIds().includes(chainId);
+    }
+    // ─────────────────────────────────────────────────────────────────────────────
+    // Protected helpers
+    // ─────────────────────────────────────────────────────────────────────────────
+    validateMarketAllowed(assetIn, assetOut, chainId) {
+        const { marketBlocklist, marketAllowlist } = this._config;
+        if (marketBlocklist?.length) {
+            const isBlocked = this.findMatchingConfig(assetIn, assetOut, chainId, marketBlocklist);
+            if (isBlocked) {
+                throw new Error(`Pair ${assetIn.metadata.symbol}/${assetOut.metadata.symbol} is blocked on chain ${chainId}`);
+            }
+        }
+        if (marketAllowlist?.length) {
+            const isAllowed = this.findMatchingConfig(assetIn, assetOut, chainId, marketAllowlist);
+            if (!isAllowed) {
+                throw new Error(`Pair ${assetIn.metadata.symbol}/${assetOut.metadata.symbol} is not in the allowlist for chain ${chainId}`);
+            }
+        }
+    }
+    resolveMarketConfig(assetIn, assetOut, chainId) {
+        const { marketAllowlist } = this._config;
+        if (!marketAllowlist?.length) {
+            throw new Error('No markets configured. Provide a marketAllowlist in swap provider config.');
+        }
+        return this.findMatchingConfig(assetIn, assetOut, chainId, marketAllowlist);
+    }
+    /**
+     * Build Permit2 approval transactions for an ERC20 swap input.
+     * Skipped for native assets. Checks both ERC20→Permit2 and Permit2→spender allowances in parallel.
+     * @param params - Resolved swap params (wallet address, asset info, chain)
+     * @param requiredAmount - Amount in wei that must be approved
+     * @param permit2Address - Permit2 contract address
+     * @param permit2Spender - The router/contract that Permit2 should approve (e.g. Universal Router)
+     * @param permit2ExpirySeconds - Optional custom expiry for the Permit2 approval
+     */
+    async buildPermit2Approvals(params, requiredAmount, permit2Address, permit2Spender, permit2ExpirySeconds) {
+        if (isNativeAsset(params.assetIn)) {
+            return { tokenApproval: undefined, permit2Approval: undefined };
+        }
+        const publicClient = this.chainManager.getPublicClient(params.chainId);
+        const token = getAssetAddress(params.assetIn, params.chainId);
+        const [tokenAllowance, permit2Allowance] = await Promise.all([
+            checkTokenAllowance({
+                publicClient,
+                token,
+                owner: params.walletAddress,
+                spender: permit2Address,
+            }),
+            checkPermit2Allowance({
+                publicClient,
+                permit2Address,
+                owner: params.walletAddress,
+                token,
+                spender: permit2Spender,
+            }),
+        ]);
+        const tokenApproval = tokenAllowance < requiredAmount
+            ? buildTokenApprovalTx(token, permit2Address)
+            : undefined;
+        // Permit2 expiration is in Unix seconds (matching EVM block.timestamp)
+        const permit2Expired = permit2Allowance.expiration < Math.floor(Date.now() / 1000);
+        const permit2Approval = permit2Allowance.amount < requiredAmount || permit2Expired
+            ? buildPermit2ApprovalTx({
+                permit2Address,
+                token,
+                spender: permit2Spender,
+                amount: requiredAmount,
+                expirySeconds: permit2ExpirySeconds,
+            })
+            : undefined;
+        return { tokenApproval, permit2Approval };
+    }
+    // ─────────────────────────────────────────────────────────────────────────────
+    // Private helpers
+    // ─────────────────────────────────────────────────────────────────────────────
+    executeValidations(params) {
+        validateAmountProvided(params.amountIn, params.amountOut);
+        validateAmountPositiveIfExists(params.amountIn);
+        validateAmountPositiveIfExists(params.amountOut);
+        validateNotBothAmounts(params.amountIn, params.amountOut);
+        validateNotSameAsset(params.assetIn, params.assetOut);
+        validateNotZeroAddress(params.walletAddress, 'walletAddress');
+        if (params.recipient) {
+            validateNotZeroAddress(params.recipient, 'recipient');
+        }
+        validateChainSupported(params.chainId, this.supportedChainIds());
+        this.validateMarketAllowed(params.assetIn, params.assetOut, params.chainId);
+        validateAssetOnChain(params.assetIn, params.chainId);
+        validateAssetOnChain(params.assetOut, params.chainId);
+    }
+    resolveParams(params) {
+        return {
+            amountInWei: parseAssetAmount(params.assetIn, params.amountIn),
+            amountOutWei: parseAssetAmount(params.assetOut, params.amountOut),
+            assetIn: params.assetIn,
+            assetOut: params.assetOut,
+            slippage: params.slippage ?? this.defaultSlippage,
+            deadline: params.deadline ??
+                Math.floor(Date.now() / 1000) + DEFAULT_DEADLINE_OFFSET,
+            // Send output tokens to specified recipient, or back to the initiating wallet
+            recipient: params.recipient ?? params.walletAddress,
+            walletAddress: params.walletAddress,
+            chainId: params.chainId,
+        };
+    }
+    findMatchingConfig(assetIn, assetOut, chainId, list) {
+        const addressIn = assetIn.address[chainId];
+        const addressOut = assetOut.address[chainId];
+        if (!addressIn || !addressOut)
+            return undefined;
+        return list.find((config) => {
+            if (config.chainId !== undefined && config.chainId !== chainId)
+                return false;
+            return this.containsPairByAddress(addressIn, addressOut, chainId, config.assets);
+        });
+    }
+    containsPairByAddress(addressIn, addressOut, chainId, assets) {
+        const addresses = assets
+            .map((a) => a.address[chainId]?.toLowerCase())
+            .filter(Boolean);
+        return (addresses.includes(addressIn.toLowerCase()) &&
+            addresses.includes(addressOut.toLowerCase()));
+    }
+}
+//# sourceMappingURL=SwapProvider.js.map

package/dist/swap/core/SwapProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SwapProvider.js","sourceRoot":"","sources":["../../../src/swap/core/SwapProvider.ts"],"names":[],"mappings":"AAkBA,OAAO,EACL,eAAe,EACf,aAAa,EACb,gBAAgB,GACjB,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EACL,sBAAsB,EACtB,oBAAoB,EACpB,qBAAqB,EACrB,mBAAmB,GACpB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EACL,8BAA8B,EAC9B,sBAAsB,EACtB,oBAAoB,EACpB,sBAAsB,EACtB,sBAAsB,EACtB,oBAAoB,EACpB,sBAAsB,EACtB,gBAAgB,GACjB,MAAM,uBAAuB,CAAA;AAE9B,MAAM,gBAAgB,GAAG,KAAK,CAAA;AAC9B,MAAM,uBAAuB,GAAG,EAAE,CAAA;AAClC,MAAM,oBAAoB,GAAG,GAAG,CAAA;AAEhC;;;;GAIG;AACH,MAAM,OAAgB,YAAY;IAMhC,YAAY,MAAe,EAAE,YAA0B;QACrD,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;QACrB,IAAI,CAAC,YAAY,GAAG,YAAY,CAAA;IAClC,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;IAED,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,OAAO,CAAC,eAAe,IAAI,gBAAgB,CAAA;IACzD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,OAAO,CAAC,MAAyB;QACrC,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAA;QAC/B,MAAM,cAAc,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAA;QACjD,gBAAgB,CACd,cAAc,CAAC,QAAQ,EACvB,IAAI,CAAC,OAAO,CAAC,WAAW,IAAI,oBAAoB,CACjD,CAAA;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAA;IACtC,CAAC;IAED,iCAAiC;IACjC,KAAK,CAAC,QAAQ,CAAC,MAAuB;QACpC,sBAAsB,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAA;QAChE,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;IAC/B,CAAC;IAED,uCAAuC;IACvC,KAAK,CAAC,SAAS,CAAC,MAA2B;QACzC,sBAAsB,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAA;QAChE,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;IAChC,CAAC;IAED,0EAA0E;IAC1E,KAAK,CAAC,UAAU,CAAC,SAA+B,EAAE;QAChD,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACnB,sBAAsB,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAA;QAClE,CAAC;QACD,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;IACjC,CAAC;IAED,gBAAgB,CAAC,OAAyB;QACxC,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;IACnD,CAAC;IAED,gFAAgF;IAChF,oBAAoB;IACpB,gFAAgF;IAEtE,qBAAqB,CAC7B,OAAc,EACd,QAAe,EACf,OAAyB;QAEzB,MAAM,EAAE,eAAe,EAAE,eAAe,EAAE,GAAG,IAAI,CAAC,OAAO,CAAA;QAEzD,IAAI,eAAe,EAAE,MAAM,EAAE,CAAC;YAC5B,MAAM,SAAS,GAAG,IAAI,CAAC,kBAAkB,CACvC,OAAO,EACP,QAAQ,EACR,OAAO,EACP,eAAe,CAChB,CAAA;YACD,IAAI,SAAS,EAAE,CAAC;gBACd,MAAM,IAAI,KAAK,CACb,QAAQ,OAAO,CAAC,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,wBAAwB,OAAO,EAAE,CAC7F,CAAA;YACH,CAAC;QACH,CAAC;QAED,IAAI,eAAe,EAAE,MAAM,EAAE,CAAC;YAC5B,MAAM,SAAS,GAAG,IAAI,CAAC,kBAAkB,CACvC,OAAO,EACP,QAAQ,EACR,OAAO,EACP,eAAe,CAChB,CAAA;YACD,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,MAAM,IAAI,KAAK,CACb,QAAQ,OAAO,CAAC,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,sCAAsC,OAAO,EAAE,CAC3G,CAAA;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAES,mBAAmB,CAC3B,OAAc,EACd,QAAe,EACf,OAAyB;QAEzB,MAAM,EAAE,eAAe,EAAE,GAAG,IAAI,CAAC,OAAO,CAAA;QACxC,IAAI,CAAC,eAAe,EAAE,MAAM,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CACb,2EAA2E,CAC5E,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,eAAe,CAAC,CAAA;IAC7E,CAAC;IAED;;;;;;;;OAQG;IACO,KAAK,CAAC,qBAAqB,CACnC,MAA0B,EAC1B,cAAsB,EACtB,cAAuB,EACvB,cAAuB,EACvB,oBAA6B;QAK7B,IAAI,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;YAClC,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,eAAe,EAAE,SAAS,EAAE,CAAA;QACjE,CAAC;QAED,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;QACtE,MAAM,KAAK,GAAG,eAAe,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,CAAA;QAE7D,MAAM,CAAC,cAAc,EAAE,gBAAgB,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YAC3D,mBAAmB,CAAC;gBAClB,YAAY;gBACZ,KAAK;gBACL,KAAK,EAAE,MAAM,CAAC,aAAa;gBAC3B,OAAO,EAAE,cAAc;aACxB,CAAC;YACF,qBAAqB,CAAC;gBACpB,YAAY;gBACZ,cAAc;gBACd,KAAK,EAAE,MAAM,CAAC,aAAa;gBAC3B,KAAK;gBACL,OAAO,EAAE,cAAc;aACxB,CAAC;SACH,CAAC,CAAA;QAEF,MAAM,aAAa,GACjB,cAAc,GAAG,cAAc;YAC7B,CAAC,CAAC,oBAAoB,CAAC,KAAK,EAAE,cAAc,CAAC;YAC7C,CAAC,CAAC,SAAS,CAAA;QAEf,uEAAuE;QACvE,MAAM,cAAc,GAClB,gBAAgB,CAAC,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAA;QAC7D,MAAM,eAAe,GACnB,gBAAgB,CAAC,MAAM,GAAG,cAAc,IAAI,cAAc;YACxD,CAAC,CAAC,sBAAsB,CAAC;gBACrB,cAAc;gBACd,KAAK;gBACL,OAAO,EAAE,cAAc;gBACvB,MAAM,EAAE,cAAc;gBACtB,aAAa,EAAE,oBAAoB;aACpC,CAAC;YACJ,CAAC,CAAC,SAAS,CAAA;QAEf,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,CAAA;IAC3C,CAAC;IAED,gFAAgF;IAChF,kBAAkB;IAClB,gFAAgF;IAExE,kBAAkB,CAAC,MAAyB;QAClD,sBAAsB,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,SAAS,CAAC,CAAA;QACzD,8BAA8B,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;QAC/C,8BAA8B,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;QAChD,sBAAsB,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,SAAS,CAAC,CAAA;QACzD,oBAAoB,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAA;QACrD,sBAAsB,CAAC,MAAM,CAAC,aAAa,EAAE,eAAe,CAAC,CAAA;QAC7D,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;YACrB,sBAAsB,CAAC,MAAM,CAAC,SAAS,EAAE,WAAW,CAAC,CAAA;QACvD,CAAC;QACD,sBAAsB,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAA;QAChE,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAA;QAC3E,oBAAoB,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,CAAA;QACpD,oBAAoB,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAA;IACvD,CAAC;IAEO,aAAa,CAAC,MAAyB;QAC7C,OAAO;YACL,WAAW,EAAE,gBAAgB,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC;YAC9D,YAAY,EAAE,gBAAgB,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,SAAS,CAAC;YACjE,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,QAAQ,EAAE,MAAM,CAAC,QAAQ,IAAI,IAAI,CAAC,eAAe;YACjD,QAAQ,EACN,MAAM,CAAC,QAAQ;gBACf,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,GAAG,uBAAuB;YACzD,8EAA8E;YAC9E,SAAS,EAAE,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,aAAa;YACnD,aAAa,EAAE,MAAM,CAAC,aAAa;YACnC,OAAO,EAAE,MAAM,CAAC,OAAO;SACxB,CAAA;IACH,CAAC;IAEO,kBAAkB,CACxB,OAAc,EACd,QAAe,EACf,OAAyB,EACzB,IAAwB;QAExB,MAAM,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QAC1C,MAAM,UAAU,GAAG,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QAC5C,IAAI,CAAC,SAAS,IAAI,CAAC,UAAU;YAAE,OAAO,SAAS,CAAA;QAE/C,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;YAC1B,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,IAAI,MAAM,CAAC,OAAO,KAAK,OAAO;gBAC5D,OAAO,KAAK,CAAA;YACd,OAAO,IAAI,CAAC,qBAAqB,CAC/B,SAAS,EACT,UAAU,EACV,OAAO,EACP,MAAM,CAAC,MAAM,CACd,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAEO,qBAAqB,CAC3B,SAAiB,EACjB,UAAkB,EAClB,OAAyB,EACzB,MAAe;QAEf,MAAM,SAAS,GAAG,MAAM;aACrB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,WAAW,EAAE,CAAC;aAC7C,MAAM,CAAC,OAAO,CAAC,CAAA;QAClB,OAAO,CACL,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC;YAC3C,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAC7C,CAAA;IACH,CAAC;CAqBF"}

package/dist/swap/core/__tests__/SwapProvider.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=SwapProvider.test.d.ts.map

package/dist/swap/core/__tests__/SwapProvider.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SwapProvider.test.d.ts","sourceRoot":"","sources":["../../../../src/swap/core/__tests__/SwapProvider.test.ts"],"names":[],"mappings":""}