@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/permit2typeddatainput.md CHANGED
@@ -13,55 +13,31 @@ let value: Permit2TypedDataInput = {
13
13
  type: "string",
14
14
  },
15
15
  {
16
- name: "chainId",
17
- type: "uint256",
18
- },
19
- {
20
- name: "verifyingContract",
21
- type: "address",
22
- },
23
- ],
24
- tokenPermissions: [
25
- {
26
- name: "token",
27
- type: "address",
16
+ name: "version",
17
+ type: "string",
28
18
  },
29
19
  {
30
- name: "amount",
20
+ name: "chainId",
31
21
  type: "uint256",
32
22
  },
33
- ],
34
- permitTransferFrom: [
35
- {
36
- name: "permitted",
37
- type: "TokenPermissions",
38
- },
39
23
  {
40
- name: "spender",
24
+ name: "verifyingContract",
41
25
  type: "address",
42
26
  },
43
- {
44
- name: "nonce",
45
- type: "uint256",
46
- },
47
- {
48
- name: "deadline",
49
- type: "uint256",
50
- },
51
27
  ],
52
28
  },
53
29
  domain: {
54
- chainId: 387057,
55
- verifyingContract: "<value>",
30
+ chainId: 42161,
31
+ verifyingContract: "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",
56
32
  },
57
33
  message: {
58
34
  permitted: {
59
35
  token: "<value>",
60
- amount: 434763,
36
+ amount: 387057,
61
37
  },
62
- spender: "<value>",
63
- nonce: 410419,
64
- deadline: 192156,
38
+ spender: "0x000000000022D473030F116dDEE9F6B43aC78BA3",
39
+ nonce: 0,
40
+ deadline: 1762269774,
65
41
  },
66
42
  };
67
43
  ```
package/docs/models/components/permit2typeddataoutput.md CHANGED
@@ -51,17 +51,17 @@ let value: Permit2TypedDataOutput = {
51
51
  ],
52
52
  },
53
53
  domain: {
54
- chainId: 387057,
54
+ chainId: 659817,
55
55
  verifyingContract: "<value>",
56
56
  },
57
57
  message: {
58
58
  permitted: {
59
59
  token: "<value>",
60
- amount: 434763,
60
+ amount: 387057,
61
61
  },
62
62
  spender: "<value>",
63
- nonce: 410419,
64
- deadline: 192156,
63
+ nonce: 382019,
64
+ deadline: 22738,
65
65
  },
66
66
  };
67
67
  ```
package/docs/models/components/permittransferfrommessage.md CHANGED
@@ -8,7 +8,7 @@ import { PermitTransferFromMessage } from "@compass-labs/api-sdk/models/componen
8
8
  let value: PermitTransferFromMessage = {
9
9
  permitted: {
10
10
  token: "<value>",
11
- amount: 434763,
11
+ amount: 387057,
12
12
  },
13
13
  spender: "<value>",
14
14
  nonce: 942324,
package/docs/models/components/permittypeddataresponseinput.md CHANGED
@@ -9,22 +9,61 @@ import { PermitTypedDataResponseInput } from "@compass-labs/api-sdk/models/compo
9
9
 
10
10
  let value: PermitTypedDataResponseInput = {
11
11
  domain: {
12
- name: "<value>",
13
- version: "<value>",
14
- chainId: 76014,
15
- verifyingContract: "<value>",
12
+ name: "USD Coin",
13
+ version: "2",
14
+ chainId: 42161,
15
+ verifyingContract: "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",
16
16
  },
17
17
  types: {
18
- eip712Domain: [],
19
- permit: [],
18
+ eip712Domain: [
19
+ {
20
+ name: "name",
21
+ type: "string",
22
+ },
23
+ {
24
+ name: "version",
25
+ type: "string",
26
+ },
27
+ {
28
+ name: "chainId",
29
+ type: "uint256",
30
+ },
31
+ {
32
+ name: "verifyingContract",
33
+ type: "address",
34
+ },
35
+ ],
36
+ permit: [
37
+ {
38
+ name: "owner",
39
+ type: "address",
40
+ },
41
+ {
42
+ name: "spender",
43
+ type: "address",
44
+ },
45
+ {
46
+ name: "value",
47
+ type: "uint256",
48
+ },
49
+ {
50
+ name: "nonce",
51
+ type: "uint256",
52
+ },
53
+ {
54
+ name: "deadline",
55
+ type: "uint256",
56
+ },
57
+ ],
20
58
  },
21
59
  primaryType: "Permit",
22
60
  message: {
23
- owner: "<value>",
24
- spender: "<value>",
25
- value: "<value>",
26
- nonce: "<value>",
27
- deadline: "<value>",
61
+ owner: "0xCE1A77F0abff993d6d3D04d44b70831c6924fb40",
62
+ spender: "0x000000000022D473030F116dDEE9F6B43aC78BA3",
63
+ value:
64
+ "115792089237316195423570985008687907853269984665640564039457584007913129639935",
65
+ nonce: "0",
66
+ deadline: "1762269774",
28
67
  },
29
68
  };
30
69
  ```
package/docs/models/components/permittypeddataresponseoutput.md CHANGED
@@ -11,11 +11,16 @@ let value: PermitTypedDataResponseOutput = {
11
11
  domain: {
12
12
  name: "<value>",
13
13
  version: "<value>",
14
- chainId: 76014,
14
+ chainId: 829341,
15
15
  verifyingContract: "<value>",
16
16
  },
17
17
  types: {
18
- eip712Domain: [],
18
+ eip712Domain: [
19
+ {
20
+ name: "<value>",
21
+ type: "<value>",
22
+ },
23
+ ],
19
24
  permit: [],
20
25
  },
21
26
  primaryType: "Permit",
package/docs/models/components/setallowancerequest.md CHANGED
@@ -21,9 +21,9 @@ let value: SetAllowanceRequest = {
21
21
  | Field | Type | Required | Description | Example |
22
22
  | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
23
23
  | `actionType` | *"SET_ALLOWANCE"* | :heavy_minus_sign: | N/A | SET_ALLOWANCE |
24
- | `token` | *string* | :heavy_check_mark: | The symbol or address of the token for which the allowance is set.. | |
25
- | `contract` | *components.SetAllowanceRequestContractUnion* | :heavy_check_mark: | The name or address of the contract to set spending allowance for. | |
26
- | `amount` | *components.SetAllowanceRequestAmount* | :heavy_check_mark: | The amount to set the allowance to. | |
27
- | `chain` | [components.SetAllowanceRequestChain](../../models/components/setallowancerequestchain.md) | :heavy_check_mark: | N/A | |
28
- | `sender` | *string* | :heavy_check_mark: | The address of the transaction sender. | |
24
+ | `token` | *string* | :heavy_check_mark: | The symbol or address of the token for which the allowance is set.. | USDC |
25
+ | `contract` | *components.SetAllowanceRequestContractUnion* | :heavy_check_mark: | The name or address of the contract to set spending allowance for. | AaveV3Pool |
26
+ | `amount` | *components.SetAllowanceRequestAmount* | :heavy_check_mark: | The amount to set the allowance to. | 0.1 |
27
+ | `chain` | [components.SetAllowanceRequestChain](../../models/components/setallowancerequestchain.md) | :heavy_check_mark: | N/A | base |
28
+ | `sender` | *string* | :heavy_check_mark: | The address of the transaction sender. | 0xa16d82c668317bF20091fA9D6D2CAE09Ee05d7c8 |
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/setallowancerequestamount.md CHANGED
@@ -8,12 +8,12 @@ The amount to set the allowance to.
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/setallowancerequestcontractenum.md CHANGED
@@ -5,7 +5,7 @@
5
5
  ```typescript
6
6
  import { SetAllowanceRequestContractEnum } from "@compass-labs/api-sdk/models/components";
7
7
 
8
- let value: SetAllowanceRequestContractEnum = "UniswapV3Router";
8
+ let value: SetAllowanceRequestContractEnum = "AaveV3Pool";
9
9
  ```
10
10
 
11
11
  ## Values
package/docs/models/components/setallowancerequestcontractunion.md CHANGED
@@ -14,6 +14,6 @@ const value: components.SetAllowanceRequestContractEnum = "AaveV3Pool";
14
14
  ### `string`
15
15
 
16
16
  ```typescript
17
- const value: string = "<value>";
17
+ const value: string = "AaveV3Pool";
18
18
  ```
19
19
 
package/docs/models/components/signedauthorization.md CHANGED
@@ -6,12 +6,12 @@
6
6
  import { SignedAuthorization } from "@compass-labs/api-sdk/models/components";
7
7
 
8
8
  let value: SignedAuthorization = {
9
- nonce: 236555,
10
- address: "84199 Elian Harbors",
11
- chainId: 183648,
12
- r: "<value>",
13
- s: 816144,
14
- yParity: 957614,
9
+ nonce: 1000,
10
+ address: "0xcA11bde05977b3631167028862bE2a173976CA11",
11
+ chainId: 42161,
12
+ r: "0x5f9f3f3226ac91bc01a72dd117141f6c6de1ed30d3af9f95c3423316dc21d615",
13
+ s: "0x78f7982ede9dabc53d7153974c5692fda8a21fc73bdafc42aaf135505e22817c",
14
+ yParity: 0,
15
15
  };
16
16
  ```
17
17
 
package/docs/models/components/skybuyrequest.md CHANGED
@@ -18,8 +18,8 @@ let value: SkyBuyRequest = {
18
18
  | Field | Type | Required | Description | Example |
19
19
  | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
20
20
  | `actionType` | *"SKY_BUY"* | :heavy_minus_sign: | N/A | SKY_BUY |
21
- | `tokenIn` | [components.SkyBuyRequestTokenIn](../../models/components/skybuyrequesttokenin.md) | :heavy_check_mark: | The token you would like to swap 1:1 for USDS. Choose from DAI or USDC. | |
22
- | `amount` | *components.SkyBuyRequestAmount* | :heavy_check_mark: | The amount of USDS you would like to buy 1:1 with 'token_in'. | |
23
- | `chain` | [components.SkyBuyRequestChain](../../models/components/skybuyrequestchain.md) | :heavy_check_mark: | N/A | |
24
- | `sender` | *string* | :heavy_check_mark: | The address of the transaction sender. | |
21
+ | `tokenIn` | [components.SkyBuyRequestTokenIn](../../models/components/skybuyrequesttokenin.md) | :heavy_check_mark: | The token you would like to swap 1:1 for USDS. Choose from DAI or USDC. | USDC |
22
+ | `amount` | *components.SkyBuyRequestAmount* | :heavy_check_mark: | The amount of USDS you would like to buy 1:1 with 'token_in'. | 0.5 |
23
+ | `chain` | [components.SkyBuyRequestChain](../../models/components/skybuyrequestchain.md) | :heavy_check_mark: | N/A | ethereum |
24
+ | `sender` | *string* | :heavy_check_mark: | The address of the transaction sender. | 0xeF61F94a856a20f4fdD831B823e8B3CF09BEec3B |
25
25
  | `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/skybuyrequestamount.md CHANGED
@@ -8,12 +8,12 @@ The amount of USDS you would like to buy 1:1 with 'token_in'.
8
8
  ### `number`
9
9
 
10
10
  ```typescript
11
- const value: number = 1284.03;
11
+ const value: number = 0.5;
12
12
  ```
13
13
 
14
14
  ### `string`
15
15
 
16
16
  ```typescript
17
- const value: string = "<value>";
17
+ const value: string = "0.5";
18
18
  ```
19
19
 
package/docs/models/components/skydepositrequest.md CHANGED
@@ -17,8 +17,8 @@ let value: SkyDepositRequest = {
17
17
  | Field | Type | Required | Description | Example |
18
18
  | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
19
19
  | `actionType` | *"SKY_DEPOSIT"* | :heavy_minus_sign: | N/A | SKY_DEPOSIT |
20
- | `amount` | *components.SkyDepositRequestAmount* | :heavy_check_mark: | The amount of USDS you would like to deposit for sUSDS to earn yield. | |
20
+ | `amount` | *components.SkyDepositRequestAmount* | :heavy_check_mark: | The amount of USDS you would like to deposit for sUSDS to earn yield. | 0.2 |
21
21
  | `receiver` | *string* | :heavy_minus_sign: | The address which will receive the sUSDS. Defaults to the sender. | |
22
22
  | `chain` | [components.SkyDepositRequestChain](../../models/components/skydepositrequestchain.md) | :heavy_minus_sign: | N/A | ethereum |
23
- | `sender` | *string* | :heavy_check_mark: | The address of the transaction sender. | |
23
+ | `sender` | *string* | :heavy_check_mark: | The address of the transaction sender. | 0x7F6063e2237a6b2aE32eDc48EF9cD1B2A8F3aD5D |
24
24
  | `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/skydepositrequestamount.md CHANGED
@@ -8,12 +8,12 @@ The amount of USDS you would like to deposit for sUSDS to earn yield.
8
8
  ### `number`
9
9
 
10
10
  ```typescript
11
- const value: number = 1284.03;
11
+ const value: number = 0.2;
12
12
  ```
13
13
 
14
14
  ### `string`
15
15
 
16
16
  ```typescript
17
- const value: string = "<value>";
17
+ const value: string = "0.2";
18
18
  ```
19
19
 
package/docs/models/components/skysellrequest.md CHANGED
@@ -18,8 +18,8 @@ let value: SkySellRequest = {
18
18
  | Field | Type | Required | Description | Example |
19
19
  | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
20
20
  | `actionType` | *"SKY_SELL"* | :heavy_minus_sign: | N/A | SKY_SELL |
21
- | `tokenOut` | [components.SkySellRequestTokenOut](../../models/components/skysellrequesttokenout.md) | :heavy_check_mark: | The token you would like to swap 1:1 with USDS. Choose from DAI or USDC. | |
22
- | `amount` | *components.SkySellRequestAmount* | :heavy_check_mark: | The amount of USDS you would like to sell 1:1 for 'token_out'. | |
23
- | `chain` | [components.SkySellRequestChain](../../models/components/skysellrequestchain.md) | :heavy_check_mark: | N/A | |
24
- | `sender` | *string* | :heavy_check_mark: | The address of the transaction sender. | |
21
+ | `tokenOut` | [components.SkySellRequestTokenOut](../../models/components/skysellrequesttokenout.md) | :heavy_check_mark: | The token you would like to swap 1:1 with USDS. Choose from DAI or USDC. | USDC |
22
+ | `amount` | *components.SkySellRequestAmount* | :heavy_check_mark: | The amount of USDS you would like to sell 1:1 for 'token_out'. | 0.2 |
23
+ | `chain` | [components.SkySellRequestChain](../../models/components/skysellrequestchain.md) | :heavy_check_mark: | N/A | ethereum |
24
+ | `sender` | *string* | :heavy_check_mark: | The address of the transaction sender. | 0x0ca38b6Ed5e12bbaf5fAf380c05a806D3a8d1CBC |
25
25
  | `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/skysellrequestamount.md CHANGED
@@ -8,12 +8,12 @@ The amount of USDS you would like to sell 1:1 for 'token_out'.
8
8
  ### `number`
9
9
 
10
10
  ```typescript
11
- const value: number = 1284.03;
11
+ const value: number = 0.2;
12
12
  ```
13
13
 
14
14
  ### `string`
15
15
 
16
16
  ```typescript
17
- const value: string = "<value>";
17
+ const value: string = "0.2";
18
18
  ```
19
19
 
package/docs/models/components/skysellrequesttokenout.md CHANGED
@@ -7,7 +7,7 @@ The token you would like to swap 1:1 with USDS. Choose from DAI or USDC.
7
7
  ```typescript
8
8
  import { SkySellRequestTokenOut } from "@compass-labs/api-sdk/models/components";
9
9
 
10
- let value: SkySellRequestTokenOut = "DAI";
10
+ let value: SkySellRequestTokenOut = "USDC";
11
11
  ```
12
12
 
13
13
  ## Values
package/docs/models/components/skywithdrawrequest.md CHANGED
@@ -20,5 +20,5 @@ let value: SkyWithdrawRequest = {
20
20
  | `amount` | *any* | :heavy_check_mark: | The amount of USDS you would like to withdraw. If set to 'ALL', your total deposited USDS amount will be withdrawn. | |
21
21
  | `receiver` | *string* | :heavy_minus_sign: | The address which will receive the withdrawn USDS. Defaults to the sender. | |
22
22
  | `chain` | [components.SkyWithdrawRequestChain](../../models/components/skywithdrawrequestchain.md) | :heavy_minus_sign: | N/A | ethereum |
23
- | `sender` | *string* | :heavy_check_mark: | The address of the transaction sender. | |
23
+ | `sender` | *string* | :heavy_check_mark: | The address of the transaction sender. | 0xacCEE9C7A5a759f814C7A770e2D8F78d662b1F60 |
24
24
  | `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/sponsorgasrequest.md CHANGED
@@ -75,10 +75,10 @@ let value: SponsorGasRequest = {
75
75
 
76
76
  ## Fields
77
77
 
78
- | Field | Type | Required | Description |
79
- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
80
- | `owner` | *string* | :heavy_check_mark: | The owner of the smart account's address. |
81
- | `chain` | [components.Chain](../../models/components/chain.md) | :heavy_check_mark: | The chain to use. |
82
- | `eip712` | *components.SponsorGasRequestEip712* | :heavy_check_mark: | The EIP-712 typed data that was signed. |
83
- | `signature` | *string* | :heavy_check_mark: | The EIP-712 signed typed data signature. |
84
- | `sender` | *string* | :heavy_check_mark: | The address of the wallet which will send the transaction. |
78
+ | Field | Type | Required | Description | Example |
79
+ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
80
+ | `owner` | *string* | :heavy_check_mark: | The owner of the smart account's address. | 0xCE1A77F0abff993d6d3D04d44b70831c6924fb40 |
81
+ | `chain` | [components.Chain](../../models/components/chain.md) | :heavy_check_mark: | The chain to use. | |
82
+ | `eip712` | *components.SponsorGasRequestEip712* | :heavy_check_mark: | The EIP-712 typed data that was signed. | {<br/>"domain": {<br/>"chainId": 42161,<br/>"name": "USD Coin",<br/>"verifyingContract": "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",<br/>"version": "2"<br/>},<br/>"message": {<br/>"deadline": "1762269774",<br/>"nonce": "0",<br/>"owner": "0xCE1A77F0abff993d6d3D04d44b70831c6924fb40",<br/>"spender": "0x000000000022D473030F116dDEE9F6B43aC78BA3",<br/>"value": "115792089237316195423570985008687907853269984665640564039457584007913129639935"<br/>},<br/>"primaryType": "Permit",<br/>"types": {<br/>"EIP712Domain": [<br/>{<br/>"name": "name",<br/>"type": "string"<br/>},<br/>{<br/>"name": "version",<br/>"type": "string"<br/>},<br/>{<br/>"name": "chainId",<br/>"type": "uint256"<br/>},<br/>{<br/>"name": "verifyingContract",<br/>"type": "address"<br/>}<br/>],<br/>"Permit": [<br/>{<br/>"name": "owner",<br/>"type": "address"<br/>},<br/>{<br/>"name": "spender",<br/>"type": "address"<br/>},<br/>{<br/>"name": "value",<br/>"type": "uint256"<br/>},<br/>{<br/>"name": "nonce",<br/>"type": "uint256"<br/>},<br/>{<br/>"name": "deadline",<br/>"type": "uint256"<br/>}<br/>]<br/>}<br/>} |
83
+ | `signature` | *string* | :heavy_check_mark: | The EIP-712 signed typed data signature. | 0x160d2709ae195f591daa33ad6ab1fb18b8762a39d8c4466c4cbe95cf6881fc3d54d469710ef0e7fd64ecff47c1ba5741d7254903bfaebdacea5aa8289f81ba9a1c |
84
+ | `sender` | *string* | :heavy_check_mark: | The address of the wallet which will send the transaction. | 0x02122Ac49b0Be2e0eAD957F2D080805A0127Aa9d |