lynx-client 0.0.1-beta.11 → 0.0.1-beta.13

package/README.md

@@ -1,4 +1,371 @@
-# Lynx Client
+# Lynx Client SDK
 
-This project introduces a client to interact with Lynx.
-It has script examples and api calls to the app, and common logic used by other Lynx repositories.
+A TypeScript SDK for interacting with the Lynx trading protocol across multiple EVM-compatible blockchains.
+
+## Features
+
+- 🔒 Type-safe interfaces for all Lynx smart contracts
+- 🌐 Multi-chain support (16+ EVM chains)
+- 📊 Built-in utilities for price, leverage, and fraction conversions
+- 🏗️ Support for both CommonJS and ESM module systems
+- 🔍 Read-only lens contracts for efficient data aggregation
+- 💼 Complete trading lifecycle management
+
+## Installation
+
+```bash
+npm install lynx-client
+```
+
+```bash
+yarn add lynx-client
+```
+
+## Quick Start
+
+```typescript
+import { 
+  connectToLatestRegistry,
+  LynxSystemAddresses,
+  createTradersPortalService,
+  buildPositionRequestIdentifier,
+  buildPositionRequestParams
+} from 'lynx-client';
+import { ethers } from 'ethers';
+
+// Initialize provider
+const provider = new ethers.JsonRpcProvider('YOUR_RPC_URL');
+const signer = await provider.getSigner();
+
+// Get chain-specific addresses
+const addresses = LynxSystemAddresses.arbitrum; // or .sonic, .base, etc.
+
+// Connect to contracts
+const registry = connectToLatestRegistry(provider, addresses.registryProxyAddress);
+
+// Create a service for trader operations
+const tradersPortal = createTradersPortalService(signer, addresses.tradersPortalAddress);
+```
+
+## Core Concepts
+
+### Supported Chains
+
+#### Engine Chains
+The Lynx protocol is deployed on the following chains:
+
+- **Sonic** (146)
+- **Boba** (288)
+- **Flare** (14)
+- **Fantom** (250)
+
+#### Source Chains
+Assets can be bridged from these additional chains:
+
+- Ethereum Mainnet (1)
+- Optimism (10)
+- BSC (56)
+- Polygon (137)
+- Fuse (122)
+- Goat (2345)
+- Mantle (5000)
+- Base (8453)
+- Mode (34443)
+- Arbitrum (42161)
+- Celo (42220)
+- Linea (59144)
+- Zircuit (48900)
+
+```typescript
+import { LynxSystemAddresses, TSupportedChainIds } from 'lynx-client';
+
+// Get addresses for a specific chain
+const sonicAddresses = LynxSystemAddresses.sonic;
+const arbitrumAddresses = LynxSystemAddresses.arbitrum;
+```
+
+### Contract Services
+
+The SDK provides service wrappers for all Lynx contracts:
+
+#### Trading Operations
+
+```typescript
+import { 
+  createTradersPortalService,
+  buildPositionRequestIdentifier,
+  buildPositionRequestParams,
+  TOpenOrderType 
+} from 'lynx-client';
+
+const tradersPortal = createTradersPortalService(signer, tradersPortalAddress);
+
+// Build position parameters using human-readable values
+const identifier = buildPositionRequestIdentifier({
+  trader: await signer.getAddress(),
+  pairId: 1, // BTC/USD
+  settlementAsset: "0x...", // USDC address
+  positionIndex: 0
+});
+
+const params = buildPositionRequestParams({
+  isLong: true,
+  collateral: 100, // 100 USDC
+  leverage: 25, // 25x leverage
+  minPrice: 50000, // $50,000
+  maxPrice: 50100, // $50,100
+  takeProfit: 55000, // $55,000
+  stopLoss: 48000 // $48,000
+});
+
+// Open a position
+await tradersPortal.traderRequests.openNewPosition(
+  identifier,
+  params,
+  TOpenOrderType.MARKET,
+  "0x", // referrer domain
+  "0x", // referrer code
+  true, // run cap tests
+  ethers.parseEther("0.01") // native fee
+);
+```
+
+#### Lens Services (Read-Only Data)
+
+```typescript
+import { createLexLensService, createTradingFloorLensService } from 'lynx-client';
+
+// LEX Pool data
+const lexLens = createLexLensService(provider, lexLensAddress);
+const poolState = await lexLens.getLexPoolState(lexPoolAddress);
+const pairConfigs = await lexLens.getAllPairConfigurationsInLex(lexPoolAddress);
+
+// Trading floor data
+const tradingFloorLens = createTradingFloorLensService(provider, tradingFloorLensAddress);
+const position = await tradingFloorLens.getPositionByPositionId(positionId);
+```
+
+### Utility Functions
+
+#### Price Conversions
+
+```typescript
+import { floatToPriceBn, priceBnToFloat } from 'lynx-client';
+
+// Convert human-readable price to contract format (8 decimals)
+const priceBn = floatToPriceBn(50000.50); // $50,000.50 → BigInt
+
+// Convert contract price to human-readable
+const price = priceBnToFloat(priceBn); // BigInt → 50000.50
+```
+
+#### Leverage Conversions
+
+```typescript
+import { floatUnitsToScaledLeverage, scaledLeverageToUnits } from 'lynx-client';
+
+// Convert human leverage to contract format
+const scaledLeverage = floatUnitsToScaledLeverage(25); // 25x → 2500
+
+// Convert contract leverage to human-readable
+const leverage = scaledLeverageToUnits(2500); // 2500 → 25x
+```
+
+#### Collateral Conversions
+
+```typescript
+import { floatToChipsBn, chipsBnToUnits } from 'lynx-client';
+
+// Convert human-readable amount to contract format (18 decimals)
+const collateralBn = floatToChipsBn(100.5); // 100.5 tokens → BigInt
+
+// Convert contract amount to human-readable
+const collateral = chipsBnToUnits(collateralBn); // BigInt → 100.5
+```
+
+#### Fraction Conversions
+
+```typescript
+import { floatToFractionBn, fractionBnToFloat } from 'lynx-client';
+
+// Convert percentage to contract format
+const fractionBn = floatToFractionBn(0.05); // 5% → 5000
+
+// Convert contract fraction to percentage
+const fraction = fractionBnToFloat(5000n); // 5000 → 0.05 (5%)
+```
+
+## Advanced Usage
+
+### Position Management
+
+```typescript
+// Update position with new TP/SL
+await tradersPortal.traderRequests.updatePositionDoubleFieldTpAndSl(
+  positionId,
+  floatToPriceBn(55000), // New TP: $55,000
+  floatToPriceBn(48000), // New SL: $48,000
+  ethers.parseEther("0.01") // Fee
+);
+
+// Close position at market
+await tradersPortal.traderRequests.setExistingPositionToMarketClose(
+  positionId,
+  floatToPriceBn(49900), // Min acceptable price
+  floatToPriceBn(50100), // Max acceptable price
+  ethers.parseEther("0.01") // Fee
+);
+```
+
+### Working with Triggers
+
+```typescript
+import { createTriggersService } from 'lynx-client';
+
+const triggers = createTriggersService(signer, triggersAddress);
+
+// Get trigger configurations
+const configs = await triggers.getTriggersConfigurations();
+const pairConfigs = await triggers.getPairConfigsInTriggers(1); // Pair ID 1
+```
+
+### LEX Pool Operations
+
+```typescript
+// Get complete LEX pool state
+const completeState = await lexLens.getCompleteStateForLex(lexPoolAddress);
+
+// Get supplier state
+const supplierState = await lexLens.getLexPoolSupplierState(
+  lexPoolAddress,
+  supplierAddress
+);
+
+// Get all fee configurations
+const feeConfigs = await lexLens.getAllFeeConfigurationsInLex(lexPoolAddress);
+```
+
+## Type Safety
+
+The SDK provides comprehensive TypeScript types for all contract interactions:
+
+```typescript
+import { 
+  TPositionRequestIdentifierStruct,
+  TPositionRequestParamsStruct,
+  TSinglePositionStruct,
+  TPairConfigsInTriggersStruct
+} from 'lynx-client';
+
+// All contract structs are properly typed
+const position: TSinglePositionStruct = await tradingFloorLens.getPositionByPositionId(id);
+console.log(position.trader); // string
+console.log(position.collateral); // bigint
+console.log(position.leverage); // bigint
+```
+
+## Error Handling
+
+The SDK validates inputs to prevent common errors:
+
+```typescript
+try {
+  // This will throw an error - can't use both price and fraction TP
+  const params = buildPositionRequestParams({
+    isLong: true,
+    collateral: 100,
+    leverage: 25,
+    minPrice: 50000,
+    maxPrice: 50100,
+    takeProfit: 55000, // Price-based TP
+    takeProfitByFraction: 0.1 // Fraction-based TP - ERROR!
+  });
+} catch (error) {
+  console.error("Cannot specify both takeProfit and takeProfitByFraction");
+}
+```
+
+## Constants and Enums
+
+```typescript
+import { 
+  TOpenOrderType,
+  TOrderCloseType,
+  TPositionField,
+  TPairIds,
+  CHIP_DECIMALS,
+  PRICES_SCALE,
+  LEVERAGE_MULTIPLIER_SCALE
+} from 'lynx-client';
+
+// Order types
+const marketOrder = TOpenOrderType.MARKET;
+const limitOrder = TOpenOrderType.LIMIT;
+
+// Pair IDs
+const btcUsd = TPairIds.BTC_USD;
+const ethUsd = TPairIds.ETH_USD;
+```
+
+## Best Practices
+
+1. **Always use builder functions** for creating position requests:
+   ```typescript
+   // ✅ Good
+   const params = buildPositionRequestParams({ ... });
+   
+   // ❌ Avoid manual construction
+   const params = { long: true, collateral: 100n, ... };
+   ```
+
+2. **Use utility functions** for conversions:
+   ```typescript
+   // ✅ Good
+   const priceBn = floatToPriceBn(50000);
+   
+   // ❌ Avoid manual calculations
+   const priceBn = BigInt(50000 * 10**8);
+   ```
+
+3. **Handle contract errors** appropriately:
+   ```typescript
+   try {
+     await tradersPortal.traderRequests.openNewPosition(...);
+   } catch (error) {
+     if (error.reason === "Insufficient collateral") {
+       // Handle specific error
+     }
+   }
+   ```
+
+## Development
+
+### Building
+
+```bash
+npm run build
+```
+
+### Testing
+
+```bash
+npm test
+```
+
+### Contributing
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## License
+
+ISC
+
+## Support
+
+- [GitHub Issues](https://github.com/lynx-protocol/lynx-client/issues)
+- [Documentation](https://lynx-finance.gitbook.io/lynx-finance/)
+- [Discord](https://discord.gg/4CGxEYwrF2)

package/dist/cjs/index.js

@@ -51,3 +51,5 @@ __exportStar(require("./lib/typechain/factories/contracts/Peripheral/Lens/Intent
 __exportStar(require("./lib/typechain/factories/contracts/Peripheral/Lens/TriggersAndPortalLens__factory"), exports);
 __exportStar(require("./lib/typechain/factories/contracts/Peripheral/Lens/LexLens__factory"), exports);
 __exportStar(require("./lib/typechain/factories/contracts/Peripheral/Lens/TradingFloorLens__factory"), exports);
+// Developer Experience utilities
+__exportStar(require("./lib/devex"), exports);

package/dist/cjs/lib/chains/chainMappings.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ENGINE_CHAIN_DISPLAY_NAME = exports.ENGINE_CHAIN_ID_BY_NAME = void 0;
+const chainConstants_1 = require("./chainConstants");
+// Engine chain mappings
+exports.ENGINE_CHAIN_ID_BY_NAME = {
+    sonic: chainConstants_1.CHAIN_ID_SONIC,
+    boba: chainConstants_1.CHAIN_ID_BOBA,
+    flare: chainConstants_1.CHAIN_ID_FLARE,
+    fantom: chainConstants_1.CHAIN_ID_FANTOM,
+};
+exports.ENGINE_CHAIN_DISPLAY_NAME = {
+    sonic: "Sonic",
+    boba: "Boba",
+    flare: "Flare",
+    fantom: "Fantom",
+};

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

@@ -2,16 +2,36 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OrderBookService = void 0;
 const OrderBookV1__factory_1 = require("../../typechain/factories/contracts/Lynx/OrderBook/OrderBookV1__factory");
-class OrderBookService {
-    constructor(address, signerOrProvider) {
-        this.signerOrProvider = signerOrProvider;
-        this.orderBookContract = OrderBookV1__factory_1.OrderBookV1__factory.connect(address, signerOrProvider);
+class OrderManagement {
+    constructor(orderBookContract) {
+        this.orderBookContract = orderBookContract;
     }
-    // Order Management
     async getAllPendingUpdateOrderIds() {
         return this.orderBookContract.getAllPendingUpdateOrderIds();
     }
-    // Contract References
+    async allPendingUpdateOrderIds(index) {
+        return this.orderBookContract.allPendingUpdateOrderIds(index);
+    }
+    async pendingUpdateTradeFieldOrdersById(positionId) {
+        return this.orderBookContract.pendingUpdateTradeFieldOrdersById(positionId);
+    }
+    async readAndDeleteUpdatePositionOrder(positionId) {
+        return this.orderBookContract.readAndDeleteUpdatePositionOrder(positionId);
+    }
+    async storeUpdatePositionDoubleFieldOrder(positionId, orderType, fieldValueA, fieldValueB) {
+        return this.orderBookContract.storeUpdatePositionDoubleFieldOrder(positionId, orderType, fieldValueA, fieldValueB);
+    }
+    async storeUpdatePositionSingleFieldOrder(positionId, orderType, fieldValue) {
+        return this.orderBookContract.storeUpdatePositionSingleFieldOrder(positionId, orderType, fieldValue);
+    }
+    async updateOrderIdPositionInList(positionId) {
+        return this.orderBookContract.updateOrderIdPositionInList(positionId);
+    }
+}
+class ContractInfo {
+    constructor(orderBookContract) {
+        this.orderBookContract = orderBookContract;
+    }
     async registry() {
         return this.orderBookContract.registry();
     }
@@ -30,7 +50,22 @@ class OrderBookService {
     async pendingImplementation() {
         return this.orderBookContract.pendingImplementation();
     }
-    // Constants
+}
+class Administration {
+    constructor(orderBookContract) {
+        this.orderBookContract = orderBookContract;
+    }
+    async setTradingFloor(tradingFloor) {
+        return this.orderBookContract.setTradingFloor(tradingFloor);
+    }
+    async _become(orderBookProxy) {
+        return this.orderBookContract._become(orderBookProxy);
+    }
+}
+class Constants {
+    constructor(orderBookContract) {
+        this.orderBookContract = orderBookContract;
+    }
     async ACCURACY_IMPROVEMENT_SCALE() {
         return this.orderBookContract.ACCURACY_IMPROVEMENT_SCALE();
     }
@@ -44,4 +79,14 @@ class OrderBookService {
         return this.orderBookContract.PRECISION();
     }
 }
+class OrderBookService {
+    constructor(address, signerOrProvider) {
+        this.signerOrProvider = signerOrProvider;
+        this.orderBookContract = OrderBookV1__factory_1.OrderBookV1__factory.connect(address, signerOrProvider);
+        this.orderManagement = new OrderManagement(this.orderBookContract);
+        this.contractInfo = new ContractInfo(this.orderBookContract);
+        this.administration = new Administration(this.orderBookContract);
+        this.constants = new Constants(this.orderBookContract);
+    }
+}
 exports.OrderBookService = OrderBookService;

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/esm/index.d.ts

@@ -35,4 +35,5 @@ export * from "./lib/typechain/factories/contracts/Peripheral/Lens/IntentsVerifi
 export * from "./lib/typechain/factories/contracts/Peripheral/Lens/TriggersAndPortalLens__factory";
 export * from "./lib/typechain/factories/contracts/Peripheral/Lens/LexLens__factory";
 export * from "./lib/typechain/factories/contracts/Peripheral/Lens/TradingFloorLens__factory";
+export * from "./lib/devex";
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAAA,cAAc,6BAA6B,CAAC;AAC5C,cAAc,yBAAyB,CAAC;AAExC,cAAc,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC;AACvC,cAAc,yCAAyC,CAAC;AACxD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,kCAAkC,CAAC;AACjD,cAAc,mBAAmB,CAAC;AAClC,cAAc,2CAA2C,CAAC;AAE1D,cAAc,+BAA+B,CAAC;AAC9C,cAAc,kCAAkC,CAAC;AACjD,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,0BAA0B,CAAC;AACzC,cAAc,wBAAwB,CAAC;AAEvC,cAAc,yCAAyC,CAAC;AACxD,cAAc,yCAAyC,CAAC;AAExD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,iCAAiC,CAAC;AAEhD,cAAc,uDAAuD,CAAC;AAEtE,cAAc,iDAAiD,CAAC;AAEhE,cAAc,uDAAuD,CAAC;AACtE,cAAc,yDAAyD,CAAC;AACxE,cAAc,oDAAoD,CAAC;AACnE,cAAc,2CAA2C,CAAC;AAE1D,cAAc,+DAA+D,CAAC;AAC9E,cAAc,iEAAiE,CAAC;AAChF,cAAc,mDAAmD,CAAC;AAClE,cAAc,4DAA4D,CAAC;AAE3E,cAAc,kFAAkF,CAAC;AACjG,cAAc,oFAAoF,CAAC;AACnG,cAAc,sEAAsE,CAAC;AACrF,cAAc,+EAA+E,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAAA,cAAc,6BAA6B,CAAC;AAC5C,cAAc,yBAAyB,CAAC;AAExC,cAAc,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC;AACvC,cAAc,yCAAyC,CAAC;AACxD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,kCAAkC,CAAC;AACjD,cAAc,mBAAmB,CAAC;AAClC,cAAc,2CAA2C,CAAC;AAE1D,cAAc,+BAA+B,CAAC;AAC9C,cAAc,kCAAkC,CAAC;AACjD,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,0BAA0B,CAAC;AACzC,cAAc,wBAAwB,CAAC;AAEvC,cAAc,yCAAyC,CAAC;AACxD,cAAc,yCAAyC,CAAC;AAExD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,iCAAiC,CAAC;AAEhD,cAAc,uDAAuD,CAAC;AAEtE,cAAc,iDAAiD,CAAC;AAEhE,cAAc,uDAAuD,CAAC;AACtE,cAAc,yDAAyD,CAAC;AACxE,cAAc,oDAAoD,CAAC;AACnE,cAAc,2CAA2C,CAAC;AAE1D,cAAc,+DAA+D,CAAC;AAC9E,cAAc,iEAAiE,CAAC;AAChF,cAAc,mDAAmD,CAAC;AAClE,cAAc,4DAA4D,CAAC;AAE3E,cAAc,kFAAkF,CAAC;AACjG,cAAc,oFAAoF,CAAC;AACnG,cAAc,sEAAsE,CAAC;AACrF,cAAc,+EAA+E,CAAC;AAG9F,cAAc,aAAa,CAAC"}

package/dist/esm/index.js

@@ -51,3 +51,5 @@ __exportStar(require("./lib/typechain/factories/contracts/Peripheral/Lens/Intent
 __exportStar(require("./lib/typechain/factories/contracts/Peripheral/Lens/TriggersAndPortalLens__factory"), exports);
 __exportStar(require("./lib/typechain/factories/contracts/Peripheral/Lens/LexLens__factory"), exports);
 __exportStar(require("./lib/typechain/factories/contracts/Peripheral/Lens/TradingFloorLens__factory"), exports);
+// Developer Experience utilities
+__exportStar(require("./lib/devex"), exports);

package/dist/esm/lib/chains/chainMappings.d.ts

@@ -0,0 +1,13 @@
+export declare const ENGINE_CHAIN_ID_BY_NAME: {
+    readonly sonic: 146;
+    readonly boba: 288;
+    readonly flare: 14;
+    readonly fantom: 250;
+};
+export declare const ENGINE_CHAIN_DISPLAY_NAME: {
+    readonly sonic: "Sonic";
+    readonly boba: "Boba";
+    readonly flare: "Flare";
+    readonly fantom: "Fantom";
+};
+//# sourceMappingURL=chainMappings.d.ts.map

package/dist/esm/lib/chains/chainMappings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"chainMappings.d.ts","sourceRoot":"","sources":["../../../../lib/chains/chainMappings.ts"],"names":[],"mappings":"AAQA,eAAO,MAAM,uBAAuB;;;;;CAK1B,CAAC;AAEX,eAAO,MAAM,yBAAyB;;;;;CAK5B,CAAC"}

package/dist/esm/lib/chains/chainMappings.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ENGINE_CHAIN_DISPLAY_NAME = exports.ENGINE_CHAIN_ID_BY_NAME = void 0;
+const chainConstants_1 = require("./chainConstants");
+// Engine chain mappings
+exports.ENGINE_CHAIN_ID_BY_NAME = {
+    sonic: chainConstants_1.CHAIN_ID_SONIC,
+    boba: chainConstants_1.CHAIN_ID_BOBA,
+    flare: chainConstants_1.CHAIN_ID_FLARE,
+    fantom: chainConstants_1.CHAIN_ID_FANTOM,
+};
+exports.ENGINE_CHAIN_DISPLAY_NAME = {
+    sonic: "Sonic",
+    boba: "Boba",
+    flare: "Flare",
+    fantom: "Fantom",
+};

package/dist/esm/lib/chains/chainTypes.d.ts

@@ -1,4 +1,5 @@
 import { CHAIN_ID_ETHEREUM, CHAIN_ID_OPTIMISM, CHAIN_ID_BSC, CHAIN_ID_FANTOM, CHAIN_ID_POLYGON, CHAIN_ID_BOBA, CHAIN_ID_MANTLE, CHAIN_ID_LINEA, CHAIN_ID_FUSE, CHAIN_ID_ARBITRUM, CHAIN_ID_CELO, CHAIN_ID_MODE, CHAIN_ID_ZIRCUIT, CHAIN_ID_BASE, CHAIN_ID_GOAT, CHAIN_ID_SONIC, CHAIN_ID_FLARE } from "./chainConstants";
+import { ENGINE_CHAIN_ID_BY_NAME } from "./chainMappings";
 export type TSourceChainIds = typeof CHAIN_ID_FUSE | typeof CHAIN_ID_LINEA | typeof CHAIN_ID_ARBITRUM | typeof CHAIN_ID_OPTIMISM | typeof CHAIN_ID_POLYGON | typeof CHAIN_ID_MANTLE | typeof CHAIN_ID_BSC | typeof CHAIN_ID_MODE | typeof CHAIN_ID_CELO | typeof CHAIN_ID_ZIRCUIT | typeof CHAIN_ID_BASE | typeof CHAIN_ID_ETHEREUM | typeof CHAIN_ID_GOAT;
 export type TEngineChainIds = typeof CHAIN_ID_FANTOM | typeof CHAIN_ID_SONIC | typeof CHAIN_ID_BOBA | typeof CHAIN_ID_FLARE;
 export type TLiveChainIds = TSourceChainIds | TEngineChainIds;
@@ -7,4 +8,6 @@ export type TEngineChainNames = "fantom" | "boba" | "sonic" | "flare";
 export type TSourceChainNames = "ethereum" | "bsc" | "fantom" | "fuse" | "optimism" | "polygon" | "arbitrum" | "celo" | "maticMainnet" | "avalanche" | "boba" | "mantle" | "mode" | "linea" | "zircuit" | "base" | "goat";
 export type TChainNames = TEngineChainNames | TSourceChainNames;
 export declare const CHAIN_ID_TO_NAME: Record<TChainIds, TChainNames>;
+export type EngineChainKey = keyof typeof ENGINE_CHAIN_ID_BY_NAME;
+export type EngineChainId = typeof ENGINE_CHAIN_ID_BY_NAME[EngineChainKey];
 //# sourceMappingURL=chainTypes.d.ts.map