@optimex-xyz/market-maker-sdk 0.7.0 → 0.8.0-dev-91a0821

package/README.md

@@ -1,5 +1,13 @@
 # PMM API Integration Documentation
 
+> **CHANGELOG (v0.7.1)**: 
+> - **Breaking Changes:**
+>   - Environment key `dev` has been renamed to `staging` - please update your environment configuration accordingly
+>   - Several functions from `routerService` moved to `protocolService`
+> - **Upgrade Notes:**
+>   - For PMMs using version 6.2, you can update to v0.7.1 without needing to change anything
+>   - If you need to use the Router, please use the values provided in the environment configuration section
+
 > **Note**: If you prefer using the SDK instead of direct API integration, please refer to the [PMM SDK Integration Guide](sdk-integration.md).
 
 A comprehensive guide for implementing Private Market Makers (PMMs) in the cross-chain trading network. This documentation covers the required integration points between PMMs and our solver backend, enabling cross-chain liquidity provision and settlement.
@@ -22,6 +30,8 @@ A comprehensive guide for implementing Private Market Makers (PMMs) in the cross
   - [5. PMM Making Payment](#5-pmm-making-payment)
     - [5.1. EVM](#51-evm)
     - [5.2. Bitcoin](#52-bitcoin)
+
+
 ## 1. Overview
 
 The PMM integration with Optimex involves bidirectional API communication:
@@ -68,16 +78,18 @@ sequenceDiagram
 
 | Environment      | Description                                                          |
 | ---------------- | -------------------------------------------------------------------- |
-| `dev`            | Development environment with test networks and staging services      |
+| `dev`            | internal environment with test networks and development services     |
+| `staging`        | Staging 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 |
 
 <details>
-<summary><strong>Development Contracts</strong></summary>
+<summary><strong>Staging Contracts</strong></summary>
 
 **Optimex L2 Testnet**
 - **Signer**: [0xA89F5060B810F3b6027D7663880c43ee77A865C7](https://scan-testnet.optimex.xyz/address/0xA89F5060B810F3b6027D7663880c43ee77A865C7)
-- **Router**: [0x193501E5F72a42DACCF8Eb1C4AB37561c213309D](https://scan-testnet.optimex.xyz/address/0x193501E5F72a42DACCF8Eb1C4AB37561c213309D)
+- **Router**: [0xa6E13A3c6c63C64d45bB453E0402B7D2eE53E564](https://scan-testnet.optimex.xyz/address/0xa6E13A3c6c63C64d45bB453E0402B7D2eE53E564)
+- **ProtocolFetcherProxy**: [0x7c07151ca4DFd93F352Ab9B132A95866697c38c2](https://scan-testnet.optimex.xyz/address/0x7c07151ca4DFd93F352Ab9B132A95866697c38c2)
 
 **Ethereum Sepolia**
 - **Payment**: [0x7387DcCfE2f1D5F80b4ECDF91eF58541517e90D2](https://sepolia.etherscan.io/address/0x7387DcCfE2f1D5F80b4ECDF91eF58541517e90D2)
@@ -94,7 +106,8 @@ sequenceDiagram
 
 **Optimex L2 Mainnet**
 - **Signer**: [0xCF9786F123F1071023dB8049808C223e94c384be](https://scan.optimex.xyz/address/0xCF9786F123F1071023dB8049808C223e94c384be)
-- **Router**: [0xcceAb862dD41f6691d81Cc016216Cd45d7BD6D4A](https://scan.optimex.xyz/address/0xcceAb862dD41f6691d81Cc016216Cd45d7BD6D4A)
+- **Router**: [0xF7fedF4A250157010807E6eA60258E3B768149Ff](https://scan.optimex.xyz/address/0xF7fedF4A250157010807E6eA60258E3B768149Ff)
+- **ProtocolFetcherProxy**: [0xFDEd4CEf9aE1E03D0BeF161262a266c1c157a32b](https://scan.optimex.xyz/address/0xFDEd4CEf9aE1E03D0BeF161262a266c1c157a32b)
 
 **Ethereum Mainnet**
 - **Payment**: [0x0A497AC4261E37FA4062762C23Cf3cB642C839b8](https://etherscan.io/address/0x0A497AC4261E37FA4062762C23Cf3cB642C839b8)