@optimex-xyz/market-maker-sdk 0.6.0 → 0.6.1

package/README.md

@@ -12,6 +12,9 @@ A comprehensive guide for implementing Private Market Makers (PMMs) in the cross
     - [1.1. Integration Flow](#11-integration-flow)
   - [2. Quick Start](#2-quick-start)
     - [2.1. API Environments](#21-api-environments)
+      - [Development Environment](#development-environment)
+      - [Pre-production Environment](#pre-production-environment)
+      - [Production Environment](#production-environment)
   - [3. PMM Backend APIs](#3-pmm-backend-apis)
     - [3.1. Endpoint: `/indicative-quote`](#31-endpoint-indicative-quote)
       - [Description](#description)
@@ -104,23 +107,44 @@ sequenceDiagram
 
 ### 2.1. API Environments
 
-| Environment      | Description                                                          | 
-| ---------------- | -------------------------------------------------------------------- | 
-| `dev`            | Development environment with test networks and staging services      | 
-| `pre-production` | Pre-production environment with mainnet networks for testing before release |
+| Environment      | Description                                                          |
+| ---------------- | -------------------------------------------------------------------- |
+| `dev`            | Development environment with test networks and staging services      |
+| `prelive` | Pre-production environment with mainnet networks for testing before release |
 | `production`     | Production environment with mainnet networks and production services |
 
-- Solver URLs: Each environment has dedicated API endpoints
-
-- RPC Endpoints: L2 RPC endpoints
-
-- 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
+#### Development Environment
+Development environment with test networks and staging services
+
+- **Signer**: 0xA89F5060B810F3b6027D7663880c43ee77A865C7
+- **Router**: 0x193501E5F72a42DACCF8Eb1C4AB37561c213309D
+- **Payment**: 0x7387DcCfE2f1D5F80b4ECDF91eF58541517e90D2
+- **ETHVault**: 0x17aD543010fc8E8065b85E203839C0CBEcdfC851
+- **WETHVault**: 0x673Ac1489457F43F04403940cE425ae19a9D639B
+- **USDTVault**: 0x62179B12Ce75B81Fcb4a2B634aD92DDaeF728e9C
+- **WBTCVault**: 0x04D0C9a5bb122958D8A64049068FD8570dDfA3Dc
+
+#### Pre-production Environment
+Pre-production environment with mainnet networks for testing before release
+
+- **Signer**: [0xCF9786F123F1071023dB8049808C223e94c384be](https://scan.optimex.xyz/address/0xCF9786F123F1071023dB8049808C223e94c384be)
+- **Router**: [0xcceAb862dD41f6691d81Cc016216Cd45d7BD6D4A](https://scan.optimex.xyz/address/0xcceAb862dD41f6691d81Cc016216Cd45d7BD6D4A)
+- **Payment**: [0x0A497AC4261E37FA4062762C23Cf3cB642C839b8](https://etherscan.io/address/0x0A497AC4261E37FA4062762C23Cf3cB642C839b8)
+- **ETHVault**: [0xF7fedF4A250157010807E6eA60258E3B768149Ff](https://etherscan.io/address/0xF7fedF4A250157010807E6eA60258E3B768149Ff)
+- **WETHVault**: [0xaD3f379AaED8Eca895209Af446F2e34f07145dbC](https://etherscan.io/address/0xaD3f379AaED8Eca895209Af446F2e34f07145dbC)
+- **USDTVault**: [0x0712CAB9e52a37aFC6fA768b20cc9b07325314fB](https://etherscan.io/address/0x0712CAB9e52a37aFC6fA768b20cc9b07325314fB)
+- **WBTCVault**: [0xCd6B5F600559104Ee19320B9F9C3b2c7672cb895](https://etherscan.io/address/0xCd6B5F600559104Ee19320B9F9C3b2c7672cb895)
+
+#### Production Environment
+Production environment with mainnet networks and production services
+
+- **Signer**: [0xCF9786F123F1071023dB8049808C223e94c384be](https://scan.optimex.xyz/address/0xCF9786F123F1071023dB8049808C223e94c384be)
+- **Router**: [0xcceAb862dD41f6691d81Cc016216Cd45d7BD6D4A](https://scan.optimex.xyz/address/0xcceAb862dD41f6691d81Cc016216Cd45d7BD6D4A)
+- **Payment**: [0x0A497AC4261E37FA4062762C23Cf3cB642C839b8](https://etherscan.io/address/0x0A497AC4261E37FA4062762C23Cf3cB642C839b8)
+- **ETHVault**: [0xF7fedF4A250157010807E6eA60258E3B768149Ff](https://etherscan.io/address/0xF7fedF4A250157010807E6eA60258E3B768149Ff)
+- **WETHVault**: [0xaD3f379AaED8Eca895209Af446F2e34f07145dbC](https://etherscan.io/address/0xaD3f379AaED8Eca895209Af446F2e34f07145dbC)
+- **USDTVault**: [0x0712CAB9e52a37aFC6fA768b20cc9b07325314fB](https://etherscan.io/address/0x0712CAB9e52a37aFC6fA768b20cc9b07325314fB)
+- **WBTCVault**: [0xCd6B5F600559104Ee19320B9F9C3b2c7672cb895](https://etherscan.io/address/0xCd6B5F600559104Ee19320B9F9C3b2c7672cb895)
 
 ## 3. PMM Backend APIs
 

package/dist/index.d.mts

@@ -5203,14 +5203,14 @@ declare const TradeDetailResponseSchema: z.ZodObject<{
         bestIndicativeQuote: z.ZodString;
         displayIndicativeQuote: z.ZodString;
         pmmFinalists: z.ZodArray<z.ZodObject<{
-            pmmId: z.ZodString;
-            pmmReceivingAddress: z.ZodString;
+            pmmId: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+            pmmReceivingAddress: z.ZodDefault<z.ZodOptional<z.ZodString>>;
         }, "strip", z.ZodTypeAny, {
             pmmId: string;
             pmmReceivingAddress: string;
         }, {
-            pmmId: string;
-            pmmReceivingAddress: string;
+            pmmId?: string | undefined;
+            pmmReceivingAddress?: string | undefined;
         }>, "many">;
         settlementQuote: z.ZodString;
         receivingAmount: z.ZodString;
@@ -5225,26 +5225,26 @@ declare const TradeDetailResponseSchema: z.ZodObject<{
         userDepositTx: z.ZodString;
         depositVault: z.ZodString;
         paymentBundle: z.ZodObject<{
-            tradeIds: z.ZodArray<z.ZodString, "many">;
-            settlementTx: z.ZodString;
-            signature: z.ZodString;
-            startIndex: z.ZodNumber;
-            pmmId: z.ZodString;
-            signedAt: z.ZodNumber;
+            tradeIds: z.ZodNullable<z.ZodArray<z.ZodString, "many">>;
+            settlementTx: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+            signature: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+            startIndex: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+            pmmId: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+            signedAt: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
         }, "strip", z.ZodTypeAny, {
             signature: string;
-            tradeIds: string[];
+            tradeIds: string[] | null;
             signedAt: number;
             pmmId: string;
             settlementTx: string;
             startIndex: number;
         }, {
-            signature: string;
-            tradeIds: string[];
-            signedAt: number;
-            pmmId: string;
-            settlementTx: string;
-            startIndex: number;
+            tradeIds: string[] | null;
+            signature?: string | undefined;
+            signedAt?: number | undefined;
+            pmmId?: string | undefined;
+            settlementTx?: string | undefined;
+            startIndex?: number | undefined;
         }>;
         userSignature: z.ZodString;
         tradeSubmissionTx: z.ZodString;
@@ -5306,7 +5306,7 @@ declare const TradeDetailResponseSchema: z.ZodObject<{
         depositVault: string;
         paymentBundle: {
             signature: string;
-            tradeIds: string[];
+            tradeIds: string[] | null;
             signedAt: number;
             pmmId: string;
             settlementTx: string;
@@ -5353,8 +5353,8 @@ declare const TradeDetailResponseSchema: z.ZodObject<{
         bestIndicativeQuote: string;
         displayIndicativeQuote: string;
         pmmFinalists: {
-            pmmId: string;
-            pmmReceivingAddress: string;
+            pmmId?: string | undefined;
+            pmmReceivingAddress?: string | undefined;
         }[];
         settlementQuote: string;
         receivingAmount: string;
@@ -5368,12 +5368,12 @@ declare const TradeDetailResponseSchema: z.ZodObject<{
         userDepositTx: string;
         depositVault: string;
         paymentBundle: {
-            signature: string;
-            tradeIds: string[];
-            signedAt: number;
-            pmmId: string;
-            settlementTx: string;
-            startIndex: number;
+            tradeIds: string[] | null;
+            signature?: string | undefined;
+            signedAt?: number | undefined;
+            pmmId?: string | undefined;
+            settlementTx?: string | undefined;
+            startIndex?: number | undefined;
         };
         userSignature: string;
         tradeSubmissionTx: string;
@@ -5435,7 +5435,7 @@ declare const TradeDetailResponseSchema: z.ZodObject<{
         depositVault: string;
         paymentBundle: {
             signature: string;
-            tradeIds: string[];
+            tradeIds: string[] | null;
             signedAt: number;
             pmmId: string;
             settlementTx: string;
@@ -5485,8 +5485,8 @@ declare const TradeDetailResponseSchema: z.ZodObject<{
         bestIndicativeQuote: string;
         displayIndicativeQuote: string;
         pmmFinalists: {
-            pmmId: string;
-            pmmReceivingAddress: string;
+            pmmId?: string | undefined;
+            pmmReceivingAddress?: string | undefined;
         }[];
         settlementQuote: string;
         receivingAmount: string;
@@ -5500,12 +5500,12 @@ declare const TradeDetailResponseSchema: z.ZodObject<{
         userDepositTx: string;
         depositVault: string;
         paymentBundle: {
-            signature: string;
-            tradeIds: string[];
-            signedAt: number;
-            pmmId: string;
-            settlementTx: string;
-            startIndex: number;
+            tradeIds: string[] | null;
+            signature?: string | undefined;
+            signedAt?: number | undefined;
+            pmmId?: string | undefined;
+            settlementTx?: string | undefined;
+            startIndex?: number | undefined;
         };
         userSignature: string;
         tradeSubmissionTx: string;

package/dist/index.d.ts

@@ -5203,14 +5203,14 @@ declare const TradeDetailResponseSchema: z.ZodObject<{
         bestIndicativeQuote: z.ZodString;
         displayIndicativeQuote: z.ZodString;
         pmmFinalists: z.ZodArray<z.ZodObject<{
-            pmmId: z.ZodString;
-            pmmReceivingAddress: z.ZodString;
+            pmmId: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+            pmmReceivingAddress: z.ZodDefault<z.ZodOptional<z.ZodString>>;
         }, "strip", z.ZodTypeAny, {
             pmmId: string;
             pmmReceivingAddress: string;
         }, {
-            pmmId: string;
-            pmmReceivingAddress: string;
+            pmmId?: string | undefined;
+            pmmReceivingAddress?: string | undefined;
         }>, "many">;
         settlementQuote: z.ZodString;
         receivingAmount: z.ZodString;
@@ -5225,26 +5225,26 @@ declare const TradeDetailResponseSchema: z.ZodObject<{
         userDepositTx: z.ZodString;
         depositVault: z.ZodString;
         paymentBundle: z.ZodObject<{
-            tradeIds: z.ZodArray<z.ZodString, "many">;
-            settlementTx: z.ZodString;
-            signature: z.ZodString;
-            startIndex: z.ZodNumber;
-            pmmId: z.ZodString;
-            signedAt: z.ZodNumber;
+            tradeIds: z.ZodNullable<z.ZodArray<z.ZodString, "many">>;
+            settlementTx: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+            signature: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+            startIndex: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+            pmmId: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+            signedAt: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
         }, "strip", z.ZodTypeAny, {
             signature: string;
-            tradeIds: string[];
+            tradeIds: string[] | null;
             signedAt: number;
             pmmId: string;
             settlementTx: string;
             startIndex: number;
         }, {
-            signature: string;
-            tradeIds: string[];
-            signedAt: number;
-            pmmId: string;
-            settlementTx: string;
-            startIndex: number;
+            tradeIds: string[] | null;
+            signature?: string | undefined;
+            signedAt?: number | undefined;
+            pmmId?: string | undefined;
+            settlementTx?: string | undefined;
+            startIndex?: number | undefined;
         }>;
         userSignature: z.ZodString;
         tradeSubmissionTx: z.ZodString;
@@ -5306,7 +5306,7 @@ declare const TradeDetailResponseSchema: z.ZodObject<{
         depositVault: string;
         paymentBundle: {
             signature: string;
-            tradeIds: string[];
+            tradeIds: string[] | null;
             signedAt: number;
             pmmId: string;
             settlementTx: string;
@@ -5353,8 +5353,8 @@ declare const TradeDetailResponseSchema: z.ZodObject<{
         bestIndicativeQuote: string;
         displayIndicativeQuote: string;
         pmmFinalists: {
-            pmmId: string;
-            pmmReceivingAddress: string;
+            pmmId?: string | undefined;
+            pmmReceivingAddress?: string | undefined;
         }[];
         settlementQuote: string;
         receivingAmount: string;
@@ -5368,12 +5368,12 @@ declare const TradeDetailResponseSchema: z.ZodObject<{
         userDepositTx: string;
         depositVault: string;
         paymentBundle: {
-            signature: string;
-            tradeIds: string[];
-            signedAt: number;
-            pmmId: string;
-            settlementTx: string;
-            startIndex: number;
+            tradeIds: string[] | null;
+            signature?: string | undefined;
+            signedAt?: number | undefined;
+            pmmId?: string | undefined;
+            settlementTx?: string | undefined;
+            startIndex?: number | undefined;
         };
         userSignature: string;
         tradeSubmissionTx: string;
@@ -5435,7 +5435,7 @@ declare const TradeDetailResponseSchema: z.ZodObject<{
         depositVault: string;
         paymentBundle: {
             signature: string;
-            tradeIds: string[];
+            tradeIds: string[] | null;
             signedAt: number;
             pmmId: string;
             settlementTx: string;
@@ -5485,8 +5485,8 @@ declare const TradeDetailResponseSchema: z.ZodObject<{
         bestIndicativeQuote: string;
         displayIndicativeQuote: string;
         pmmFinalists: {
-            pmmId: string;
-            pmmReceivingAddress: string;
+            pmmId?: string | undefined;
+            pmmReceivingAddress?: string | undefined;
         }[];
         settlementQuote: string;
         receivingAmount: string;
@@ -5500,12 +5500,12 @@ declare const TradeDetailResponseSchema: z.ZodObject<{
         userDepositTx: string;
         depositVault: string;
         paymentBundle: {
-            signature: string;
-            tradeIds: string[];
-            signedAt: number;
-            pmmId: string;
-            settlementTx: string;
-            startIndex: number;
+            tradeIds: string[] | null;
+            signature?: string | undefined;
+            signedAt?: number | undefined;
+            pmmId?: string | undefined;
+            settlementTx?: string | undefined;
+            startIndex?: number | undefined;
         };
         userSignature: string;
         tradeSubmissionTx: string;

package/dist/index.js

@@ -4034,16 +4034,16 @@ var TokenInfoSchema = import_zod.z.object({
   feeOut: import_zod.z.boolean()
 });
 var PMMFinalistSchema = import_zod.z.object({
-  pmmId: import_zod.z.string(),
-  pmmReceivingAddress: import_zod.z.string()
+  pmmId: import_zod.z.string().optional().default(""),
+  pmmReceivingAddress: import_zod.z.string().optional().default("")
 });
 var PaymentBundleSchema = import_zod.z.object({
-  tradeIds: import_zod.z.array(import_zod.z.string()),
-  settlementTx: import_zod.z.string(),
-  signature: import_zod.z.string(),
-  startIndex: import_zod.z.number(),
-  pmmId: import_zod.z.string(),
-  signedAt: import_zod.z.number()
+  tradeIds: import_zod.z.array(import_zod.z.string()).nullable(),
+  settlementTx: import_zod.z.string().optional().default(""),
+  signature: import_zod.z.string().optional().default("0x"),
+  startIndex: import_zod.z.number().optional().default(0),
+  pmmId: import_zod.z.string().optional().default(""),
+  signedAt: import_zod.z.number().optional().default(0)
 });
 var TradeDetailResponseSchema = import_zod.z.object({
   data: import_zod.z.object({

package/dist/index.mjs

@@ -3969,16 +3969,16 @@ var TokenInfoSchema = z.object({
   feeOut: z.boolean()
 });
 var PMMFinalistSchema = z.object({
-  pmmId: z.string(),
-  pmmReceivingAddress: z.string()
+  pmmId: z.string().optional().default(""),
+  pmmReceivingAddress: z.string().optional().default("")
 });
 var PaymentBundleSchema = z.object({
-  tradeIds: z.array(z.string()),
-  settlementTx: z.string(),
-  signature: z.string(),
-  startIndex: z.number(),
-  pmmId: z.string(),
-  signedAt: z.number()
+  tradeIds: z.array(z.string()).nullable(),
+  settlementTx: z.string().optional().default(""),
+  signature: z.string().optional().default("0x"),
+  startIndex: z.number().optional().default(0),
+  pmmId: z.string().optional().default(""),
+  signedAt: z.number().optional().default(0)
 });
 var TradeDetailResponseSchema = z.object({
   data: z.object({

package/package.json

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