@optimex-xyz/market-maker-sdk 0.8.0 → 0.9.0-dev-cb35949
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -6
- package/dist/index.d.mts +620 -2
- package/dist/index.d.ts +620 -2
- package/dist/index.js +489 -47
- package/dist/index.mjs +465 -26
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,11 +1,12 @@
|
|
|
1
1
|
# PMM API Integration Documentation
|
|
2
2
|
|
|
3
|
-
> **CHANGELOG (v0.
|
|
3
|
+
> **CHANGELOG (v0.8.0)**:
|
|
4
4
|
> - **Breaking Changes:**
|
|
5
|
-
> -
|
|
6
|
-
> -
|
|
5
|
+
> - Update to get router contract from protocol fetcher
|
|
6
|
+
> - Use consistent trade_id across all protocol
|
|
7
|
+
> - Add `user_receiving_address`, `user_refund_pubkey`, `from_user_address` to `indicative_quote` api requirement as optional fields.
|
|
7
8
|
> - **Upgrade Notes:**
|
|
8
|
-
> - For PMMs
|
|
9
|
+
> - For PMMs older version you can update to v0.8.0 without needing to change anything
|
|
9
10
|
> - If you need to use the Router, please use the values provided in the environment configuration section
|
|
10
11
|
|
|
11
12
|
> **Note**: If you prefer using the SDK instead of direct API integration, please refer to the [PMM SDK Integration Guide](sdk-integration.md).
|
|
@@ -88,7 +89,7 @@ sequenceDiagram
|
|
|
88
89
|
|
|
89
90
|
**Optimex L2 Testnet**
|
|
90
91
|
- **Signer**: [0xA89F5060B810F3b6027D7663880c43ee77A865C7](https://scan-testnet.optimex.xyz/address/0xA89F5060B810F3b6027D7663880c43ee77A865C7)
|
|
91
|
-
- **Router**: [
|
|
92
|
+
- **Router**: [0x31C88ebd9E430455487b6a5c8971e8eF63e97ED4](https://scan-testnet.optimex.xyz/address/0x31C88ebd9E430455487b6a5c8971e8eF63e97ED4)
|
|
92
93
|
- **ProtocolFetcherProxy**: [0x7c07151ca4DFd93F352Ab9B132A95866697c38c2](https://scan-testnet.optimex.xyz/address/0x7c07151ca4DFd93F352Ab9B132A95866697c38c2)
|
|
93
94
|
|
|
94
95
|
**Ethereum Sepolia**
|
|
@@ -106,7 +107,7 @@ sequenceDiagram
|
|
|
106
107
|
|
|
107
108
|
**Optimex L2 Mainnet**
|
|
108
109
|
- **Signer**: [0xCF9786F123F1071023dB8049808C223e94c384be](https://scan.optimex.xyz/address/0xCF9786F123F1071023dB8049808C223e94c384be)
|
|
109
|
-
- **Router**: [
|
|
110
|
+
- **Router**: [0x1e878cCa765a8aAFEBecCa672c767441b4859634](https://scan.optimex.xyz/address/0x1e878cCa765a8aAFEBecCa672c767441b4859634)
|
|
110
111
|
- **ProtocolFetcherProxy**: [0xFDEd4CEf9aE1E03D0BeF161262a266c1c157a32b](https://scan.optimex.xyz/address/0xFDEd4CEf9aE1E03D0BeF161262a266c1c157a32b)
|
|
111
112
|
|
|
112
113
|
**Ethereum Mainnet**
|
|
@@ -141,6 +142,9 @@ Provides an indicative quote for the given token pair and trade amount. The quot
|
|
|
141
142
|
- `deposited` (boolean, optional): Whether the deposit has been confirmed. This allows the PMM to decide the returned quote.
|
|
142
143
|
- `trade_timeout` (string, optional): The deadline when user is expected to receive tokens from PMM in UNIX timestamp. We expect the trade to be completed before this timeout. But if not, some actions can still be taken.
|
|
143
144
|
- `script_timeout` (string, optional): The hard timeout for the trade, UNIX timestamp. After this timeout, the trade will not be processed further.
|
|
145
|
+
- `from_user_address` (string, optional): The user's address from which the input token will be sent from.
|
|
146
|
+
- `user_receiving_address` (string, optional): The user's address to which the output token will be sent to.
|
|
147
|
+
- `user_refund_pubkey` (string, optional): The user's public key to which the refund will be sent.
|
|
144
148
|
|
|
145
149
|
#### Example Request
|
|
146
150
|
|