@compass-labs/api-sdk 2.2.45-rc.0 → 2.2.45-rc.1

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.
@@ -20,7 +20,7 @@ import { Result } from "../types/fp.js";
20
20
  *
21
21
  * 1. If `approval_safe_tx_eip712` is populated (Safe→LOP allowance is
22
22
  * insufficient), sign it with `wallet.signTypedData(...)` and relay via
23
- * `POST /v2/safe/sponsor_gas` so the sponsor broadcasts the resulting
23
+ * `POST /v2/gas_sponsorship/prepare` so the sponsor broadcasts the resulting
24
24
  * `Safe.execTransaction(USDC.approve(LOP_v4, ...))`. Wait for that tx
25
25
  * to confirm before signing the order.
26
26
  * 2. Sign `order.safe_message_eip712` with the same owner wallet — this is
@@ -59,7 +59,7 @@ const async_js_1 = require("../types/async.js");
59
59
  *
60
60
  * 1. If `approval_safe_tx_eip712` is populated (Safe→LOP allowance is
61
61
  * insufficient), sign it with `wallet.signTypedData(...)` and relay via
62
- * `POST /v2/safe/sponsor_gas` so the sponsor broadcasts the resulting
62
+ * `POST /v2/gas_sponsorship/prepare` so the sponsor broadcasts the resulting
63
63
  * `Safe.execTransaction(USDC.approve(LOP_v4, ...))`. Wait for that tx
64
64
  * to confirm before signing the order.
65
65
  * 2. Sign `order.safe_message_eip712` with the same owner wallet — this is
@@ -18,7 +18,7 @@ import { Result } from "../types/fp.js";
18
18
  * Returns ``cancel_safe_tx_eip712``: an EIP-712 ``Safe.execTransaction``
19
19
  * payload whose inner call is ``LOP.cancelOrder(makerTraits, orderHash)``.
20
20
  * Sign with the Tokenized Assets Account's owner via
21
- * ``wallet.signTypedData(...)`` and relay via ``POST /v2/safe/sponsor_gas``
21
+ * ``wallet.signTypedData(...)`` and relay via ``POST /v2/gas_sponsorship/prepare``
22
22
  * so the sponsor broadcasts ``execTransaction`` on the product account
23
23
  * (the order's maker). The owner can also broadcast ``execTransaction``
24
24
  * directly if not using gas sponsorship.
@@ -57,7 +57,7 @@ const async_js_1 = require("../types/async.js");
57
57
  * Returns ``cancel_safe_tx_eip712``: an EIP-712 ``Safe.execTransaction``
58
58
  * payload whose inner call is ``LOP.cancelOrder(makerTraits, orderHash)``.
59
59
  * Sign with the Tokenized Assets Account's owner via
60
- * ``wallet.signTypedData(...)`` and relay via ``POST /v2/safe/sponsor_gas``
60
+ * ``wallet.signTypedData(...)`` and relay via ``POST /v2/gas_sponsorship/prepare``
61
61
  * so the sponsor broadcasts ``execTransaction`` on the product account
62
62
  * (the order's maker). The owner can also broadcast ``execTransaction``
63
63
  * directly if not using gas sponsorship.
@@ -13,7 +13,7 @@ export type TokenizedAssetsBuildOrderResponse = {
13
13
  */
14
14
  quote: Quote;
15
15
  /**
16
- * EIP-712 `Safe.execTransaction` wrapping `USDC.approve(LOP_v4, max_uint256)`. Populated when the Tokenized Assets Account's allowance to LOP v4 is below `amount`; sign with `wallet.signTypedData(...)` and relay via `POST /v2/safe/sponsor_gas`. `null` when allowance is already sufficient.
16
+ * EIP-712 `Safe.execTransaction` wrapping `USDC.approve(LOP_v4, max_uint256)`. Populated when the Tokenized Assets Account's allowance to LOP v4 is below `amount`; sign with `wallet.signTypedData(...)` and relay via `POST /v2/gas_sponsorship/prepare`. `null` when allowance is already sufficient.
17
17
  */
18
18
  approvalSafeTxEip712?: BatchedSafeOperationsResponseOutput | null | undefined;
19
19
  /**
@@ -82,7 +82,7 @@ export declare class TokenizedAssets extends ClientSDK {
82
82
  *
83
83
  * 1. If `approval_safe_tx_eip712` is populated (Safe→LOP allowance is
84
84
  * insufficient), sign it with `wallet.signTypedData(...)` and relay via
85
- * `POST /v2/safe/sponsor_gas` so the sponsor broadcasts the resulting
85
+ * `POST /v2/gas_sponsorship/prepare` so the sponsor broadcasts the resulting
86
86
  * `Safe.execTransaction(USDC.approve(LOP_v4, ...))`. Wait for that tx
87
87
  * to confirm before signing the order.
88
88
  * 2. Sign `order.safe_message_eip712` with the same owner wallet — this is
@@ -121,7 +121,7 @@ export declare class TokenizedAssets extends ClientSDK {
121
121
  * Returns ``cancel_safe_tx_eip712``: an EIP-712 ``Safe.execTransaction``
122
122
  * payload whose inner call is ``LOP.cancelOrder(makerTraits, orderHash)``.
123
123
  * Sign with the Tokenized Assets Account's owner via
124
- * ``wallet.signTypedData(...)`` and relay via ``POST /v2/safe/sponsor_gas``
124
+ * ``wallet.signTypedData(...)`` and relay via ``POST /v2/gas_sponsorship/prepare``
125
125
  * so the sponsor broadcasts ``execTransaction`` on the product account
126
126
  * (the order's maker). The owner can also broadcast ``execTransaction``
127
127
  * directly if not using gas sponsorship.
@@ -108,7 +108,7 @@ class TokenizedAssets extends sdks_js_1.ClientSDK {
108
108
  *
109
109
  * 1. If `approval_safe_tx_eip712` is populated (Safe→LOP allowance is
110
110
  * insufficient), sign it with `wallet.signTypedData(...)` and relay via
111
- * `POST /v2/safe/sponsor_gas` so the sponsor broadcasts the resulting
111
+ * `POST /v2/gas_sponsorship/prepare` so the sponsor broadcasts the resulting
112
112
  * `Safe.execTransaction(USDC.approve(LOP_v4, ...))`. Wait for that tx
113
113
  * to confirm before signing the order.
114
114
  * 2. Sign `order.safe_message_eip712` with the same owner wallet — this is
@@ -151,7 +151,7 @@ class TokenizedAssets extends sdks_js_1.ClientSDK {
151
151
  * Returns ``cancel_safe_tx_eip712``: an EIP-712 ``Safe.execTransaction``
152
152
  * payload whose inner call is ``LOP.cancelOrder(makerTraits, orderHash)``.
153
153
  * Sign with the Tokenized Assets Account's owner via
154
- * ``wallet.signTypedData(...)`` and relay via ``POST /v2/safe/sponsor_gas``
154
+ * ``wallet.signTypedData(...)`` and relay via ``POST /v2/gas_sponsorship/prepare``
155
155
  * so the sponsor broadcasts ``execTransaction`` on the product account
156
156
  * (the order's maker). The owner can also broadcast ``execTransaction``
157
157
  * directly if not using gas sponsorship.
@@ -20,7 +20,7 @@ import { Result } from "../types/fp.js";
20
20
  *
21
21
  * 1. If `approval_safe_tx_eip712` is populated (Safe→LOP allowance is
22
22
  * insufficient), sign it with `wallet.signTypedData(...)` and relay via
23
- * `POST /v2/safe/sponsor_gas` so the sponsor broadcasts the resulting
23
+ * `POST /v2/gas_sponsorship/prepare` so the sponsor broadcasts the resulting
24
24
  * `Safe.execTransaction(USDC.approve(LOP_v4, ...))`. Wait for that tx
25
25
  * to confirm before signing the order.
26
26
  * 2. Sign `order.safe_message_eip712` with the same owner wallet — this is
@@ -23,7 +23,7 @@ import { APIPromise } from "../types/async.js";
23
23
  *
24
24
  * 1. If `approval_safe_tx_eip712` is populated (Safe→LOP allowance is
25
25
  * insufficient), sign it with `wallet.signTypedData(...)` and relay via
26
- * `POST /v2/safe/sponsor_gas` so the sponsor broadcasts the resulting
26
+ * `POST /v2/gas_sponsorship/prepare` so the sponsor broadcasts the resulting
27
27
  * `Safe.execTransaction(USDC.approve(LOP_v4, ...))`. Wait for that tx
28
28
  * to confirm before signing the order.
29
29
  * 2. Sign `order.safe_message_eip712` with the same owner wallet — this is
@@ -18,7 +18,7 @@ import { Result } from "../types/fp.js";
18
18
  * Returns ``cancel_safe_tx_eip712``: an EIP-712 ``Safe.execTransaction``
19
19
  * payload whose inner call is ``LOP.cancelOrder(makerTraits, orderHash)``.
20
20
  * Sign with the Tokenized Assets Account's owner via
21
- * ``wallet.signTypedData(...)`` and relay via ``POST /v2/safe/sponsor_gas``
21
+ * ``wallet.signTypedData(...)`` and relay via ``POST /v2/gas_sponsorship/prepare``
22
22
  * so the sponsor broadcasts ``execTransaction`` on the product account
23
23
  * (the order's maker). The owner can also broadcast ``execTransaction``
24
24
  * directly if not using gas sponsorship.
@@ -21,7 +21,7 @@ import { APIPromise } from "../types/async.js";
21
21
  * Returns ``cancel_safe_tx_eip712``: an EIP-712 ``Safe.execTransaction``
22
22
  * payload whose inner call is ``LOP.cancelOrder(makerTraits, orderHash)``.
23
23
  * Sign with the Tokenized Assets Account's owner via
24
- * ``wallet.signTypedData(...)`` and relay via ``POST /v2/safe/sponsor_gas``
24
+ * ``wallet.signTypedData(...)`` and relay via ``POST /v2/gas_sponsorship/prepare``
25
25
  * so the sponsor broadcasts ``execTransaction`` on the product account
26
26
  * (the order's maker). The owner can also broadcast ``execTransaction``
27
27
  * directly if not using gas sponsorship.
@@ -13,7 +13,7 @@ export type TokenizedAssetsBuildOrderResponse = {
13
13
  */
14
14
  quote: Quote;
15
15
  /**
16
- * EIP-712 `Safe.execTransaction` wrapping `USDC.approve(LOP_v4, max_uint256)`. Populated when the Tokenized Assets Account's allowance to LOP v4 is below `amount`; sign with `wallet.signTypedData(...)` and relay via `POST /v2/safe/sponsor_gas`. `null` when allowance is already sufficient.
16
+ * EIP-712 `Safe.execTransaction` wrapping `USDC.approve(LOP_v4, max_uint256)`. Populated when the Tokenized Assets Account's allowance to LOP v4 is below `amount`; sign with `wallet.signTypedData(...)` and relay via `POST /v2/gas_sponsorship/prepare`. `null` when allowance is already sufficient.
17
17
  */
18
18
  approvalSafeTxEip712?: BatchedSafeOperationsResponseOutput | null | undefined;
19
19
  /**
@@ -82,7 +82,7 @@ export declare class TokenizedAssets extends ClientSDK {
82
82
  *
83
83
  * 1. If `approval_safe_tx_eip712` is populated (Safe→LOP allowance is
84
84
  * insufficient), sign it with `wallet.signTypedData(...)` and relay via
85
- * `POST /v2/safe/sponsor_gas` so the sponsor broadcasts the resulting
85
+ * `POST /v2/gas_sponsorship/prepare` so the sponsor broadcasts the resulting
86
86
  * `Safe.execTransaction(USDC.approve(LOP_v4, ...))`. Wait for that tx
87
87
  * to confirm before signing the order.
88
88
  * 2. Sign `order.safe_message_eip712` with the same owner wallet — this is
@@ -121,7 +121,7 @@ export declare class TokenizedAssets extends ClientSDK {
121
121
  * Returns ``cancel_safe_tx_eip712``: an EIP-712 ``Safe.execTransaction``
122
122
  * payload whose inner call is ``LOP.cancelOrder(makerTraits, orderHash)``.
123
123
  * Sign with the Tokenized Assets Account's owner via
124
- * ``wallet.signTypedData(...)`` and relay via ``POST /v2/safe/sponsor_gas``
124
+ * ``wallet.signTypedData(...)`` and relay via ``POST /v2/gas_sponsorship/prepare``
125
125
  * so the sponsor broadcasts ``execTransaction`` on the product account
126
126
  * (the order's maker). The owner can also broadcast ``execTransaction``
127
127
  * directly if not using gas sponsorship.
@@ -105,7 +105,7 @@ export class TokenizedAssets extends ClientSDK {
105
105
  *
106
106
  * 1. If `approval_safe_tx_eip712` is populated (Safe→LOP allowance is
107
107
  * insufficient), sign it with `wallet.signTypedData(...)` and relay via
108
- * `POST /v2/safe/sponsor_gas` so the sponsor broadcasts the resulting
108
+ * `POST /v2/gas_sponsorship/prepare` so the sponsor broadcasts the resulting
109
109
  * `Safe.execTransaction(USDC.approve(LOP_v4, ...))`. Wait for that tx
110
110
  * to confirm before signing the order.
111
111
  * 2. Sign `order.safe_message_eip712` with the same owner wallet — this is
@@ -148,7 +148,7 @@ export class TokenizedAssets extends ClientSDK {
148
148
  * Returns ``cancel_safe_tx_eip712``: an EIP-712 ``Safe.execTransaction``
149
149
  * payload whose inner call is ``LOP.cancelOrder(makerTraits, orderHash)``.
150
150
  * Sign with the Tokenized Assets Account's owner via
151
- * ``wallet.signTypedData(...)`` and relay via ``POST /v2/safe/sponsor_gas``
151
+ * ``wallet.signTypedData(...)`` and relay via ``POST /v2/gas_sponsorship/prepare``
152
152
  * so the sponsor broadcasts ``execTransaction`` on the product account
153
153
  * (the order's maker). The owner can also broadcast ``execTransaction``
154
154
  * directly if not using gas sponsorship.
@@ -58,5 +58,5 @@ let value: TokenizedAssetsBuildOrderResponse = {
58
58
  | Field | Type | Required | Description |
59
59
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
60
60
  | `quote` | [components.Quote](../../models/components/quote.md) | :heavy_check_mark: | Quote preview returned alongside an order. |
61
- | `approvalSafeTxEip712` | [components.BatchedSafeOperationsResponseOutput](../../models/components/batchedsafeoperationsresponseoutput.md) | :heavy_minus_sign: | EIP-712 `Safe.execTransaction` wrapping `USDC.approve(LOP_v4, max_uint256)`. Populated when the Tokenized Assets Account's allowance to LOP v4 is below `amount`; sign with `wallet.signTypedData(...)` and relay via `POST /v2/safe/sponsor_gas`. `null` when allowance is already sufficient. |
61
+ | `approvalSafeTxEip712` | [components.BatchedSafeOperationsResponseOutput](../../models/components/batchedsafeoperationsresponseoutput.md) | :heavy_minus_sign: | EIP-712 `Safe.execTransaction` wrapping `USDC.approve(LOP_v4, max_uint256)`. Populated when the Tokenized Assets Account's allowance to LOP v4 is below `amount`; sign with `wallet.signTypedData(...)` and relay via `POST /v2/gas_sponsorship/prepare`. `null` when allowance is already sufficient. |
62
62
  | `order` | [components.OrderToSign](../../models/components/ordertosign.md) | :heavy_check_mark: | Fusion order metadata bundled with the SafeMessage EIP-712 to sign.<br/><br/>The owner signs ``safe_message_eip712`` (a `SafeMessage(bytes message)`<br/>payload wrapping ``order_hash`` for ERC-1271). At submit time the SDK<br/>relays the resulting 65-byte ECDSA together with ``order_message``,<br/>``extension``, and ``quote_id`` so 1inch's relayer can broadcast the<br/>order; resolvers fill it via ``Safe.isValidSignature``. |
@@ -506,7 +506,7 @@ The flow is **signing-based, not transaction-based**:
506
506
 
507
507
  1. If `approval_safe_tx_eip712` is populated (Safe→LOP allowance is
508
508
  insufficient), sign it with `wallet.signTypedData(...)` and relay via
509
- `POST /v2/safe/sponsor_gas` so the sponsor broadcasts the resulting
509
+ `POST /v2/gas_sponsorship/prepare` so the sponsor broadcasts the resulting
510
510
  `Safe.execTransaction(USDC.approve(LOP_v4, ...))`. Wait for that tx
511
511
  to confirm before signing the order.
512
512
  2. Sign `order.safe_message_eip712` with the same owner wallet — this is
@@ -701,7 +701,7 @@ Build a SafeTx EIP-712 wrapping the on-chain cancel for a Fusion order.
701
701
  Returns ``cancel_safe_tx_eip712``: an EIP-712 ``Safe.execTransaction``
702
702
  payload whose inner call is ``LOP.cancelOrder(makerTraits, orderHash)``.
703
703
  Sign with the Tokenized Assets Account's owner via
704
- ``wallet.signTypedData(...)`` and relay via ``POST /v2/safe/sponsor_gas``
704
+ ``wallet.signTypedData(...)`` and relay via ``POST /v2/gas_sponsorship/prepare``
705
705
  so the sponsor broadcasts ``execTransaction`` on the product account
706
706
  (the order's maker). The owner can also broadcast ``execTransaction``
707
707
  directly if not using gas sponsorship.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@compass-labs/api-sdk",
3
- "version": "2.2.45-rc.0",
3
+ "version": "2.2.45-rc.1",
4
4
  "author": "royalnine",
5
5
  "type": "module",
6
6
  "tshy": {
@@ -38,7 +38,7 @@ import { Result } from "../types/fp.js";
38
38
  *
39
39
  * 1. If `approval_safe_tx_eip712` is populated (Safe→LOP allowance is
40
40
  * insufficient), sign it with `wallet.signTypedData(...)` and relay via
41
- * `POST /v2/safe/sponsor_gas` so the sponsor broadcasts the resulting
41
+ * `POST /v2/gas_sponsorship/prepare` so the sponsor broadcasts the resulting
42
42
  * `Safe.execTransaction(USDC.approve(LOP_v4, ...))`. Wait for that tx
43
43
  * to confirm before signing the order.
44
44
  * 2. Sign `order.safe_message_eip712` with the same owner wallet — this is
@@ -36,7 +36,7 @@ import { Result } from "../types/fp.js";
36
36
  * Returns ``cancel_safe_tx_eip712``: an EIP-712 ``Safe.execTransaction``
37
37
  * payload whose inner call is ``LOP.cancelOrder(makerTraits, orderHash)``.
38
38
  * Sign with the Tokenized Assets Account's owner via
39
- * ``wallet.signTypedData(...)`` and relay via ``POST /v2/safe/sponsor_gas``
39
+ * ``wallet.signTypedData(...)`` and relay via ``POST /v2/gas_sponsorship/prepare``
40
40
  * so the sponsor broadcasts ``execTransaction`` on the product account
41
41
  * (the order's maker). The owner can also broadcast ``execTransaction``
42
42
  * directly if not using gas sponsorship.
@@ -23,7 +23,7 @@ export type TokenizedAssetsBuildOrderResponse = {
23
23
  */
24
24
  quote: Quote;
25
25
  /**
26
- * EIP-712 `Safe.execTransaction` wrapping `USDC.approve(LOP_v4, max_uint256)`. Populated when the Tokenized Assets Account's allowance to LOP v4 is below `amount`; sign with `wallet.signTypedData(...)` and relay via `POST /v2/safe/sponsor_gas`. `null` when allowance is already sufficient.
26
+ * EIP-712 `Safe.execTransaction` wrapping `USDC.approve(LOP_v4, max_uint256)`. Populated when the Tokenized Assets Account's allowance to LOP v4 is below `amount`; sign with `wallet.signTypedData(...)` and relay via `POST /v2/gas_sponsorship/prepare`. `null` when allowance is already sufficient.
27
27
  */
28
28
  approvalSafeTxEip712?: BatchedSafeOperationsResponseOutput | null | undefined;
29
29
  /**
@@ -157,7 +157,7 @@ export class TokenizedAssets extends ClientSDK {
157
157
  *
158
158
  * 1. If `approval_safe_tx_eip712` is populated (Safe→LOP allowance is
159
159
  * insufficient), sign it with `wallet.signTypedData(...)` and relay via
160
- * `POST /v2/safe/sponsor_gas` so the sponsor broadcasts the resulting
160
+ * `POST /v2/gas_sponsorship/prepare` so the sponsor broadcasts the resulting
161
161
  * `Safe.execTransaction(USDC.approve(LOP_v4, ...))`. Wait for that tx
162
162
  * to confirm before signing the order.
163
163
  * 2. Sign `order.safe_message_eip712` with the same owner wallet — this is
@@ -216,7 +216,7 @@ export class TokenizedAssets extends ClientSDK {
216
216
  * Returns ``cancel_safe_tx_eip712``: an EIP-712 ``Safe.execTransaction``
217
217
  * payload whose inner call is ``LOP.cancelOrder(makerTraits, orderHash)``.
218
218
  * Sign with the Tokenized Assets Account's owner via
219
- * ``wallet.signTypedData(...)`` and relay via ``POST /v2/safe/sponsor_gas``
219
+ * ``wallet.signTypedData(...)`` and relay via ``POST /v2/gas_sponsorship/prepare``
220
220
  * so the sponsor broadcasts ``execTransaction`` on the product account
221
221
  * (the order's maker). The owner can also broadcast ``execTransaction``
222
222
  * directly if not using gas sponsorship.