@optimex-xyz/market-maker-sdk 0.5.1 → 0.5.3

package/README.md

@@ -104,12 +104,23 @@ sequenceDiagram
 
 ### 2.1. API Environments
 
-| Environment  | Description                                                          |
-| ------------ | -------------------------------------------------------------------- |
-| `dev`        | Development environment with test networks and staging services      |
-| `production` | Production environment with mainnet networks and production services |
+| Environment      | Description                                                          | Base URL                             |
+| ---------------- | -------------------------------------------------------------------- | ------------------------------------ |
+| `dev`            | Development environment with test networks and staging services      | `https://api-dev.bitfi.com`          |
+| `pre-production` | Pre-production environment with mainnet networks for testing before release | `https://api-preprod.bitfi.com` |
+| `production`     | Production environment with mainnet networks and production services | `https://api.bitfi.com`              |
 
-Each environment includes specific configuration for backend URLs, RPC endpoints, router addresses, and payment addresses.
+- Solver URLs: Each environment has dedicated API endpoints
+
+- RPC Endpoints: L2 RPC endpoints remain the same across all environments
+
+- Router Addresses: Smart contract addresses for routing transactions
+
+  - **Note:** pre-production and production share the same router addresses
+
+- Payment Addresses: Addresses used for fee collection and settlement
+
+  - **Note:** pre-production and production share the same payment addresses
 
 ## 3. PMM Backend APIs
 

package/dist/index.d.mts

@@ -1,7 +1,7 @@
 import { DeferredTopicFilter, EventFragment, EventLog, TransactionRequest, Typed, ContractTransactionResponse, FunctionFragment, ContractTransaction, LogDescription, BaseContract, ContractRunner, Interface, AddressLike, BigNumberish, BytesLike, Result, Listener, ContractMethod, Provider, Signer as Signer$1, Wallet, TypedDataDomain } from 'ethers';
 import { z } from 'zod';
 
-type Environment = 'dev' | 'production';
+type Environment = 'dev' | 'prelive' | 'production';
 interface EnvironmentConfig {
     backendUrl: string;
     rpcUrl: string;
@@ -4930,9 +4930,13 @@ declare const TradeDetailResponseSchema: z.ZodObject<{
         amountAfterFees: z.ZodString;
         fromUserAddress: z.ZodString;
         userReceivingAddress: z.ZodString;
+        scriptTimeout: z.ZodNumber;
         protocolFeeInBps: z.ZodString;
-        protocolMpcPubkey: z.ZodString;
-        protocolMpcAddress: z.ZodString;
+        affiliateFeeInBps: z.ZodString;
+        totalFee: z.ZodString;
+        protocolFee: z.ZodString;
+        affiliateFee: z.ZodString;
+        mpcAssetChainPubkey: z.ZodString;
         bestIndicativeQuote: z.ZodString;
         displayIndicativeQuote: z.ZodString;
         pmmFinalists: z.ZodArray<z.ZodObject<{
@@ -4955,6 +4959,7 @@ declare const TradeDetailResponseSchema: z.ZodObject<{
         pmmFailureStats: z.ZodRecord<z.ZodString, z.ZodNumber>;
         commitedSignature: z.ZodString;
         minAmountOut: z.ZodNull;
+        tradeTimeout: z.ZodNumber;
         userDepositTx: z.ZodString;
         depositVault: z.ZodString;
         paymentBundle: z.ZodObject<{
@@ -4986,12 +4991,6 @@ declare const TradeDetailResponseSchema: z.ZodObject<{
         state: z.ZodString;
         lastUpdateMsg: z.ZodString;
         version: z.ZodNumber;
-        scriptTimeout: z.ZodNumber;
-        affiliateFeeInBps: z.ZodString;
-        totalFee: z.ZodString;
-        protocolFee: z.ZodString;
-        affiliateFee: z.ZodString;
-        tradeTimeout: z.ZodNumber;
     }, "strip", z.ZodTypeAny, {
         version: number;
         tradeId: string;
@@ -5020,8 +5019,10 @@ declare const TradeDetailResponseSchema: z.ZodObject<{
         fromUserAddress: string;
         userReceivingAddress: string;
         protocolFeeInBps: string;
-        protocolMpcPubkey: string;
-        protocolMpcAddress: string;
+        affiliateFeeInBps: string;
+        protocolFee: string;
+        affiliateFee: string;
+        mpcAssetChainPubkey: string;
         bestIndicativeQuote: string;
         displayIndicativeQuote: string;
         pmmFinalists: {
@@ -5053,9 +5054,6 @@ declare const TradeDetailResponseSchema: z.ZodObject<{
         tradeMakePaymentTx: string;
         state: string;
         lastUpdateMsg: string;
-        affiliateFeeInBps: string;
-        protocolFee: string;
-        affiliateFee: string;
     }, {
         version: number;
         tradeId: string;
@@ -5084,8 +5082,10 @@ declare const TradeDetailResponseSchema: z.ZodObject<{
         fromUserAddress: string;
         userReceivingAddress: string;
         protocolFeeInBps: string;
-        protocolMpcPubkey: string;
-        protocolMpcAddress: string;
+        affiliateFeeInBps: string;
+        protocolFee: string;
+        affiliateFee: string;
+        mpcAssetChainPubkey: string;
         bestIndicativeQuote: string;
         displayIndicativeQuote: string;
         pmmFinalists: {
@@ -5117,9 +5117,6 @@ declare const TradeDetailResponseSchema: z.ZodObject<{
         tradeMakePaymentTx: string;
         state: string;
         lastUpdateMsg: string;
-        affiliateFeeInBps: string;
-        protocolFee: string;
-        affiliateFee: string;
     }>;
     traceId: z.ZodString;
 }, "strip", z.ZodTypeAny, {
@@ -5151,8 +5148,10 @@ declare const TradeDetailResponseSchema: z.ZodObject<{
         fromUserAddress: string;
         userReceivingAddress: string;
         protocolFeeInBps: string;
-        protocolMpcPubkey: string;
-        protocolMpcAddress: string;
+        affiliateFeeInBps: string;
+        protocolFee: string;
+        affiliateFee: string;
+        mpcAssetChainPubkey: string;
         bestIndicativeQuote: string;
         displayIndicativeQuote: string;
         pmmFinalists: {
@@ -5184,9 +5183,6 @@ declare const TradeDetailResponseSchema: z.ZodObject<{
         tradeMakePaymentTx: string;
         state: string;
         lastUpdateMsg: string;
-        affiliateFeeInBps: string;
-        protocolFee: string;
-        affiliateFee: string;
     };
     traceId: string;
 }, {
@@ -5218,8 +5214,10 @@ declare const TradeDetailResponseSchema: z.ZodObject<{
         fromUserAddress: string;
         userReceivingAddress: string;
         protocolFeeInBps: string;
-        protocolMpcPubkey: string;
-        protocolMpcAddress: string;
+        affiliateFeeInBps: string;
+        protocolFee: string;
+        affiliateFee: string;
+        mpcAssetChainPubkey: string;
         bestIndicativeQuote: string;
         displayIndicativeQuote: string;
         pmmFinalists: {
@@ -5251,9 +5249,6 @@ declare const TradeDetailResponseSchema: z.ZodObject<{
         tradeMakePaymentTx: string;
         state: string;
         lastUpdateMsg: string;
-        affiliateFeeInBps: string;
-        protocolFee: string;
-        affiliateFee: string;
     };
     traceId: string;
 }>;

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { DeferredTopicFilter, EventFragment, EventLog, TransactionRequest, Typed, ContractTransactionResponse, FunctionFragment, ContractTransaction, LogDescription, BaseContract, ContractRunner, Interface, AddressLike, BigNumberish, BytesLike, Result, Listener, ContractMethod, Provider, Signer as Signer$1, Wallet, TypedDataDomain } from 'ethers';
 import { z } from 'zod';
 
-type Environment = 'dev' | 'production';
+type Environment = 'dev' | 'prelive' | 'production';
 interface EnvironmentConfig {
     backendUrl: string;
     rpcUrl: string;
@@ -4930,9 +4930,13 @@ declare const TradeDetailResponseSchema: z.ZodObject<{
         amountAfterFees: z.ZodString;
         fromUserAddress: z.ZodString;
         userReceivingAddress: z.ZodString;
+        scriptTimeout: z.ZodNumber;
         protocolFeeInBps: z.ZodString;
-        protocolMpcPubkey: z.ZodString;
-        protocolMpcAddress: z.ZodString;
+        affiliateFeeInBps: z.ZodString;
+        totalFee: z.ZodString;
+        protocolFee: z.ZodString;
+        affiliateFee: z.ZodString;
+        mpcAssetChainPubkey: z.ZodString;
         bestIndicativeQuote: z.ZodString;
         displayIndicativeQuote: z.ZodString;
         pmmFinalists: z.ZodArray<z.ZodObject<{
@@ -4955,6 +4959,7 @@ declare const TradeDetailResponseSchema: z.ZodObject<{
         pmmFailureStats: z.ZodRecord<z.ZodString, z.ZodNumber>;
         commitedSignature: z.ZodString;
         minAmountOut: z.ZodNull;
+        tradeTimeout: z.ZodNumber;
         userDepositTx: z.ZodString;
         depositVault: z.ZodString;
         paymentBundle: z.ZodObject<{
@@ -4986,12 +4991,6 @@ declare const TradeDetailResponseSchema: z.ZodObject<{
         state: z.ZodString;
         lastUpdateMsg: z.ZodString;
         version: z.ZodNumber;
-        scriptTimeout: z.ZodNumber;
-        affiliateFeeInBps: z.ZodString;
-        totalFee: z.ZodString;
-        protocolFee: z.ZodString;
-        affiliateFee: z.ZodString;
-        tradeTimeout: z.ZodNumber;
     }, "strip", z.ZodTypeAny, {
         version: number;
         tradeId: string;
@@ -5020,8 +5019,10 @@ declare const TradeDetailResponseSchema: z.ZodObject<{
         fromUserAddress: string;
         userReceivingAddress: string;
         protocolFeeInBps: string;
-        protocolMpcPubkey: string;
-        protocolMpcAddress: string;
+        affiliateFeeInBps: string;
+        protocolFee: string;
+        affiliateFee: string;
+        mpcAssetChainPubkey: string;
         bestIndicativeQuote: string;
         displayIndicativeQuote: string;
         pmmFinalists: {
@@ -5053,9 +5054,6 @@ declare const TradeDetailResponseSchema: z.ZodObject<{
         tradeMakePaymentTx: string;
         state: string;
         lastUpdateMsg: string;
-        affiliateFeeInBps: string;
-        protocolFee: string;
-        affiliateFee: string;
     }, {
         version: number;
         tradeId: string;
@@ -5084,8 +5082,10 @@ declare const TradeDetailResponseSchema: z.ZodObject<{
         fromUserAddress: string;
         userReceivingAddress: string;
         protocolFeeInBps: string;
-        protocolMpcPubkey: string;
-        protocolMpcAddress: string;
+        affiliateFeeInBps: string;
+        protocolFee: string;
+        affiliateFee: string;
+        mpcAssetChainPubkey: string;
         bestIndicativeQuote: string;
         displayIndicativeQuote: string;
         pmmFinalists: {
@@ -5117,9 +5117,6 @@ declare const TradeDetailResponseSchema: z.ZodObject<{
         tradeMakePaymentTx: string;
         state: string;
         lastUpdateMsg: string;
-        affiliateFeeInBps: string;
-        protocolFee: string;
-        affiliateFee: string;
     }>;
     traceId: z.ZodString;
 }, "strip", z.ZodTypeAny, {
@@ -5151,8 +5148,10 @@ declare const TradeDetailResponseSchema: z.ZodObject<{
         fromUserAddress: string;
         userReceivingAddress: string;
         protocolFeeInBps: string;
-        protocolMpcPubkey: string;
-        protocolMpcAddress: string;
+        affiliateFeeInBps: string;
+        protocolFee: string;
+        affiliateFee: string;
+        mpcAssetChainPubkey: string;
         bestIndicativeQuote: string;
         displayIndicativeQuote: string;
         pmmFinalists: {
@@ -5184,9 +5183,6 @@ declare const TradeDetailResponseSchema: z.ZodObject<{
         tradeMakePaymentTx: string;
         state: string;
         lastUpdateMsg: string;
-        affiliateFeeInBps: string;
-        protocolFee: string;
-        affiliateFee: string;
     };
     traceId: string;
 }, {
@@ -5218,8 +5214,10 @@ declare const TradeDetailResponseSchema: z.ZodObject<{
         fromUserAddress: string;
         userReceivingAddress: string;
         protocolFeeInBps: string;
-        protocolMpcPubkey: string;
-        protocolMpcAddress: string;
+        affiliateFeeInBps: string;
+        protocolFee: string;
+        affiliateFee: string;
+        mpcAssetChainPubkey: string;
         bestIndicativeQuote: string;
         displayIndicativeQuote: string;
         pmmFinalists: {
@@ -5251,9 +5249,6 @@ declare const TradeDetailResponseSchema: z.ZodObject<{
         tradeMakePaymentTx: string;
         state: string;
         lastUpdateMsg: string;
-        affiliateFeeInBps: string;
-        protocolFee: string;
-        affiliateFee: string;
     };
     traceId: string;
 }>;

package/dist/index.js

@@ -79,6 +79,14 @@ var environments = {
       ethereum_sepolia: "0x7387DcCfE2f1D5F80b4ECDF91eF58541517e90D2"
     }
   },
+  prelive: {
+    backendUrl: "https://pre-api.optimex.xyz",
+    rpcUrl: "https://bitfi-ledger-testnet.alt.technology",
+    routerAddress: "0x272599CE3602A49B580A5C4a4d3C1067E30248D2",
+    paymentAddressMap: {
+      ethereum: "x0A497AC4261E37FA4062762C23Cf3cB642C839b8"
+    }
+  },
   production: {
     backendUrl: "https://api.optimex.xyz",
     rpcUrl: "https://bitfi-ledger-testnet.alt.technology",
@@ -3864,9 +3872,13 @@ var TradeDetailResponseSchema = import_zod.z.object({
     amountAfterFees: import_zod.z.string(),
     fromUserAddress: import_zod.z.string(),
     userReceivingAddress: import_zod.z.string(),
+    scriptTimeout: import_zod.z.number(),
     protocolFeeInBps: import_zod.z.string(),
-    protocolMpcPubkey: import_zod.z.string(),
-    protocolMpcAddress: import_zod.z.string(),
+    affiliateFeeInBps: import_zod.z.string(),
+    totalFee: import_zod.z.string(),
+    protocolFee: import_zod.z.string(),
+    affiliateFee: import_zod.z.string(),
+    mpcAssetChainPubkey: import_zod.z.string(),
     bestIndicativeQuote: import_zod.z.string(),
     displayIndicativeQuote: import_zod.z.string(),
     pmmFinalists: import_zod.z.array(PMMFinalistSchema),
@@ -3880,6 +3892,7 @@ var TradeDetailResponseSchema = import_zod.z.object({
     pmmFailureStats: import_zod.z.record(import_zod.z.number()),
     commitedSignature: import_zod.z.string(),
     minAmountOut: import_zod.z.null(),
+    tradeTimeout: import_zod.z.number(),
     userDepositTx: import_zod.z.string(),
     depositVault: import_zod.z.string(),
     paymentBundle: PaymentBundleSchema,
@@ -3889,13 +3902,7 @@ var TradeDetailResponseSchema = import_zod.z.object({
     tradeMakePaymentTx: import_zod.z.string(),
     state: import_zod.z.string(),
     lastUpdateMsg: import_zod.z.string(),
-    version: import_zod.z.number(),
-    scriptTimeout: import_zod.z.number(),
-    affiliateFeeInBps: import_zod.z.string(),
-    totalFee: import_zod.z.string(),
-    protocolFee: import_zod.z.string(),
-    affiliateFee: import_zod.z.string(),
-    tradeTimeout: import_zod.z.number()
+    version: import_zod.z.number()
   }),
   traceId: import_zod.z.string()
 });

package/dist/index.mjs

@@ -14,6 +14,14 @@ var environments = {
       ethereum_sepolia: "0x7387DcCfE2f1D5F80b4ECDF91eF58541517e90D2"
     }
   },
+  prelive: {
+    backendUrl: "https://pre-api.optimex.xyz",
+    rpcUrl: "https://bitfi-ledger-testnet.alt.technology",
+    routerAddress: "0x272599CE3602A49B580A5C4a4d3C1067E30248D2",
+    paymentAddressMap: {
+      ethereum: "x0A497AC4261E37FA4062762C23Cf3cB642C839b8"
+    }
+  },
   production: {
     backendUrl: "https://api.optimex.xyz",
     rpcUrl: "https://bitfi-ledger-testnet.alt.technology",
@@ -3799,9 +3807,13 @@ var TradeDetailResponseSchema = z.object({
     amountAfterFees: z.string(),
     fromUserAddress: z.string(),
     userReceivingAddress: z.string(),
+    scriptTimeout: z.number(),
     protocolFeeInBps: z.string(),
-    protocolMpcPubkey: z.string(),
-    protocolMpcAddress: z.string(),
+    affiliateFeeInBps: z.string(),
+    totalFee: z.string(),
+    protocolFee: z.string(),
+    affiliateFee: z.string(),
+    mpcAssetChainPubkey: z.string(),
     bestIndicativeQuote: z.string(),
     displayIndicativeQuote: z.string(),
     pmmFinalists: z.array(PMMFinalistSchema),
@@ -3815,6 +3827,7 @@ var TradeDetailResponseSchema = z.object({
     pmmFailureStats: z.record(z.number()),
     commitedSignature: z.string(),
     minAmountOut: z.null(),
+    tradeTimeout: z.number(),
     userDepositTx: z.string(),
     depositVault: z.string(),
     paymentBundle: PaymentBundleSchema,
@@ -3824,13 +3837,7 @@ var TradeDetailResponseSchema = z.object({
     tradeMakePaymentTx: z.string(),
     state: z.string(),
     lastUpdateMsg: z.string(),
-    version: z.number(),
-    scriptTimeout: z.number(),
-    affiliateFeeInBps: z.string(),
-    totalFee: z.string(),
-    protocolFee: z.string(),
-    affiliateFee: z.string(),
-    tradeTimeout: z.number()
+    version: z.number()
   }),
   traceId: z.string()
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@optimex-xyz/market-maker-sdk",
-  "version": "0.5.1",
+  "version": "0.5.3",
   "private": false,
   "publishConfig": {
     "access": "public"