@steerprotocol/sdk 1.30.8 → 2.0.0

package/dist/esm/const/protocol.js

@@ -1,242 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isAlgebraHookSupported = exports.getProtcolTypeByAmmType = exports.isAlgebraIntegralV2Protocol = exports.isAerodromeVault = exports.isPoolSharkProtocol = exports.isAlgebraIntegralProtocol = exports.isAlgebraDirectionProtocol = exports.isThickV2Protocol = exports.isShadowProtocol = exports.isAlgebraProtocol = exports.ALGEBRA_INTEGRAL_V_2_0_PROTOCOLS = exports.AERODROME_PROTOCOLS = exports.ALGEBRA_INTEGRAL_PROTOCOLS = exports.POOLSHARK_PROTOCOLS = exports.DIRECTIONAL_ALGEBRA_PROTOCOLS = exports.SHADOW_PROTOCOLS = exports.ALGEBRA_PROTOCOLS = exports.StakingProtocol = void 0;
-exports.isValidStakingProtocol = isValidStakingProtocol;
-exports.normalizeProtocol = normalizeProtocol;
-const types_1 = require("../base/vault/single-asset/types");
-const chain_1 = require("./chain");
-/**
- * Enum representing supported staking protocols
- */
-var StakingProtocol;
-(function (StakingProtocol) {
-    StakingProtocol["Forge"] = "Forge";
-    StakingProtocol["Kinetix"] = "Kinetix";
-    StakingProtocol["Uniswap"] = "Uniswap";
-    StakingProtocol["SushiSwap"] = "SushiSwap";
-    StakingProtocol["QuickSwapV3"] = "QuickSwapV3";
-    StakingProtocol["ArthSwap"] = "ArthSwap";
-    StakingProtocol["arthswap"] = "arthswap";
-    StakingProtocol["Swapsicle"] = "Swapsicle";
-    StakingProtocol["Spark"] = "Spark";
-    StakingProtocol["Spark32"] = "Spark32";
-})(StakingProtocol || (exports.StakingProtocol = StakingProtocol = {}));
-/**
- * Checks if a given string is a valid StakingProtocol enum value.
- *
- * @param protocol - The protocol string to validate
- * @returns True if the protocol is a valid StakingProtocol, false otherwise
- * @example
- * ```typescript
- * if (isValidStakingProtocol('Uniswap')) {
- *   // Handle valid protocol
- * }
- * ```
- */
-function isValidStakingProtocol(protocol) {
-    // Convert the input protocol to title case (first letter uppercase, rest lowercase)
-    const normalizedProtocol = protocol.charAt(0).toUpperCase() + protocol.slice(1).toLowerCase();
-    return Object.values(StakingProtocol).includes(normalizedProtocol);
-}
-/**
- * Normalizes a protocol string to its corresponding StakingProtocol enum value.
- *
- * @param protocol - The protocol string to normalize
- * @returns The normalized StakingProtocol enum value
- * @throws Error if the protocol string is invalid
- * @example
- * ```typescript
- * const protocol = normalizeProtocol('uniswap');
- * // Returns: StakingProtocol.Uniswap
- * ```
- */
-function normalizeProtocol(protocol) {
-    const normalizedProtocol = protocol.charAt(0).toUpperCase() + protocol.slice(1).toLowerCase();
-    if (!isValidStakingProtocol(normalizedProtocol)) {
-        throw new Error(`Invalid protocol: ${protocol}`);
-    }
-    return normalizedProtocol;
-}
-/**
- * List of protocols that implement the Algebra interface
- */
-exports.ALGEBRA_PROTOCOLS = [
-    chain_1.Protocol.QuickSwap,
-    chain_1.Protocol.Wasabee,
-    chain_1.Protocol.Beam,
-    chain_1.Protocol.QuickSwapIntegral,
-    chain_1.Protocol.SilverSwap,
-    chain_1.Protocol.Ocelex,
-    chain_1.Protocol.Henjin,
-    chain_1.Protocol.Camelot,
-    chain_1.Protocol.Ocelex,
-    chain_1.Protocol.Lynex,
-    chain_1.Protocol.Thena,
-    chain_1.Protocol.Hercules,
-    chain_1.Protocol.QuickSwapAlgebra,
-    chain_1.Protocol.Kim,
-    chain_1.Protocol.Swapsicle,
-    chain_1.Protocol.Fenix,
-    chain_1.Protocol.StellaSwap,
-    chain_1.Protocol.Glyph,
-    chain_1.Protocol.KatanaIntegral,
-    chain_1.Protocol.Blackhole,
-    chain_1.Protocol.Nest,
-    chain_1.Protocol.Cypher,
-    chain_1.Protocol.SparkIntegral,
-];
-exports.SHADOW_PROTOCOLS = [chain_1.Protocol.Shadow, chain_1.Protocol.MachineX];
-/**
- * List of protocols that implement directional Algebra interface
- */
-exports.DIRECTIONAL_ALGEBRA_PROTOCOLS = [chain_1.Protocol.Camelot, chain_1.Protocol.Hercules];
-/**
- * List of protocols that implement the PoolShark interface
- */
-exports.POOLSHARK_PROTOCOLS = [chain_1.Protocol.PoolShark];
-/**
- * List of protocols that implement the Algebra Integral interface
- */
-exports.ALGEBRA_INTEGRAL_PROTOCOLS = [
-    chain_1.Protocol.Kim,
-    chain_1.Protocol.Wasabee,
-    chain_1.Protocol.Swapsicle,
-    chain_1.Protocol.QuickSwapIntegral,
-    chain_1.Protocol.Fenix,
-    chain_1.Protocol.Henjin,
-    chain_1.Protocol.SilverSwap,
-    chain_1.Protocol.Beam,
-    chain_1.Protocol.Glyph,
-    chain_1.Protocol.KatanaIntegral,
-    chain_1.Protocol.Blackhole,
-    chain_1.Protocol.Nest,
-    chain_1.Protocol.Cypher,
-    chain_1.Protocol.SparkIntegral,
-];
-exports.AERODROME_PROTOCOLS = [chain_1.Protocol.Aerodrome, chain_1.Protocol.AerodromeV2, chain_1.Protocol.Cypher];
-exports.ALGEBRA_INTEGRAL_V_2_0_PROTOCOLS = [
-    chain_1.Protocol.QuickSwapIntegral,
-    chain_1.Protocol.Wasabee,
-    chain_1.Protocol.KatanaIntegral,
-    chain_1.Protocol.Blackhole,
-    chain_1.Protocol.Cypher,
-    chain_1.Protocol.SparkIntegral,
-];
-/**
- * List of protocols that implement the Thick interface
- */
-const THICK_PROTOCOLS = [chain_1.Protocol.ThickV2];
-/**
- * Checks if a protocol implements the Algebra interface.
- *
- * @param protocol - The protocol to check
- * @returns True if the protocol implements Algebra, false otherwise
- */
-const isAlgebraProtocol = (protocol) => {
-    return exports.ALGEBRA_PROTOCOLS.includes(protocol);
-};
-exports.isAlgebraProtocol = isAlgebraProtocol;
-/**
- * Checks if a protocol implements the Shadow interface.
- *
- * @param protocol - The protocol to check
- * @returns True if the protocol implements Shadow, false otherwise
- */
-const isShadowProtocol = (protocol) => {
-    return exports.SHADOW_PROTOCOLS.includes(protocol);
-};
-exports.isShadowProtocol = isShadowProtocol;
-/**
- * Checks if a protocol implements the ThickV2 interface.
- *
- * @param protocol - The protocol to check
- * @returns True if the protocol implements ThickV2, false otherwise
- */
-const isThickV2Protocol = (protocol) => {
-    return THICK_PROTOCOLS.includes(protocol);
-};
-exports.isThickV2Protocol = isThickV2Protocol;
-/**
- * Checks if a protocol implements the Algebra Direction interface.
- *
- * @param protocol - The protocol to check
- * @returns True if the protocol implements Algebra Direction, false otherwise
- */
-const isAlgebraDirectionProtocol = (protocol) => {
-    return exports.DIRECTIONAL_ALGEBRA_PROTOCOLS.includes(protocol);
-};
-exports.isAlgebraDirectionProtocol = isAlgebraDirectionProtocol;
-/**
- * Checks if a protocol implements the Algebra Integral interface.
- *
- * @param protocol - The protocol to check
- * @returns True if the protocol implements Algebra Integral, false otherwise
- */
-const isAlgebraIntegralProtocol = (protocol) => {
-    return exports.ALGEBRA_INTEGRAL_PROTOCOLS.includes(protocol);
-};
-exports.isAlgebraIntegralProtocol = isAlgebraIntegralProtocol;
-/**
- * Checks if a protocol implements the PoolShark interface.
- *
- * @param protocol - The protocol to check
- * @returns True if the protocol implements PoolShark, false otherwise
- */
-const isPoolSharkProtocol = (protocol) => {
-    return exports.POOLSHARK_PROTOCOLS.includes(protocol);
-};
-exports.isPoolSharkProtocol = isPoolSharkProtocol;
-const isAerodromeVault = (protocol) => {
-    return exports.AERODROME_PROTOCOLS.includes(protocol);
-};
-exports.isAerodromeVault = isAerodromeVault;
-const isAlgebraIntegralV2Protocol = (protocol) => {
-    return exports.ALGEBRA_INTEGRAL_V_2_0_PROTOCOLS.includes(protocol);
-};
-exports.isAlgebraIntegralV2Protocol = isAlgebraIntegralV2Protocol;
-const getProtcolTypeByAmmType = (ammType) => {
-    if (ammType === types_1.AMMType.Algebra) {
-        return chain_1.Protocol.QuickSwap;
-    }
-    if (ammType === types_1.AMMType.AlgebraDirectional) {
-        return chain_1.Protocol.Camelot;
-    }
-    if (ammType === types_1.AMMType.AlgebraIntegral) {
-        return chain_1.Protocol.QuickSwapIntegral;
-    }
-    if (ammType === types_1.AMMType.UniswapV3) {
-        return chain_1.Protocol.Uniswap;
-    }
-    if (ammType === types_1.AMMType.Aerodrome) {
-        return chain_1.Protocol.Aerodrome;
-    }
-    throw Error('Protocol type not found');
-};
-exports.getProtcolTypeByAmmType = getProtcolTypeByAmmType;
-/**
- * Checks if a protocol supports algebraHook for a given chain.
- *
- * @param protocolInfo - The protocol information object
- * @param chain - The chain to check for algebraHook support
- * @returns True if the protocol supports algebraHook on the given chain, false otherwise
- * @example
- * ```typescript
- * const protocolInfo = `getProtocolInfoBy`Name('QuickSwapIntegral', 'api-key');
- * if (isAlgebraHookSupported(protocolInfo, Chain.Base)) {
- *   // Protocol supports algebraHook on Base chain
- * }
- * ```
- */
-const isAlgebraHookSupported = (protocolInfo, chain) => {
-    if (!protocolInfo) {
-        return false;
-    }
-    // Check if the protocol has algebraHook supported chains defined
-    if (protocolInfo.algebraHookSupportedChains && Array.isArray(protocolInfo.algebraHookSupportedChains)) {
-        return protocolInfo.algebraHookSupportedChains.includes(chain);
-    }
-    // Fallback: if no specific chains are defined but beaconAlgebraHook exists, assume it's supported
-    return !!protocolInfo.beaconAlgebraHook;
-};
-exports.isAlgebraHookSupported = isAlgebraHookSupported;
-//# sourceMappingURL=protocol.js.map

package/dist/esm/const/protocol.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"protocol.js","sourceRoot":"","sources":["../../../src/const/protocol.ts"],"names":[],"mappings":";;;AAgCA,wDAIC;AAcD,8CAMC;AAxDD,4DAA2D;AAE3D,mCAA0C;AAE1C;;GAEG;AACH,IAAY,eAWX;AAXD,WAAY,eAAe;IACzB,kCAAe,CAAA;IACf,sCAAmB,CAAA;IACnB,sCAAmB,CAAA;IACnB,0CAAuB,CAAA;IACvB,8CAA2B,CAAA;IAC3B,wCAAqB,CAAA;IACrB,wCAAqB,CAAA;IACrB,0CAAuB,CAAA;IACvB,kCAAe,CAAA;IACf,sCAAmB,CAAA;AACrB,CAAC,EAXW,eAAe,+BAAf,eAAe,QAW1B;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,sBAAsB,CAAC,QAAgB;IACrD,oFAAoF;IACpF,MAAM,kBAAkB,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;IAC9F,OAAO,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,QAAQ,CAAC,kBAAqC,CAAC,CAAC;AACxF,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,iBAAiB,CAAC,QAAgB;IAChD,MAAM,kBAAkB,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;IAC9F,IAAI,CAAC,sBAAsB,CAAC,kBAAkB,CAAC,EAAE,CAAC;QAChD,MAAM,IAAI,KAAK,CAAC,qBAAqB,QAAQ,EAAE,CAAC,CAAC;IACnD,CAAC;IACD,OAAO,kBAAqC,CAAC;AAC/C,CAAC;AAED;;GAEG;AAGU,QAAA,iBAAiB,GAAG;IAC/B,gBAAQ,CAAC,SAAS;IAClB,gBAAQ,CAAC,OAAO;IAChB,gBAAQ,CAAC,IAAI;IACb,gBAAQ,CAAC,iBAAiB;IAC1B,gBAAQ,CAAC,UAAU;IACnB,gBAAQ,CAAC,MAAM;IACf,gBAAQ,CAAC,MAAM;IACf,gBAAQ,CAAC,OAAO;IAChB,gBAAQ,CAAC,MAAM;IACf,gBAAQ,CAAC,KAAK;IACd,gBAAQ,CAAC,KAAK;IACd,gBAAQ,CAAC,QAAQ;IACjB,gBAAQ,CAAC,gBAAgB;IACzB,gBAAQ,CAAC,GAAG;IACZ,gBAAQ,CAAC,SAAS;IAClB,gBAAQ,CAAC,KAAK;IACd,gBAAQ,CAAC,UAAU;IACnB,gBAAQ,CAAC,KAAK;IACd,gBAAQ,CAAC,cAAc;IACvB,gBAAQ,CAAC,SAAS;IAClB,gBAAQ,CAAC,IAAI;IACb,gBAAQ,CAAC,MAAM;IACf,gBAAQ,CAAC,aAAa;CACvB,CAAC;AAEW,QAAA,gBAAgB,GAAG,CAAC,gBAAQ,CAAC,MAAM,EAAE,gBAAQ,CAAC,QAAQ,CAAC,CAAC;AAErE;;GAEG;AACU,QAAA,6BAA6B,GAAG,CAAC,gBAAQ,CAAC,OAAO,EAAE,gBAAQ,CAAC,QAAQ,CAAC,CAAC;AAEnF;;GAEG;AACU,QAAA,mBAAmB,GAAG,CAAC,gBAAQ,CAAC,SAAS,CAAC,CAAC;AAExD;;GAEG;AACU,QAAA,0BAA0B,GAAG;IACxC,gBAAQ,CAAC,GAAG;IACZ,gBAAQ,CAAC,OAAO;IAChB,gBAAQ,CAAC,SAAS;IAClB,gBAAQ,CAAC,iBAAiB;IAC1B,gBAAQ,CAAC,KAAK;IACd,gBAAQ,CAAC,MAAM;IACf,gBAAQ,CAAC,UAAU;IACnB,gBAAQ,CAAC,IAAI;IACb,gBAAQ,CAAC,KAAK;IACd,gBAAQ,CAAC,cAAc;IACvB,gBAAQ,CAAC,SAAS;IAClB,gBAAQ,CAAC,IAAI;IACb,gBAAQ,CAAC,MAAM;IACf,gBAAQ,CAAC,aAAa;CACvB,CAAC;AAEW,QAAA,mBAAmB,GAAG,CAAC,gBAAQ,CAAC,SAAS,EAAE,gBAAQ,CAAC,WAAW,EAAE,gBAAQ,CAAC,MAAM,CAAC,CAAC;AAElF,QAAA,gCAAgC,GAAG;IAC9C,gBAAQ,CAAC,iBAAiB;IAC1B,gBAAQ,CAAC,OAAO;IAChB,gBAAQ,CAAC,cAAc;IACvB,gBAAQ,CAAC,SAAS;IAClB,gBAAQ,CAAC,MAAM;IACf,gBAAQ,CAAC,aAAa;CACvB,CAAA;AAED;;GAEG;AACH,MAAM,eAAe,GAAG,CAAC,gBAAQ,CAAC,OAAO,CAAC,CAAC;AAE3C;;;;;GAKG;AACI,MAAM,iBAAiB,GAAG,CAAC,QAA2B,EAAE,EAAE;IAC/D,OAAO,yBAAiB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AAC9C,CAAC,CAAC;AAFW,QAAA,iBAAiB,qBAE5B;AAGF;;;;;GAKG;AACI,MAAM,gBAAgB,GAAG,CAAC,QAA2B,EAAE,EAAE;IAC9D,OAAO,wBAAgB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AAC7C,CAAC,CAAC;AAFW,QAAA,gBAAgB,oBAE3B;AAEF;;;;;GAKG;AACI,MAAM,iBAAiB,GAAG,CAAC,QAA2B,EAAE,EAAE;IAC/D,OAAO,eAAe,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AAC5C,CAAC,CAAC;AAFW,QAAA,iBAAiB,qBAE5B;AAEF;;;;;GAKG;AACI,MAAM,0BAA0B,GAAG,CAAC,QAA2B,EAAE,EAAE;IACxE,OAAO,qCAA6B,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AAC1D,CAAC,CAAC;AAFW,QAAA,0BAA0B,8BAErC;AAEF;;;;;GAKG;AACI,MAAM,yBAAyB,GAAG,CAAC,QAA2B,EAAE,EAAE;IACvE,OAAO,kCAA0B,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AACvD,CAAC,CAAC;AAFW,QAAA,yBAAyB,6BAEpC;AAGF;;;;;GAKG;AACI,MAAM,mBAAmB,GAAG,CAAC,QAA2B,EAAE,EAAE;IACjE,OAAO,2BAAmB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AAChD,CAAC,CAAC;AAFW,QAAA,mBAAmB,uBAE9B;AAGK,MAAM,gBAAgB,GAAG,CAAC,QAA2B,EAAW,EAAE;IACrE,OAAO,2BAAmB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AAClD,CAAC,CAAA;AAFY,QAAA,gBAAgB,oBAE5B;AAEM,MAAM,2BAA2B,GAAG,CAAC,QAA2B,EAAW,EAAE;IAClF,OAAO,wCAAgC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AAC7D,CAAC,CAAA;AAFY,QAAA,2BAA2B,+BAEvC;AAEM,MAAM,uBAAuB,GAAG,CAAC,OAAgB,EAAY,EAAE;IAEpE,IAAI,OAAO,KAAK,eAAO,CAAC,OAAO,EAAE,CAAC;QAChC,OAAO,gBAAQ,CAAC,SAAS,CAAA;IAC3B,CAAC;IAED,IAAI,OAAO,KAAK,eAAO,CAAC,kBAAkB,EAAE,CAAC;QAC3C,OAAO,gBAAQ,CAAC,OAAO,CAAA;IACzB,CAAC;IAED,IAAI,OAAO,KAAK,eAAO,CAAC,eAAe,EAAE,CAAC;QACxC,OAAO,gBAAQ,CAAC,iBAAiB,CAAA;IACnC,CAAC;IAED,IAAI,OAAO,KAAK,eAAO,CAAC,SAAS,EAAE,CAAC;QAClC,OAAO,gBAAQ,CAAC,OAAO,CAAA;IACzB,CAAC;IAED,IAAI,OAAO,KAAK,eAAO,CAAC,SAAS,EAAE,CAAC;QAClC,OAAO,gBAAQ,CAAC,SAAS,CAAA;IAC3B,CAAC;IAED,MAAM,KAAK,CAAC,yBAAyB,CAAC,CAAA;AACxC,CAAC,CAAA;AAvBY,QAAA,uBAAuB,2BAuBnC;AAED;;;;;;;;;;;;;GAaG;AACI,MAAM,sBAAsB,GAAG,CAAC,YAAsC,EAAE,KAAY,EAAW,EAAE;IACtG,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,iEAAiE;IACjE,IAAI,YAAY,CAAC,0BAA0B,IAAI,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,0BAA0B,CAAC,EAAE,CAAC;QACtG,OAAO,YAAY,CAAC,0BAA0B,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACjE,CAAC;IAED,kGAAkG;IAClG,OAAO,CAAC,CAAC,YAAY,CAAC,iBAAiB,CAAC;AAC1C,CAAC,CAAA;AAZY,QAAA,sBAAsB,0BAYlC","sourcesContent":["import { AMMType } from '../base/vault/single-asset/types';\nimport { SupportedProtocol, ProtocolInfo } from '../types';\nimport { Protocol, Chain } from './chain';\n\n/**\n * Enum representing supported staking protocols\n */\nexport enum StakingProtocol {\n  Forge = 'Forge',\n  Kinetix = 'Kinetix',\n  Uniswap = 'Uniswap',\n  SushiSwap = 'SushiSwap',\n  QuickSwapV3 = 'QuickSwapV3',\n  ArthSwap = 'ArthSwap',\n  arthswap = 'arthswap',\n  Swapsicle = 'Swapsicle',\n  Spark = 'Spark',\n  Spark32 = 'Spark32',\n}\n\n/**\n * Checks if a given string is a valid StakingProtocol enum value.\n *\n * @param protocol - The protocol string to validate\n * @returns True if the protocol is a valid StakingProtocol, false otherwise\n * @example\n * ```typescript\n * if (isValidStakingProtocol('Uniswap')) {\n *   // Handle valid protocol\n * }\n * ```\n */\nexport function isValidStakingProtocol(protocol: string): protocol is StakingProtocol {\n  // Convert the input protocol to title case (first letter uppercase, rest lowercase)\n  const normalizedProtocol = protocol.charAt(0).toUpperCase() + protocol.slice(1).toLowerCase();\n  return Object.values(StakingProtocol).includes(normalizedProtocol as StakingProtocol);\n}\n\n/**\n * Normalizes a protocol string to its corresponding StakingProtocol enum value.\n *\n * @param protocol - The protocol string to normalize\n * @returns The normalized StakingProtocol enum value\n * @throws Error if the protocol string is invalid\n * @example\n * ```typescript\n * const protocol = normalizeProtocol('uniswap');\n * // Returns: StakingProtocol.Uniswap\n * ```\n */\nexport function normalizeProtocol(protocol: string): StakingProtocol {\n  const normalizedProtocol = protocol.charAt(0).toUpperCase() + protocol.slice(1).toLowerCase();\n  if (!isValidStakingProtocol(normalizedProtocol)) {\n    throw new Error(`Invalid protocol: ${protocol}`);\n  }\n  return normalizedProtocol as StakingProtocol;\n}\n\n/**\n * List of protocols that implement the Algebra interface\n */\n\n\nexport const ALGEBRA_PROTOCOLS = [\n  Protocol.QuickSwap,\n  Protocol.Wasabee,\n  Protocol.Beam,\n  Protocol.QuickSwapIntegral,\n  Protocol.SilverSwap,\n  Protocol.Ocelex,\n  Protocol.Henjin,\n  Protocol.Camelot,\n  Protocol.Ocelex,\n  Protocol.Lynex,\n  Protocol.Thena,\n  Protocol.Hercules,\n  Protocol.QuickSwapAlgebra,\n  Protocol.Kim,\n  Protocol.Swapsicle,\n  Protocol.Fenix,\n  Protocol.StellaSwap,\n  Protocol.Glyph,\n  Protocol.KatanaIntegral,\n  Protocol.Blackhole,\n  Protocol.Nest,\n  Protocol.Cypher,\n  Protocol.SparkIntegral,\n];\n\nexport const SHADOW_PROTOCOLS = [Protocol.Shadow, Protocol.MachineX];\n\n/**\n * List of protocols that implement directional Algebra interface\n */\nexport const DIRECTIONAL_ALGEBRA_PROTOCOLS = [Protocol.Camelot, Protocol.Hercules];\n\n/**\n * List of protocols that implement the PoolShark interface\n */\nexport const POOLSHARK_PROTOCOLS = [Protocol.PoolShark];\n\n/**\n * List of protocols that implement the Algebra Integral interface\n */\nexport const ALGEBRA_INTEGRAL_PROTOCOLS = [\n  Protocol.Kim,\n  Protocol.Wasabee,\n  Protocol.Swapsicle,\n  Protocol.QuickSwapIntegral,\n  Protocol.Fenix,\n  Protocol.Henjin,\n  Protocol.SilverSwap,\n  Protocol.Beam,\n  Protocol.Glyph,\n  Protocol.KatanaIntegral,\n  Protocol.Blackhole,\n  Protocol.Nest,\n  Protocol.Cypher,\n  Protocol.SparkIntegral,\n];\n\nexport const AERODROME_PROTOCOLS = [Protocol.Aerodrome, Protocol.AerodromeV2, Protocol.Cypher];\n\nexport const ALGEBRA_INTEGRAL_V_2_0_PROTOCOLS = [\n  Protocol.QuickSwapIntegral,\n  Protocol.Wasabee,\n  Protocol.KatanaIntegral,\n  Protocol.Blackhole,\n  Protocol.Cypher,\n  Protocol.SparkIntegral,\n]\n\n/**\n * List of protocols that implement the Thick interface\n */\nconst THICK_PROTOCOLS = [Protocol.ThickV2];\n\n/**\n * Checks if a protocol implements the Algebra interface.\n *\n * @param protocol - The protocol to check\n * @returns True if the protocol implements Algebra, false otherwise\n */\nexport const isAlgebraProtocol = (protocol: SupportedProtocol) => {\n  return ALGEBRA_PROTOCOLS.includes(protocol);\n};\n\n\n/**\n * Checks if a protocol implements the Shadow interface.\n *\n * @param protocol - The protocol to check\n * @returns True if the protocol implements Shadow, false otherwise\n */\nexport const isShadowProtocol = (protocol: SupportedProtocol) => {\n  return SHADOW_PROTOCOLS.includes(protocol);\n};\n\n/**\n * Checks if a protocol implements the ThickV2 interface.\n *\n * @param protocol - The protocol to check\n * @returns True if the protocol implements ThickV2, false otherwise\n */\nexport const isThickV2Protocol = (protocol: SupportedProtocol) => {\n  return THICK_PROTOCOLS.includes(protocol);\n};\n\n/**\n * Checks if a protocol implements the Algebra Direction interface.\n *\n * @param protocol - The protocol to check\n * @returns True if the protocol implements Algebra Direction, false otherwise\n */\nexport const isAlgebraDirectionProtocol = (protocol: SupportedProtocol) => {\n  return DIRECTIONAL_ALGEBRA_PROTOCOLS.includes(protocol);\n};\n\n/**\n * Checks if a protocol implements the Algebra Integral interface.\n *\n * @param protocol - The protocol to check\n * @returns True if the protocol implements Algebra Integral, false otherwise\n */\nexport const isAlgebraIntegralProtocol = (protocol: SupportedProtocol) => {\n  return ALGEBRA_INTEGRAL_PROTOCOLS.includes(protocol);\n};\n\n\n/**\n * Checks if a protocol implements the PoolShark interface.\n *\n * @param protocol - The protocol to check\n * @returns True if the protocol implements PoolShark, false otherwise\n */\nexport const isPoolSharkProtocol = (protocol: SupportedProtocol) => {\n  return POOLSHARK_PROTOCOLS.includes(protocol);\n};\n\n\nexport const isAerodromeVault = (protocol: SupportedProtocol): boolean => {\n    return AERODROME_PROTOCOLS.includes(protocol);\n}\n\nexport const isAlgebraIntegralV2Protocol = (protocol: SupportedProtocol): boolean => {\n  return ALGEBRA_INTEGRAL_V_2_0_PROTOCOLS.includes(protocol);\n}\n\nexport const getProtcolTypeByAmmType = (ammType: AMMType): Protocol => {\n\n  if (ammType === AMMType.Algebra) {\n    return Protocol.QuickSwap\n  }\n\n  if (ammType === AMMType.AlgebraDirectional) {\n    return Protocol.Camelot\n  }\n\n  if (ammType === AMMType.AlgebraIntegral) {\n    return Protocol.QuickSwapIntegral\n  }\n\n  if (ammType === AMMType.UniswapV3) {\n    return Protocol.Uniswap\n  }\n\n  if (ammType === AMMType.Aerodrome) {\n    return Protocol.Aerodrome\n  }\n\n  throw Error('Protocol type not found')\n}\n\n/**\n * Checks if a protocol supports algebraHook for a given chain.\n *\n * @param protocolInfo - The protocol information object\n * @param chain - The chain to check for algebraHook support\n * @returns True if the protocol supports algebraHook on the given chain, false otherwise\n * @example\n * ```typescript\n * const protocolInfo = `getProtocolInfoBy`Name('QuickSwapIntegral', 'api-key');\n * if (isAlgebraHookSupported(protocolInfo, Chain.Base)) {\n *   // Protocol supports algebraHook on Base chain\n * }\n * ```\n */\nexport const isAlgebraHookSupported = (protocolInfo: ProtocolInfo | undefined, chain: Chain): boolean => {\n  if (!protocolInfo) {\n    return false;\n  }\n  \n  // Check if the protocol has algebraHook supported chains defined\n  if (protocolInfo.algebraHookSupportedChains && Array.isArray(protocolInfo.algebraHookSupportedChains)) {\n    return protocolInfo.algebraHookSupportedChains.includes(chain);\n  }\n  \n  // Fallback: if no specific chains are defined but beaconAlgebraHook exists, assume it's supported\n  return !!protocolInfo.beaconAlgebraHook;\n} "]}

package/dist/esm/const/quoter.js

@@ -1,425 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.QuoterV2Factory = void 0;
-exports.isUniswapQuoteParams = isUniswapQuoteParams;
-exports.isAlgebraQuoteParams = isAlgebraQuoteParams;
-exports.isThickQuoteParams = isThickQuoteParams;
-exports.isAlgebraIntegral21QuoteParams = isAlgebraIntegral21QuoteParams;
-exports.isShadowQuoteParams = isShadowQuoteParams;
-exports.validateQuoteParams = validateQuoteParams;
-exports.getExpectedParamType = getExpectedParamType;
-const viem_1 = require("viem");
-const chain_js_1 = require("./chain.js");
-const beacon_js_1 = require("./amm/utils/beacon.js");
-const protocol_js_1 = require("./protocol.js");
-const quoter_js_1 = require("./abis/quoter.js");
-const index_js_1 = require("./amm/index.js");
-/**
- * Factory class for creating QuoterV2 contract instances with the appropriate ABI
- * based on the protocol type detected from beacon names.
- *
- * @example
- * ```typescript
- * import { createPublicClient, http, parseEther } from 'viem';
- * import { polygon } from 'viem/chains';
- * import { QuoterV2Factory } from './quoter.js';
- *
- * // Create a viem client
- * const client = createPublicClient({
- *   chain: polygon,
- *   transport: http()
- * });
- *
- * // Configure network with quoter addresses
- * const networkConfig = {
- *   quoterV2: {
- *     'QuickSwap': '0x...',
- *     'Uniswap': '0x...',
- *     'ThickV2': '0x...',
- *     'Shadow': '0x...',
- *     'KatanaIntegral': '0x...'
- *   }
- * };
- *
- * const factory = new QuoterV2Factory(networkConfig);
- *
- * // Example 1: Uniswap V3 style (fee-based)
- * const { quoter: uniQuoter, params: uniParams } = factory.createQuoterWithParams('uniswap', client, {
- *   tokenIn: '0xA0b86a33E6f73c7C6789b65f71C1ab8EbAbD3A01',
- *   tokenOut: '0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174',
- *   amountIn: parseEther('1'),
- *   fee: 3000,
- *   sqrtPriceLimitX96: 0n
- * });
- *
- * // Example 2: QuickSwap (Algebra style)
- * const { quoter: quickQuoter, params: quickParams } = factory.createQuoterWithParams('quickswap', client, {
- *   tokenIn: '0xA0b86a33E6f73c7C6789b65f71C1ab8EbAbD3A01',
- *   tokenOut: '0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174',
- *   amountIn: parseEther('1'),
- *   limitSqrtPrice: 0n
- * });
- *
- * // Example 3: Thick V2 (tick spacing)
- * const { quoter: thickQuoter, params: thickParams } = factory.createQuoterWithParams('thickv2', client, {
- *   tokenIn: '0xA0b86a33E6f73c7C6789b65f71C1ab8EbAbD3A01',
- *   tokenOut: '0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174',
- *   amountIn: parseEther('1'),
- *   tickSpacing: 60,
- *   sqrtPriceLimitX96: 0n
- * });
- *
- * // Example 4: Katana Integral (with deployer)
- * const { quoter: katanaQuoter, params: katanaParams } = factory.createQuoterWithParams('katanaintegral', client, {
- *   tokenIn: '0xA0b86a33E6f73c7C6789b65f71C1ab8EbAbD3A01',
- *   tokenOut: '0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174',
- *   amountIn: parseEther('1'),
- *   deployer: '0x...',
- *   limitSqrtPrice: 0n
- * });
- *
- * // Use the quoter contracts
- * const uniResult = await uniQuoter.read.quoteExactInputSingle([uniParams]);
- * const quickResult = await quickQuoter.read.quoteExactInputSingle([quickParams]);
- * const thickResult = await thickQuoter.read.quoteExactInputSingle([thickParams]);
- * const katanaResult = await katanaQuoter.read.quoteExactInputSingle([katanaParams]);
- * ```
- */
-class QuoterV2Factory {
-    constructor(networkConfig) {
-        this.networkConfig = networkConfig;
-    }
-    /**
-     * Creates quote parameters for the quoteExactInputSingle function based on the protocol type.
-     *
-     * @param beaconName - The beacon identifier to determine the protocol type
-     * @param params - The input parameters for the quote
-     * @returns Formatted parameters object for the specific protocol's quoteExactInputSingle function
-     * @throws Error if protocol type is not supported
-     *
-     * @example
-     * ```typescript
-     * const factory = new QuoterV2Factory(networkConfig);
-     *
-     * // For Uniswap V3
-     * const uniParams = factory.getQuoteParams('uniswap', {
-     *   tokenIn: '0x...',
-     *   tokenOut: '0x...',
-     *   amountIn: parseEther('1'),
-     *   fee: 3000,
-     *   sqrtPriceLimitX96: 0n
-     * });
-     *
-     * // For QuickSwap (Algebra)
-     * const quickParams = factory.getQuoteParams('quickswap', {
-     *   tokenIn: '0x...',
-     *   tokenOut: '0x...',
-     *   amountIn: parseEther('1'),
-     *   limitSqrtPrice: 0n
-     * });
-     * ```
-     */
-    getQuoteParams(protocol, params) {
-        // Validate parameters first
-        validateQuoteParams(protocol, params);
-        if (!protocol) {
-            throw Error('Protocol not found');
-        }
-        // Check for Algebra Integral v2.1 vaults (newer version with deployer)
-        if (this.isAlgebraIntegral21Vault(protocol)) {
-            const p = params;
-            return {
-                tokenIn: p.tokenIn,
-                tokenOut: p.tokenOut,
-                deployer: p.deployer,
-                amountIn: p.amountIn,
-                limitSqrtPrice: p.limitSqrtPrice || 0n
-            };
-        }
-        // Check for Shadow protocol vaults
-        if ((0, protocol_js_1.isShadowProtocol)(protocol)) {
-            const p = params;
-            return {
-                tokenIn: p.tokenIn,
-                tokenOut: p.tokenOut,
-                amountIn: p.amountIn,
-                tickSpacing: p.tickSpacing,
-                sqrtPriceLimitX96: p.sqrtPriceLimitX96 || 0n
-            };
-        }
-        // Check for Algebra Integral vaults (older version)
-        if ((0, protocol_js_1.isAlgebraIntegralProtocol)(protocol)) {
-            const p = params;
-            return {
-                tokenIn: p.tokenIn,
-                tokenOut: p.tokenOut,
-                amountIn: p.amountIn,
-                limitSqrtPrice: p.limitSqrtPrice || 0n
-            };
-        }
-        // Check for Algebra-based protocols (QuickSwap, etc.)
-        if (protocol && (0, protocol_js_1.isAlgebraProtocol)(protocol)) {
-            const p = params;
-            return {
-                tokenIn: p.tokenIn,
-                tokenOut: p.tokenOut,
-                amountIn: p.amountIn,
-                limitSqrtPrice: p.limitSqrtPrice || 0n
-            };
-        }
-        // Check for Thick V2 protocols
-        if ((0, protocol_js_1.isThickV2Protocol)(protocol)) {
-            const p = params;
-            return {
-                tokenIn: p.tokenIn,
-                tokenOut: p.tokenOut,
-                amountIn: p.amountIn,
-                tickSpacing: p.tickSpacing,
-                sqrtPriceLimitX96: p.sqrtPriceLimitX96 || 0n
-            };
-        }
-        // Default to Uniswap V3 style (fee-based)
-        const p = params;
-        return {
-            tokenIn: p.tokenIn,
-            tokenOut: p.tokenOut,
-            amountIn: p.amountIn,
-            fee: p.fee,
-            sqrtPriceLimitX96: p.sqrtPriceLimitX96 || 0n
-        };
-    }
-    /**
-     * Creates a QuoterV2 contract instance with the appropriate ABI for the given beacon.
-     *
-     * @param beaconName - The beacon identifier to determine the protocol type
-     * @param client - The viem client for contract interactions
-     * @returns A viem contract instance with the appropriate ABI
-     * @throws Error if quoter address is not found for the protocol
-     */
-    createQuoterV2(protocol, client) {
-        const quoterV2Address = this.getQuoterV2Address(protocol);
-        if (!quoterV2Address) {
-            throw new Error(`QuoterV2 address not found for protocol: ${protocol}`);
-        }
-        const abi = this.getQuoterAbi(protocol);
-        return (0, viem_1.getContract)({
-            address: quoterV2Address,
-            abi,
-            client
-        });
-    }
-    /**
-     * Convenience function that creates both the quoter contract and properly formatted quote parameters.
-     *
-     * @param beaconName - The beacon identifier to determine the protocol type
-     * @param client - The viem client for contract interactions
-     * @param params - The input parameters for the quote
-     * @returns Object containing the quoter contract and formatted parameters
-     * @throws Error if quoter address is not found for the protocol
-     *
-     * @example
-     * ```typescript
-     * const factory = new QuoterV2Factory(networkConfig);
-     *
-     * const { quoter, params } = factory.createQuoterWithParams('quickswap', client, {
-     *   tokenIn: '0x...',
-     *   tokenOut: '0x...',
-     *   amountIn: parseEther('1'),
-     *   limitSqrtPrice: 0n
-     * });
-     *
-     * // Use directly
-     * const result = await quoter.read.quoteExactInputSingle([params]);
-     * ```
-     */
-    createQuoterWithParams(protocol, client, params) {
-        const quoter = this.createQuoterV2(protocol, client);
-        const formattedParams = this.getQuoteParams(protocol, params);
-        return {
-            quoter,
-            params: formattedParams
-        };
-    }
-    /**
-     * Gets the appropriate QuoterV2 ABI based on the beacon name and protocol.
-     *
-     * @param protocol - The detected protocol type
-     * @returns The appropriate ABI array
-     */
-    getQuoterAbi(protocol) {
-        if (!protocol) {
-            throw Error('Protocol not avaiable');
-        }
-        // Check for Algebra Integral v2.1 vaults (newer version)
-        if (this.isAlgebraIntegral21Vault(protocol)) {
-            return quoter_js_1.QuoterV2AlgebgraIntegral21;
-        }
-        // Check for Shadow protocol vaults
-        if ((0, protocol_js_1.isShadowProtocol)(protocol)) {
-            return quoter_js_1.QuoterV2Shadow;
-        }
-        // Check for Algebra Integral vaults (older version)
-        if ((0, protocol_js_1.isAlgebraIntegralProtocol)(protocol)) {
-            return quoter_js_1.QuoterV2AlgebgraIntegral;
-        }
-        // Check for Lynex protocol (special case)
-        if (protocol === chain_js_1.Protocol.Lynex) {
-            // Note: Lynex currently uses the same ABI as QuickSwap in this implementation
-            // If Lynex has a different ABI, add it to the ABIs in quoter.ts as QuoterV2Lynex
-            // and import it at the top of this file
-            return quoter_js_1.QuickSwapQuoterV2;
-        }
-        // Check for Algebra-based protocols
-        if (protocol && (0, protocol_js_1.isAlgebraProtocol)(protocol)) {
-            return quoter_js_1.QuickSwapQuoterV2;
-        }
-        // Check for Thick V2 protocols
-        if ((0, protocol_js_1.isThickV2Protocol)(protocol)) {
-            return quoter_js_1.QuoterV2Thick;
-        }
-        // Default to standard Uniswap V3 QuoterV2 ABI
-        return quoter_js_1.UniswapV3QuoterABI;
-    }
-    /**
-     * Gets the QuoterV2 address for the given protocol from the network configuration.
-     *
-     * @param protocol - The protocol type
-     * @returns The quoter address or undefined if not found
-     */
-    getQuoterV2Address(protocol) {
-        if (!protocol) {
-            return undefined;
-        }
-        const contractAddresses = (0, index_js_1.getProtocolContractAddresses)(protocol, this.networkConfig.name, 'QuoterV2');
-        if (!protocol || !contractAddresses) {
-            return undefined;
-        }
-        return contractAddresses.quoterV2Address;
-    }
-    /**
-     * Checks if the beacon represents an Algebra Integral v2.1 vault.
-     *
-     * @param beaconName - The beacon identifier
-     * @returns True if it's an Algebra Integral v2.1 vault
-     */
-    isAlgebraIntegral21Vault(protocol) {
-        return protocol === chain_js_1.Protocol.KatanaIntegral;
-    }
-}
-exports.QuoterV2Factory = QuoterV2Factory;
-/**
- * Helper function to get QuoterV2 address for a protocol from network config.
- *
- * @param protocol - The protocol to get the quoter address for
- * @param networkConfig - The network configuration object
- * @returns The quoter address or undefined if not found
- *
- * @example
- * ```typescript
- * const quoterAddress = getQuoterV2Address(Protocol.QuickSwap, networkConfig);
- * if (quoterAddress) {
- *   // Use the quoter address
- * }
- * ```
- */
-/**
- * Type guard to check if parameters are for Uniswap V3 style quoter
- */
-function isUniswapQuoteParams(params) {
-    return 'fee' in params;
-}
-/**
- * Type guard to check if parameters are for Algebra style quoter
- */
-function isAlgebraQuoteParams(params) {
-    return 'limitSqrtPrice' in params;
-}
-/**
- * Type guard to check if parameters are for Thick V2 style quoter
- */
-function isThickQuoteParams(params) {
-    return 'tickSpacing' in params && 'sqrtPriceLimitX96' in params;
-}
-/**
- * Type guard to check if parameters are for Algebra Integral v2.1 style quoter
- */
-function isAlgebraIntegral21QuoteParams(params) {
-    return 'deployer' in params;
-}
-/**
- * Type guard to check if parameters are for Shadow style quoter
- */
-function isShadowQuoteParams(params) {
-    return 'tickSpacing' in params && 'sqrtPriceLimitX96' in params;
-}
-/**
- * Validates quote parameters based on the protocol type detected from beacon name
- *
- * @param beaconName - The beacon identifier to determine the protocol type
- * @param params - The parameters to validate
- * @throws Error if parameters don't match the expected protocol type
- */
-function validateQuoteParams(protocol, params) {
-    if (!protocol) {
-        throw Error('Protocol not found');
-    }
-    // Validate required fields
-    if (!params.tokenIn || !params.tokenOut || !params.amountIn) {
-        throw new Error('Missing required parameters: tokenIn, tokenOut, and amountIn are required');
-    }
-    // Check for Algebra Integral v2.1 vaults (newer version with deployer)
-    if (protocol === chain_js_1.Protocol.KatanaIntegral) {
-        if (!isAlgebraIntegral21QuoteParams(params)) {
-            throw new Error('AlgebraIntegral21QuoteParams required: must include deployer field');
-        }
-        return;
-    }
-    // Check for Shadow protocol vaults
-    if (protocol && (0, protocol_js_1.isShadowProtocol)(protocol)) {
-        if (!isShadowQuoteParams(params) && !isThickQuoteParams(params)) {
-            throw new Error('ShadowQuoteParams required: must include tickSpacing field');
-        }
-        return;
-    }
-    // Check for Thick V2 protocols
-    if (protocol && (0, protocol_js_1.isThickV2Protocol)(protocol)) {
-        if (!isThickQuoteParams(params)) {
-            throw new Error('ThickQuoteParams required: must include tickSpacing field');
-        }
-        return;
-    }
-    // Check for Algebra-based protocols
-    if (protocol && (0, protocol_js_1.isAlgebraProtocol)(protocol)) {
-        if (!isAlgebraQuoteParams(params)) {
-            throw new Error('AlgebraQuoteParams required: limitSqrtPrice field expected');
-        }
-        return;
-    }
-    // Default to Uniswap V3 style validation
-    if (!isUniswapQuoteParams(params)) {
-        throw new Error('UniswapQuoteParams required: must include fee field');
-    }
-}
-/**
- * Gets the expected parameter type for a given beacon name
- *
- * @param beaconName - The beacon identifier
- * @returns String describing the expected parameter type
- */
-function getExpectedParamType(beaconName) {
-    const protocol = (0, beacon_js_1.getProtocolTypeByBeacon)(beaconName);
-    if (beaconName.toLowerCase().includes('katanaintegral') || protocol === chain_js_1.Protocol.KatanaIntegral) {
-        return 'AlgebraIntegral21QuoteParams (requires: tokenIn, tokenOut, amountIn, deployer, limitSqrtPrice?)';
-    }
-    if (protocol && (0, protocol_js_1.isShadowProtocol)(protocol)) {
-        return 'ShadowQuoteParams (requires: tokenIn, tokenOut, amountIn, tickSpacing, sqrtPriceLimitX96?)';
-    }
-    if (protocol && (0, protocol_js_1.isThickV2Protocol)(protocol)) {
-        return 'ThickQuoteParams (requires: tokenIn, tokenOut, amountIn, tickSpacing, sqrtPriceLimitX96?)';
-    }
-    if (protocol && (0, protocol_js_1.isAlgebraProtocol)(protocol)) {
-        return 'AlgebraQuoteParams (requires: tokenIn, tokenOut, amountIn, limitSqrtPrice?)';
-    }
-    return 'UniswapQuoteParams (requires: tokenIn, tokenOut, amountIn, fee, sqrtPriceLimitX96?)';
-}
-//# sourceMappingURL=quoter.js.map