@xyo-network/uniswap-v4-crypto-market-plugin 3.5.2

package/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

package/README.md

@@ -0,0 +1,13 @@
+[![logo][]](https://xyo.network)
+
+Part of [sdk-xyo-client-js](https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js)
+
+## License
+
+> See the [LICENSE](LICENSE) file for license details
+
+## Credits
+
+[Made with 🔥 and ❄️ by XYO](https://xyo.network)
+
+[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png

package/dist/neutral/index.mjs

@@ -0,0 +1,194 @@
+// src/lib/priceFromUniswapV4.ts
+import { ZeroAddress as ZeroAddress3 } from "ethers";
+
+// src/lib/getExchangeRate.ts
+import { IStateView__factory } from "@xyo-network/uniswap-typechain/v4-periphery";
+import { ZeroAddress as ZeroAddress2 } from "ethers/constants";
+
+// src/lib/getPoolId.ts
+import { AbiCoder } from "ethers/abi";
+import { ZeroAddress } from "ethers/constants";
+import { keccak256 } from "ethers/crypto";
+
+// src/lib/sortTokens.ts
+var sortTokens = (tokenA, tokenB) => {
+  return tokenA.sortsBefore(tokenB) ? [tokenA, tokenB] : [tokenB, tokenA];
+};
+
+// src/lib/getPoolId.ts
+var getPoolId = (tokenA, tokenB, fee, tickSpacing, hooks) => {
+  const [currency0, currency1] = sortTokens(tokenA, tokenB);
+  const currency0Addr = currency0.isNative ? ZeroAddress : currency0.wrapped.address;
+  const currency1Addr = currency1.isNative ? ZeroAddress : currency1.wrapped.address;
+  return keccak256(
+    AbiCoder.defaultAbiCoder().encode(
+      ["address", "address", "uint24", "int24", "address"],
+      [currency0Addr, currency1Addr, fee, tickSpacing, hooks]
+    )
+  );
+};
+
+// src/lib/getPriceFromSqrtX96.ts
+var getPriceFromSqrtX96 = (sqrtPriceX96, decimalsA, decimalsB) => {
+  const Q96 = 2n ** 96n;
+  const numerator = sqrtPriceX96 * sqrtPriceX96 * 10n ** 18n;
+  const denominator = Q96 * Q96;
+  let price = numerator / denominator;
+  const decimalAdjustment = decimalsB - decimalsA;
+  if (decimalAdjustment > 0) {
+    price *= 10n ** BigInt(decimalAdjustment);
+  } else if (decimalAdjustment < 0) {
+    price /= 10n ** BigInt(-decimalAdjustment);
+  }
+  return Number(price) / 1e18;
+};
+
+// src/lib/UniswapV4ContractAddresses.ts
+var UniswapV4ContractAddresses = {
+  Ethereum: {
+    PoolManager: "0x000000000004444c5dc75cB358380D2e3dE08A90",
+    PositionDescriptor: "0xd1428ba554f4c8450b763a0b2040a4935c63f06c",
+    PositionManager: "0xbd216513d74c8cf14cf4747e6aaa6420ff64ee9e",
+    Quoter: "0x52f0e24d1c21c8a0cb1e5a5dd6198556bd9e1203",
+    StateView: "0x7ffe42c4a5deea5b0fec41c94c136cf115597227",
+    UniversalRouter: "0x66a9893cc07d91d95644aedd05d03f95e1dba8af"
+  }
+};
+
+// src/lib/getExchangeRate.ts
+var getExchangeRate = async (tokenA, tokenB, fee, hookAddress, provider) => {
+  const hooks = hookAddress || ZeroAddress2;
+  const stateView = IStateView__factory.connect(UniswapV4ContractAddresses.Ethereum.StateView, provider);
+  const [token0, token1] = sortTokens(tokenA, tokenB);
+  const poolId = getPoolId(token0, token1, fee, 60, hooks);
+  if (poolId === ZeroAddress2) throw new Error("Invalid poolId");
+  const response = await stateView.getSlot0(poolId);
+  const price = getPriceFromSqrtX96(response.sqrtPriceX96, token1.decimals, token0.decimals);
+  return price;
+};
+
+// src/lib/tokenRegistryValueToToken.ts
+import { Token } from "@uniswap/sdk-core";
+import { getAddress } from "ethers/address";
+var tokenRegistryValueToToken = (value) => {
+  const {
+    address,
+    chainId,
+    decimals,
+    symbol,
+    name
+  } = value;
+  const normalizedAddress = getAddress(address.toLowerCase());
+  return new Token(chainId, normalizedAddress, decimals, symbol, name);
+};
+
+// src/lib/priceFromUniswapV4.ts
+var priceFromUniswapV4 = async (poolId, provider) => {
+  const {
+    tokens,
+    fee,
+    hookAddress = ZeroAddress3
+  } = poolId;
+  const tokenA = tokenRegistryValueToToken(tokens[0]);
+  const tokenB = tokenRegistryValueToToken(tokens[1]);
+  const rate = await getExchangeRate(tokenA, tokenB, fee, hookAddress, provider);
+  const token0 = {
+    address: tokenA.address,
+    symbol: tokenA.symbol || "",
+    value: Math.max(rate, 0)
+  };
+  const token1 = {
+    address: tokenB.address,
+    symbol: tokenB.symbol || "",
+    value: rate > 0 ? Number((1 / rate).toPrecision(6)) : 0
+  };
+  const pair = { tokens: [token0, token1] };
+  return pair;
+};
+
+// src/lib/pricesFromUniswapV4.ts
+var pricesFromUniswapV4 = async (poolId, provider) => {
+  return await Promise.all(poolId.map((pool) => priceFromUniswapV4(pool, provider)));
+};
+
+// src/lib/UniswapV4DefaultPools.ts
+import { ZeroAddress as ZeroAddress4 } from "ethers";
+var TokenRegistry = {
+  USDT: {
+    address: "0xdac17f958d2ee523a2206206994597c13d831ec7",
+    chainId: 1,
+    decimals: 6,
+    symbol: "USDT"
+  },
+  XYO: {
+    address: "0x55296f69f40ea6d20e478533c15a6b08b654e758",
+    chainId: 1,
+    decimals: 18,
+    symbol: "XYO"
+  }
+};
+var UniswapV4DefaultPools = {
+  "XYO:USDT": {
+    fee: 3e3,
+    hookAddress: ZeroAddress4,
+    tickSpacing: 60,
+    tokens: [TokenRegistry.XYO, TokenRegistry.USDT]
+  }
+};
+
+// src/Plugin.ts
+import { PayloadSetSchema } from "@xyo-network/payload-model";
+import { createPayloadSetWitnessPlugin } from "@xyo-network/payloadset-plugin";
+import { UniswapCryptoMarketSchema as UniswapCryptoMarketSchema2 } from "@xyo-network/uniswap-crypto-market-payload-plugin";
+
+// src/Witness.ts
+import { assertEx } from "@xylabs/assert";
+import { AbstractWitness } from "@xyo-network/abstract-witness";
+import { UniswapCryptoMarketSchema, UniswapV4CryptoMarketWitnessConfigSchema } from "@xyo-network/uniswap-crypto-market-payload-plugin";
+var UniswapV4CryptoMarketWitness = class extends AbstractWitness {
+  static configSchemas = [...super.configSchemas, UniswapV4CryptoMarketWitnessConfigSchema];
+  static defaultConfigSchema = UniswapV4CryptoMarketWitnessConfigSchema;
+  get pools() {
+    return this.config?.poolKeys ?? Object.values(UniswapV4DefaultPools);
+  }
+  get provider() {
+    return assertEx(this.params.provider, () => "Provider Required");
+  }
+  async observeHandler() {
+    await this.started("throw");
+    const pairs = await pricesFromUniswapV4(this.pools, this.provider);
+    const timestamp = Date.now();
+    const payload = {
+      pairs,
+      schema: UniswapCryptoMarketSchema,
+      timestamp
+    };
+    return [payload];
+  }
+  async startHandler() {
+    await super.startHandler();
+    return true;
+  }
+};
+
+// src/Plugin.ts
+var UniswapV4CryptoMarketPlugin = () => createPayloadSetWitnessPlugin(
+  { required: { [UniswapCryptoMarketSchema2]: 1 }, schema: PayloadSetSchema },
+  {
+    witness: async (params) => {
+      const result = await UniswapV4CryptoMarketWitness.create(params);
+      return result;
+    }
+  }
+);
+export {
+  TokenRegistry,
+  UniswapV4CryptoMarketPlugin,
+  UniswapV4CryptoMarketWitness,
+  UniswapV4DefaultPools,
+  UniswapV4CryptoMarketPlugin as default,
+  priceFromUniswapV4,
+  pricesFromUniswapV4,
+  tokenRegistryValueToToken
+};
+//# sourceMappingURL=index.mjs.map

package/dist/neutral/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/lib/priceFromUniswapV4.ts","../../src/lib/getExchangeRate.ts","../../src/lib/getPoolId.ts","../../src/lib/sortTokens.ts","../../src/lib/getPriceFromSqrtX96.ts","../../src/lib/UniswapV4ContractAddresses.ts","../../src/lib/tokenRegistryValueToToken.ts","../../src/lib/pricesFromUniswapV4.ts","../../src/lib/UniswapV4DefaultPools.ts","../../src/Plugin.ts","../../src/Witness.ts"],"sourcesContent":["import type { UniswapCryptoPair, UniswapCryptoToken } from '@xyo-network/uniswap-crypto-market-payload-plugin'\nimport type { Provider } from 'ethers'\nimport { ZeroAddress } from 'ethers'\n\nimport type { TokenPairPoolKey } from '../types/index.ts'\nimport { getExchangeRate } from './getExchangeRate.ts'\nimport { tokenRegistryValueToToken } from './tokenRegistryValueToToken.ts'\n\nexport const priceFromUniswapV4 = async (poolId: TokenPairPoolKey, provider: Provider): Promise<UniswapCryptoPair> => {\n  const {\n    tokens, fee, hookAddress = ZeroAddress,\n  } = poolId\n  const tokenA = tokenRegistryValueToToken(tokens[0])\n  const tokenB = tokenRegistryValueToToken(tokens[1])\n  const rate = await getExchangeRate(tokenA, tokenB, fee, hookAddress, provider)\n  const token0: UniswapCryptoToken = {\n    address: tokenA.address,\n    symbol: tokenA.symbol || '',\n    value: Math.max(rate, 0),\n  }\n  const token1: UniswapCryptoToken = {\n    address: tokenB.address,\n    symbol: tokenB.symbol || '',\n    value: rate > 0 ? Number((1 / rate).toPrecision(6)) : 0,\n  }\n  const pair: UniswapCryptoPair = { tokens: [token0, token1] }\n  return pair\n}\n","import type { Token } from '@uniswap/sdk-core'\nimport { IStateView__factory } from '@xyo-network/uniswap-typechain/v4-periphery'\nimport { ZeroAddress } from 'ethers/constants'\nimport type { Provider } from 'ethers/providers'\n\nimport { getPoolId } from './getPoolId.ts'\nimport { getPriceFromSqrtX96 } from './getPriceFromSqrtX96.ts'\nimport { sortTokens } from './sortTokens.ts'\nimport { UniswapV4ContractAddresses } from './UniswapV4ContractAddresses.ts'\n\n/**\n * Returns the price of the token pair in the Uniswap V4 pool.\n * @param tokenA The first token in the pair.\n * @param tokenB The second token in the pair.\n * @param fee The fee tier for the pool.\n * @param hookAddress The address of the hook contract. Default is ZeroAddress.\n * @param provider The EVM provider to use for the transaction.\n * @returns The price of the token pair.\n */\nexport const getExchangeRate = async (\n  tokenA: Token,\n  tokenB: Token,\n  fee: number,\n  hookAddress: string | undefined,\n  provider: Provider,\n): Promise<number> => {\n  const hooks = hookAddress || ZeroAddress\n  const stateView = IStateView__factory.connect(UniswapV4ContractAddresses.Ethereum.StateView, provider)\n  const [token0, token1] = sortTokens(tokenA, tokenB)\n  const poolId: string = getPoolId(token0, token1, fee, 60, hooks)\n  if (poolId === ZeroAddress) throw new Error('Invalid poolId')\n  const response = await stateView.getSlot0(poolId)\n  const price = getPriceFromSqrtX96(response.sqrtPriceX96, token1.decimals, token0.decimals)\n  return price\n}\n","import type { Token } from '@uniswap/sdk-core'\nimport { AbiCoder } from 'ethers/abi'\nimport { ZeroAddress } from 'ethers/constants'\nimport { keccak256 } from 'ethers/crypto'\n\nimport { sortTokens } from './sortTokens.ts'\n\n/**\n * Computes the pool address for a given pair of tokens, fee, tick spacing, and hooks which\n * is used to identify the pool on the Uniswap V4 protocol.\n * @param tokenA - The first token in the pair.\n * @param tokenB - The second token in the pair.\n * @param fee - The fee tier for the pool.\n * @param tickSpacing - The tick spacing for the pool.\n * @param hooks - The hooks associated with the pool.\n * @returns The computed pool address as a string.\n */\nexport const getPoolId = (tokenA: Token, tokenB: Token, fee: number, tickSpacing: number, hooks: string): string => {\n  const [currency0, currency1] = sortTokens(tokenA, tokenB)\n  const currency0Addr = currency0.isNative ? ZeroAddress : currency0.wrapped.address\n  const currency1Addr = currency1.isNative ? ZeroAddress : currency1.wrapped.address\n  return keccak256(\n    AbiCoder.defaultAbiCoder().encode(\n      ['address', 'address', 'uint24', 'int24', 'address'],\n      [currency0Addr, currency1Addr, fee, tickSpacing, hooks],\n    ),\n  )\n}\n","import type { Token } from '@uniswap/sdk-core'\n\n/**\n * Sorts two tokens in ascending order by address to ensure consistent ordering.\n *\n * In Uniswap v2, v3, and v4, pool addresses are deterministically derived using\n * `CREATE2` with a hash of the pool's initialization parameters. One critical\n * part of this hash is the `token0` and `token1` addresses. To ensure uniqueness\n * and prevent duplicate pools (e.g., USDC/WETH and WETH/USDC being treated as different),\n * Uniswap requires that token pairs be ordered **lexicographically by address**.\n *\n * This method ensures that tokens are sorted according to that rule.\n *\n * This is required any time you:\n * - Derive a pool address\n * - Generate a pool ID\n * - Call a function that expects a PoolKey or token pair in sorted order\n *\n * @param tokenA - The first token to compare\n * @param tokenB - The second token to compare\n * @returns A tuple `[token0, token1]` sorted by address in ascending order\n */\nexport const sortTokens = (tokenA: Token, tokenB: Token): [Token, Token] => {\n  return tokenA.sortsBefore(tokenB) ? [tokenA, tokenB] : [tokenB, tokenA]\n}\n","/**\n * Calculates the price from the square root price in Q96 format.\n * @param sqrtPriceX96 The square root price in Q96 format.\n * @param decimalsA The number of decimals for the first token.\n * @param decimalsB The number of decimals for the second token.\n * @returns The price as a number.\n */\nexport const getPriceFromSqrtX96 = (sqrtPriceX96: bigint, decimalsA: number, decimalsB: number): number => {\n  const Q96 = 2n ** 96n\n\n  // Scale to avoid floating point math by using a 1e18 factor\n  const numerator = sqrtPriceX96 * sqrtPriceX96 * 10n ** 18n\n  const denominator = Q96 * Q96\n\n  let price = numerator / denominator\n\n  // Adjust for decimal differences\n  const decimalAdjustment = decimalsB - decimalsA\n  if (decimalAdjustment > 0) {\n    price *= 10n ** BigInt(decimalAdjustment)\n  } else if (decimalAdjustment < 0) {\n    price /= 10n ** BigInt(-decimalAdjustment)\n  }\n\n  return Number(price) / 1e18\n}\n","// https://docs.uniswap.org/contracts/v4/deployments#mainnet-deployments\nexport const UniswapV4ContractAddresses = {\n  Ethereum: {\n    PoolManager: '0x000000000004444c5dc75cB358380D2e3dE08A90',\n    PositionDescriptor: '0xd1428ba554f4c8450b763a0b2040a4935c63f06c',\n    PositionManager: '0xbd216513d74c8cf14cf4747e6aaa6420ff64ee9e',\n    Quoter: '0x52f0e24d1c21c8a0cb1e5a5dd6198556bd9e1203',\n    StateView: '0x7ffe42c4a5deea5b0fec41c94c136cf115597227',\n    UniversalRouter: '0x66a9893cc07d91d95644aedd05d03f95e1dba8af',\n  },\n}\n","import { Token } from '@uniswap/sdk-core'\nimport { getAddress } from 'ethers/address'\n\nimport type { TokenParameters } from '../types/index.ts'\n\nexport const tokenRegistryValueToToken = (value: TokenParameters): Token => {\n  const {\n    address, chainId, decimals, symbol, name,\n  } = value\n  const normalizedAddress = getAddress(address.toLowerCase())\n  return new Token(chainId, normalizedAddress, decimals, symbol, name)\n}\n","import type { UniswapCryptoPair } from '@xyo-network/uniswap-crypto-market-payload-plugin'\nimport type { Provider } from 'ethers'\n\nimport type { TokenPairPoolKey } from '../types/index.ts'\nimport { priceFromUniswapV4 } from './priceFromUniswapV4.ts'\n\nexport const pricesFromUniswapV4 = async (poolId: TokenPairPoolKey[], provider: Provider): Promise<UniswapCryptoPair[]> => {\n  return await Promise.all(poolId.map(pool => priceFromUniswapV4(pool, provider)))\n}\n","import { ZeroAddress } from 'ethers'\n\nimport type { TokenPairPoolKey, TokenParameters } from '../types/index.ts'\n\nexport const TokenRegistry: Record<string, TokenParameters> = {\n  USDT: {\n    address: '0xdac17f958d2ee523a2206206994597c13d831ec7',\n    chainId: 1,\n    decimals: 6,\n    symbol: 'USDT',\n  },\n  XYO: {\n    address: '0x55296f69f40ea6d20e478533c15a6b08b654e758',\n    chainId: 1,\n    decimals: 18,\n    symbol: 'XYO',\n  },\n} as const\n\nexport const UniswapV4DefaultPools: Record<string, TokenPairPoolKey> = {\n  'XYO:USDT': {\n    fee: 3000,\n    hookAddress: ZeroAddress,\n    tickSpacing: 60,\n    tokens: [TokenRegistry.XYO, TokenRegistry.USDT],\n  },\n} as const\n","import { PayloadSetSchema } from '@xyo-network/payload-model'\nimport { createPayloadSetWitnessPlugin } from '@xyo-network/payloadset-plugin'\nimport { UniswapCryptoMarketSchema } from '@xyo-network/uniswap-crypto-market-payload-plugin'\n\nimport { UniswapV4CryptoMarketWitness } from './Witness.ts'\n\nexport const UniswapV4CryptoMarketPlugin = () =>\n  createPayloadSetWitnessPlugin<UniswapV4CryptoMarketWitness>(\n    { required: { [UniswapCryptoMarketSchema]: 1 }, schema: PayloadSetSchema },\n    {\n      witness: async (params) => {\n        const result = await UniswapV4CryptoMarketWitness.create(params)\n        return result\n      },\n    },\n  )\n","import { assertEx } from '@xylabs/assert'\nimport { AbstractWitness } from '@xyo-network/abstract-witness'\nimport type { AnyConfigSchema } from '@xyo-network/module-model'\nimport type { Payload, Schema } from '@xyo-network/payload-model'\nimport type { UniswapCryptoMarketPayload } from '@xyo-network/uniswap-crypto-market-payload-plugin'\nimport { UniswapCryptoMarketSchema, UniswapV4CryptoMarketWitnessConfigSchema } from '@xyo-network/uniswap-crypto-market-payload-plugin'\nimport type { WitnessParams } from '@xyo-network/witness-model'\nimport type { Provider } from 'ethers'\n\nimport type { UniswapV4CryptoMarketWitnessConfig } from './Config.ts'\nimport { pricesFromUniswapV4, UniswapV4DefaultPools } from './lib/index.ts'\nimport type { TokenPairPoolKey } from './types/index.ts'\n\nexport type UniswapV4CryptoMarketWitnessParams = WitnessParams<\n  AnyConfigSchema<UniswapV4CryptoMarketWitnessConfig>,\n  {\n    provider?: Provider\n  }\n>\n\nexport class UniswapV4CryptoMarketWitness<\n  TParams extends UniswapV4CryptoMarketWitnessParams = UniswapV4CryptoMarketWitnessParams,\n> extends AbstractWitness<TParams> {\n  static override readonly configSchemas: Schema[] = [...super.configSchemas, UniswapV4CryptoMarketWitnessConfigSchema]\n  static override readonly defaultConfigSchema: Schema = UniswapV4CryptoMarketWitnessConfigSchema\n\n  protected get pools(): TokenPairPoolKey[] {\n    return this.config?.poolKeys ?? Object.values(UniswapV4DefaultPools)\n  }\n\n  protected get provider() {\n    return assertEx(this.params.provider, () => 'Provider Required')\n  }\n\n  protected override async observeHandler(): Promise<Payload[]> {\n    await this.started('throw')\n    const pairs = await pricesFromUniswapV4(this.pools, this.provider)\n    const timestamp = Date.now()\n    const payload: UniswapCryptoMarketPayload = {\n      pairs, schema: UniswapCryptoMarketSchema, timestamp,\n    }\n    return [payload]\n  }\n\n  protected override async startHandler() {\n    await super.startHandler()\n    return true\n  }\n}\n"],"mappings":";AAEA,SAAS,eAAAA,oBAAmB;;;ACD5B,SAAS,2BAA2B;AACpC,SAAS,eAAAC,oBAAmB;;;ACD5B,SAAS,gBAAgB;AACzB,SAAS,mBAAmB;AAC5B,SAAS,iBAAiB;;;ACmBnB,IAAM,aAAa,CAAC,QAAe,WAAkC;AAC1E,SAAO,OAAO,YAAY,MAAM,IAAI,CAAC,QAAQ,MAAM,IAAI,CAAC,QAAQ,MAAM;AACxE;;;ADPO,IAAM,YAAY,CAAC,QAAe,QAAe,KAAa,aAAqB,UAA0B;AAClH,QAAM,CAAC,WAAW,SAAS,IAAI,WAAW,QAAQ,MAAM;AACxD,QAAM,gBAAgB,UAAU,WAAW,cAAc,UAAU,QAAQ;AAC3E,QAAM,gBAAgB,UAAU,WAAW,cAAc,UAAU,QAAQ;AAC3E,SAAO;AAAA,IACL,SAAS,gBAAgB,EAAE;AAAA,MACzB,CAAC,WAAW,WAAW,UAAU,SAAS,SAAS;AAAA,MACnD,CAAC,eAAe,eAAe,KAAK,aAAa,KAAK;AAAA,IACxD;AAAA,EACF;AACF;;;AEpBO,IAAM,sBAAsB,CAAC,cAAsB,WAAmB,cAA8B;AACzG,QAAM,MAAM,MAAM;AAGlB,QAAM,YAAY,eAAe,eAAe,OAAO;AACvD,QAAM,cAAc,MAAM;AAE1B,MAAI,QAAQ,YAAY;AAGxB,QAAM,oBAAoB,YAAY;AACtC,MAAI,oBAAoB,GAAG;AACzB,aAAS,OAAO,OAAO,iBAAiB;AAAA,EAC1C,WAAW,oBAAoB,GAAG;AAChC,aAAS,OAAO,OAAO,CAAC,iBAAiB;AAAA,EAC3C;AAEA,SAAO,OAAO,KAAK,IAAI;AACzB;;;ACxBO,IAAM,6BAA6B;AAAA,EACxC,UAAU;AAAA,IACR,aAAa;AAAA,IACb,oBAAoB;AAAA,IACpB,iBAAiB;AAAA,IACjB,QAAQ;AAAA,IACR,WAAW;AAAA,IACX,iBAAiB;AAAA,EACnB;AACF;;;AJSO,IAAM,kBAAkB,OAC7B,QACA,QACA,KACA,aACA,aACoB;AACpB,QAAM,QAAQ,eAAeC;AAC7B,QAAM,YAAY,oBAAoB,QAAQ,2BAA2B,SAAS,WAAW,QAAQ;AACrG,QAAM,CAAC,QAAQ,MAAM,IAAI,WAAW,QAAQ,MAAM;AAClD,QAAM,SAAiB,UAAU,QAAQ,QAAQ,KAAK,IAAI,KAAK;AAC/D,MAAI,WAAWA,aAAa,OAAM,IAAI,MAAM,gBAAgB;AAC5D,QAAM,WAAW,MAAM,UAAU,SAAS,MAAM;AAChD,QAAM,QAAQ,oBAAoB,SAAS,cAAc,OAAO,UAAU,OAAO,QAAQ;AACzF,SAAO;AACT;;;AKlCA,SAAS,aAAa;AACtB,SAAS,kBAAkB;AAIpB,IAAM,4BAA4B,CAAC,UAAkC;AAC1E,QAAM;AAAA,IACJ;AAAA,IAAS;AAAA,IAAS;AAAA,IAAU;AAAA,IAAQ;AAAA,EACtC,IAAI;AACJ,QAAM,oBAAoB,WAAW,QAAQ,YAAY,CAAC;AAC1D,SAAO,IAAI,MAAM,SAAS,mBAAmB,UAAU,QAAQ,IAAI;AACrE;;;ANHO,IAAM,qBAAqB,OAAO,QAA0B,aAAmD;AACpH,QAAM;AAAA,IACJ;AAAA,IAAQ;AAAA,IAAK,cAAcC;AAAA,EAC7B,IAAI;AACJ,QAAM,SAAS,0BAA0B,OAAO,CAAC,CAAC;AAClD,QAAM,SAAS,0BAA0B,OAAO,CAAC,CAAC;AAClD,QAAM,OAAO,MAAM,gBAAgB,QAAQ,QAAQ,KAAK,aAAa,QAAQ;AAC7E,QAAM,SAA6B;AAAA,IACjC,SAAS,OAAO;AAAA,IAChB,QAAQ,OAAO,UAAU;AAAA,IACzB,OAAO,KAAK,IAAI,MAAM,CAAC;AAAA,EACzB;AACA,QAAM,SAA6B;AAAA,IACjC,SAAS,OAAO;AAAA,IAChB,QAAQ,OAAO,UAAU;AAAA,IACzB,OAAO,OAAO,IAAI,QAAQ,IAAI,MAAM,YAAY,CAAC,CAAC,IAAI;AAAA,EACxD;AACA,QAAM,OAA0B,EAAE,QAAQ,CAAC,QAAQ,MAAM,EAAE;AAC3D,SAAO;AACT;;;AOrBO,IAAM,sBAAsB,OAAO,QAA4B,aAAqD;AACzH,SAAO,MAAM,QAAQ,IAAI,OAAO,IAAI,UAAQ,mBAAmB,MAAM,QAAQ,CAAC,CAAC;AACjF;;;ACRA,SAAS,eAAAC,oBAAmB;AAIrB,IAAM,gBAAiD;AAAA,EAC5D,MAAM;AAAA,IACJ,SAAS;AAAA,IACT,SAAS;AAAA,IACT,UAAU;AAAA,IACV,QAAQ;AAAA,EACV;AAAA,EACA,KAAK;AAAA,IACH,SAAS;AAAA,IACT,SAAS;AAAA,IACT,UAAU;AAAA,IACV,QAAQ;AAAA,EACV;AACF;AAEO,IAAM,wBAA0D;AAAA,EACrE,YAAY;AAAA,IACV,KAAK;AAAA,IACL,aAAaA;AAAA,IACb,aAAa;AAAA,IACb,QAAQ,CAAC,cAAc,KAAK,cAAc,IAAI;AAAA,EAChD;AACF;;;AC1BA,SAAS,wBAAwB;AACjC,SAAS,qCAAqC;AAC9C,SAAS,6BAAAC,kCAAiC;;;ACF1C,SAAS,gBAAgB;AACzB,SAAS,uBAAuB;AAIhC,SAAS,2BAA2B,gDAAgD;AAe7E,IAAM,+BAAN,cAEG,gBAAyB;AAAA,EACjC,OAAyB,gBAA0B,CAAC,GAAG,MAAM,eAAe,wCAAwC;AAAA,EACpH,OAAyB,sBAA8B;AAAA,EAEvD,IAAc,QAA4B;AACxC,WAAO,KAAK,QAAQ,YAAY,OAAO,OAAO,qBAAqB;AAAA,EACrE;AAAA,EAEA,IAAc,WAAW;AACvB,WAAO,SAAS,KAAK,OAAO,UAAU,MAAM,mBAAmB;AAAA,EACjE;AAAA,EAEA,MAAyB,iBAAqC;AAC5D,UAAM,KAAK,QAAQ,OAAO;AAC1B,UAAM,QAAQ,MAAM,oBAAoB,KAAK,OAAO,KAAK,QAAQ;AACjE,UAAM,YAAY,KAAK,IAAI;AAC3B,UAAM,UAAsC;AAAA,MAC1C;AAAA,MAAO,QAAQ;AAAA,MAA2B;AAAA,IAC5C;AACA,WAAO,CAAC,OAAO;AAAA,EACjB;AAAA,EAEA,MAAyB,eAAe;AACtC,UAAM,MAAM,aAAa;AACzB,WAAO;AAAA,EACT;AACF;;;AD1CO,IAAM,8BAA8B,MACzC;AAAA,EACE,EAAE,UAAU,EAAE,CAACC,0BAAyB,GAAG,EAAE,GAAG,QAAQ,iBAAiB;AAAA,EACzE;AAAA,IACE,SAAS,OAAO,WAAW;AACzB,YAAM,SAAS,MAAM,6BAA6B,OAAO,MAAM;AAC/D,aAAO;AAAA,IACT;AAAA,EACF;AACF;","names":["ZeroAddress","ZeroAddress","ZeroAddress","ZeroAddress","ZeroAddress","UniswapCryptoMarketSchema","UniswapCryptoMarketSchema"]}

package/dist/types/Config.d.ts

@@ -0,0 +1,8 @@
+import type { UniswapV4CryptoMarketWitnessConfigSchema } from '@xyo-network/uniswap-crypto-market-payload-plugin';
+import type { WitnessConfig } from '@xyo-network/witness-model';
+import type { TokenPairPoolKey } from './types/index.ts';
+export type UniswapV4CryptoMarketWitnessConfig = WitnessConfig<{
+    poolKeys?: TokenPairPoolKey[];
+    schema: UniswapV4CryptoMarketWitnessConfigSchema;
+}>;
+//# sourceMappingURL=Config.d.ts.map

package/dist/types/Config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wCAAwC,EAAE,MAAM,mDAAmD,CAAA;AACjH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAE/D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AAExD,MAAM,MAAM,kCAAkC,GAAG,aAAa,CAAC;IAC7D,QAAQ,CAAC,EAAE,gBAAgB,EAAE,CAAA;IAC7B,MAAM,EAAE,wCAAwC,CAAA;CACjD,CAAC,CAAA"}

package/dist/types/Plugin.d.ts

@@ -0,0 +1,15 @@
+import { UniswapV4CryptoMarketWitness } from './Witness.ts';
+export declare const UniswapV4CryptoMarketPlugin: () => import("@xyo-network/payloadset-plugin").PayloadSetWitnessPlugin<UniswapV4CryptoMarketWitness<import(".store/@xylabs-base-npm-4.8.7-ae479fd9f4/package").BaseParamsFields & {
+    account?: import(".store/@xyo-network-account-model-npm-3.13.0-942698b671/package").AccountInstance | "random";
+    addToResolvers?: boolean;
+    additionalSigners?: import(".store/@xyo-network-account-model-npm-3.13.0-942698b671/package").AccountInstance[];
+    allowNameResolution?: boolean;
+    config: import("@xyo-network/module-model").AnyConfigSchema<import("./Config.ts").UniswapV4CryptoMarketWitnessConfig>;
+    ephemeralQueryAccountEnabled?: boolean;
+    moduleIdentifierTransformers?: import("@xyo-network/module-model").ModuleIdentifierTransformer[];
+    privateChildren?: import("@xyo-network/module-model").ModuleInstance[];
+    publicChildren?: import("@xyo-network/module-model").ModuleInstance[];
+} & {
+    provider?: import("ethers").Provider;
+}>>;
+//# sourceMappingURL=Plugin.d.ts.map

package/dist/types/Plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Plugin.d.ts","sourceRoot":"","sources":["../../src/Plugin.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,4BAA4B,EAAE,MAAM,cAAc,CAAA;AAE3D,eAAO,MAAM,2BAA2B;;;;;;;;;;;;GASrC,CAAA"}

package/dist/types/Witness.d.ts

@@ -0,0 +1,19 @@
+import { AbstractWitness } from '@xyo-network/abstract-witness';
+import type { AnyConfigSchema } from '@xyo-network/module-model';
+import type { Payload, Schema } from '@xyo-network/payload-model';
+import type { WitnessParams } from '@xyo-network/witness-model';
+import type { Provider } from 'ethers';
+import type { UniswapV4CryptoMarketWitnessConfig } from './Config.ts';
+import type { TokenPairPoolKey } from './types/index.ts';
+export type UniswapV4CryptoMarketWitnessParams = WitnessParams<AnyConfigSchema<UniswapV4CryptoMarketWitnessConfig>, {
+    provider?: Provider;
+}>;
+export declare class UniswapV4CryptoMarketWitness<TParams extends UniswapV4CryptoMarketWitnessParams = UniswapV4CryptoMarketWitnessParams> extends AbstractWitness<TParams> {
+    static readonly configSchemas: Schema[];
+    static readonly defaultConfigSchema: Schema;
+    protected get pools(): TokenPairPoolKey[];
+    protected get provider(): Provider;
+    protected observeHandler(): Promise<Payload[]>;
+    protected startHandler(): Promise<boolean>;
+}
+//# sourceMappingURL=Witness.d.ts.map

package/dist/types/Witness.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Witness.d.ts","sourceRoot":"","sources":["../../src/Witness.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAA;AAC/D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAChE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AAGjE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAC/D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAA;AAEtC,OAAO,KAAK,EAAE,kCAAkC,EAAE,MAAM,aAAa,CAAA;AAErE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AAExD,MAAM,MAAM,kCAAkC,GAAG,aAAa,CAC5D,eAAe,CAAC,kCAAkC,CAAC,EACnD;IACE,QAAQ,CAAC,EAAE,QAAQ,CAAA;CACpB,CACF,CAAA;AAED,qBAAa,4BAA4B,CACvC,OAAO,SAAS,kCAAkC,GAAG,kCAAkC,CACvF,SAAQ,eAAe,CAAC,OAAO,CAAC;IAChC,gBAAyB,aAAa,EAAE,MAAM,EAAE,CAAqE;IACrH,gBAAyB,mBAAmB,EAAE,MAAM,CAA2C;IAE/F,SAAS,KAAK,KAAK,IAAI,gBAAgB,EAAE,CAExC;IAED,SAAS,KAAK,QAAQ,aAErB;cAEwB,cAAc,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;cAUpC,YAAY;CAItC"}

package/dist/types/index.d.ts

@@ -0,0 +1,5 @@
+export * from './Config.ts';
+export * from './lib/index.ts';
+export { UniswapV4CryptoMarketPlugin as default, UniswapV4CryptoMarketPlugin } from './Plugin.ts';
+export * from './Witness.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,gBAAgB,CAAA;AAC9B,OAAO,EAAE,2BAA2B,IAAI,OAAO,EAAE,2BAA2B,EAAE,MAAM,aAAa,CAAA;AACjG,cAAc,cAAc,CAAA"}

package/dist/types/lib/UniswapV4ContractAddresses.d.ts

@@ -0,0 +1,11 @@
+export declare const UniswapV4ContractAddresses: {
+    Ethereum: {
+        PoolManager: string;
+        PositionDescriptor: string;
+        PositionManager: string;
+        Quoter: string;
+        StateView: string;
+        UniversalRouter: string;
+    };
+};
+//# sourceMappingURL=UniswapV4ContractAddresses.d.ts.map

package/dist/types/lib/UniswapV4ContractAddresses.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UniswapV4ContractAddresses.d.ts","sourceRoot":"","sources":["../../../src/lib/UniswapV4ContractAddresses.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,0BAA0B;;;;;;;;;CAStC,CAAA"}

package/dist/types/lib/UniswapV4DefaultPools.d.ts

@@ -0,0 +1,4 @@
+import type { TokenPairPoolKey, TokenParameters } from '../types/index.ts';
+export declare const TokenRegistry: Record<string, TokenParameters>;
+export declare const UniswapV4DefaultPools: Record<string, TokenPairPoolKey>;
+//# sourceMappingURL=UniswapV4DefaultPools.d.ts.map

package/dist/types/lib/UniswapV4DefaultPools.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UniswapV4DefaultPools.d.ts","sourceRoot":"","sources":["../../../src/lib/UniswapV4DefaultPools.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAE1E,eAAO,MAAM,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAahD,CAAA;AAEV,eAAO,MAAM,qBAAqB,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAOzD,CAAA"}

package/dist/types/lib/UniswapV4TokenIdentifier.d.ts

@@ -0,0 +1,8 @@
+export interface UniswapV4TokenIdentifier {
+    chainId: number;
+    address: string;
+    decimals: number;
+    symbol?: string;
+    name?: string;
+}
+//# sourceMappingURL=UniswapV4TokenIdentifier.d.ts.map

package/dist/types/lib/UniswapV4TokenIdentifier.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UniswapV4TokenIdentifier.d.ts","sourceRoot":"","sources":["../../../src/lib/UniswapV4TokenIdentifier.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,wBAAwB;IACvC,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAA;CACd"}

package/dist/types/lib/getExchangeRate.d.ts

@@ -0,0 +1,13 @@
+import type { Token } from '@uniswap/sdk-core';
+import type { Provider } from 'ethers/providers';
+/**
+ * Returns the price of the token pair in the Uniswap V4 pool.
+ * @param tokenA The first token in the pair.
+ * @param tokenB The second token in the pair.
+ * @param fee The fee tier for the pool.
+ * @param hookAddress The address of the hook contract. Default is ZeroAddress.
+ * @param provider The EVM provider to use for the transaction.
+ * @returns The price of the token pair.
+ */
+export declare const getExchangeRate: (tokenA: Token, tokenB: Token, fee: number, hookAddress: string | undefined, provider: Provider) => Promise<number>;
+//# sourceMappingURL=getExchangeRate.d.ts.map

package/dist/types/lib/getExchangeRate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getExchangeRate.d.ts","sourceRoot":"","sources":["../../../src/lib/getExchangeRate.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAA;AAG9C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AAOhD;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe,GAC1B,QAAQ,KAAK,EACb,QAAQ,KAAK,EACb,KAAK,MAAM,EACX,aAAa,MAAM,GAAG,SAAS,EAC/B,UAAU,QAAQ,KACjB,OAAO,CAAC,MAAM,CAShB,CAAA"}

package/dist/types/lib/getPoolId.d.ts

@@ -0,0 +1,13 @@
+import type { Token } from '@uniswap/sdk-core';
+/**
+ * Computes the pool address for a given pair of tokens, fee, tick spacing, and hooks which
+ * is used to identify the pool on the Uniswap V4 protocol.
+ * @param tokenA - The first token in the pair.
+ * @param tokenB - The second token in the pair.
+ * @param fee - The fee tier for the pool.
+ * @param tickSpacing - The tick spacing for the pool.
+ * @param hooks - The hooks associated with the pool.
+ * @returns The computed pool address as a string.
+ */
+export declare const getPoolId: (tokenA: Token, tokenB: Token, fee: number, tickSpacing: number, hooks: string) => string;
+//# sourceMappingURL=getPoolId.d.ts.map

package/dist/types/lib/getPoolId.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getPoolId.d.ts","sourceRoot":"","sources":["../../../src/lib/getPoolId.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAA;AAO9C;;;;;;;;;GASG;AACH,eAAO,MAAM,SAAS,GAAI,QAAQ,KAAK,EAAE,QAAQ,KAAK,EAAE,KAAK,MAAM,EAAE,aAAa,MAAM,EAAE,OAAO,MAAM,KAAG,MAUzG,CAAA"}

package/dist/types/lib/getPriceFromSqrtX96.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Calculates the price from the square root price in Q96 format.
+ * @param sqrtPriceX96 The square root price in Q96 format.
+ * @param decimalsA The number of decimals for the first token.
+ * @param decimalsB The number of decimals for the second token.
+ * @returns The price as a number.
+ */
+export declare const getPriceFromSqrtX96: (sqrtPriceX96: bigint, decimalsA: number, decimalsB: number) => number;
+//# sourceMappingURL=getPriceFromSqrtX96.d.ts.map

package/dist/types/lib/getPriceFromSqrtX96.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getPriceFromSqrtX96.d.ts","sourceRoot":"","sources":["../../../src/lib/getPriceFromSqrtX96.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,GAAI,cAAc,MAAM,EAAE,WAAW,MAAM,EAAE,WAAW,MAAM,KAAG,MAkBhG,CAAA"}

package/dist/types/lib/index.d.ts

@@ -0,0 +1,5 @@
+export * from './priceFromUniswapV4.ts';
+export * from './pricesFromUniswapV4.ts';
+export * from './tokenRegistryValueToToken.ts';
+export * from './UniswapV4DefaultPools.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/lib/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAA;AACvC,cAAc,0BAA0B,CAAA;AACxC,cAAc,gCAAgC,CAAA;AAC9C,cAAc,4BAA4B,CAAA"}

package/dist/types/lib/priceFromUniswapV4.d.ts

@@ -0,0 +1,5 @@
+import type { UniswapCryptoPair } from '@xyo-network/uniswap-crypto-market-payload-plugin';
+import type { Provider } from 'ethers';
+import type { TokenPairPoolKey } from '../types/index.ts';
+export declare const priceFromUniswapV4: (poolId: TokenPairPoolKey, provider: Provider) => Promise<UniswapCryptoPair>;
+//# sourceMappingURL=priceFromUniswapV4.d.ts.map

package/dist/types/lib/priceFromUniswapV4.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"priceFromUniswapV4.d.ts","sourceRoot":"","sources":["../../../src/lib/priceFromUniswapV4.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAsB,MAAM,mDAAmD,CAAA;AAC9G,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAA;AAGtC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AAIzD,eAAO,MAAM,kBAAkB,GAAU,QAAQ,gBAAgB,EAAE,UAAU,QAAQ,KAAG,OAAO,CAAC,iBAAiB,CAmBhH,CAAA"}

package/dist/types/lib/pricesFromUniswapV4.d.ts

@@ -0,0 +1,5 @@
+import type { UniswapCryptoPair } from '@xyo-network/uniswap-crypto-market-payload-plugin';
+import type { Provider } from 'ethers';
+import type { TokenPairPoolKey } from '../types/index.ts';
+export declare const pricesFromUniswapV4: (poolId: TokenPairPoolKey[], provider: Provider) => Promise<UniswapCryptoPair[]>;
+//# sourceMappingURL=pricesFromUniswapV4.d.ts.map

package/dist/types/lib/pricesFromUniswapV4.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pricesFromUniswapV4.d.ts","sourceRoot":"","sources":["../../../src/lib/pricesFromUniswapV4.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mDAAmD,CAAA;AAC1F,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAA;AAEtC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AAGzD,eAAO,MAAM,mBAAmB,GAAU,QAAQ,gBAAgB,EAAE,EAAE,UAAU,QAAQ,KAAG,OAAO,CAAC,iBAAiB,EAAE,CAErH,CAAA"}

package/dist/types/lib/sortTokens.d.ts

@@ -0,0 +1,23 @@
+import type { Token } from '@uniswap/sdk-core';
+/**
+ * Sorts two tokens in ascending order by address to ensure consistent ordering.
+ *
+ * In Uniswap v2, v3, and v4, pool addresses are deterministically derived using
+ * `CREATE2` with a hash of the pool's initialization parameters. One critical
+ * part of this hash is the `token0` and `token1` addresses. To ensure uniqueness
+ * and prevent duplicate pools (e.g., USDC/WETH and WETH/USDC being treated as different),
+ * Uniswap requires that token pairs be ordered **lexicographically by address**.
+ *
+ * This method ensures that tokens are sorted according to that rule.
+ *
+ * This is required any time you:
+ * - Derive a pool address
+ * - Generate a pool ID
+ * - Call a function that expects a PoolKey or token pair in sorted order
+ *
+ * @param tokenA - The first token to compare
+ * @param tokenB - The second token to compare
+ * @returns A tuple `[token0, token1]` sorted by address in ascending order
+ */
+export declare const sortTokens: (tokenA: Token, tokenB: Token) => [Token, Token];
+//# sourceMappingURL=sortTokens.d.ts.map

package/dist/types/lib/sortTokens.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sortTokens.d.ts","sourceRoot":"","sources":["../../../src/lib/sortTokens.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAA;AAE9C;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,UAAU,GAAI,QAAQ,KAAK,EAAE,QAAQ,KAAK,KAAG,CAAC,KAAK,EAAE,KAAK,CAEtE,CAAA"}

package/dist/types/lib/tokenRegistryValueToToken.d.ts

@@ -0,0 +1,4 @@
+import { Token } from '@uniswap/sdk-core';
+import type { TokenParameters } from '../types/index.ts';
+export declare const tokenRegistryValueToToken: (value: TokenParameters) => Token;
+//# sourceMappingURL=tokenRegistryValueToToken.d.ts.map

package/dist/types/lib/tokenRegistryValueToToken.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tokenRegistryValueToToken.d.ts","sourceRoot":"","sources":["../../../src/lib/tokenRegistryValueToToken.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAA;AAGzC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAExD,eAAO,MAAM,yBAAyB,GAAI,OAAO,eAAe,KAAG,KAMlE,CAAA"}

package/dist/types/types/TokenPairPoolKey.d.ts

@@ -0,0 +1,8 @@
+import type { TokenParameters } from './TokenParameters.ts';
+export type TokenPairPoolKey = {
+    fee: number;
+    hookAddress: string;
+    tickSpacing: number;
+    tokens: [TokenParameters, TokenParameters];
+};
+//# sourceMappingURL=TokenPairPoolKey.d.ts.map

package/dist/types/types/TokenPairPoolKey.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TokenPairPoolKey.d.ts","sourceRoot":"","sources":["../../../src/types/TokenPairPoolKey.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAe3D,MAAM,MAAM,gBAAgB,GAAG;IAC7B,GAAG,EAAE,MAAM,CAAA;IACX,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;IACnB,MAAM,EAAE,CAAC,eAAe,EAAE,eAAe,CAAC,CAAA;CAC3C,CAAA"}

package/dist/types/types/TokenParameters.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Represents the minimal metadata required to define an ERC-20 token
+ * in the context of Uniswap pool interactions, token registries, or
+ * off-chain utilities.
+ *
+ * This structure is designed to be lightweight but expressive enough
+ * to support pool ID generation, token sorting, and on-chain lookups.
+ */
+export type TokenParameters = {
+    /**
+     * The Ethereum address of the token contract.
+     */
+    address: string;
+    /**
+     * The chain ID where this token is deployed.
+     * This enables multi-chain compatibility and avoids collisions between
+     * tokens with the same address on different networks (e.g. mainnet vs testnet).
+     */
+    chainId: number;
+    /**
+     * The number of decimals used by the token.
+     * This is required for correct price calculations and amount formatting.
+     */
+    decimals: number;
+    /**
+     * A short uppercase identifier for the token (e.g. 'USDT', 'WETH').
+     * Used for display, logging, and lookup convenience.
+     */
+    symbol: string;
+    /**
+     * (Optional) The full human-readable name of the token (e.g. 'Tether USD').
+     * Useful for UIs or token metadata enrichment.
+     */
+    name?: string;
+};
+//# sourceMappingURL=TokenParameters.d.ts.map

package/dist/types/types/TokenParameters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TokenParameters.d.ts","sourceRoot":"","sources":["../../../src/types/TokenParameters.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA"}

package/dist/types/types/index.d.ts

@@ -0,0 +1,3 @@
+export * from './TokenPairPoolKey.ts';
+export * from './TokenParameters.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAA;AACrC,cAAc,sBAAsB,CAAA"}

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@xyo-network/uniswap-v4-crypto-market-plugin",
+  "version": "3.5.2",
+  "description": "Typescript/Javascript Plugins for XYO Platform",
+  "homepage": "https://xyo.network",
+  "bugs": {
+    "url": "git+https://github.com/XYOracleNetwork/plugins/issues",
+    "email": "support@xyo.network"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/XYOracleNetwork/plugins.git"
+  },
+  "license": "LGPL-3.0-only",
+  "author": {
+    "name": "XYO Development Team",
+    "email": "support@xyo.network",
+    "url": "https://xyo.network"
+  },
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "default": "./dist/neutral/index.mjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "module": "dist/neutral/index.mjs",
+  "types": "dist/types/index.d.ts",
+  "dependencies": {
+    "@uniswap/sdk-core": "^7.7.2",
+    "@uniswap/v3-sdk": "^3.25.2",
+    "@xylabs/assert": "^4.8.7",
+    "@xylabs/delay": "^4.8.7",
+    "@xylabs/enum": "^4.8.7",
+    "@xylabs/promise": "^4.8.7",
+    "@xyo-network/abstract-witness": "^3.13.0",
+    "@xyo-network/module-model": "^3.13.0",
+    "@xyo-network/open-zeppelin-typechain": "^3.5.2",
+    "@xyo-network/payload-model": "^3.13.0",
+    "@xyo-network/payloadset-plugin": "^3.13.0",
+    "@xyo-network/uniswap-crypto-market-payload-plugin": "^3.5.2",
+    "@xyo-network/uniswap-typechain": "^3.5.2",
+    "@xyo-network/witness-model": "^3.13.0",
+    "ethers": "^6.13.6"
+  },
+  "devDependencies": {
+    "@xylabs/ts-scripts-yarn3": "^6.3.1",
+    "@xylabs/tsconfig": "^6.3.1",
+    "@xylabs/vitest-extended": "^4.8.7",
+    "@xyo-network/payload-wrapper": "^3.13.0",
+    "@xyo-network/witness-blockchain-abstract": "^3.13.0",
+    "typescript": "^5.8.3",
+    "vitest": "^3.1.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/Config.ts

@@ -0,0 +1,9 @@
+import type { UniswapV4CryptoMarketWitnessConfigSchema } from '@xyo-network/uniswap-crypto-market-payload-plugin'
+import type { WitnessConfig } from '@xyo-network/witness-model'
+
+import type { TokenPairPoolKey } from './types/index.ts'
+
+export type UniswapV4CryptoMarketWitnessConfig = WitnessConfig<{
+  poolKeys?: TokenPairPoolKey[]
+  schema: UniswapV4CryptoMarketWitnessConfigSchema
+}>

package/src/Plugin.ts

@@ -0,0 +1,16 @@
+import { PayloadSetSchema } from '@xyo-network/payload-model'
+import { createPayloadSetWitnessPlugin } from '@xyo-network/payloadset-plugin'
+import { UniswapCryptoMarketSchema } from '@xyo-network/uniswap-crypto-market-payload-plugin'
+
+import { UniswapV4CryptoMarketWitness } from './Witness.ts'
+
+export const UniswapV4CryptoMarketPlugin = () =>
+  createPayloadSetWitnessPlugin<UniswapV4CryptoMarketWitness>(
+    { required: { [UniswapCryptoMarketSchema]: 1 }, schema: PayloadSetSchema },
+    {
+      witness: async (params) => {
+        const result = await UniswapV4CryptoMarketWitness.create(params)
+        return result
+      },
+    },
+  )

package/src/Witness.ts

@@ -0,0 +1,49 @@
+import { assertEx } from '@xylabs/assert'
+import { AbstractWitness } from '@xyo-network/abstract-witness'
+import type { AnyConfigSchema } from '@xyo-network/module-model'
+import type { Payload, Schema } from '@xyo-network/payload-model'
+import type { UniswapCryptoMarketPayload } from '@xyo-network/uniswap-crypto-market-payload-plugin'
+import { UniswapCryptoMarketSchema, UniswapV4CryptoMarketWitnessConfigSchema } from '@xyo-network/uniswap-crypto-market-payload-plugin'
+import type { WitnessParams } from '@xyo-network/witness-model'
+import type { Provider } from 'ethers'
+
+import type { UniswapV4CryptoMarketWitnessConfig } from './Config.ts'
+import { pricesFromUniswapV4, UniswapV4DefaultPools } from './lib/index.ts'
+import type { TokenPairPoolKey } from './types/index.ts'
+
+export type UniswapV4CryptoMarketWitnessParams = WitnessParams<
+  AnyConfigSchema<UniswapV4CryptoMarketWitnessConfig>,
+  {
+    provider?: Provider
+  }
+>
+
+export class UniswapV4CryptoMarketWitness<
+  TParams extends UniswapV4CryptoMarketWitnessParams = UniswapV4CryptoMarketWitnessParams,
+> extends AbstractWitness<TParams> {
+  static override readonly configSchemas: Schema[] = [...super.configSchemas, UniswapV4CryptoMarketWitnessConfigSchema]
+  static override readonly defaultConfigSchema: Schema = UniswapV4CryptoMarketWitnessConfigSchema
+
+  protected get pools(): TokenPairPoolKey[] {
+    return this.config?.poolKeys ?? Object.values(UniswapV4DefaultPools)
+  }
+
+  protected get provider() {
+    return assertEx(this.params.provider, () => 'Provider Required')
+  }
+
+  protected override async observeHandler(): Promise<Payload[]> {
+    await this.started('throw')
+    const pairs = await pricesFromUniswapV4(this.pools, this.provider)
+    const timestamp = Date.now()
+    const payload: UniswapCryptoMarketPayload = {
+      pairs, schema: UniswapCryptoMarketSchema, timestamp,
+    }
+    return [payload]
+  }
+
+  protected override async startHandler() {
+    await super.startHandler()
+    return true
+  }
+}

package/src/index.ts

@@ -0,0 +1,4 @@
+export * from './Config.ts'
+export * from './lib/index.ts'
+export { UniswapV4CryptoMarketPlugin as default, UniswapV4CryptoMarketPlugin } from './Plugin.ts'
+export * from './Witness.ts'

package/src/lib/UniswapV4ContractAddresses.ts

@@ -0,0 +1,11 @@
+// https://docs.uniswap.org/contracts/v4/deployments#mainnet-deployments
+export const UniswapV4ContractAddresses = {
+  Ethereum: {
+    PoolManager: '0x000000000004444c5dc75cB358380D2e3dE08A90',
+    PositionDescriptor: '0xd1428ba554f4c8450b763a0b2040a4935c63f06c',
+    PositionManager: '0xbd216513d74c8cf14cf4747e6aaa6420ff64ee9e',
+    Quoter: '0x52f0e24d1c21c8a0cb1e5a5dd6198556bd9e1203',
+    StateView: '0x7ffe42c4a5deea5b0fec41c94c136cf115597227',
+    UniversalRouter: '0x66a9893cc07d91d95644aedd05d03f95e1dba8af',
+  },
+}

package/src/lib/UniswapV4DefaultPools.ts

@@ -0,0 +1,27 @@
+import { ZeroAddress } from 'ethers'
+
+import type { TokenPairPoolKey, TokenParameters } from '../types/index.ts'
+
+export const TokenRegistry: Record<string, TokenParameters> = {
+  USDT: {
+    address: '0xdac17f958d2ee523a2206206994597c13d831ec7',
+    chainId: 1,
+    decimals: 6,
+    symbol: 'USDT',
+  },
+  XYO: {
+    address: '0x55296f69f40ea6d20e478533c15a6b08b654e758',
+    chainId: 1,
+    decimals: 18,
+    symbol: 'XYO',
+  },
+} as const
+
+export const UniswapV4DefaultPools: Record<string, TokenPairPoolKey> = {
+  'XYO:USDT': {
+    fee: 3000,
+    hookAddress: ZeroAddress,
+    tickSpacing: 60,
+    tokens: [TokenRegistry.XYO, TokenRegistry.USDT],
+  },
+} as const

package/src/lib/UniswapV4TokenIdentifier.ts

@@ -0,0 +1,7 @@
+export interface UniswapV4TokenIdentifier {
+  chainId: number
+  address: string
+  decimals: number
+  symbol?: string
+  name?: string
+}

package/src/lib/getExchangeRate.ts

@@ -0,0 +1,35 @@
+import type { Token } from '@uniswap/sdk-core'
+import { IStateView__factory } from '@xyo-network/uniswap-typechain/v4-periphery'
+import { ZeroAddress } from 'ethers/constants'
+import type { Provider } from 'ethers/providers'
+
+import { getPoolId } from './getPoolId.ts'
+import { getPriceFromSqrtX96 } from './getPriceFromSqrtX96.ts'
+import { sortTokens } from './sortTokens.ts'
+import { UniswapV4ContractAddresses } from './UniswapV4ContractAddresses.ts'
+
+/**
+ * Returns the price of the token pair in the Uniswap V4 pool.
+ * @param tokenA The first token in the pair.
+ * @param tokenB The second token in the pair.
+ * @param fee The fee tier for the pool.
+ * @param hookAddress The address of the hook contract. Default is ZeroAddress.
+ * @param provider The EVM provider to use for the transaction.
+ * @returns The price of the token pair.
+ */
+export const getExchangeRate = async (
+  tokenA: Token,
+  tokenB: Token,
+  fee: number,
+  hookAddress: string | undefined,
+  provider: Provider,
+): Promise<number> => {
+  const hooks = hookAddress || ZeroAddress
+  const stateView = IStateView__factory.connect(UniswapV4ContractAddresses.Ethereum.StateView, provider)
+  const [token0, token1] = sortTokens(tokenA, tokenB)
+  const poolId: string = getPoolId(token0, token1, fee, 60, hooks)
+  if (poolId === ZeroAddress) throw new Error('Invalid poolId')
+  const response = await stateView.getSlot0(poolId)
+  const price = getPriceFromSqrtX96(response.sqrtPriceX96, token1.decimals, token0.decimals)
+  return price
+}

package/src/lib/getPoolId.ts

@@ -0,0 +1,28 @@
+import type { Token } from '@uniswap/sdk-core'
+import { AbiCoder } from 'ethers/abi'
+import { ZeroAddress } from 'ethers/constants'
+import { keccak256 } from 'ethers/crypto'
+
+import { sortTokens } from './sortTokens.ts'
+
+/**
+ * Computes the pool address for a given pair of tokens, fee, tick spacing, and hooks which
+ * is used to identify the pool on the Uniswap V4 protocol.
+ * @param tokenA - The first token in the pair.
+ * @param tokenB - The second token in the pair.
+ * @param fee - The fee tier for the pool.
+ * @param tickSpacing - The tick spacing for the pool.
+ * @param hooks - The hooks associated with the pool.
+ * @returns The computed pool address as a string.
+ */
+export const getPoolId = (tokenA: Token, tokenB: Token, fee: number, tickSpacing: number, hooks: string): string => {
+  const [currency0, currency1] = sortTokens(tokenA, tokenB)
+  const currency0Addr = currency0.isNative ? ZeroAddress : currency0.wrapped.address
+  const currency1Addr = currency1.isNative ? ZeroAddress : currency1.wrapped.address
+  return keccak256(
+    AbiCoder.defaultAbiCoder().encode(
+      ['address', 'address', 'uint24', 'int24', 'address'],
+      [currency0Addr, currency1Addr, fee, tickSpacing, hooks],
+    ),
+  )
+}

package/src/lib/getPriceFromSqrtX96.ts

@@ -0,0 +1,26 @@
+/**
+ * Calculates the price from the square root price in Q96 format.
+ * @param sqrtPriceX96 The square root price in Q96 format.
+ * @param decimalsA The number of decimals for the first token.
+ * @param decimalsB The number of decimals for the second token.
+ * @returns The price as a number.
+ */
+export const getPriceFromSqrtX96 = (sqrtPriceX96: bigint, decimalsA: number, decimalsB: number): number => {
+  const Q96 = 2n ** 96n
+
+  // Scale to avoid floating point math by using a 1e18 factor
+  const numerator = sqrtPriceX96 * sqrtPriceX96 * 10n ** 18n
+  const denominator = Q96 * Q96
+
+  let price = numerator / denominator
+
+  // Adjust for decimal differences
+  const decimalAdjustment = decimalsB - decimalsA
+  if (decimalAdjustment > 0) {
+    price *= 10n ** BigInt(decimalAdjustment)
+  } else if (decimalAdjustment < 0) {
+    price /= 10n ** BigInt(-decimalAdjustment)
+  }
+
+  return Number(price) / 1e18
+}

package/src/lib/index.ts

@@ -0,0 +1,4 @@
+export * from './priceFromUniswapV4.ts'
+export * from './pricesFromUniswapV4.ts'
+export * from './tokenRegistryValueToToken.ts'
+export * from './UniswapV4DefaultPools.ts'

package/src/lib/priceFromUniswapV4.ts

@@ -0,0 +1,28 @@
+import type { UniswapCryptoPair, UniswapCryptoToken } from '@xyo-network/uniswap-crypto-market-payload-plugin'
+import type { Provider } from 'ethers'
+import { ZeroAddress } from 'ethers'
+
+import type { TokenPairPoolKey } from '../types/index.ts'
+import { getExchangeRate } from './getExchangeRate.ts'
+import { tokenRegistryValueToToken } from './tokenRegistryValueToToken.ts'
+
+export const priceFromUniswapV4 = async (poolId: TokenPairPoolKey, provider: Provider): Promise<UniswapCryptoPair> => {
+  const {
+    tokens, fee, hookAddress = ZeroAddress,
+  } = poolId
+  const tokenA = tokenRegistryValueToToken(tokens[0])
+  const tokenB = tokenRegistryValueToToken(tokens[1])
+  const rate = await getExchangeRate(tokenA, tokenB, fee, hookAddress, provider)
+  const token0: UniswapCryptoToken = {
+    address: tokenA.address,
+    symbol: tokenA.symbol || '',
+    value: Math.max(rate, 0),
+  }
+  const token1: UniswapCryptoToken = {
+    address: tokenB.address,
+    symbol: tokenB.symbol || '',
+    value: rate > 0 ? Number((1 / rate).toPrecision(6)) : 0,
+  }
+  const pair: UniswapCryptoPair = { tokens: [token0, token1] }
+  return pair
+}

package/src/lib/pricesFromUniswapV4.ts

@@ -0,0 +1,9 @@
+import type { UniswapCryptoPair } from '@xyo-network/uniswap-crypto-market-payload-plugin'
+import type { Provider } from 'ethers'
+
+import type { TokenPairPoolKey } from '../types/index.ts'
+import { priceFromUniswapV4 } from './priceFromUniswapV4.ts'
+
+export const pricesFromUniswapV4 = async (poolId: TokenPairPoolKey[], provider: Provider): Promise<UniswapCryptoPair[]> => {
+  return await Promise.all(poolId.map(pool => priceFromUniswapV4(pool, provider)))
+}

package/src/lib/sortTokens.ts

@@ -0,0 +1,25 @@
+import type { Token } from '@uniswap/sdk-core'
+
+/**
+ * Sorts two tokens in ascending order by address to ensure consistent ordering.
+ *
+ * In Uniswap v2, v3, and v4, pool addresses are deterministically derived using
+ * `CREATE2` with a hash of the pool's initialization parameters. One critical
+ * part of this hash is the `token0` and `token1` addresses. To ensure uniqueness
+ * and prevent duplicate pools (e.g., USDC/WETH and WETH/USDC being treated as different),
+ * Uniswap requires that token pairs be ordered **lexicographically by address**.
+ *
+ * This method ensures that tokens are sorted according to that rule.
+ *
+ * This is required any time you:
+ * - Derive a pool address
+ * - Generate a pool ID
+ * - Call a function that expects a PoolKey or token pair in sorted order
+ *
+ * @param tokenA - The first token to compare
+ * @param tokenB - The second token to compare
+ * @returns A tuple `[token0, token1]` sorted by address in ascending order
+ */
+export const sortTokens = (tokenA: Token, tokenB: Token): [Token, Token] => {
+  return tokenA.sortsBefore(tokenB) ? [tokenA, tokenB] : [tokenB, tokenA]
+}

package/src/lib/tokenRegistryValueToToken.ts

@@ -0,0 +1,12 @@
+import { Token } from '@uniswap/sdk-core'
+import { getAddress } from 'ethers/address'
+
+import type { TokenParameters } from '../types/index.ts'
+
+export const tokenRegistryValueToToken = (value: TokenParameters): Token => {
+  const {
+    address, chainId, decimals, symbol, name,
+  } = value
+  const normalizedAddress = getAddress(address.toLowerCase())
+  return new Token(chainId, normalizedAddress, decimals, symbol, name)
+}

package/src/types/TokenPairPoolKey.ts

@@ -0,0 +1,21 @@
+import type { TokenParameters } from './TokenParameters.ts'
+
+// NOTE: We could import this type from @uniswap/v4-core, but
+// they are currently hardcoded the  ethers v5 which
+// causes many issues since we are using ethers v6.  Moreover,
+// we would have to hit the ERC20 contract to get the decimals
+// and name of the token, which is not ideal as it never changes.
+// export type PoolKey = {
+//   currency0: string
+//   currency1: string
+//   fee: number
+//   tickSpacing: number
+//   hooks: string
+// }
+
+export type TokenPairPoolKey = {
+  fee: number
+  hookAddress: string
+  tickSpacing: number
+  tokens: [TokenParameters, TokenParameters]
+}

package/src/types/TokenParameters.ts

@@ -0,0 +1,39 @@
+/**
+ * Represents the minimal metadata required to define an ERC-20 token
+ * in the context of Uniswap pool interactions, token registries, or
+ * off-chain utilities.
+ *
+ * This structure is designed to be lightweight but expressive enough
+ * to support pool ID generation, token sorting, and on-chain lookups.
+ */
+export type TokenParameters = {
+  /**
+   * The Ethereum address of the token contract.
+   */
+  address: string
+
+  /**
+   * The chain ID where this token is deployed.
+   * This enables multi-chain compatibility and avoids collisions between
+   * tokens with the same address on different networks (e.g. mainnet vs testnet).
+   */
+  chainId: number
+
+  /**
+   * The number of decimals used by the token.
+   * This is required for correct price calculations and amount formatting.
+   */
+  decimals: number
+
+  /**
+   * A short uppercase identifier for the token (e.g. 'USDT', 'WETH').
+   * Used for display, logging, and lookup convenience.
+   */
+  symbol: string
+
+  /**
+   * (Optional) The full human-readable name of the token (e.g. 'Tether USD').
+   * Useful for UIs or token metadata enrichment.
+   */
+  name?: string
+}

package/src/types/index.ts

@@ -0,0 +1,2 @@
+export * from './TokenPairPoolKey.ts'
+export * from './TokenParameters.ts'

package/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPoints": ["./src/index.ts"],
+  "tsconfig": "./tsconfig.typedoc.json"
+}

package/xy.config.ts

@@ -0,0 +1,10 @@
+import type { XyTsupConfig } from '@xylabs/ts-scripts-yarn3'
+const config: XyTsupConfig = {
+  compile: {
+    browser: {},
+    node: {},
+    neutral: { src: true },
+  },
+}
+
+export default config