lynx-client 0.0.1-beta.9 → 0.0.3

package/dist/cjs/lib/contractsIntegration/deployedContractsConnector.js

@@ -1,22 +1,133 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.connectToRegistryProxyForSigner = connectToRegistryProxyForSigner;
+exports.connectToLatestRegistryForSigner = connectToLatestRegistryForSigner;
+exports.connectToLatestRegistry = connectToLatestRegistry;
+exports.connectToTradingFloorProxyForSigner = connectToTradingFloorProxyForSigner;
+exports.connectToTradingFloorProxy = connectToTradingFloorProxy;
+exports.connectToLatestTradingFloorForSigner = connectToLatestTradingFloorForSigner;
+exports.connectToLatestTradingFloor = connectToLatestTradingFloor;
+exports.connectToOrderBookProxyForSigner = connectToOrderBookProxyForSigner;
+exports.connectToOrderBookProxy = connectToOrderBookProxy;
+exports.connectToLatestOrderBookForSigner = connectToLatestOrderBookForSigner;
+exports.connectToLatestOrderBook = connectToLatestOrderBook;
+exports.connectToLatestTradersPortalForSigner = connectToLatestTradersPortalForSigner;
+exports.connectToLatestTradersPortal = connectToLatestTradersPortal;
+exports.connectToLatestTriggersForSigner = connectToLatestTriggersForSigner;
+exports.connectToLatestTriggers = connectToLatestTriggers;
 exports.connectToTradingFloorLens = connectToTradingFloorLens;
 exports.connectToLeXLens = connectToLeXLens;
-exports.connectToIntentsVerifierLens = connectToIntentsVerifierLens;
-exports.connectToTriggersAndPortalLens = connectToTriggersAndPortalLens;
+exports.createIntentsVerifierLensService = createIntentsVerifierLensService;
+exports.createTriggersAndPortalLensService = createTriggersAndPortalLensService;
+exports.createTradingFloorLensService = createTradingFloorLensService;
+exports.createLexLensService = createLexLensService;
 const TradingFloorLens__factory_1 = require("../typechain/factories/contracts/Peripheral/Lens/TradingFloorLens__factory");
 const LexLens__factory_1 = require("../typechain/factories/contracts/Peripheral/Lens/LexLens__factory");
-const IntentsVerifierLens__factory_1 = require("../typechain/factories/contracts/Peripheral/Lens/IntentsVerifierLens__factory");
-const TriggersAndPortalLens__factory_1 = require("../typechain/factories/contracts/Peripheral/Lens/TriggersAndPortalLens__factory");
+const RegistryProxy__factory_1 = require("../typechain/factories/contracts/Lynx/Registry/RegistryProxy__factory");
+const RegistryV1__factory_1 = require("../typechain/factories/contracts/Lynx/Registry/RegistryV1__factory");
+const TradingFloorProxy__factory_1 = require("../typechain/factories/contracts/Lynx/TradingFloor/TradingFloorProxy__factory");
+const TradingFloorV1__factory_1 = require("../typechain/factories/contracts/Lynx/TradingFloor/TradingFloorV1__factory");
+const OrderBookProxy__factory_1 = require("../typechain/factories/contracts/Lynx/OrderBook/OrderBookProxy__factory");
+const OrderBookV1__factory_1 = require("../typechain/factories/contracts/Lynx/OrderBook/OrderBookV1__factory");
+const TradersPortalV1__factory_1 = require("../typechain/factories/contracts/Lynx/TradersPortal/TradersPortalV1__factory");
+const TriggersV1__factory_1 = require("../typechain/factories/contracts/Lynx/Triggers/TriggersV1__factory");
+const IntentsVerifierLensService_1 = require("./IntentsVerifierLensService");
+const TriggersAndPortalLensService_1 = require("./TriggersAndPortalLensService");
+const TradingFloorLensService_1 = require("./TradingFloorLensService");
+const LexLensService_1 = require("./LexLensService");
+//
+// ***** Registry & Proxy *****
+//
+function connectToRegistryProxyForSigner(signer, address) {
+    return RegistryProxy__factory_1.RegistryProxy__factory.connect(address, signer);
+}
+/**
+ * To be used with the proxy address and the implementation ABI
+ */
+function connectToLatestRegistryForSigner(signer, address) {
+    return RegistryV1__factory_1.RegistryV1__factory.connect(address, signer);
+}
+/**
+ * To be used with the proxy address and the implementation ABI
+ */
+function connectToLatestRegistry(provider, address) {
+    return RegistryV1__factory_1.RegistryV1__factory.connect(address, provider);
+}
+//
+// ***** Trading Floor & Proxy *****
+//
+function connectToTradingFloorProxyForSigner(signer, address) {
+    return TradingFloorProxy__factory_1.TradingFloorProxy__factory.connect(address, signer);
+}
+function connectToTradingFloorProxy(provider, address) {
+    return TradingFloorProxy__factory_1.TradingFloorProxy__factory.connect(address, provider);
+}
+/**
+ * To be used with the proxy address and the implementation ABI
+ */
+function connectToLatestTradingFloorForSigner(signer, address) {
+    return TradingFloorV1__factory_1.TradingFloorV1__factory.connect(address, signer);
+}
+/**
+ * To be used with the proxy address and the implementation ABI
+ */
+function connectToLatestTradingFloor(provider, address) {
+    return TradingFloorV1__factory_1.TradingFloorV1__factory.connect(address, provider);
+}
+//
+// ***** Order Book Proxy *****
+//
+function connectToOrderBookProxyForSigner(signer, address) {
+    return OrderBookProxy__factory_1.OrderBookProxy__factory.connect(address, signer);
+}
+function connectToOrderBookProxy(provider, address) {
+    return OrderBookProxy__factory_1.OrderBookProxy__factory.connect(address, provider);
+}
+//
+// ***** Order Book *****
+//
+function connectToLatestOrderBookForSigner(signer, address) {
+    return OrderBookV1__factory_1.OrderBookV1__factory.connect(address, signer);
+}
+function connectToLatestOrderBook(provider, address) {
+    return OrderBookV1__factory_1.OrderBookV1__factory.connect(address, provider);
+}
+//
+// Trading
+//
+function connectToLatestTradersPortalForSigner(signer, address) {
+    return TradersPortalV1__factory_1.TradersPortalV1__factory.connect(address, signer);
+}
+function connectToLatestTradersPortal(provider, address) {
+    return TradersPortalV1__factory_1.TradersPortalV1__factory.connect(address, provider);
+}
+//
+// Triggers
+//
+function connectToLatestTriggersForSigner(signer, address) {
+    return TriggersV1__factory_1.TriggersV1__factory.connect(address, signer);
+}
+function connectToLatestTriggers(provider, address) {
+    return TriggersV1__factory_1.TriggersV1__factory.connect(address, provider);
+}
 function connectToTradingFloorLens(provider, address) {
     return TradingFloorLens__factory_1.TradingFloorLens__factory.connect(address, provider);
 }
 function connectToLeXLens(provider, address) {
     return LexLens__factory_1.LexLens__factory.connect(address, provider);
 }
-function connectToIntentsVerifierLens(provider, address) {
-    return IntentsVerifierLens__factory_1.IntentsVerifierLens__factory.connect(address, provider);
+//
+// ***** Lens Services *****
+//
+function createIntentsVerifierLensService(signerOrProvider, address) {
+    return new IntentsVerifierLensService_1.IntentsVerifierLensService(signerOrProvider, address);
+}
+function createTriggersAndPortalLensService(signerOrProvider, address) {
+    return new TriggersAndPortalLensService_1.TriggersAndPortalLensService(signerOrProvider, address);
+}
+function createTradingFloorLensService(signerOrProvider, address) {
+    return new TradingFloorLensService_1.TradingFloorLensService(signerOrProvider, address);
 }
-function connectToTriggersAndPortalLens(provider, address) {
-    return TriggersAndPortalLens__factory_1.TriggersAndPortalLens__factory.connect(address, provider);
+function createLexLensService(signerOrProvider, address) {
+    return new LexLensService_1.LexLensService(signerOrProvider, address);
 }

package/dist/cjs/lib/devex/getChainAddresses.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getChainAddresses = getChainAddresses;
+const systemAddresses_1 = require("../addresses/systemAddresses");
+const lensAddresses_1 = require("../addresses/lensAddresses");
+const deployedContractsConnector_1 = require("../contractsIntegration/deployedContractsConnector");
+const chainMappings_1 = require("../chains/chainMappings");
+/**
+ * Get all Lynx system contract addresses for a specific chain
+ * @param options - Chain ID and provider
+ * @returns Promise<ILynxChainAddresses> - All system contract addresses
+ * @throws Error if chain is not supported
+ *
+ * @example
+ * ```typescript
+ * import { getChainAddresses } from 'lynx-client/devex';
+ * import { ethers } from 'ethers';
+ *
+ * const provider = new ethers.JsonRpcProvider('https://rpc.example.com');
+ * const addresses = await getChainAddresses({ chainId: 146, provider });
+ *
+ * console.log(addresses.tradingFloorAddress); // Address of TradingFloor contract
+ * ```
+ */
+async function getChainAddresses(options) {
+    const { chainId, provider } = options;
+    // Find the chain configuration
+    const chainEntry = Object.entries(chainMappings_1.ENGINE_CHAIN_ID_BY_NAME).find(([_, id]) => id === chainId);
+    if (!chainEntry) {
+        throw new Error(`Chain ID ${chainId} is not supported by Lynx protocol engine chains`);
+    }
+    const [chainKey] = chainEntry;
+    const addresses = systemAddresses_1.LynxSystemAddresses[chainKey];
+    const lensAddresses = lensAddresses_1.LensAddresses[chainKey];
+    const chainName = chainMappings_1.ENGINE_CHAIN_DISPLAY_NAME[chainKey];
+    // Connect to registry to get current implementation addresses
+    const registry = (0, deployedContractsConnector_1.connectToLatestRegistry)(provider, addresses.registryProxyAddress);
+    try {
+        // Fetch all contract addresses from registry
+        const [tradersPortal, orderBook, triggers,] = await Promise.all([
+            registry.tradersPortal(),
+            registry.orderBook(),
+            registry.triggers(),
+        ]);
+        // Get registry implementation
+        const registryImplementation = await registry.implementation();
+        return {
+            chainId,
+            chainName,
+            registryProxyAddress: addresses.registryProxyAddress,
+            registryImplementationAddress: registryImplementation,
+            tradersPortalAddress: tradersPortal,
+            tradingFloorAddress: addresses.tradingFloorProxyAddress,
+            orderBookAddress: orderBook,
+            triggersAddress: triggers,
+            lexLensAddress: lensAddresses.lexLens,
+            tradingFloorLensAddress: lensAddresses.tradingFloorLensLens,
+            intentsVerifierLensAddress: lensAddresses.intentsVerifierLens,
+            triggersAndPortalLensAddress: lensAddresses.triggersAndPortalLens,
+        };
+    }
+    catch (error) {
+        throw new Error(`Failed to fetch addresses from registry on chain ${chainId}: ${error instanceof Error ? error.message : 'Unknown error'}`);
+    }
+}

package/dist/cjs/lib/devex/getSupportedEngineChains.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSupportedEngineChains = getSupportedEngineChains;
+exports.isEngineChainId = isEngineChainId;
+const systemAddresses_1 = require("../addresses/systemAddresses");
+const chainMappings_1 = require("../chains/chainMappings");
+/**
+ * Get all chains supported by the Lynx protocol
+ * @returns Array of supported chains with their details
+ *
+ * @example
+ * ```typescript
+ * import { getSupportedChains } from 'lynx-client/devex';
+ *
+ * const chains = getSupportedChains();
+ * chains.forEach(chain => {
+ *   console.log(`${chain.chainName} (${chain.chainId}): ${chain.registryProxyAddress}`);
+ * });
+ * ```
+ */
+function getSupportedEngineChains() {
+    return Object.entries(systemAddresses_1.LynxSystemAddresses).map(([chainKey, config]) => ({
+        chainId: chainMappings_1.ENGINE_CHAIN_ID_BY_NAME[chainKey],
+        chainName: chainMappings_1.ENGINE_CHAIN_DISPLAY_NAME[chainKey] || chainKey,
+        chainKey,
+        registryProxyAddress: config.registryProxyAddress,
+    }));
+}
+/**
+ * Check if a chain is supported by the Lynx protocol
+ * @param chainId - The chain ID to check
+ * @returns boolean - true if supported, false otherwise
+ *
+ * @example
+ * ```typescript
+ * import { isChainSupported } from 'lynx-client/devex';
+ *
+ * if (isChainSupported(146)) {
+ *   console.log('Sonic chain is supported!');
+ * }
+ * ```
+ */
+function isEngineChainId(chainId) {
+    return Object.values(chainMappings_1.ENGINE_CHAIN_ID_BY_NAME).includes(chainId);
+}

package/dist/cjs/lib/devex/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isEngineChainId = exports.getSupportedEngineChains = exports.getChainAddresses = void 0;
+// Developer Experience utilities
+var getChainAddresses_1 = require("./getChainAddresses");
+Object.defineProperty(exports, "getChainAddresses", { enumerable: true, get: function () { return getChainAddresses_1.getChainAddresses; } });
+var getSupportedEngineChains_1 = require("./getSupportedEngineChains");
+Object.defineProperty(exports, "getSupportedEngineChains", { enumerable: true, get: function () { return getSupportedEngineChains_1.getSupportedEngineChains; } });
+Object.defineProperty(exports, "isEngineChainId", { enumerable: true, get: function () { return getSupportedEngineChains_1.isEngineChainId; } });

package/dist/cjs/lib/devex/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/lib/lynxSystem/hashes.js

@@ -1,8 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.hashContractName = hashContractName;
+exports.hashRoleName = hashRoleName;
 const ethers_1 = require("ethers");
 function hashContractName(contractName) {
     const contractNameHash = ethers_1.ethers.solidityPackedKeccak256(["string"], [contractName]);
     return contractNameHash;
 }
+/**
+ * Helper function to hash role names for use in role-based access control tests
+ * @param roleName The human-readable role name
+ * @returns The keccak256 hash of the role name as a hex string
+ */
+function hashRoleName(roleName) {
+    return ethers_1.ethers.keccak256(ethers_1.ethers.toUtf8Bytes(roleName));
+}

package/dist/cjs/lib/lynxSystem/lynxScalesUtils.js

@@ -4,6 +4,8 @@ exports.precisionBnToFloat = precisionBnToFloat;
 exports.floatToPrecisionBn = floatToPrecisionBn;
 exports.priceBnToFloat = priceBnToFloat;
 exports.floatToPriceBn = floatToPriceBn;
+exports.fractionBnToFloat = fractionBnToFloat;
+exports.floatToFractionBn = floatToFractionBn;
 const scales_1 = require("../constants/scales");
 const bignumbers_1 = require("../utils/bignumbers");
 function precisionBnToFloat(precisionBn) {
@@ -18,3 +20,9 @@ function priceBnToFloat(pricesBn) {
 function floatToPriceBn(priceUnits) {
     return (0, bignumbers_1.floatToUnitsBn)(priceUnits, scales_1.PRICES_SCALE);
 }
+function fractionBnToFloat(fractionBn) {
+    return Number(fractionBn) / Number(scales_1.FRACTION_MULTIPLIER_SCALE);
+}
+function floatToFractionBn(fractionUnits) {
+    return BigInt(Math.round(fractionUnits * Number(scales_1.FRACTION_MULTIPLIER_SCALE)));
+}

package/dist/cjs/lib/lynxSystem/registry/registryReading.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readTradersPortalAddress = readTradersPortalAddress;
+exports.readTriggersAddress = readTriggersAddress;
+exports.readChipsFactoryAddress = readChipsFactoryAddress;
+exports.readLexProxiesFactoryAddress = readLexProxiesFactoryAddress;
+exports.readChipsIntentsVerifierAddress = readChipsIntentsVerifierAddress;
+exports.readLiquidityIntentsVerifierAddress = readLiquidityIntentsVerifierAddress;
+exports.readTradeIntentsVerifierAddress = readTradeIntentsVerifierAddress;
+const deployedContractsConnector_1 = require("../../contractsIntegration/deployedContractsConnector");
+async function readTradersPortalAddress(provider, registryProxyAddress) {
+    const registry = (0, deployedContractsConnector_1.connectToLatestRegistry)(provider, registryProxyAddress);
+    return await registry.tradersPortal();
+}
+async function readTriggersAddress(provider, registryProxyAddress) {
+    const registry = (0, deployedContractsConnector_1.connectToLatestRegistry)(provider, registryProxyAddress);
+    return await registry.triggers();
+}
+async function readChipsFactoryAddress(provider, registryProxyAddress) {
+    const registry = (0, deployedContractsConnector_1.connectToLatestRegistry)(provider, registryProxyAddress);
+    return await registry.chipsFactory();
+}
+async function readLexProxiesFactoryAddress(provider, registryProxyAddress) {
+    const registry = (0, deployedContractsConnector_1.connectToLatestRegistry)(provider, registryProxyAddress);
+    return await registry.lexProxiesFactory();
+}
+async function readChipsIntentsVerifierAddress(provider, registryProxyAddress) {
+    const registry = (0, deployedContractsConnector_1.connectToLatestRegistry)(provider, registryProxyAddress);
+    return await registry.chipsIntentsVerifier();
+}
+async function readLiquidityIntentsVerifierAddress(provider, registryProxyAddress) {
+    const registry = (0, deployedContractsConnector_1.connectToLatestRegistry)(provider, registryProxyAddress);
+    return await registry.liquidityIntentsVerifier();
+}
+async function readTradeIntentsVerifierAddress(provider, registryProxyAddress) {
+    const registry = (0, deployedContractsConnector_1.connectToLatestRegistry)(provider, registryProxyAddress);
+    return await registry.tradeIntentsVerifier();
+}

package/dist/cjs/lib/priceFeeds/pyth/pythFeedConstants.js

@@ -43,6 +43,7 @@ exports.PYTH_PAIRS_PRICE_FEED_IDS = {
     [pairIds_1.PAIR_CONFIGS_IDS.FTM_USD]: "0xf490b178d0c85683b7a0f2388b40af2e6f7c90cbe0f96b31f315f08d0e5a2d6d",
     [pairIds_1.PAIR_CONFIGS_IDS.SOL_USD]: "0xef0d8b6fda2ceba41da15d4095d1da392a0d2f8ed0c6c7bc0f4cfac8c280b56d",
     [pairIds_1.PAIR_CONFIGS_IDS.S_USD]: "0xf490b178d0c85683b7a0f2388b40af2e6f7c90cbe0f96b31f315f08d0e5a2d6d",
+    [pairIds_1.PAIR_CONFIGS_IDS.FLR_USD]: "0x035aa8d0a2d74e19438f2c1440edff9f3b95f915ca65f681a25ed0bad3dc228d",
     [pairIds_1.PAIR_CONFIGS_IDS.EUR_USD]: "0xa995d00bb36a63cef7fd2c287dc105fc8f3d93779f062f09551b0af3e81ec30b",
     [pairIds_1.PAIR_CONFIGS_IDS.GBP_USD]: "0x84c2dde9633d93d1bcad84e7dc41c9d56578b7ec52fabedc1f335d673df0a7c1",
     [pairIds_1.PAIR_CONFIGS_IDS.AUD_USD]: "0x67a6f93030420c1c9e3fe37c1ab6b77966af82f995944a9fefce357a22854a80",
@@ -58,6 +59,4 @@ exports.PYTH_PAIRS_PRICE_FEED_IDS = {
     [pairIds_1.PAIR_CONFIGS_IDS.NZD_USD_CAT]: "",
     [pairIds_1.PAIR_CONFIGS_IDS.USD_JPY_CAT]: "",
     [pairIds_1.PAIR_CONFIGS_IDS.USD_CHF_CAT]: "",
-    // Pairs Unsupported by pyth
-    [pairIds_1.PAIR_CONFIGS_IDS.FLR_USD]: "",
 };

package/dist/cjs/lib/typechain/contracts/Lynx/Lex/LexPool/LexPoolV1.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/lib/typechain/contracts/Lynx/OrderBook/OrderBookProxy.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/lib/typechain/contracts/Lynx/OrderBook/OrderBookV1.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/lib/typechain/contracts/Lynx/Registry/RegistryProxy.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/lib/typechain/contracts/Lynx/Registry/RegistryV1.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/lib/typechain/contracts/Lynx/TradersPortal/TradersPortalV1.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/lib/typechain/contracts/Lynx/TradingFloor/TradingFloorProxy.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/lib/typechain/contracts/Lynx/TradingFloor/TradingFloorV1.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/lib/typechain/contracts/Lynx/Triggers/TriggersV1.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/lib/typechain/contracts/Peripheral/TokensDistribution/SinglePhaseSingleTokenDistributor/SinglePhaseSingleTokenDistributor.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });