@mento-protocol/mento-sdk 3.2.7 → 3.3.0-beta.0

package/dist/core/types/route.d.ts

@@ -0,0 +1,62 @@
+import { Pool } from './pool';
+import { RouteToken } from './token';
+/**
+ * Route identifier: sorted symbols joined with hyphen
+ * Represents the two endpoint tokens regardless of the path taken
+ */
+export type RouteID = `${string}-${string}`;
+/**
+ * Represents a tradable route between two tokens, including the pool path needed to execute the trade
+ */
+export interface Route {
+    /**
+     * Canonical identifier: sorted symbols joined with hyphen
+     * Always uses alphabetical order (e.g., 'EURm-USDm' not 'USDm-EURm')
+     * Ensures consistent identification regardless of query direction
+     */
+    id: RouteID;
+    /**
+     * The two tokens being traded, in alphabetical order by symbol
+     * Always [symbolA, symbolB] where symbolA < symbolB alphabetically
+     */
+    tokens: [RouteToken, RouteToken];
+    /**
+     * Array of exchange hops needed to execute the trade
+     * Length 1: Direct route (single pool)
+     * Length 2: Two-hop route via intermediate token through two pools
+     * Order matters for execution
+     */
+    path: Array<Pool>;
+}
+/**
+ * Extended route with cost data for route optimization
+ */
+export interface RouteWithCost extends Route {
+    /**
+     * Cost data for this route
+     * Used to select optimal route when multiple options exist
+     */
+    costData: {
+        /**
+         * Total cost percentage for this route
+         * Lower is better (more cost-efficient)
+         * Example: 0.3 means 0.3% cost
+         */
+        totalCostPercent: number;
+        /**
+         * Per-hop cost breakdown
+         * Used for detailed cost analysis and debugging
+         */
+        hops: Array<{
+            /**
+             * Pool Address for this hop
+             */
+            poolAddress: string;
+            /**
+             * Cost percentage for this specific hop
+             */
+            costPercent: number;
+        }>;
+    };
+}
+//# sourceMappingURL=route.d.ts.map

package/dist/core/types/route.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=route.js.map

package/dist/core/types/token.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Minimal token info for routing purposes.
+ * Contains only the fields needed to identify and route between tokens.
+ */
+export interface RouteToken {
+    address: string;
+    symbol: string;
+}
+/**
+ * Full token info for consumer-facing operations.
+ * Extends RouteToken with display and transaction fields.
+ */
+export interface Token extends RouteToken {
+    name: string;
+    decimals: number;
+}
+export interface StableToken extends Token {
+    totalSupply: string;
+}
+export type CollateralAsset = Token;
+//# sourceMappingURL=token.d.ts.map

package/dist/core/types/token.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=token.js.map

package/dist/core/types/tradingLimits.d.ts

@@ -0,0 +1,91 @@
+/**
+ * Human-friendly representation of a trading limit.
+ * Used by frontends to display limit status and calculate remaining capacity.
+ */
+export interface TradingLimit {
+    /** Token address this limit applies to */
+    asset: string;
+    /** Maximum amount that can flow IN (raw value - V1: 0 decimals, V2: 15 decimals) */
+    maxIn: bigint;
+    /** Maximum amount that can flow OUT (raw value - V1: 0 decimals, V2: 15 decimals) */
+    maxOut: bigint;
+    /** Unix timestamp when this limit window resets */
+    until: number;
+    /** Token decimals for consumer scaling */
+    decimals: number;
+}
+/**
+ * Trading limits configuration for V1 (Broker/Virtual pools).
+ * Uses configurable timeframes and 0 decimal precision.
+ */
+export interface TradingLimitsConfigV1 {
+    /** Time window in seconds for L0 limit */
+    timestep0: number;
+    /** Time window in seconds for L1 limit */
+    timestep1: number;
+    /** L0 limit value (0 decimal precision) */
+    limit0: bigint;
+    /** L1 limit value (0 decimal precision) */
+    limit1: bigint;
+    /** Global limit value (0 decimal precision) */
+    limitGlobal: bigint;
+    /** Flags bitmap: bit 0=L0, bit 1=L1, bit 2=LG */
+    flags: number;
+}
+/**
+ * Trading limits state for V1 (Broker/Virtual pools).
+ */
+export interface TradingLimitsStateV1 {
+    /** Timestamp of last L0 window reset */
+    lastUpdated0: number;
+    /** Timestamp of last L1 window reset */
+    lastUpdated1: number;
+    /** Current netflow for L0 (0 decimal precision) */
+    netflow0: bigint;
+    /** Current netflow for L1 (0 decimal precision) */
+    netflow1: bigint;
+    /** Current global netflow (0 decimal precision) */
+    netflowGlobal: bigint;
+}
+/**
+ * Trading limits configuration for V2 (FPMM pools).
+ * Uses fixed timeframes (5 min for L0, 1 day for L1) and 15 decimal precision.
+ */
+export interface TradingLimitsConfigV2 {
+    /** L0 limit value (15 decimal precision) */
+    limit0: bigint;
+    /** L1 limit value (15 decimal precision) */
+    limit1: bigint;
+    /** Token decimals */
+    decimals: number;
+}
+/**
+ * Trading limits state for V2 (FPMM pools).
+ */
+export interface TradingLimitsStateV2 {
+    /** Timestamp of last L0 window reset */
+    lastUpdated0: number;
+    /** Timestamp of last L1 window reset */
+    lastUpdated1: number;
+    /** Current netflow for L0 (15 decimal precision) */
+    netflow0: bigint;
+    /** Current netflow for L1 (15 decimal precision) */
+    netflow1: bigint;
+}
+/**
+ * Combined tradability status for a pool.
+ * Separates circuit breaker and trading limits for distinct UI messaging.
+ */
+export interface PoolTradabilityStatus {
+    /** Overall tradability (circuitBreakerOk AND limitsOk) */
+    tradable: boolean;
+    /** Circuit breaker status - true if not tripped */
+    circuitBreakerOk: boolean;
+    /** Raw trading mode value (0 = BIDIRECTIONAL, non-zero = suspended) */
+    tradingMode: number;
+    /** Trading limits status - true if limits not exhausted */
+    limitsOk: boolean;
+    /** Detailed limit info for UI display */
+    limits: TradingLimit[];
+}
+//# sourceMappingURL=tradingLimits.d.ts.map

package/dist/core/types/tradingLimits.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=tradingLimits.js.map

package/dist/core/types/tradingMode.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Trading modes for rate feeds in the BreakerBox circuit breaker.
+ *
+ * The BreakerBox uses a bitmask approach where multiple breakers can
+ * contribute to the final trading mode. In practice:
+ * - 0 = Bidirectional (trading enabled)
+ * - Any non-zero value = Trading suspended
+ *
+ * For SDK consumers, use isTradingEnabled() helper to check if trading
+ * is allowed.
+ */
+export declare enum TradingMode {
+    /** Bidirectional trading is enabled (normal operation) */
+    BIDIRECTIONAL = 0,
+    /** Trading is suspended (circuit breaker tripped) - any non-zero value */
+    SUSPENDED = 1
+}
+/**
+ * Check if trading is enabled for a given trading mode.
+ * @param mode - The trading mode value from BreakerBox
+ * @returns true if trading is enabled (mode === 0)
+ */
+export declare function isTradingEnabled(mode: number): boolean;
+//# sourceMappingURL=tradingMode.d.ts.map

package/dist/core/types/tradingMode.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TradingMode = void 0;
+exports.isTradingEnabled = isTradingEnabled;
+/**
+ * Trading modes for rate feeds in the BreakerBox circuit breaker.
+ *
+ * The BreakerBox uses a bitmask approach where multiple breakers can
+ * contribute to the final trading mode. In practice:
+ * - 0 = Bidirectional (trading enabled)
+ * - Any non-zero value = Trading suspended
+ *
+ * For SDK consumers, use isTradingEnabled() helper to check if trading
+ * is allowed.
+ */
+var TradingMode;
+(function (TradingMode) {
+    /** Bidirectional trading is enabled (normal operation) */
+    TradingMode[TradingMode["BIDIRECTIONAL"] = 0] = "BIDIRECTIONAL";
+    /** Trading is suspended (circuit breaker tripped) - any non-zero value */
+    TradingMode[TradingMode["SUSPENDED"] = 1] = "SUSPENDED";
+})(TradingMode || (exports.TradingMode = TradingMode = {}));
+/**
+ * Check if trading is enabled for a given trading mode.
+ * @param mode - The trading mode value from BreakerBox
+ * @returns true if trading is enabled (mode === 0)
+ */
+function isTradingEnabled(mode) {
+    return mode === TradingMode.BIDIRECTIONAL;
+}
+//# sourceMappingURL=tradingMode.js.map

package/dist/core/types/transaction.d.ts

@@ -0,0 +1,45 @@
+export interface ContractCallOptions {
+    address: string;
+    abi: string[] | unknown[];
+    functionName: string;
+    args?: unknown[];
+}
+/**
+ * Contract write options for building call parameters
+ *
+ * Configuration for building transaction call parameters for write operations.
+ * These parameters can be used by consumers to execute transactions themselves.
+ */
+export interface ContractWriteOptions extends ContractCallOptions {
+    /**
+     * Optional gas limit override
+     * If not provided, will be estimated automatically
+     */
+    gasLimit?: bigint;
+    /**
+     * Transaction value in wei
+     * For payable functions only
+     */
+    value?: bigint;
+}
+/**
+ * Call parameters for executing a contract transaction
+ *
+ * Contains all the data needed to execute a contract call.
+ * Consumers can use these parameters with their own wallet/signer to execute transactions.
+ */
+export interface CallParams {
+    /**
+     * Contract address to call
+     */
+    to: string;
+    /**
+     * Encoded function call data (hex string)
+     */
+    data: string;
+    /**
+     * Transaction value in wei (hex string with 0x prefix)
+     */
+    value: string;
+}
+//# sourceMappingURL=transaction.d.ts.map

package/dist/core/types/transaction.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=transaction.js.map