@compass-labs/api-sdk 2.2.46-rc.0 → 2.2.46

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.
Files changed (149) hide show
  1. package/README.md +8 -8
  2. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.d.ts +12 -8
  3. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.d.ts.map +1 -1
  4. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.js +12 -8
  5. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.js.map +1 -1
  6. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarkets.d.ts +9 -4
  7. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarkets.d.ts.map +1 -1
  8. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarkets.js +9 -4
  9. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarkets.js.map +1 -1
  10. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.d.ts +13 -5
  11. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.d.ts.map +1 -1
  12. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.js +13 -5
  13. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.js.map +1 -1
  14. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrder.d.ts +16 -15
  15. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrder.d.ts.map +1 -1
  16. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrder.js +16 -15
  17. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrder.js.map +1 -1
  18. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.d.ts +8 -4
  19. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.d.ts.map +1 -1
  20. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.js +8 -4
  21. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.js.map +1 -1
  22. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.d.ts +9 -11
  23. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.d.ts.map +1 -1
  24. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.js +9 -11
  25. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.js.map +1 -1
  26. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.d.ts +10 -11
  27. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.d.ts.map +1 -1
  28. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.js +10 -11
  29. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.js.map +1 -1
  30. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsPositions.d.ts +10 -5
  31. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsPositions.d.ts.map +1 -1
  32. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsPositions.js +10 -5
  33. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsPositions.js.map +1 -1
  34. package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.d.ts +4 -4
  35. package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.js +1 -1
  36. package/dist/commonjs/models/components/marketdetail.d.ts +5 -5
  37. package/dist/commonjs/models/components/marketdetail.js +1 -1
  38. package/dist/commonjs/models/components/ohlccandle.d.ts +1 -1
  39. package/dist/commonjs/models/components/orderstatus.d.ts +8 -8
  40. package/dist/commonjs/models/components/orderstatus.js +1 -1
  41. package/dist/commonjs/models/components/ordertosign.d.ts +9 -10
  42. package/dist/commonjs/models/components/ordertosign.d.ts.map +1 -1
  43. package/dist/commonjs/models/components/ordertosign.js.map +1 -1
  44. package/dist/commonjs/models/components/quote.d.ts +2 -2
  45. package/dist/commonjs/models/components/quotefee.d.ts +2 -2
  46. package/dist/commonjs/models/components/tokenizedassetsbuildorderrequest.d.ts +3 -3
  47. package/dist/commonjs/models/components/tokenizedassetsbuildorderresponse.d.ts +7 -8
  48. package/dist/commonjs/models/components/tokenizedassetsbuildorderresponse.d.ts.map +1 -1
  49. package/dist/commonjs/models/components/tokenizedassetsbuildorderresponse.js.map +1 -1
  50. package/dist/commonjs/models/components/tokenizedassetscancelorderrequest.d.ts +1 -1
  51. package/dist/commonjs/models/components/tokenizedassetssubmitorderrequest.d.ts +8 -10
  52. package/dist/commonjs/models/components/tokenizedassetssubmitorderrequest.d.ts.map +1 -1
  53. package/dist/commonjs/models/components/tokenizedassetssubmitorderrequest.js.map +1 -1
  54. package/dist/commonjs/sdk/tokenizedassets.d.ts +94 -70
  55. package/dist/commonjs/sdk/tokenizedassets.d.ts.map +1 -1
  56. package/dist/commonjs/sdk/tokenizedassets.js +94 -70
  57. package/dist/commonjs/sdk/tokenizedassets.js.map +1 -1
  58. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.d.ts +12 -8
  59. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.d.ts.map +1 -1
  60. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.js +12 -8
  61. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.js.map +1 -1
  62. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarkets.d.ts +9 -4
  63. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarkets.d.ts.map +1 -1
  64. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarkets.js +9 -4
  65. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarkets.js.map +1 -1
  66. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.d.ts +13 -5
  67. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.d.ts.map +1 -1
  68. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.js +13 -5
  69. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.js.map +1 -1
  70. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrder.d.ts +16 -15
  71. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrder.d.ts.map +1 -1
  72. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrder.js +16 -15
  73. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrder.js.map +1 -1
  74. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.d.ts +8 -4
  75. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.d.ts.map +1 -1
  76. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.js +8 -4
  77. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.js.map +1 -1
  78. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.d.ts +9 -11
  79. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.d.ts.map +1 -1
  80. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.js +9 -11
  81. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.js.map +1 -1
  82. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.d.ts +10 -11
  83. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.d.ts.map +1 -1
  84. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.js +10 -11
  85. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.js.map +1 -1
  86. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsPositions.d.ts +10 -5
  87. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsPositions.d.ts.map +1 -1
  88. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsPositions.js +10 -5
  89. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsPositions.js.map +1 -1
  90. package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.d.ts +4 -4
  91. package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.js +1 -1
  92. package/dist/esm/models/components/marketdetail.d.ts +5 -5
  93. package/dist/esm/models/components/marketdetail.js +1 -1
  94. package/dist/esm/models/components/ohlccandle.d.ts +1 -1
  95. package/dist/esm/models/components/orderstatus.d.ts +8 -8
  96. package/dist/esm/models/components/orderstatus.js +1 -1
  97. package/dist/esm/models/components/ordertosign.d.ts +9 -10
  98. package/dist/esm/models/components/ordertosign.d.ts.map +1 -1
  99. package/dist/esm/models/components/ordertosign.js.map +1 -1
  100. package/dist/esm/models/components/quote.d.ts +2 -2
  101. package/dist/esm/models/components/quotefee.d.ts +2 -2
  102. package/dist/esm/models/components/tokenizedassetsbuildorderrequest.d.ts +3 -3
  103. package/dist/esm/models/components/tokenizedassetsbuildorderresponse.d.ts +7 -8
  104. package/dist/esm/models/components/tokenizedassetsbuildorderresponse.d.ts.map +1 -1
  105. package/dist/esm/models/components/tokenizedassetsbuildorderresponse.js.map +1 -1
  106. package/dist/esm/models/components/tokenizedassetscancelorderrequest.d.ts +1 -1
  107. package/dist/esm/models/components/tokenizedassetssubmitorderrequest.d.ts +8 -10
  108. package/dist/esm/models/components/tokenizedassetssubmitorderrequest.d.ts.map +1 -1
  109. package/dist/esm/models/components/tokenizedassetssubmitorderrequest.js.map +1 -1
  110. package/dist/esm/sdk/tokenizedassets.d.ts +94 -70
  111. package/dist/esm/sdk/tokenizedassets.d.ts.map +1 -1
  112. package/dist/esm/sdk/tokenizedassets.js +94 -70
  113. package/dist/esm/sdk/tokenizedassets.js.map +1 -1
  114. package/docs/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.md +2 -2
  115. package/docs/models/components/compassapibackendv2modelstokenizedassetsmarketmarketchain.md +1 -1
  116. package/docs/models/components/marketdetail.md +3 -3
  117. package/docs/models/components/marketdetailchain.md +1 -1
  118. package/docs/models/components/ohlccandle.md +1 -1
  119. package/docs/models/components/orderstatus.md +9 -9
  120. package/docs/models/components/ordertosign.md +12 -13
  121. package/docs/models/components/quote.md +6 -6
  122. package/docs/models/components/quotefee.md +2 -2
  123. package/docs/models/components/status.md +1 -1
  124. package/docs/models/components/tokenizedassetsbuildorderrequest.md +8 -8
  125. package/docs/models/components/tokenizedassetsbuildorderresponse.md +6 -6
  126. package/docs/models/components/tokenizedassetscancelorderrequest.md +3 -3
  127. package/docs/models/components/tokenizedassetssubmitorderrequest.md +11 -13
  128. package/docs/sdks/tokenizedassets/README.md +87 -63
  129. package/package.json +1 -1
  130. package/src/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.ts +12 -8
  131. package/src/funcs/tokenizedAssetsTokenizedAssetsMarkets.ts +9 -4
  132. package/src/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.ts +13 -5
  133. package/src/funcs/tokenizedAssetsTokenizedAssetsOrder.ts +16 -15
  134. package/src/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.ts +8 -4
  135. package/src/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.ts +9 -11
  136. package/src/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.ts +10 -11
  137. package/src/funcs/tokenizedAssetsTokenizedAssetsPositions.ts +10 -5
  138. package/src/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.ts +4 -4
  139. package/src/models/components/marketdetail.ts +5 -5
  140. package/src/models/components/ohlccandle.ts +1 -1
  141. package/src/models/components/orderstatus.ts +8 -8
  142. package/src/models/components/ordertosign.ts +9 -10
  143. package/src/models/components/quote.ts +2 -2
  144. package/src/models/components/quotefee.ts +2 -2
  145. package/src/models/components/tokenizedassetsbuildorderrequest.ts +3 -3
  146. package/src/models/components/tokenizedassetsbuildorderresponse.ts +7 -8
  147. package/src/models/components/tokenizedassetscancelorderrequest.ts +1 -1
  148. package/src/models/components/tokenizedassetssubmitorderrequest.ts +8 -10
  149. package/src/sdk/tokenizedassets.ts +94 -70
package/docs/models/components/orderstatus.md CHANGED
@@ -16,12 +16,12 @@ let value: OrderStatus = {
16
16
 
17
17
  ## Fields
18
18
 
19
- | Field | Type | Required | Description |
20
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
21
- | `orderHash` | *string* | :heavy_check_mark: | On-chain order hash. |
22
- | `status` | [components.Status](../../models/components/status.md) | :heavy_check_mark: | Coarse-grained order state. Compass collapses Fusion's finer-grained states (`refunded`, `false-predicate`, etc.) into this 4-value enum. |
23
- | `fillTxHash` | *string* | :heavy_minus_sign: | Tx hash of the most recent resolver fill (populated when filled or partially filled). |
24
- | `fillPriceUsd` | *string* | :heavy_minus_sign: | Implied USD execution rate per unit of the taker token, derived from filled amounts and the maker-side USD price. For USDC→equity buys this is the USD paid per equity unit. Omitted if maker/taker decimals are unknown. |
25
- | `filledAmount` | *string* | :heavy_minus_sign: | Sum of base-unit amounts filled so far. Populated for partial fills while `status` is still `pending`, and for fully filled orders. |
26
- | `submittedAt` | *string* | :heavy_minus_sign: | ISO 8601 UTC timestamp of order submission. |
27
- | `updatedAt` | *string* | :heavy_check_mark: | ISO 8601 UTC timestamp of this status read. |
19
+ | Field | Type | Required | Description |
20
+ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
21
+ | `orderHash` | *string* | :heavy_check_mark: | On-chain order hash. |
22
+ | `status` | [components.Status](../../models/components/status.md) | :heavy_check_mark: | Order lifecycle state. One of `pending`, `filled`, `expired`, or `cancelled`. Upstream protocol states beyond these four (e.g. `partially-filled`, `refunded`) are mapped onto this set. |
23
+ | `fillTxHash` | *string* | :heavy_minus_sign: | Transaction hash of the most recent fill. Populated for fully filled orders and for partial fills while `status` is still `pending`. |
24
+ | `fillPriceUsd` | *string* | :heavy_minus_sign: | Implied USD execution rate per unit of the received token, derived from filled amounts and the input token's USD price. For USDC → equity buys, this is the USD paid per equity unit. Omitted when token decimals or pricing are not available. |
25
+ | `filledAmount` | *string* | :heavy_minus_sign: | Total amount filled so far, expressed as a raw integer in the input token's decimals. Populated for partial fills while `status` is still `pending`, and for fully filled orders. |
26
+ | `submittedAt` | *string* | :heavy_minus_sign: | ISO 8601 UTC timestamp at which the order was submitted. |
27
+ | `updatedAt` | *string* | :heavy_check_mark: | ISO 8601 UTC timestamp at which this status was read. |
package/docs/models/components/ordertosign.md CHANGED
@@ -1,12 +1,11 @@
1
1
  # OrderToSign
2
2
 
3
- Fusion order metadata bundled with the SafeMessage EIP-712 to sign.
3
+ Order metadata plus the EIP-712 payload the owner signs to authorize it.
4
4
 
5
- The owner signs ``safe_message_eip712`` (a `SafeMessage(bytes message)`
6
- payload wrapping ``order_hash`` for ERC-1271). At submit time the SDK
7
- relays the resulting 65-byte ECDSA together with ``order_message``,
8
- ``extension``, and ``quote_id`` so 1inch's relayer can broadcast the
9
- order; resolvers fill it via ``Safe.isValidSignature``.
5
+ The owner signs ``safe_message_eip712`` off-chain. At submit time the
6
+ signature is sent back to ``/order/submit`` together with
7
+ ``order_message``, ``extension``, and ``quote_id``; resolvers validate
8
+ the signature against the Tokenized Assets Account at fill time.
10
9
 
11
10
  ## Example Usage
12
11
 
@@ -46,10 +45,10 @@ let value: OrderToSign = {
46
45
 
47
46
  ## Fields
48
47
 
49
- | Field | Type | Required | Description |
50
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
51
- | `orderHash` | *string* | :heavy_check_mark: | The 1inch LOP order hash. Wrapped inside `safe_message_eip712.message.message` for ERC-1271 signing; also relayed to `/order/submit` so the API can fall back to it if the upstream submit response omits the hash. |
52
- | `extension` | *string* | :heavy_check_mark: | Opaque hex blob from 1inch — pass back to `/order/submit` unchanged. |
53
- | `quoteId` | *string* | :heavy_check_mark: | 1inch quote identifier — must be echoed back at `/order/submit`. |
54
- | `orderMessage` | Record<string, *any*> | :heavy_check_mark: | Fusion order struct (maker, makerAsset, makingAmount, etc.) — pass back to `/order/submit` unchanged. Maker is the Tokenized Assets Account, not the EOA owner. |
55
- | `safeMessageEip712` | [components.SafeMessageEip712Response](../../models/components/safemessageeip712response.md) | :heavy_check_mark: | ``signTypedData`` payload for ``SafeMessage(bytes message)``. |
48
+ | Field | Type | Required | Description |
49
+ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
50
+ | `orderHash` | *string* | :heavy_check_mark: | The on-chain order hash. Wrapped inside `safe_message_eip712.message.message` for the owner to sign; also passed back to `/order/submit` so the API can return a usable handle even if the upstream submit response omits the hash. |
51
+ | `extension` | *string* | :heavy_check_mark: | Opaque hex blob from the upstream quote — pass back to `/order/submit` unchanged. |
52
+ | `quoteId` | *string* | :heavy_check_mark: | Upstream quote identifier — must be echoed back at `/order/submit`. |
53
+ | `orderMessage` | Record<string, *any*> | :heavy_check_mark: | Order struct (maker, makerAsset, makingAmount, etc.) — pass back to `/order/submit` unchanged. The maker is the Tokenized Assets Account, not the owner's wallet. |
54
+ | `safeMessageEip712` | [components.SafeMessageEip712Response](../../models/components/safemessageeip712response.md) | :heavy_check_mark: | ``signTypedData`` payload for ``SafeMessage(bytes message)``. |
package/docs/models/components/quote.md CHANGED
@@ -25,9 +25,9 @@ let value: Quote = {
25
25
 
26
26
  ## Fields
27
27
 
28
- | Field | Type | Required | Description |
29
- | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
30
- | `input` | [components.TokenAmount](../../models/components/tokenamount.md) | :heavy_check_mark: | A token + amount pair for one leg of the quote. |
31
- | `output` | [components.TokenAmount](../../models/components/tokenamount.md) | :heavy_check_mark: | A token + amount pair for one leg of the quote. |
32
- | `fee` | [components.QuoteFee](../../models/components/quotefee.md) | :heavy_check_mark: | Aggregate fee charged by the Fusion auction (resolver + protocol). |
33
- | `estFillSeconds` | *number* | :heavy_check_mark: | Auction duration upper-bound in seconds. |
28
+ | Field | Type | Required | Description |
29
+ | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
30
+ | `input` | [components.TokenAmount](../../models/components/tokenamount.md) | :heavy_check_mark: | A token + amount pair for one leg of the quote. |
31
+ | `output` | [components.TokenAmount](../../models/components/tokenamount.md) | :heavy_check_mark: | A token + amount pair for one leg of the quote. |
32
+ | `fee` | [components.QuoteFee](../../models/components/quotefee.md) | :heavy_check_mark: | Aggregate fee charged for the order. |
33
+ | `estFillSeconds` | *number* | :heavy_check_mark: | Estimated upper bound on time-to-fill, in seconds. |
package/docs/models/components/quotefee.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # QuoteFee
2
2
 
3
- Aggregate fee charged by the Fusion auction (resolver + protocol).
3
+ Aggregate fee charged for the order.
4
4
 
5
5
  ## Example Usage
6
6
 
@@ -14,5 +14,5 @@ let value: QuoteFee = {};
14
14
 
15
15
  | Field | Type | Required | Description |
16
16
  | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
17
- | `amountUsd` | *string* | :heavy_minus_sign: | Total fee in USD, decimal string. |
17
+ | `amountUsd` | *string* | :heavy_minus_sign: | Total fee in USD as a decimal string. |
18
18
  | `bps` | *number* | :heavy_minus_sign: | Fee as basis points of the input amount. |
package/docs/models/components/status.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Status
2
2
 
3
- Coarse-grained order state. Compass collapses Fusion's finer-grained states (`refunded`, `false-predicate`, etc.) into this 4-value enum.
3
+ Order lifecycle state. One of `pending`, `filled`, `expired`, or `cancelled`. Upstream protocol states beyond these four (e.g. `partially-filled`, `refunded`) are mapped onto this set.
4
4
 
5
5
  ## Example Usage
6
6
 
package/docs/models/components/tokenizedassetsbuildorderrequest.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # TokenizedAssetsBuildOrderRequest
2
2
 
3
- Build a buy/sell order against the 1inch Fusion intent flow.
3
+ Build a buy or sell order for a tokenized equity.
4
4
 
5
5
  ## Example Usage
6
6
 
@@ -18,10 +18,10 @@ let value: TokenizedAssetsBuildOrderRequest = {
18
18
 
19
19
  ## Fields
20
20
 
21
- | Field | Type | Required | Description | Example |
22
- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
23
- | `fromToken` | *string* | :heavy_check_mark: | Token the sender is paying. Either an on-chain Ondo symbol (e.g. `TSLAon`), the literal `USDC`, or a 0x-prefixed Ethereum address. | |
24
- | `toToken` | *string* | :heavy_check_mark: | Token the sender is receiving. Same accepted forms as `from_token`. | |
25
- | `amount` | *string* | :heavy_check_mark: | Human-readable amount of `from_token` to swap (decimal string). Decimals are applied server-side. | |
26
- | `owner` | *string* | :heavy_check_mark: | EOA that owns the Tokenized Assets Account. Determines the product account address and signs the EIP-712 envelopes returned by this endpoint (the approve SafeTx and the SafeMessage wrapping the order hash). | |
27
- | `slippageBps` | *number* | :heavy_minus_sign: | Max acceptable slippage in basis points (1 bp = 0.01%). | 50 |
21
+ | Field | Type | Required | Description | Example |
22
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
23
+ | `fromToken` | *string* | :heavy_check_mark: | Token the sender is paying. Either an on-chain Ondo symbol (e.g. `TSLAon`), the literal `USDC`, or a 0x-prefixed Ethereum address. | |
24
+ | `toToken` | *string* | :heavy_check_mark: | Token the sender is receiving. Same accepted forms as `from_token`. | |
25
+ | `amount` | *string* | :heavy_check_mark: | Human-readable amount of `from_token` to swap (decimal string). Decimals are applied server-side. | |
26
+ | `owner` | *string* | :heavy_check_mark: | Wallet that owns the Tokenized Assets Account. The product account address is derived deterministically from this owner. The owner signs the EIP-712 payloads returned by this endpoint (the optional approval and the order itself). | |
27
+ | `slippageBps` | *number* | :heavy_minus_sign: | Max acceptable slippage in basis points (1 bp = 0.01%). Range 1-1000 (0.01%-10%); defaults to 50 (0.5%). | 50 |
package/docs/models/components/tokenizedassetsbuildorderresponse.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # TokenizedAssetsBuildOrderResponse
2
2
 
3
- Composed response: quote + optional approval SafeTx + EIP-712 order to sign.
3
+ Quote, optional approval payload, and the EIP-712 order to sign.
4
4
 
5
5
  ## Example Usage
6
6
 
@@ -55,8 +55,8 @@ let value: TokenizedAssetsBuildOrderResponse = {
55
55
 
56
56
  ## Fields
57
57
 
58
- | Field | Type | Required | Description |
59
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
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/gas_sponsorship/prepare`. `null` when allowance is already sufficient. |
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``. |
58
+ | Field | Type | Required | Description |
59
+ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
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 payload that authorizes a one-time max-approve of `from_token` to the settlement contract. Populated when the Tokenized Assets Account's existing allowance is below `amount`. The owner signs it, then it is broadcast via `POST /v2/gas_sponsorship/prepare` (or directly by the owner) to set the allowance on-chain. `null` when the allowance is already sufficient. |
62
+ | `order` | [components.OrderToSign](../../models/components/ordertosign.md) | :heavy_check_mark: | Order metadata plus the EIP-712 payload the owner signs to authorize it.<br/><br/>The owner signs ``safe_message_eip712`` off-chain. At submit time the<br/>signature is sent back to ``/order/submit`` together with<br/>``order_message``, ``extension``, and ``quote_id``; resolvers validate<br/>the signature against the Tokenized Assets Account at fill time. |
package/docs/models/components/tokenizedassetscancelorderrequest.md CHANGED
@@ -12,6 +12,6 @@ let value: TokenizedAssetsCancelOrderRequest = {
12
12
 
13
13
  ## Fields
14
14
 
15
- | Field | Type | Required | Description |
16
- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
17
- | `owner` | *string* | :heavy_check_mark: | EOA that owns the Tokenized Assets Account. The product account predicted from this owner must match the order's on-chain maker; the API rejects otherwise (only the order's maker can cancel it). |
15
+ | Field | Type | Required | Description |
16
+ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
17
+ | `owner` | *string* | :heavy_check_mark: | Wallet that owns the Tokenized Assets Account. The account address derived from this owner must match the order's on-chain maker; the API rejects otherwise (only the order's maker can cancel it). |
package/docs/models/components/tokenizedassetssubmitorderrequest.md CHANGED
@@ -1,12 +1,10 @@
1
1
  # TokenizedAssetsSubmitOrderRequest
2
2
 
3
- Relay an owner-signed Fusion order to the 1inch relayer.
3
+ Submit an owner-signed order to the resolver network.
4
4
 
5
- The shape mirrors what `POST /order` returned plus the wallet's
6
- EIP-712 signature — all fields are required by the upstream relayer.
7
- Maker is the Tokenized Assets Account (the Safe), so the signature is
8
- validated via ERC-1271 (`Safe.isValidSignature`) at fill time rather
9
- than as an EOA personal-sign.
5
+ The shape echoes what `POST /order` returned plus the owner's
6
+ EIP-712 signature. The maker is the Tokenized Assets Account, so the
7
+ signature is validated against the product account at fill time.
10
8
 
11
9
  ## Example Usage
12
10
 
@@ -27,10 +25,10 @@ let value: TokenizedAssetsSubmitOrderRequest = {
27
25
 
28
26
  ## Fields
29
27
 
30
- | Field | Type | Required | Description |
31
- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
32
- | `signedOrder` | Record<string, *any*> | :heavy_check_mark: | The Fusion order struct returned by `/order` (`order.order_message`). `maker` is the Tokenized Assets Account, not the EOA owner — relay this dict back to the API verbatim. |
33
- | `signature` | *string* | :heavy_check_mark: | EIP-712 signature produced by `wallet.signTypedData(order.safe_message_eip712)` from the `/order` response. The Tokenized Assets Account validates this via ERC-1271 (`Safe.isValidSignature`) at fill time, so the signature must be the owner's signature over the SafeMessage hash, not the raw Fusion order hash. For a single-owner Safe this is the standard 65-byte ECDSA `(r, s, v)` blob; multi-owner Safes and pre-approved-hash flows produce variable-length signatures and are also accepted — the relayer enforces its own checks downstream. |
34
- | `extension` | *string* | :heavy_check_mark: | Opaque hex blob from the `/order` response — pass back unchanged. |
35
- | `quoteId` | *string* | :heavy_check_mark: | `order.quote_id` from the `/order` response. |
36
- | `orderHash` | *string* | :heavy_minus_sign: | EIP-712 order hash from `order.order_hash` in the `/order` response. Optional but recommended: 1inch's relayer occasionally accepts a submit with a 2xx empty body; passing the hash through lets the API still return a usable handle for status / cancel lookups instead of failing. |
28
+ | Field | Type | Required | Description |
29
+ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
30
+ | `signedOrder` | Record<string, *any*> | :heavy_check_mark: | The order struct returned by `/order` (`order.order_message`). `maker` is the Tokenized Assets Account, not the owner's wallet — pass this dict back to the API verbatim. |
31
+ | `signature` | *string* | :heavy_check_mark: | Owner's EIP-712 signature over `order.safe_message_eip712` from the `/order` response. The signature is validated against the Tokenized Assets Account at fill time, so it must be a signature over the typed-data hash, not the raw order hash. |
32
+ | `extension` | *string* | :heavy_check_mark: | Opaque hex blob from the `/order` response — pass back unchanged. |
33
+ | `quoteId` | *string* | :heavy_check_mark: | `order.quote_id` from the `/order` response — pass back unchanged. |
34
+ | `orderHash` | *string* | :heavy_minus_sign: | `order.order_hash` from the `/order` response. Optional but recommended: the upstream relayer occasionally returns a 2xx with an empty body, and supplying the hash lets the API still return a usable handle for status and cancel lookups instead of failing. |