@xyo-network/uniswap-v4-crypto-market-plugin 4.0.0 → 4.1.0

package/dist/neutral/index.d.ts

@@ -0,0 +1,82 @@
+import { UniswapV4CryptoMarketWitnessConfigSchema, UniswapCryptoPair } from '@xyo-network/uniswap-crypto-market-payload-plugin';
+import { WitnessConfig, WitnessParams } from '@xyo-network/witness-model';
+import { Provider } from 'ethers';
+import { Token } from '@uniswap/sdk-core';
+import * as _xyo_network_payloadset_plugin from '@xyo-network/payloadset-plugin';
+import { AbstractWitness } from '@xyo-network/abstract-witness';
+import { AnyConfigSchema } from '@xyo-network/module-model';
+import { Schema, Payload } from '@xyo-network/payload-model';
+
+/**
+ * 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.
+ */
+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;
+};
+
+type TokenPairPoolKey = {
+    fee: number;
+    hookAddress: string;
+    tickSpacing: number;
+    tokens: [TokenParameters, TokenParameters];
+};
+
+type UniswapV4CryptoMarketWitnessConfig = WitnessConfig<{
+    poolKeys?: TokenPairPoolKey[];
+    schema: UniswapV4CryptoMarketWitnessConfigSchema;
+}>;
+
+declare const priceFromUniswapV4: (poolId: TokenPairPoolKey, provider: Provider) => Promise<UniswapCryptoPair>;
+
+declare const pricesFromUniswapV4: (poolId: TokenPairPoolKey[], provider: Provider) => Promise<UniswapCryptoPair[]>;
+
+declare const tokenRegistryValueToToken: (value: TokenParameters) => Token;
+
+declare const TokenRegistry: Record<string, TokenParameters>;
+declare const UniswapV4DefaultPools: Record<string, TokenPairPoolKey>;
+
+interface UniswapV4CryptoMarketWitnessParams extends WitnessParams<AnyConfigSchema<UniswapV4CryptoMarketWitnessConfig>> {
+    provider?: Provider;
+}
+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<void>;
+}
+
+declare const UniswapV4CryptoMarketPlugin: () => _xyo_network_payloadset_plugin.PayloadSetWitnessPlugin<UniswapV4CryptoMarketWitness<UniswapV4CryptoMarketWitnessParams>>;
+
+export { TokenRegistry, UniswapV4CryptoMarketPlugin, UniswapV4CryptoMarketWitness, UniswapV4DefaultPools, UniswapV4CryptoMarketPlugin as default, priceFromUniswapV4, pricesFromUniswapV4, tokenRegistryValueToToken };
+export type { UniswapV4CryptoMarketWitnessConfig, UniswapV4CryptoMarketWitnessParams };

package/dist/neutral/lib/spec/priceFromUniswapV4.spec.d.ts

@@ -0,0 +1,2 @@
+import '@xylabs/vitest-extended';
+//# sourceMappingURL=priceFromUniswapV4.spec.d.ts.map

package/dist/neutral/lib/spec/priceFromUniswapV4.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"priceFromUniswapV4.spec.d.ts","sourceRoot":"","sources":["../../../../src/lib/spec/priceFromUniswapV4.spec.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAA"}

package/dist/neutral/spec/Plugin.spec.d.ts

@@ -0,0 +1,2 @@
+import '@xylabs/vitest-extended';
+//# sourceMappingURL=Plugin.spec.d.ts.map

package/dist/neutral/spec/Plugin.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Plugin.spec.d.ts","sourceRoot":"","sources":["../../../src/spec/Plugin.spec.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAA"}

package/dist/neutral/spec/Witness.spec.d.ts

@@ -0,0 +1,2 @@
+import '@xylabs/vitest-extended';
+//# sourceMappingURL=Witness.spec.d.ts.map

package/dist/neutral/spec/Witness.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Witness.spec.d.ts","sourceRoot":"","sources":["../../../src/spec/Witness.spec.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/uniswap-v4-crypto-market-plugin",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "description": "Typescript/Javascript Plugins for XYO Platform",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -21,31 +21,31 @@
   "type": "module",
   "exports": {
     ".": {
-      "types": "./dist/types/index.d.ts",
+      "types": "./dist/neutral/index.d.ts",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
   "module": "dist/neutral/index.mjs",
-  "types": "dist/types/index.d.ts",
+  "types": "dist/neutral/index.d.ts",
   "dependencies": {
     "@uniswap/sdk-core": "^7.7.2",
-    "@xylabs/assert": "^4.12.31",
-    "@xyo-network/abstract-witness": "^4.0.1",
-    "@xyo-network/module-model": "^4.0.1",
-    "@xyo-network/payload-model": "^4.0.1",
-    "@xyo-network/payloadset-plugin": "^4.0.1",
-    "@xyo-network/uniswap-crypto-market-payload-plugin": "^4.0.0",
+    "@xylabs/assert": "^4.13.15",
+    "@xyo-network/abstract-witness": "^4.1.1",
+    "@xyo-network/module-model": "^4.1.1",
+    "@xyo-network/payload-model": "^4.1.1",
+    "@xyo-network/payloadset-plugin": "^4.1.1",
+    "@xyo-network/uniswap-crypto-market-payload-plugin": "^4.1.0",
     "@xyo-network/uniswap-typechain": "^3.5.4",
-    "@xyo-network/witness-model": "^4.0.1",
+    "@xyo-network/witness-model": "^4.1.1",
     "ethers": "^6.15.0"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^6.5.12",
-    "@xylabs/tsconfig": "^6.5.12",
-    "@xylabs/vitest-extended": "^4.12.31",
-    "@xyo-network/payload-wrapper": "^4.0.1",
-    "@xyo-network/witness-blockchain-abstract": "^4.0.1",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.24",
+    "@xylabs/tsconfig": "^7.0.0-rc.24",
+    "@xylabs/vitest-extended": "^4.13.15",
+    "@xyo-network/payload-wrapper": "^4.1.1",
+    "@xyo-network/witness-blockchain-abstract": "^4.1.1",
     "knip": "^5.61.3",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"

package/dist/types/index.d.ts

@@ -1,5 +0,0 @@
-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