@compass-labs/api-sdk 2.1.26-rc.9 → 2.1.27-rc.0

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 (195) hide show
  1. package/codeSamples_typescript.yaml +6 -6
  2. package/dist/commonjs/funcs/earnEarnManage.d.ts +4 -1
  3. package/dist/commonjs/funcs/earnEarnManage.d.ts.map +1 -1
  4. package/dist/commonjs/funcs/earnEarnManage.js +4 -1
  5. package/dist/commonjs/funcs/earnEarnManage.js.map +1 -1
  6. package/dist/commonjs/funcs/earnEarnPositions.js +1 -1
  7. package/dist/commonjs/funcs/earnEarnPositions.js.map +1 -1
  8. package/dist/commonjs/models/components/fee.d.ts +6 -5
  9. package/dist/commonjs/models/components/fee.d.ts.map +1 -1
  10. package/dist/commonjs/models/components/fee.js +2 -1
  11. package/dist/commonjs/models/components/fee.js.map +1 -1
  12. package/dist/commonjs/models/operations/v2earnpositions.d.ts +3 -3
  13. package/dist/commonjs/models/operations/v2earnpositions.d.ts.map +1 -1
  14. package/dist/commonjs/models/operations/v2earnpositions.js +1 -6
  15. package/dist/commonjs/models/operations/v2earnpositions.js.map +1 -1
  16. package/dist/commonjs/sdk/earn.d.ts +4 -1
  17. package/dist/commonjs/sdk/earn.d.ts.map +1 -1
  18. package/dist/commonjs/sdk/earn.js +4 -1
  19. package/dist/commonjs/sdk/earn.js.map +1 -1
  20. package/dist/esm/funcs/earnEarnManage.d.ts +4 -1
  21. package/dist/esm/funcs/earnEarnManage.d.ts.map +1 -1
  22. package/dist/esm/funcs/earnEarnManage.js +4 -1
  23. package/dist/esm/funcs/earnEarnManage.js.map +1 -1
  24. package/dist/esm/funcs/earnEarnPositions.js +1 -1
  25. package/dist/esm/funcs/earnEarnPositions.js.map +1 -1
  26. package/dist/esm/models/components/fee.d.ts +6 -5
  27. package/dist/esm/models/components/fee.d.ts.map +1 -1
  28. package/dist/esm/models/components/fee.js +2 -1
  29. package/dist/esm/models/components/fee.js.map +1 -1
  30. package/dist/esm/models/operations/v2earnpositions.d.ts +3 -3
  31. package/dist/esm/models/operations/v2earnpositions.d.ts.map +1 -1
  32. package/dist/esm/models/operations/v2earnpositions.js +1 -6
  33. package/dist/esm/models/operations/v2earnpositions.js.map +1 -1
  34. package/dist/esm/sdk/earn.d.ts +4 -1
  35. package/dist/esm/sdk/earn.d.ts.map +1 -1
  36. package/dist/esm/sdk/earn.js +4 -1
  37. package/dist/esm/sdk/earn.js.map +1 -1
  38. package/docs/models/components/aavelooprequest.md +15 -15
  39. package/docs/models/components/aaverepayrequest.md +5 -5
  40. package/docs/models/components/aaverepayrequestamount.md +2 -2
  41. package/docs/models/components/aaverepayrequestchain.md +1 -1
  42. package/docs/models/components/aavesetuseremoderequest.md +3 -3
  43. package/docs/models/components/aavesetuseremoderequestchain.md +1 -1
  44. package/docs/models/components/aavesupplyrequest.md +4 -4
  45. package/docs/models/components/aavesupplyrequestamount.md +2 -2
  46. package/docs/models/components/aavesupplyrequestchain.md +1 -1
  47. package/docs/models/components/aavewithdrawrequest.md +5 -5
  48. package/docs/models/components/aavewithdrawrequestamount.md +2 -2
  49. package/docs/models/components/aavewithdrawrequestchain.md +1 -1
  50. package/docs/models/components/aerodromeslipstreambuyexactlyrequest.md +7 -7
  51. package/docs/models/components/aerodromeslipstreambuyexactlyrequestamountinmaximum.md +2 -2
  52. package/docs/models/components/aerodromeslipstreambuyexactlyrequestamountout.md +2 -2
  53. package/docs/models/components/aerodromeslipstreamincreaseliquidityprovisionrequest.md +7 -7
  54. package/docs/models/components/aerodromeslipstreamincreaseliquidityprovisionrequestamount0desired.md +2 -2
  55. package/docs/models/components/aerodromeslipstreamincreaseliquidityprovisionrequestamount0min.md +2 -2
  56. package/docs/models/components/aerodromeslipstreamincreaseliquidityprovisionrequestamount1desired.md +2 -2
  57. package/docs/models/components/aerodromeslipstreamincreaseliquidityprovisionrequestamount1min.md +2 -2
  58. package/docs/models/components/aerodromeslipstreammintliquidityprovisionrequest.md +12 -12
  59. package/docs/models/components/aerodromeslipstreammintliquidityprovisionrequestamount0desired.md +2 -2
  60. package/docs/models/components/aerodromeslipstreammintliquidityprovisionrequestamount0min.md +2 -2
  61. package/docs/models/components/aerodromeslipstreammintliquidityprovisionrequestamount1desired.md +2 -2
  62. package/docs/models/components/aerodromeslipstreammintliquidityprovisionrequestamount1min.md +2 -2
  63. package/docs/models/components/aerodromeslipstreamsellexactlyrequest.md +6 -6
  64. package/docs/models/components/aerodromeslipstreamsellexactlyrequestamountin.md +2 -2
  65. package/docs/models/components/aerodromeslipstreamwithdrawliquidityprovisionrequest.md +4 -4
  66. package/docs/models/components/aerodromeslipstreamwithdrawliquidityprovisionrequestpercentageforwithdrawal.md +2 -2
  67. package/docs/models/components/approvetransferrequest.md +2 -2
  68. package/docs/models/components/approvetransferresponse.md +7 -2
  69. package/docs/models/components/batchedsafeoperationsresponseinput.md +22 -9
  70. package/docs/models/components/batchedsafeoperationsresponseoutput.md +2 -7
  71. package/docs/models/components/batcheduseroperationsrequest.md +2 -2
  72. package/docs/models/components/createaccountrequest.md +5 -5
  73. package/docs/models/components/createaccountrequestchain.md +1 -1
  74. package/docs/models/components/denomination.md +2 -2
  75. package/docs/models/components/depositforburnrequest.md +4 -4
  76. package/docs/models/components/depositforburnrequestamount.md +2 -2
  77. package/docs/models/components/depositforburnresponse.md +2 -7
  78. package/docs/models/components/destinationchain.md +1 -1
  79. package/docs/models/components/earnmanageparams.md +2 -2
  80. package/docs/models/components/earnmanageparamsvenue.md +1 -1
  81. package/docs/models/components/earnmanagerequest.md +4 -4
  82. package/docs/models/components/earnmanagerequestvenue.md +1 -1
  83. package/docs/models/components/earnswaprequest.md +5 -5
  84. package/docs/models/components/earnswaprequestamountin.md +2 -2
  85. package/docs/models/components/earnswapresponse.md +2 -7
  86. package/docs/models/components/earntransferrequest.md +5 -5
  87. package/docs/models/components/earntransferrequestaction.md +1 -1
  88. package/docs/models/components/earntransferrequestamount.md +2 -2
  89. package/docs/models/components/earntransferresponse.md +2 -7
  90. package/docs/models/components/earntransferresponseeip712.md +6 -11
  91. package/docs/models/components/ethenadepositrequest.md +3 -3
  92. package/docs/models/components/ethenadepositrequestamount.md +2 -2
  93. package/docs/models/components/ethenarequesttowithdrawrequest.md +2 -2
  94. package/docs/models/components/ethenaunstakerequest.md +2 -2
  95. package/docs/models/components/fee.md +5 -5
  96. package/docs/models/components/feeamount.md +1 -1
  97. package/docs/models/components/initialcollateralamount.md +2 -2
  98. package/docs/models/components/loantovalue.md +2 -2
  99. package/docs/models/components/maxslippagepercent.md +2 -2
  100. package/docs/models/components/mintpreparerequest.md +5 -5
  101. package/docs/models/components/morphoborrowrequest.md +4 -4
  102. package/docs/models/components/morphoborrowrequestamount.md +2 -2
  103. package/docs/models/components/morphoborrowrequestchain.md +1 -1
  104. package/docs/models/components/morphodepositrequest.md +4 -4
  105. package/docs/models/components/morphodepositrequestamount.md +2 -2
  106. package/docs/models/components/morphodepositrequestchain.md +1 -1
  107. package/docs/models/components/morphorepayrequest.md +3 -3
  108. package/docs/models/components/morphosupplycollateralrequest.md +4 -4
  109. package/docs/models/components/morphosupplycollateralrequestamount.md +2 -2
  110. package/docs/models/components/morphosupplycollateralrequestchain.md +1 -1
  111. package/docs/models/components/morphowithdrawcollateralrequest.md +4 -4
  112. package/docs/models/components/morphowithdrawcollateralrequestamount.md +2 -2
  113. package/docs/models/components/morphowithdrawrequest.md +3 -3
  114. package/docs/models/components/morphowithdrawrequestchain.md +1 -1
  115. package/docs/models/components/multicallauthorizationrequest.md +4 -4
  116. package/docs/models/components/multicallauthorizationrequestchain.md +1 -1
  117. package/docs/models/components/multicallexecuterequest.md +7 -7
  118. package/docs/models/components/multiplier.md +2 -2
  119. package/docs/models/components/odosswaprequest.md +6 -6
  120. package/docs/models/components/odosswaprequestamountin.md +2 -2
  121. package/docs/models/components/pendlemanageliquidityrequest.md +7 -7
  122. package/docs/models/components/pendlemanageliquidityrequestamountin.md +2 -2
  123. package/docs/models/components/pendlemanageliquidityrequestchain.md +1 -1
  124. package/docs/models/components/pendleredeemyieldrequest.md +3 -3
  125. package/docs/models/components/pendletradeptrequest.md +7 -7
  126. package/docs/models/components/pendletradeptrequestaction.md +1 -1
  127. package/docs/models/components/pendletradeptrequestamountin.md +2 -2
  128. package/docs/models/components/pendletradeytrequest.md +7 -7
  129. package/docs/models/components/pendletradeytrequestaction.md +1 -1
  130. package/docs/models/components/pendletradeytrequestamountin.md +2 -2
  131. package/docs/models/components/permit2typeddatainput.md +10 -34
  132. package/docs/models/components/permit2typeddataoutput.md +4 -4
  133. package/docs/models/components/permittransferfrommessage.md +1 -1
  134. package/docs/models/components/permittypeddataresponseinput.md +50 -11
  135. package/docs/models/components/permittypeddataresponseoutput.md +7 -2
  136. package/docs/models/components/setallowancerequest.md +5 -5
  137. package/docs/models/components/setallowancerequestamount.md +2 -2
  138. package/docs/models/components/setallowancerequestcontractenum.md +1 -1
  139. package/docs/models/components/setallowancerequestcontractunion.md +1 -1
  140. package/docs/models/components/signedauthorization.md +6 -6
  141. package/docs/models/components/skybuyrequest.md +4 -4
  142. package/docs/models/components/skybuyrequestamount.md +2 -2
  143. package/docs/models/components/skydepositrequest.md +2 -2
  144. package/docs/models/components/skydepositrequestamount.md +2 -2
  145. package/docs/models/components/skysellrequest.md +4 -4
  146. package/docs/models/components/skysellrequestamount.md +2 -2
  147. package/docs/models/components/skysellrequesttokenout.md +1 -1
  148. package/docs/models/components/skywithdrawrequest.md +1 -1
  149. package/docs/models/components/sponsorgasrequest.md +7 -7
  150. package/docs/models/components/sponsorgasrequesteip712.md +76 -48
  151. package/docs/models/components/tokentransferrequest.md +5 -5
  152. package/docs/models/components/tokentransferrequestamount.md +2 -2
  153. package/docs/models/components/tokentransferrequestchain.md +1 -1
  154. package/docs/models/components/uniswapbuyexactlyrequest.md +6 -6
  155. package/docs/models/components/uniswapbuyexactlyrequestamountout.md +2 -2
  156. package/docs/models/components/uniswapbuyexactlyrequestchain.md +1 -1
  157. package/docs/models/components/uniswapincreaseliquidityprovisionrequest.md +7 -7
  158. package/docs/models/components/uniswapincreaseliquidityprovisionrequestamount0desired.md +2 -2
  159. package/docs/models/components/uniswapincreaseliquidityprovisionrequestamount0min.md +2 -2
  160. package/docs/models/components/uniswapincreaseliquidityprovisionrequestamount1desired.md +2 -2
  161. package/docs/models/components/uniswapincreaseliquidityprovisionrequestamount1min.md +2 -2
  162. package/docs/models/components/uniswapincreaseliquidityprovisionrequestchain.md +1 -1
  163. package/docs/models/components/uniswapmintliquidityprovisionrequest.md +11 -11
  164. package/docs/models/components/uniswapmintliquidityprovisionrequestamount0desired.md +2 -2
  165. package/docs/models/components/uniswapmintliquidityprovisionrequestamount0min.md +2 -2
  166. package/docs/models/components/uniswapmintliquidityprovisionrequestamount1desired.md +2 -2
  167. package/docs/models/components/uniswapmintliquidityprovisionrequestamount1min.md +2 -2
  168. package/docs/models/components/uniswapsellexactlyrequest.md +6 -6
  169. package/docs/models/components/uniswapsellexactlyrequestamountin.md +2 -2
  170. package/docs/models/components/uniswapsellexactlyrequestchain.md +1 -1
  171. package/docs/models/components/uniswapwithdrawliquidityprovisionrequest.md +4 -4
  172. package/docs/models/components/uniswapwithdrawliquidityprovisionrequestchain.md +1 -1
  173. package/docs/models/components/uniswapwithdrawliquidityprovisionrequestpercentageforwithdrawal.md +2 -2
  174. package/docs/models/components/unwrapwethrequest.md +3 -3
  175. package/docs/models/components/unwrapwethrequestamount.md +2 -2
  176. package/docs/models/components/unwrapwethrequestchain.md +1 -1
  177. package/docs/models/components/v2bundlerequest.md +7 -7
  178. package/docs/models/components/v2useroperation.md +2 -2
  179. package/docs/models/components/v2useroperationbody.md +2 -2
  180. package/docs/models/components/vaultdepositrequest.md +4 -4
  181. package/docs/models/components/vaultdepositrequestamount.md +2 -2
  182. package/docs/models/components/vaultvenue.md +1 -1
  183. package/docs/models/components/vaultwithdrawrequest.md +3 -3
  184. package/docs/models/components/vaultwithdrawrequestchain.md +1 -1
  185. package/docs/models/components/wrapethrequest.md +3 -3
  186. package/docs/models/components/wrapethrequestamount.md +2 -2
  187. package/docs/models/components/wrapethrequestchain.md +1 -1
  188. package/docs/models/operations/v2earnpositionsrequest.md +2 -2
  189. package/docs/sdks/earn/README.md +18 -15
  190. package/package.json +1 -1
  191. package/src/funcs/earnEarnManage.ts +4 -1
  192. package/src/funcs/earnEarnPositions.ts +1 -1
  193. package/src/models/components/fee.ts +6 -5
  194. package/src/models/operations/v2earnpositions.ts +4 -9
  195. package/src/sdk/earn.ts +4 -1
package/docs/models/components/sponsorgasrequesteip712.md CHANGED
@@ -10,22 +10,35 @@ The EIP-712 typed data that was signed.
10
10
  ```typescript
11
11
  const value: components.BatchedSafeOperationsResponseInput = {
12
12
  domain: {
13
- chainId: 95340,
14
- verifyingContract: "<value>",
13
+ chainId: 42161,
14
+ verifyingContract: "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",
15
15
  },
16
16
  types: {
17
- eip712Domain: [],
18
- safeTx: [
17
+ eip712Domain: [
19
18
  {
20
- name: "<value>",
21
- type: "<value>",
19
+ name: "name",
20
+ type: "string",
21
+ },
22
+ {
23
+ name: "version",
24
+ type: "string",
25
+ },
26
+ {
27
+ name: "chainId",
28
+ type: "uint256",
29
+ },
30
+ {
31
+ name: "verifyingContract",
32
+ type: "address",
22
33
  },
23
34
  ],
35
+ safeTx: [],
24
36
  },
25
37
  primaryType: "SafeTx",
26
38
  message: {
27
39
  to: "<value>",
28
- value: "<value>",
40
+ value:
41
+ "115792089237316195423570985008687907853269984665640564039457584007913129639935",
29
42
  data: "<value>",
30
43
  operation: 0,
31
44
  safeTxGas: "<value>",
@@ -33,7 +46,7 @@ const value: components.BatchedSafeOperationsResponseInput = {
33
46
  gasPrice: "<value>",
34
47
  gasToken: "<value>",
35
48
  refundReceiver: "<value>",
36
- nonce: "<value>",
49
+ nonce: "0",
37
50
  },
38
51
  };
39
52
  ```
@@ -43,36 +56,21 @@ const value: components.BatchedSafeOperationsResponseInput = {
43
56
  ```typescript
44
57
  const value: components.PermitTypedDataResponseInput = {
45
58
  domain: {
46
- name: "<value>",
47
- version: "<value>",
48
- chainId: 76014,
49
- verifyingContract: "<value>",
59
+ name: "USD Coin",
60
+ version: "2",
61
+ chainId: 42161,
62
+ verifyingContract: "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",
50
63
  },
51
- types: {
52
- eip712Domain: [],
53
- permit: [],
54
- },
55
- primaryType: "Permit",
56
- message: {
57
- owner: "<value>",
58
- spender: "<value>",
59
- value: "<value>",
60
- nonce: "<value>",
61
- deadline: "<value>",
62
- },
63
- };
64
- ```
65
-
66
- ### `components.Permit2TypedDataInput`
67
-
68
- ```typescript
69
- const value: components.Permit2TypedDataInput = {
70
64
  types: {
71
65
  eip712Domain: [
72
66
  {
73
67
  name: "name",
74
68
  type: "string",
75
69
  },
70
+ {
71
+ name: "version",
72
+ type: "string",
73
+ },
76
74
  {
77
75
  name: "chainId",
78
76
  type: "uint256",
@@ -82,47 +80,77 @@ const value: components.Permit2TypedDataInput = {
82
80
  type: "address",
83
81
  },
84
82
  ],
85
- tokenPermissions: [
83
+ permit: [
86
84
  {
87
- name: "token",
85
+ name: "owner",
86
+ type: "address",
87
+ },
88
+ {
89
+ name: "spender",
88
90
  type: "address",
89
91
  },
90
92
  {
91
- name: "amount",
93
+ name: "value",
94
+ type: "uint256",
95
+ },
96
+ {
97
+ name: "nonce",
98
+ type: "uint256",
99
+ },
100
+ {
101
+ name: "deadline",
92
102
  type: "uint256",
93
103
  },
94
104
  ],
95
- permitTransferFrom: [
105
+ },
106
+ primaryType: "Permit",
107
+ message: {
108
+ owner: "0xCE1A77F0abff993d6d3D04d44b70831c6924fb40",
109
+ spender: "0x000000000022D473030F116dDEE9F6B43aC78BA3",
110
+ value:
111
+ "115792089237316195423570985008687907853269984665640564039457584007913129639935",
112
+ nonce: "0",
113
+ deadline: "1762269774",
114
+ },
115
+ };
116
+ ```
117
+
118
+ ### `components.Permit2TypedDataInput`
119
+
120
+ ```typescript
121
+ const value: components.Permit2TypedDataInput = {
122
+ types: {
123
+ eip712Domain: [
96
124
  {
97
- name: "permitted",
98
- type: "TokenPermissions",
125
+ name: "name",
126
+ type: "string",
99
127
  },
100
128
  {
101
- name: "spender",
102
- type: "address",
129
+ name: "version",
130
+ type: "string",
103
131
  },
104
132
  {
105
- name: "nonce",
133
+ name: "chainId",
106
134
  type: "uint256",
107
135
  },
108
136
  {
109
- name: "deadline",
110
- type: "uint256",
137
+ name: "verifyingContract",
138
+ type: "address",
111
139
  },
112
140
  ],
113
141
  },
114
142
  domain: {
115
- chainId: 387057,
116
- verifyingContract: "<value>",
143
+ chainId: 42161,
144
+ verifyingContract: "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",
117
145
  },
118
146
  message: {
119
147
  permitted: {
120
148
  token: "<value>",
121
- amount: 434763,
149
+ amount: 387057,
122
150
  },
123
- spender: "<value>",
124
- nonce: 410419,
125
- deadline: 192156,
151
+ spender: "0x000000000022D473030F116dDEE9F6B43aC78BA3",
152
+ nonce: 0,
153
+ deadline: 1762269774,
126
154
  },
127
155
  };
128
156
  ```
package/docs/models/components/tokentransferrequest.md CHANGED
@@ -21,9 +21,9 @@ let value: TokenTransferRequest = {
21
21
  | Field | Type | Required | Description | Example |
22
22
  | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
23
23
  | `actionType` | *"TOKEN_TRANSFER"* | :heavy_minus_sign: | N/A | TOKEN_TRANSFER |
24
- | `to` | *string* | :heavy_check_mark: | The recipient of the tokens. | |
25
- | `token` | *string* | :heavy_check_mark: | The symbol or address of the token to transfer. | |
26
- | `amount` | *components.TokenTransferRequestAmount* | :heavy_check_mark: | Amount of token to transfer | |
27
- | `chain` | [components.TokenTransferRequestChain](../../models/components/tokentransferrequestchain.md) | :heavy_check_mark: | N/A | |
28
- | `sender` | *string* | :heavy_check_mark: | The address of the transaction sender. | |
24
+ | `to` | *string* | :heavy_check_mark: | The recipient of the tokens. | 0x0000000000000000000000000000000000000000 |
25
+ | `token` | *string* | :heavy_check_mark: | The symbol or address of the token to transfer. | USDC |
26
+ | `amount` | *components.TokenTransferRequestAmount* | :heavy_check_mark: | Amount of token to transfer | 0.1 |
27
+ | `chain` | [components.TokenTransferRequestChain](../../models/components/tokentransferrequestchain.md) | :heavy_check_mark: | N/A | base |
28
+ | `sender` | *string* | :heavy_check_mark: | The address of the transaction sender. | 0xA06a2D62D71BeAf93FA0a684A92c28729297eC81 |
29
29
  | `estimateGas` | *boolean* | :heavy_minus_sign: | Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed. | true |
package/docs/models/components/tokentransferrequestamount.md CHANGED
@@ -8,12 +8,12 @@ Amount of token to transfer
8
8
  ### `number`
9
9
 
10
10
  ```typescript
11
- const value: number = 1284.03;
11
+ const value: number = 0.1;
12
12
  ```
13
13
 
14
14
  ### `string`
15
15
 
16
16
  ```typescript
17
- const value: string = "<value>";
17
+ const value: string = "0.1";
18
18
  ```
19
19
 
package/docs/models/components/tokentransferrequestchain.md CHANGED
@@ -5,7 +5,7 @@
5
5
  ```typescript
6
6
  import { TokenTransferRequestChain } from "@compass-labs/api-sdk/models/components";
7
7
 
8
- let value: TokenTransferRequestChain = "arbitrum";
8
+ let value: TokenTransferRequestChain = "base";
9
9
  ```
10
10
 
11
11
  ## Values
package/docs/models/components/uniswapbuyexactlyrequest.md CHANGED
@@ -23,11 +23,11 @@ let value: UniswapBuyExactlyRequest = {
23
23
  | Field | Type | Required | Description | Example |
24
24
  | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
25
25
  | `actionType` | *"UNISWAP_BUY_EXACTLY"* | :heavy_minus_sign: | N/A | UNISWAP_BUY_EXACTLY |
26
- | `tokenIn` | *string* | :heavy_check_mark: | The symbol or address of the token to swap from.. | |
27
- | `tokenOut` | *string* | :heavy_check_mark: | The symbol or address of the token to swap to.. | |
26
+ | `tokenIn` | *string* | :heavy_check_mark: | The symbol or address of the token to swap from.. | USDC |
27
+ | `tokenOut` | *string* | :heavy_check_mark: | The symbol or address of the token to swap to.. | USDT |
28
28
  | `fee` | [components.FeeEnum](../../models/components/feeenum.md) | :heavy_check_mark: | The transaction fee of a Uniswap pool in bips.<br/><br/>Uniswap supports 4 different fee levels. | |
29
- | `amountOut` | *components.UniswapBuyExactlyRequestAmountOut* | :heavy_check_mark: | The amount of 'token_out' to buy. | |
30
- | `maxSlippagePercent` | *number* | :heavy_check_mark: | The maximum slippage allowed in percent. e.g. `1` means `1 %` slippage allowed. | |
31
- | `chain` | [components.UniswapBuyExactlyRequestChain](../../models/components/uniswapbuyexactlyrequestchain.md) | :heavy_check_mark: | N/A | |
32
- | `sender` | *string* | :heavy_check_mark: | The address of the transaction sender. | |
29
+ | `amountOut` | *components.UniswapBuyExactlyRequestAmountOut* | :heavy_check_mark: | The amount of 'token_out' to buy. | 0.1 |
30
+ | `maxSlippagePercent` | *number* | :heavy_check_mark: | The maximum slippage allowed in percent. e.g. `1` means `1 %` slippage allowed. | 0.5 |
31
+ | `chain` | [components.UniswapBuyExactlyRequestChain](../../models/components/uniswapbuyexactlyrequestchain.md) | :heavy_check_mark: | N/A | base |
32
+ | `sender` | *string* | :heavy_check_mark: | The address of the transaction sender. | 0x7a27794511C14F6afFDE618D3d8ef7B9C24058Ac |
33
33
  | `estimateGas` | *boolean* | :heavy_minus_sign: | Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed. | true |
package/docs/models/components/uniswapbuyexactlyrequestamountout.md CHANGED
@@ -8,12 +8,12 @@ The amount of 'token_out' to buy.
8
8
  ### `number`
9
9
 
10
10
  ```typescript
11
- const value: number = 1284.03;
11
+ const value: number = 0.1;
12
12
  ```
13
13
 
14
14
  ### `string`
15
15
 
16
16
  ```typescript
17
- const value: string = "<value>";
17
+ const value: string = "0.1";
18
18
  ```
19
19
 
package/docs/models/components/uniswapbuyexactlyrequestchain.md CHANGED
@@ -5,7 +5,7 @@
5
5
  ```typescript
6
6
  import { UniswapBuyExactlyRequestChain } from "@compass-labs/api-sdk/models/components";
7
7
 
8
- let value: UniswapBuyExactlyRequestChain = "arbitrum";
8
+ let value: UniswapBuyExactlyRequestChain = "base";
9
9
  ```
10
10
 
11
11
  ## Values
package/docs/models/components/uniswapincreaseliquidityprovisionrequest.md CHANGED
@@ -23,11 +23,11 @@ let value: UniswapIncreaseLiquidityProvisionRequest = {
23
23
  | Field | Type | Required | Description | Example |
24
24
  | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ |
25
25
  | `actionType` | *"UNISWAP_ADD_LIQUIDITY"* | :heavy_minus_sign: | N/A | UNISWAP_ADD_LIQUIDITY |
26
- | `tokenId` | *number* | :heavy_check_mark: | Token ID of the NFT representing the liquidity provisioned position. | |
27
- | `amount0Desired` | *components.UniswapIncreaseLiquidityProvisionRequestAmount0Desired* | :heavy_check_mark: | The desired amount of the first token to deposit | |
28
- | `amount1Desired` | *components.UniswapIncreaseLiquidityProvisionRequestAmount1Desired* | :heavy_check_mark: | The desired amount of the second token to deposit | |
29
- | `amount0Min` | *components.UniswapIncreaseLiquidityProvisionRequestAmount0Min* | :heavy_check_mark: | The minimum amount of the first token to deposit | |
30
- | `amount1Min` | *components.UniswapIncreaseLiquidityProvisionRequestAmount1Min* | :heavy_check_mark: | The minimum amount of the second token to deposit | |
31
- | `chain` | [components.UniswapIncreaseLiquidityProvisionRequestChain](../../models/components/uniswapincreaseliquidityprovisionrequestchain.md) | :heavy_check_mark: | N/A | |
32
- | `sender` | *string* | :heavy_check_mark: | The address of the transaction sender. | |
26
+ | `tokenId` | *number* | :heavy_check_mark: | Token ID of the NFT representing the liquidity provisioned position. | 3432182 |
27
+ | `amount0Desired` | *components.UniswapIncreaseLiquidityProvisionRequestAmount0Desired* | :heavy_check_mark: | The desired amount of the first token to deposit | 0.3 |
28
+ | `amount1Desired` | *components.UniswapIncreaseLiquidityProvisionRequestAmount1Desired* | :heavy_check_mark: | The desired amount of the second token to deposit | 0.0 |
29
+ | `amount0Min` | *components.UniswapIncreaseLiquidityProvisionRequestAmount0Min* | :heavy_check_mark: | The minimum amount of the first token to deposit | 0.00 |
30
+ | `amount1Min` | *components.UniswapIncreaseLiquidityProvisionRequestAmount1Min* | :heavy_check_mark: | The minimum amount of the second token to deposit | 0.00 |
31
+ | `chain` | [components.UniswapIncreaseLiquidityProvisionRequestChain](../../models/components/uniswapincreaseliquidityprovisionrequestchain.md) | :heavy_check_mark: | N/A | base |
32
+ | `sender` | *string* | :heavy_check_mark: | The address of the transaction sender. | 0x41096de529D54718a5600185F8C4460979ed75C9 |
33
33
  | `estimateGas` | *boolean* | :heavy_minus_sign: | Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed. | true |
package/docs/models/components/uniswapincreaseliquidityprovisionrequestamount0desired.md CHANGED
@@ -8,12 +8,12 @@ The desired amount of the first token to deposit
8
8
  ### `number`
9
9
 
10
10
  ```typescript
11
- const value: number = 1284.03;
11
+ const value: number = 0.3;
12
12
  ```
13
13
 
14
14
  ### `string`
15
15
 
16
16
  ```typescript
17
- const value: string = "<value>";
17
+ const value: string = "0.3";
18
18
  ```
19
19
 
package/docs/models/components/uniswapincreaseliquidityprovisionrequestamount0min.md CHANGED
@@ -8,12 +8,12 @@ The minimum amount of the first token to deposit
8
8
  ### `number`
9
9
 
10
10
  ```typescript
11
- const value: number = 1284.03;
11
+ const value: number = 0;
12
12
  ```
13
13
 
14
14
  ### `string`
15
15
 
16
16
  ```typescript
17
- const value: string = "<value>";
17
+ const value: string = "0.00";
18
18
  ```
19
19
 
package/docs/models/components/uniswapincreaseliquidityprovisionrequestamount1desired.md CHANGED
@@ -8,12 +8,12 @@ The desired amount of the second token to deposit
8
8
  ### `number`
9
9
 
10
10
  ```typescript
11
- const value: number = 1284.03;
11
+ const value: number = 0;
12
12
  ```
13
13
 
14
14
  ### `string`
15
15
 
16
16
  ```typescript
17
- const value: string = "<value>";
17
+ const value: string = "0.0";
18
18
  ```
19
19
 
package/docs/models/components/uniswapincreaseliquidityprovisionrequestamount1min.md CHANGED
@@ -8,12 +8,12 @@ The minimum amount of the second token to deposit
8
8
  ### `number`
9
9
 
10
10
  ```typescript
11
- const value: number = 1284.03;
11
+ const value: number = 0;
12
12
  ```
13
13
 
14
14
  ### `string`
15
15
 
16
16
  ```typescript
17
- const value: string = "<value>";
17
+ const value: string = "0.00";
18
18
  ```
19
19
 
package/docs/models/components/uniswapincreaseliquidityprovisionrequestchain.md CHANGED
@@ -5,7 +5,7 @@
5
5
  ```typescript
6
6
  import { UniswapIncreaseLiquidityProvisionRequestChain } from "@compass-labs/api-sdk/models/components";
7
7
 
8
- let value: UniswapIncreaseLiquidityProvisionRequestChain = "arbitrum";
8
+ let value: UniswapIncreaseLiquidityProvisionRequestChain = "base";
9
9
  ```
10
10
 
11
11
  ## Values
package/docs/models/components/uniswapmintliquidityprovisionrequest.md CHANGED
@@ -28,16 +28,16 @@ let value: UniswapMintLiquidityProvisionRequest = {
28
28
  | Field | Type | Required | Description | Example |
29
29
  | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
30
30
  | `actionType` | *"UNISWAP_MINT_LIQUIDITY_PROVISION"* | :heavy_minus_sign: | N/A | UNISWAP_MINT_LIQUIDITY_PROVISION |
31
- | `token0` | *string* | :heavy_check_mark: | The symbol or address of the first token in the pair. | |
32
- | `token1` | *string* | :heavy_check_mark: | The symbol or address of the second token in the pair. | |
31
+ | `token0` | *string* | :heavy_check_mark: | The symbol or address of the first token in the pair. | USDC |
32
+ | `token1` | *string* | :heavy_check_mark: | The symbol or address of the second token in the pair. | USDT |
33
33
  | `fee` | [components.FeeEnum](../../models/components/feeenum.md) | :heavy_check_mark: | The transaction fee of a Uniswap pool in bips.<br/><br/>Uniswap supports 4 different fee levels. | |
34
- | `tickLower` | *number* | :heavy_check_mark: | The lower tick of the range to mint the position in | |
35
- | `tickUpper` | *number* | :heavy_check_mark: | The upper tick of the range to mint the position in | |
36
- | `amount0Desired` | *components.UniswapMintLiquidityProvisionRequestAmount0Desired* | :heavy_check_mark: | The desired amount of the first token to deposit | |
37
- | `amount1Desired` | *components.UniswapMintLiquidityProvisionRequestAmount1Desired* | :heavy_check_mark: | The desired amount of the second token to deposit | |
38
- | `amount0Min` | *components.UniswapMintLiquidityProvisionRequestAmount0Min* | :heavy_check_mark: | The minimum amount of the first token to deposit | |
39
- | `amount1Min` | *components.UniswapMintLiquidityProvisionRequestAmount1Min* | :heavy_check_mark: | The minimum amount of the second token to deposit | |
40
- | `recipient` | *string* | :heavy_minus_sign: | The address that will receive the LP tokens | |
41
- | `chain` | [components.UniswapMintLiquidityProvisionRequestChain](../../models/components/uniswapmintliquidityprovisionrequestchain.md) | :heavy_check_mark: | N/A | |
42
- | `sender` | *string* | :heavy_check_mark: | The address of the transaction sender. | |
34
+ | `tickLower` | *number* | :heavy_check_mark: | The lower tick of the range to mint the position in | 1823 |
35
+ | `tickUpper` | *number* | :heavy_check_mark: | The upper tick of the range to mint the position in | 2623 |
36
+ | `amount0Desired` | *components.UniswapMintLiquidityProvisionRequestAmount0Desired* | :heavy_check_mark: | The desired amount of the first token to deposit | 0.05 |
37
+ | `amount1Desired` | *components.UniswapMintLiquidityProvisionRequestAmount1Desired* | :heavy_check_mark: | The desired amount of the second token to deposit | 0.00 |
38
+ | `amount0Min` | *components.UniswapMintLiquidityProvisionRequestAmount0Min* | :heavy_check_mark: | The minimum amount of the first token to deposit | 0 |
39
+ | `amount1Min` | *components.UniswapMintLiquidityProvisionRequestAmount1Min* | :heavy_check_mark: | The minimum amount of the second token to deposit | 0 |
40
+ | `recipient` | *string* | :heavy_minus_sign: | The address that will receive the LP tokens | 0x41096de529D54718a5600185F8C4460979ed75C9 |
41
+ | `chain` | [components.UniswapMintLiquidityProvisionRequestChain](../../models/components/uniswapmintliquidityprovisionrequestchain.md) | :heavy_check_mark: | N/A | base |
42
+ | `sender` | *string* | :heavy_check_mark: | The address of the transaction sender. | 0x41096de529D54718a5600185F8C4460979ed75C9 |
43
43
  | `estimateGas` | *boolean* | :heavy_minus_sign: | Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed. | true |
package/docs/models/components/uniswapmintliquidityprovisionrequestamount0desired.md CHANGED
@@ -8,12 +8,12 @@ The desired amount of the first token to deposit
8
8
  ### `number`
9
9
 
10
10
  ```typescript
11
- const value: number = 1284.03;
11
+ const value: number = 0.05;
12
12
  ```
13
13
 
14
14
  ### `string`
15
15
 
16
16
  ```typescript
17
- const value: string = "<value>";
17
+ const value: string = "0.05";
18
18
  ```
19
19
 
package/docs/models/components/uniswapmintliquidityprovisionrequestamount0min.md CHANGED
@@ -8,12 +8,12 @@ The minimum amount of the first token to deposit
8
8
  ### `number`
9
9
 
10
10
  ```typescript
11
- const value: number = 1284.03;
11
+ const value: number = 0;
12
12
  ```
13
13
 
14
14
  ### `string`
15
15
 
16
16
  ```typescript
17
- const value: string = "<value>";
17
+ const value: string = "0";
18
18
  ```
19
19
 
package/docs/models/components/uniswapmintliquidityprovisionrequestamount1desired.md CHANGED
@@ -8,12 +8,12 @@ The desired amount of the second token to deposit
8
8
  ### `number`
9
9
 
10
10
  ```typescript
11
- const value: number = 1284.03;
11
+ const value: number = 0;
12
12
  ```
13
13
 
14
14
  ### `string`
15
15
 
16
16
  ```typescript
17
- const value: string = "<value>";
17
+ const value: string = "0.00";
18
18
  ```
19
19
 
package/docs/models/components/uniswapmintliquidityprovisionrequestamount1min.md CHANGED
@@ -8,12 +8,12 @@ The minimum amount of the second token to deposit
8
8
  ### `number`
9
9
 
10
10
  ```typescript
11
- const value: number = 1284.03;
11
+ const value: number = 0;
12
12
  ```
13
13
 
14
14
  ### `string`
15
15
 
16
16
  ```typescript
17
- const value: string = "<value>";
17
+ const value: string = "0";
18
18
  ```
19
19
 
package/docs/models/components/uniswapsellexactlyrequest.md CHANGED
@@ -23,11 +23,11 @@ let value: UniswapSellExactlyRequest = {
23
23
  | Field | Type | Required | Description | Example |
24
24
  | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
25
25
  | `actionType` | *"UNISWAP_SELL_EXACTLY"* | :heavy_minus_sign: | N/A | UNISWAP_SELL_EXACTLY |
26
- | `tokenIn` | *string* | :heavy_check_mark: | The symbol or address of the token to sell.. | |
27
- | `tokenOut` | *string* | :heavy_check_mark: | The symbol or address of the token to buy.. | |
26
+ | `tokenIn` | *string* | :heavy_check_mark: | The symbol or address of the token to sell.. | USDC |
27
+ | `tokenOut` | *string* | :heavy_check_mark: | The symbol or address of the token to buy.. | USDT |
28
28
  | `fee` | [components.FeeEnum](../../models/components/feeenum.md) | :heavy_check_mark: | The transaction fee of a Uniswap pool in bips.<br/><br/>Uniswap supports 4 different fee levels. | |
29
- | `amountIn` | *components.UniswapSellExactlyRequestAmountIn* | :heavy_check_mark: | The amount of the `token_in` to sell | |
30
- | `maxSlippagePercent` | *number* | :heavy_check_mark: | The maximum slippage allowed in percent. e.g. `1` means `1 %` slippage allowed. | |
31
- | `chain` | [components.UniswapSellExactlyRequestChain](../../models/components/uniswapsellexactlyrequestchain.md) | :heavy_check_mark: | N/A | |
32
- | `sender` | *string* | :heavy_check_mark: | The address of the transaction sender. | |
29
+ | `amountIn` | *components.UniswapSellExactlyRequestAmountIn* | :heavy_check_mark: | The amount of the `token_in` to sell | 0.1 |
30
+ | `maxSlippagePercent` | *number* | :heavy_check_mark: | The maximum slippage allowed in percent. e.g. `1` means `1 %` slippage allowed. | 0.5 |
31
+ | `chain` | [components.UniswapSellExactlyRequestChain](../../models/components/uniswapsellexactlyrequestchain.md) | :heavy_check_mark: | N/A | base |
32
+ | `sender` | *string* | :heavy_check_mark: | The address of the transaction sender. | 0xA7DeA16238DdF6ed8AaC73A348bbdE6da20C20B5 |
33
33
  | `estimateGas` | *boolean* | :heavy_minus_sign: | Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed. | true |
package/docs/models/components/uniswapsellexactlyrequestamountin.md CHANGED
@@ -8,12 +8,12 @@ The amount of the `token_in` to sell
8
8
  ### `number`
9
9
 
10
10
  ```typescript
11
- const value: number = 1284.03;
11
+ const value: number = 0.1;
12
12
  ```
13
13
 
14
14
  ### `string`
15
15
 
16
16
  ```typescript
17
- const value: string = "<value>";
17
+ const value: string = "0.1";
18
18
  ```
19
19
 
package/docs/models/components/uniswapsellexactlyrequestchain.md CHANGED
@@ -5,7 +5,7 @@
5
5
  ```typescript
6
6
  import { UniswapSellExactlyRequestChain } from "@compass-labs/api-sdk/models/components";
7
7
 
8
- let value: UniswapSellExactlyRequestChain = "ethereum";
8
+ let value: UniswapSellExactlyRequestChain = "base";
9
9
  ```
10
10
 
11
11
  ## Values