@compass-labs/api-sdk 2.1.26-rc.13 → 2.1.26-rc.15

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 (148) hide show
  1. package/docs/models/components/aavelooprequest.md +15 -15
  2. package/docs/models/components/aaverepayrequest.md +5 -5
  3. package/docs/models/components/aaverepayrequestamount.md +2 -2
  4. package/docs/models/components/aaverepayrequestchain.md +1 -1
  5. package/docs/models/components/aavesetuseremoderequest.md +3 -3
  6. package/docs/models/components/aavesetuseremoderequestchain.md +1 -1
  7. package/docs/models/components/aavesupplyrequest.md +4 -4
  8. package/docs/models/components/aavesupplyrequestamount.md +2 -2
  9. package/docs/models/components/aavesupplyrequestchain.md +1 -1
  10. package/docs/models/components/aavewithdrawrequest.md +5 -5
  11. package/docs/models/components/aavewithdrawrequestamount.md +2 -2
  12. package/docs/models/components/aavewithdrawrequestchain.md +1 -1
  13. package/docs/models/components/aerodromeslipstreambuyexactlyrequest.md +7 -7
  14. package/docs/models/components/aerodromeslipstreambuyexactlyrequestamountinmaximum.md +2 -2
  15. package/docs/models/components/aerodromeslipstreambuyexactlyrequestamountout.md +2 -2
  16. package/docs/models/components/aerodromeslipstreamincreaseliquidityprovisionrequest.md +7 -7
  17. package/docs/models/components/aerodromeslipstreamincreaseliquidityprovisionrequestamount0desired.md +2 -2
  18. package/docs/models/components/aerodromeslipstreamincreaseliquidityprovisionrequestamount0min.md +2 -2
  19. package/docs/models/components/aerodromeslipstreamincreaseliquidityprovisionrequestamount1desired.md +2 -2
  20. package/docs/models/components/aerodromeslipstreamincreaseliquidityprovisionrequestamount1min.md +2 -2
  21. package/docs/models/components/aerodromeslipstreammintliquidityprovisionrequest.md +12 -12
  22. package/docs/models/components/aerodromeslipstreammintliquidityprovisionrequestamount0desired.md +2 -2
  23. package/docs/models/components/aerodromeslipstreammintliquidityprovisionrequestamount0min.md +2 -2
  24. package/docs/models/components/aerodromeslipstreammintliquidityprovisionrequestamount1desired.md +2 -2
  25. package/docs/models/components/aerodromeslipstreammintliquidityprovisionrequestamount1min.md +2 -2
  26. package/docs/models/components/aerodromeslipstreamsellexactlyrequest.md +6 -6
  27. package/docs/models/components/aerodromeslipstreamsellexactlyrequestamountin.md +2 -2
  28. package/docs/models/components/aerodromeslipstreamwithdrawliquidityprovisionrequest.md +4 -4
  29. package/docs/models/components/aerodromeslipstreamwithdrawliquidityprovisionrequestpercentageforwithdrawal.md +2 -2
  30. package/docs/models/components/approvetransferrequest.md +2 -2
  31. package/docs/models/components/approvetransferresponse.md +7 -2
  32. package/docs/models/components/batchedsafeoperationsresponseinput.md +22 -9
  33. package/docs/models/components/batchedsafeoperationsresponseoutput.md +2 -7
  34. package/docs/models/components/batcheduseroperationsrequest.md +2 -2
  35. package/docs/models/components/createaccountrequest.md +3 -3
  36. package/docs/models/components/createaccountrequestchain.md +1 -1
  37. package/docs/models/components/depositforburnrequest.md +4 -4
  38. package/docs/models/components/depositforburnrequestamount.md +2 -2
  39. package/docs/models/components/depositforburnresponse.md +2 -7
  40. package/docs/models/components/destinationchain.md +1 -1
  41. package/docs/models/components/earnmanageparams.md +2 -2
  42. package/docs/models/components/earnmanageparamsvenue.md +1 -1
  43. package/docs/models/components/earnmanagerequest.md +3 -3
  44. package/docs/models/components/earnmanagerequestvenue.md +1 -1
  45. package/docs/models/components/earnswaprequest.md +4 -4
  46. package/docs/models/components/earnswaprequestamountin.md +2 -2
  47. package/docs/models/components/earnswapresponse.md +2 -7
  48. package/docs/models/components/earntransferrequest.md +4 -4
  49. package/docs/models/components/earntransferrequestaction.md +1 -1
  50. package/docs/models/components/earntransferrequestamount.md +2 -2
  51. package/docs/models/components/earntransferresponse.md +2 -7
  52. package/docs/models/components/earntransferresponseeip712.md +6 -11
  53. package/docs/models/components/ethenadepositrequest.md +3 -3
  54. package/docs/models/components/ethenadepositrequestamount.md +2 -2
  55. package/docs/models/components/ethenarequesttowithdrawrequest.md +2 -2
  56. package/docs/models/components/ethenaunstakerequest.md +2 -2
  57. package/docs/models/components/initialcollateralamount.md +2 -2
  58. package/docs/models/components/loantovalue.md +2 -2
  59. package/docs/models/components/maxslippagepercent.md +2 -2
  60. package/docs/models/components/mintpreparerequest.md +5 -5
  61. package/docs/models/components/morphoborrowrequest.md +4 -4
  62. package/docs/models/components/morphoborrowrequestamount.md +2 -2
  63. package/docs/models/components/morphoborrowrequestchain.md +1 -1
  64. package/docs/models/components/morphodepositrequest.md +4 -4
  65. package/docs/models/components/morphodepositrequestamount.md +2 -2
  66. package/docs/models/components/morphodepositrequestchain.md +1 -1
  67. package/docs/models/components/morphorepayrequest.md +3 -3
  68. package/docs/models/components/morphosupplycollateralrequest.md +4 -4
  69. package/docs/models/components/morphosupplycollateralrequestamount.md +2 -2
  70. package/docs/models/components/morphosupplycollateralrequestchain.md +1 -1
  71. package/docs/models/components/morphowithdrawcollateralrequest.md +4 -4
  72. package/docs/models/components/morphowithdrawcollateralrequestamount.md +2 -2
  73. package/docs/models/components/morphowithdrawrequest.md +3 -3
  74. package/docs/models/components/morphowithdrawrequestchain.md +1 -1
  75. package/docs/models/components/multicallauthorizationrequest.md +4 -4
  76. package/docs/models/components/multicallauthorizationrequestchain.md +1 -1
  77. package/docs/models/components/multicallexecuterequest.md +7 -7
  78. package/docs/models/components/multiplier.md +2 -2
  79. package/docs/models/components/odosswaprequest.md +6 -6
  80. package/docs/models/components/odosswaprequestamountin.md +2 -2
  81. package/docs/models/components/pendlemanageliquidityrequest.md +7 -7
  82. package/docs/models/components/pendlemanageliquidityrequestamountin.md +2 -2
  83. package/docs/models/components/pendlemanageliquidityrequestchain.md +1 -1
  84. package/docs/models/components/pendleredeemyieldrequest.md +3 -3
  85. package/docs/models/components/pendletradeptrequest.md +7 -7
  86. package/docs/models/components/pendletradeptrequestaction.md +1 -1
  87. package/docs/models/components/pendletradeptrequestamountin.md +2 -2
  88. package/docs/models/components/pendletradeytrequest.md +7 -7
  89. package/docs/models/components/pendletradeytrequestaction.md +1 -1
  90. package/docs/models/components/pendletradeytrequestamountin.md +2 -2
  91. package/docs/models/components/permit2typeddatainput.md +10 -34
  92. package/docs/models/components/permit2typeddataoutput.md +4 -4
  93. package/docs/models/components/permittransferfrommessage.md +1 -1
  94. package/docs/models/components/permittypeddataresponseinput.md +50 -11
  95. package/docs/models/components/permittypeddataresponseoutput.md +7 -2
  96. package/docs/models/components/setallowancerequest.md +5 -5
  97. package/docs/models/components/setallowancerequestamount.md +2 -2
  98. package/docs/models/components/setallowancerequestcontractenum.md +1 -1
  99. package/docs/models/components/setallowancerequestcontractunion.md +1 -1
  100. package/docs/models/components/signedauthorization.md +6 -6
  101. package/docs/models/components/skybuyrequest.md +4 -4
  102. package/docs/models/components/skybuyrequestamount.md +2 -2
  103. package/docs/models/components/skydepositrequest.md +2 -2
  104. package/docs/models/components/skydepositrequestamount.md +2 -2
  105. package/docs/models/components/skysellrequest.md +4 -4
  106. package/docs/models/components/skysellrequestamount.md +2 -2
  107. package/docs/models/components/skysellrequesttokenout.md +1 -1
  108. package/docs/models/components/skywithdrawrequest.md +1 -1
  109. package/docs/models/components/sponsorgasrequest.md +7 -7
  110. package/docs/models/components/sponsorgasrequesteip712.md +76 -48
  111. package/docs/models/components/tokentransferrequest.md +5 -5
  112. package/docs/models/components/tokentransferrequestamount.md +2 -2
  113. package/docs/models/components/tokentransferrequestchain.md +1 -1
  114. package/docs/models/components/uniswapbuyexactlyrequest.md +6 -6
  115. package/docs/models/components/uniswapbuyexactlyrequestamountout.md +2 -2
  116. package/docs/models/components/uniswapbuyexactlyrequestchain.md +1 -1
  117. package/docs/models/components/uniswapincreaseliquidityprovisionrequest.md +7 -7
  118. package/docs/models/components/uniswapincreaseliquidityprovisionrequestamount0desired.md +2 -2
  119. package/docs/models/components/uniswapincreaseliquidityprovisionrequestamount0min.md +2 -2
  120. package/docs/models/components/uniswapincreaseliquidityprovisionrequestamount1desired.md +2 -2
  121. package/docs/models/components/uniswapincreaseliquidityprovisionrequestamount1min.md +2 -2
  122. package/docs/models/components/uniswapincreaseliquidityprovisionrequestchain.md +1 -1
  123. package/docs/models/components/uniswapmintliquidityprovisionrequest.md +11 -11
  124. package/docs/models/components/uniswapmintliquidityprovisionrequestamount0desired.md +2 -2
  125. package/docs/models/components/uniswapmintliquidityprovisionrequestamount0min.md +2 -2
  126. package/docs/models/components/uniswapmintliquidityprovisionrequestamount1desired.md +2 -2
  127. package/docs/models/components/uniswapmintliquidityprovisionrequestamount1min.md +2 -2
  128. package/docs/models/components/uniswapsellexactlyrequest.md +6 -6
  129. package/docs/models/components/uniswapsellexactlyrequestamountin.md +2 -2
  130. package/docs/models/components/uniswapsellexactlyrequestchain.md +1 -1
  131. package/docs/models/components/uniswapwithdrawliquidityprovisionrequest.md +4 -4
  132. package/docs/models/components/uniswapwithdrawliquidityprovisionrequestchain.md +1 -1
  133. package/docs/models/components/uniswapwithdrawliquidityprovisionrequestpercentageforwithdrawal.md +2 -2
  134. package/docs/models/components/unwrapwethrequest.md +3 -3
  135. package/docs/models/components/unwrapwethrequestamount.md +2 -2
  136. package/docs/models/components/unwrapwethrequestchain.md +1 -1
  137. package/docs/models/components/v2bundlerequest.md +6 -6
  138. package/docs/models/components/v2useroperation.md +2 -2
  139. package/docs/models/components/v2useroperationbody.md +2 -2
  140. package/docs/models/components/vaultdepositrequest.md +4 -4
  141. package/docs/models/components/vaultdepositrequestamount.md +2 -2
  142. package/docs/models/components/vaultvenue.md +1 -1
  143. package/docs/models/components/vaultwithdrawrequest.md +3 -3
  144. package/docs/models/components/vaultwithdrawrequestchain.md +1 -1
  145. package/docs/models/components/wrapethrequest.md +3 -3
  146. package/docs/models/components/wrapethrequestamount.md +2 -2
  147. package/docs/models/components/wrapethrequestchain.md +1 -1
  148. package/package.json +1 -1
@@ -31,18 +31,18 @@ let value: AaveLoopRequest = {
31
31
 
32
32
  ## Fields
33
33
 
34
- | Field | Type | Required | Description | Example |
35
- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
36
- | `chain` | [components.AaveLoopRequestChain](../../models/components/aavelooprequestchain.md) | :heavy_check_mark: | N/A | |
37
- | `sender` | *string* | :heavy_check_mark: | The address of the transaction sender. | |
38
- | `estimateGas` | *boolean* | :heavy_minus_sign: | Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed. | true |
39
- | `signedAuthorization` | [components.SignedAuthorization](../../models/components/signedauthorization.md) | :heavy_minus_sign: | EIP-7702 authorization. Required when `is_account_abstraction` is False. | |
40
- | `collateralToken` | *string* | :heavy_check_mark: | Symbol or address of token to supply to Aave.. | |
41
- | `borrowToken` | *string* | :heavy_check_mark: | Symbol or address of token to borrow from Aave.. | |
42
- | `initialCollateralAmount` | *components.InitialCollateralAmount* | :heavy_check_mark: | Amount of collateral token to supply to Aave | |
43
- | `multiplier` | *components.Multiplier* | :heavy_check_mark: | Leverage multiplier. Total loop collateral will be calculated as `multiplier` x `initial_collateral_amount` | |
44
- | `maxSlippagePercent` | *components.MaxSlippagePercent* | :heavy_check_mark: | Maximum allowed slippage for token swaps in percentage | |
45
- | `loanToValue` | *components.LoanToValue* | :heavy_check_mark: | Loan To Value percentage of the loop | |
46
- | `emodeCategory` | *number* | :heavy_minus_sign: | Aave E-Mode category ID to set before executing the loop. If not provided, E-Mode will not be changed. | |
47
- | `isAccountAbstraction` | *boolean* | :heavy_minus_sign: | Whether to use account abstraction for the transaction. | false |
48
- | `accountOwner` | *string* | :heavy_minus_sign: | The owner address of the smart account (Safe). Required when `is_account_abstraction` is True. This address will be used as the 'from' address when building the execTransaction call. | |
34
+ | Field | Type | Required | Description | Example |
35
+ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
36
+ | `chain` | [components.AaveLoopRequestChain](../../models/components/aavelooprequestchain.md) | :heavy_check_mark: | N/A | arbitrum |
37
+ | `sender` | *string* | :heavy_check_mark: | The address of the transaction sender. | 0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B |
38
+ | `estimateGas` | *boolean* | :heavy_minus_sign: | Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed. | true |
39
+ | `signedAuthorization` | [components.SignedAuthorization](../../models/components/signedauthorization.md) | :heavy_minus_sign: | EIP-7702 authorization. Required when `is_account_abstraction` is False. | {<br/>"address": "0xcA11bde05977b3631167028862bE2a173976CA11",<br/>"chainId": 42161,<br/>"nonce": 1000,<br/>"r": "0x5f9f3f3226ac91bc01a72dd117141f6c6de1ed30d3af9f95c3423316dc21d615",<br/>"s": "0x78f7982ede9dabc53d7153974c5692fda8a21fc73bdafc42aaf135505e22817c",<br/>"yParity": 0<br/>} |
40
+ | `collateralToken` | *string* | :heavy_check_mark: | Symbol or address of token to supply to Aave.. | USDC |
41
+ | `borrowToken` | *string* | :heavy_check_mark: | Symbol or address of token to borrow from Aave.. | WETH |
42
+ | `initialCollateralAmount` | *components.InitialCollateralAmount* | :heavy_check_mark: | Amount of collateral token to supply to Aave | 1000 |
43
+ | `multiplier` | *components.Multiplier* | :heavy_check_mark: | Leverage multiplier. Total loop collateral will be calculated as `multiplier` x `initial_collateral_amount` | 2.5 |
44
+ | `maxSlippagePercent` | *components.MaxSlippagePercent* | :heavy_check_mark: | Maximum allowed slippage for token swaps in percentage | 0.5 |
45
+ | `loanToValue` | *components.LoanToValue* | :heavy_check_mark: | Loan To Value percentage of the loop | 60 |
46
+ | `emodeCategory` | *number* | :heavy_minus_sign: | Aave E-Mode category ID to set before executing the loop. If not provided, E-Mode will not be changed. | |
47
+ | `isAccountAbstraction` | *boolean* | :heavy_minus_sign: | Whether to use account abstraction for the transaction. | false |
48
+ | `accountOwner` | *string* | :heavy_minus_sign: | The owner address of the smart account (Safe). Required when `is_account_abstraction` is True. This address will be used as the 'from' address when building the execTransaction call. | |
@@ -20,10 +20,10 @@ let value: AaveRepayRequest = {
20
20
  | Field | Type | Required | Description | Example |
21
21
  | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
22
22
  | `actionType` | *"AAVE_REPAY"* | :heavy_minus_sign: | N/A | AAVE_REPAY |
23
- | `token` | *string* | :heavy_check_mark: | The symbol of the underlying asset to repay.. | |
24
- | `amount` | *components.AaveRepayRequestAmount* | :heavy_check_mark: | The amount of the asset to repay | |
23
+ | `token` | *string* | :heavy_check_mark: | The symbol of the underlying asset to repay.. | USDC |
24
+ | `amount` | *components.AaveRepayRequestAmount* | :heavy_check_mark: | The amount of the asset to repay | 0.2 |
25
25
  | `interestRateMode` | [components.InterestRateMode](../../models/components/interestratemode.md) | :heavy_check_mark: | On AAVE there are 2 different interest modes.<br/><br/>A stable (but typically higher rate), or a variable rate. | |
26
- | `onBehalfOf` | *string* | :heavy_minus_sign: | The address on behalf of whom the supply is made | |
27
- | `chain` | [components.AaveRepayRequestChain](../../models/components/aaverepayrequestchain.md) | :heavy_check_mark: | N/A | |
28
- | `sender` | *string* | :heavy_check_mark: | The address of the transaction sender. | |
26
+ | `onBehalfOf` | *string* | :heavy_minus_sign: | The address on behalf of whom the supply is made | 0x3254f3b1918637ba924e3F18968Cb74219974b63 |
27
+ | `chain` | [components.AaveRepayRequestChain](../../models/components/aaverepayrequestchain.md) | :heavy_check_mark: | N/A | base |
28
+ | `sender` | *string* | :heavy_check_mark: | The address of the transaction sender. | 0x3254f3b1918637ba924e3F18968Cb74219974b63 |
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 |
@@ -8,12 +8,12 @@ The amount of the asset to repay
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
 
@@ -5,7 +5,7 @@
5
5
  ```typescript
6
6
  import { AaveRepayRequestChain } from "@compass-labs/api-sdk/models/components";
7
7
 
8
- let value: AaveRepayRequestChain = "arbitrum";
8
+ let value: AaveRepayRequestChain = "base";
9
9
  ```
10
10
 
11
11
  ## Values
@@ -17,7 +17,7 @@ let value: AaveSetUserEModeRequest = {
17
17
  | Field | Type | Required | Description | Example |
18
18
  | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
19
19
  | `actionType` | *"AAVE_SET_USER_EMODE"* | :heavy_minus_sign: | N/A | AAVE_SET_USER_EMODE |
20
- | `categoryId` | *number* | :heavy_check_mark: | The eMode category ID to set for the user. 0 = no eMode, 1+ = specific eMode category. | |
21
- | `chain` | [components.AaveSetUserEModeRequestChain](../../models/components/aavesetuseremoderequestchain.md) | :heavy_check_mark: | N/A | |
22
- | `sender` | *string* | :heavy_check_mark: | The address of the transaction sender. | |
20
+ | `categoryId` | *number* | :heavy_check_mark: | The eMode category ID to set for the user. 0 = no eMode, 1+ = specific eMode category. | 2 |
21
+ | `chain` | [components.AaveSetUserEModeRequestChain](../../models/components/aavesetuseremoderequestchain.md) | :heavy_check_mark: | N/A | base |
22
+ | `sender` | *string* | :heavy_check_mark: | The address of the transaction sender. | 0xBa5e0D5cB0e661Bd6E68d8D667ceCb87aa0F95C1 |
23
23
  | `estimateGas` | *boolean* | :heavy_minus_sign: | Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed. | true |
@@ -5,7 +5,7 @@
5
5
  ```typescript
6
6
  import { AaveSetUserEModeRequestChain } from "@compass-labs/api-sdk/models/components";
7
7
 
8
- let value: AaveSetUserEModeRequestChain = "arbitrum";
8
+ let value: AaveSetUserEModeRequestChain = "base";
9
9
  ```
10
10
 
11
11
  ## Values
@@ -18,9 +18,9 @@ let value: AaveSupplyRequest = {
18
18
  | Field | Type | Required | Description | Example |
19
19
  | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
20
20
  | `actionType` | *"AAVE_SUPPLY"* | :heavy_minus_sign: | N/A | AAVE_SUPPLY |
21
- | `token` | *string* | :heavy_check_mark: | The symbol or address of the underlying asset to supply as collateral. You can borrow against it.. | |
22
- | `amount` | *components.AaveSupplyRequestAmount* | :heavy_check_mark: | The amount of the asset to supply | |
21
+ | `token` | *string* | :heavy_check_mark: | The symbol or address of the underlying asset to supply as collateral. You can borrow against it.. | USDC |
22
+ | `amount` | *components.AaveSupplyRequestAmount* | :heavy_check_mark: | The amount of the asset to supply | 0.5 |
23
23
  | `onBehalfOf` | *string* | :heavy_minus_sign: | The address on behalf of whom the supply is made. Defaults to the transaction sender. | |
24
- | `chain` | [components.AaveSupplyRequestChain](../../models/components/aavesupplyrequestchain.md) | :heavy_check_mark: | N/A | |
25
- | `sender` | *string* | :heavy_check_mark: | The address of the transaction sender. | |
24
+ | `chain` | [components.AaveSupplyRequestChain](../../models/components/aavesupplyrequestchain.md) | :heavy_check_mark: | N/A | base |
25
+ | `sender` | *string* | :heavy_check_mark: | The address of the transaction sender. | 0x466C298e40c57e1DfD364443B364DFB2717BF882 |
26
26
  | `estimateGas` | *boolean* | :heavy_minus_sign: | Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed. | true |
@@ -8,12 +8,12 @@ The amount of the asset to supply
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
 
@@ -5,7 +5,7 @@
5
5
  ```typescript
6
6
  import { AaveSupplyRequestChain } from "@compass-labs/api-sdk/models/components";
7
7
 
8
- let value: AaveSupplyRequestChain = "ethereum";
8
+ let value: AaveSupplyRequestChain = "base";
9
9
  ```
10
10
 
11
11
  ## Values
@@ -19,9 +19,9 @@ let value: AaveWithdrawRequest = {
19
19
  | Field | Type | Required | Description | Example |
20
20
  | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
21
21
  | `actionType` | *"AAVE_WITHDRAW"* | :heavy_minus_sign: | N/A | AAVE_WITHDRAW |
22
- | `token` | *string* | :heavy_check_mark: | The symbol of the underlying asset to withdraw.. | |
23
- | `amount` | *components.AaveWithdrawRequestAmount* | :heavy_check_mark: | The amount of the asset to withdraw | |
24
- | `recipient` | *string* | :heavy_check_mark: | The address of the recipient of the withdrawn funds. | |
25
- | `chain` | [components.AaveWithdrawRequestChain](../../models/components/aavewithdrawrequestchain.md) | :heavy_check_mark: | N/A | |
26
- | `sender` | *string* | :heavy_check_mark: | The address of the transaction sender. | |
22
+ | `token` | *string* | :heavy_check_mark: | The symbol of the underlying asset to withdraw.. | USDC |
23
+ | `amount` | *components.AaveWithdrawRequestAmount* | :heavy_check_mark: | The amount of the asset to withdraw | 0.5 |
24
+ | `recipient` | *string* | :heavy_check_mark: | The address of the recipient of the withdrawn funds. | 0x388f03DABdc414E11da8Da63198D183C82836866 |
25
+ | `chain` | [components.AaveWithdrawRequestChain](../../models/components/aavewithdrawrequestchain.md) | :heavy_check_mark: | N/A | base |
26
+ | `sender` | *string* | :heavy_check_mark: | The address of the transaction sender. | 0x388f03DABdc414E11da8Da63198D183C82836866 |
27
27
  | `estimateGas` | *boolean* | :heavy_minus_sign: | Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed. | true |
@@ -8,12 +8,12 @@ The amount of the asset to withdraw
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
 
@@ -5,7 +5,7 @@
5
5
  ```typescript
6
6
  import { AaveWithdrawRequestChain } from "@compass-labs/api-sdk/models/components";
7
7
 
8
- let value: AaveWithdrawRequestChain = "arbitrum";
8
+ let value: AaveWithdrawRequestChain = "base";
9
9
  ```
10
10
 
11
11
  ## Values
@@ -23,11 +23,11 @@ let value: AerodromeSlipstreamBuyExactlyRequest = {
23
23
  | Field | Type | Required | Description | Example |
24
24
  | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
25
25
  | `actionType` | *"AERODROME_SLIPSTREAM_BUY_EXACTLY"* | :heavy_minus_sign: | N/A | AERODROME_SLIPSTREAM_BUY_EXACTLY |
26
- | `tokenIn` | *string* | :heavy_check_mark: | The symbol of the token to swap from. | |
27
- | `tokenOut` | *string* | :heavy_check_mark: | The symbol of the token to swap to. | |
28
- | `tickSpacing` | *number* | :heavy_check_mark: | The tick spacing of the pool | |
29
- | `amountOut` | *components.AerodromeSlipstreamBuyExactlyRequestAmountOut* | :heavy_check_mark: | The amount of the token to swap to | |
30
- | `amountInMaximum` | *components.AerodromeSlipstreamBuyExactlyRequestAmountInMaximum* | :heavy_check_mark: | The maximum amount of the token to swap from | |
31
- | `chain` | [components.AerodromeSlipstreamBuyExactlyRequestChain](../../models/components/aerodromeslipstreambuyexactlyrequestchain.md) | :heavy_check_mark: | N/A | |
32
- | `sender` | *string* | :heavy_check_mark: | The address of the transaction sender. | |
26
+ | `tokenIn` | *string* | :heavy_check_mark: | The symbol of the token to swap from. | USDC |
27
+ | `tokenOut` | *string* | :heavy_check_mark: | The symbol of the token to swap to. | WETH |
28
+ | `tickSpacing` | *number* | :heavy_check_mark: | The tick spacing of the pool | 100 |
29
+ | `amountOut` | *components.AerodromeSlipstreamBuyExactlyRequestAmountOut* | :heavy_check_mark: | The amount of the token to swap to | 1e-05 |
30
+ | `amountInMaximum` | *components.AerodromeSlipstreamBuyExactlyRequestAmountInMaximum* | :heavy_check_mark: | The maximum amount of the token to swap from | 0.1 |
31
+ | `chain` | [components.AerodromeSlipstreamBuyExactlyRequestChain](../../models/components/aerodromeslipstreambuyexactlyrequestchain.md) | :heavy_check_mark: | N/A | base |
32
+ | `sender` | *string* | :heavy_check_mark: | The address of the transaction sender. | 0xA4C4fB06093C91E70528d4029050f358c4B065EE |
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 |
@@ -8,12 +8,12 @@ The maximum amount of the token to swap from
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
 
@@ -8,12 +8,12 @@ The amount of the token to swap to
8
8
  ### `number`
9
9
 
10
10
  ```typescript
11
- const value: number = 1284.03;
11
+ const value: number = 0.00001;
12
12
  ```
13
13
 
14
14
  ### `string`
15
15
 
16
16
  ```typescript
17
- const value: string = "<value>";
17
+ const value: string = "0.00001";
18
18
  ```
19
19
 
@@ -21,11 +21,11 @@ let value: AerodromeSlipstreamIncreaseLiquidityProvisionRequest = {
21
21
  | Field | Type | Required | Description | Example |
22
22
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
23
23
  | `actionType` | *"AERODROME_SLIPSTREAM_INCREASE_LIQUIDITY_PROVISION"* | :heavy_minus_sign: | N/A | AERODROME_SLIPSTREAM_INCREASE_LIQUIDITY_PROVISION |
24
- | `tokenId` | *number* | :heavy_check_mark: | Token ID of the NFT representing the liquidity provisioned position. | |
25
- | `amount0Desired` | *components.AerodromeSlipstreamIncreaseLiquidityProvisionRequestAmount0Desired* | :heavy_check_mark: | The desired amount of the first token to deposit | |
26
- | `amount1Desired` | *components.AerodromeSlipstreamIncreaseLiquidityProvisionRequestAmount1Desired* | :heavy_check_mark: | The desired amount of the second token to deposit | |
27
- | `amount0Min` | *components.AerodromeSlipstreamIncreaseLiquidityProvisionRequestAmount0Min* | :heavy_check_mark: | The minimum amount of the first token to deposit | |
28
- | `amount1Min` | *components.AerodromeSlipstreamIncreaseLiquidityProvisionRequestAmount1Min* | :heavy_check_mark: | The minimum amount of the second token to deposit | |
29
- | `chain` | [components.AerodromeSlipstreamIncreaseLiquidityProvisionRequestChain](../../models/components/aerodromeslipstreamincreaseliquidityprovisionrequestchain.md) | :heavy_check_mark: | N/A | |
30
- | `sender` | *string* | :heavy_check_mark: | The address of the transaction sender. | |
24
+ | `tokenId` | *number* | :heavy_check_mark: | Token ID of the NFT representing the liquidity provisioned position. | 17570780 |
25
+ | `amount0Desired` | *components.AerodromeSlipstreamIncreaseLiquidityProvisionRequestAmount0Desired* | :heavy_check_mark: | The desired amount of the first token to deposit | 0.02 |
26
+ | `amount1Desired` | *components.AerodromeSlipstreamIncreaseLiquidityProvisionRequestAmount1Desired* | :heavy_check_mark: | The desired amount of the second token to deposit | 0.01 |
27
+ | `amount0Min` | *components.AerodromeSlipstreamIncreaseLiquidityProvisionRequestAmount0Min* | :heavy_check_mark: | The minimum amount of the first token to deposit | 0 |
28
+ | `amount1Min` | *components.AerodromeSlipstreamIncreaseLiquidityProvisionRequestAmount1Min* | :heavy_check_mark: | The minimum amount of the second token to deposit | 0 |
29
+ | `chain` | [components.AerodromeSlipstreamIncreaseLiquidityProvisionRequestChain](../../models/components/aerodromeslipstreamincreaseliquidityprovisionrequestchain.md) | :heavy_check_mark: | N/A | base |
30
+ | `sender` | *string* | :heavy_check_mark: | The address of the transaction sender. | 0x46D00E3Dc6E9B788B9730Ab38433a16CB55EDd7a |
31
31
  | `estimateGas` | *boolean* | :heavy_minus_sign: | Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed. | true |
@@ -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.02;
12
12
  ```
13
13
 
14
14
  ### `string`
15
15
 
16
16
  ```typescript
17
- const value: string = "<value>";
17
+ const value: string = "0.02";
18
18
  ```
19
19
 
@@ -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
 
@@ -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.01;
12
12
  ```
13
13
 
14
14
  ### `string`
15
15
 
16
16
  ```typescript
17
- const value: string = "<value>";
17
+ const value: string = "0.01";
18
18
  ```
19
19
 
@@ -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
 
@@ -28,16 +28,16 @@ let value: AerodromeSlipstreamMintLiquidityProvisionRequest = {
28
28
  | Field | Type | Required | Description | Example |
29
29
  | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
30
30
  | `actionType` | *"AERODROME_SLIPSTREAM_MINT_LIQUIDITY_PROVISION"* | :heavy_minus_sign: | N/A | AERODROME_SLIPSTREAM_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. | |
33
- | `tickSpacing` | *number* | :heavy_check_mark: | The tick spacing of the pool | |
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.AerodromeSlipstreamMintLiquidityProvisionRequestAmount0Desired* | :heavy_check_mark: | The desired amount of the first token to deposit | |
37
- | `amount1Desired` | *components.AerodromeSlipstreamMintLiquidityProvisionRequestAmount1Desired* | :heavy_check_mark: | The desired amount of the second token to deposit | |
38
- | `amount0Min` | *components.AerodromeSlipstreamMintLiquidityProvisionRequestAmount0Min* | :heavy_check_mark: | The minimum amount of the first token to deposit | |
39
- | `amount1Min` | *components.AerodromeSlipstreamMintLiquidityProvisionRequestAmount1Min* | :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.AerodromeSlipstreamMintLiquidityProvisionRequestChain](../../models/components/aerodromeslipstreammintliquidityprovisionrequestchain.md) | :heavy_check_mark: | N/A | |
42
- | `sender` | *string* | :heavy_check_mark: | The address of the transaction sender. | |
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
+ | `tickSpacing` | *number* | :heavy_check_mark: | The tick spacing of the pool | 1 |
34
+ | `tickLower` | *number* | :heavy_check_mark: | The lower tick of the range to mint the position in | 100 |
35
+ | `tickUpper` | *number* | :heavy_check_mark: | The upper tick of the range to mint the position in | 200 |
36
+ | `amount0Desired` | *components.AerodromeSlipstreamMintLiquidityProvisionRequestAmount0Desired* | :heavy_check_mark: | The desired amount of the first token to deposit | 0.01 |
37
+ | `amount1Desired` | *components.AerodromeSlipstreamMintLiquidityProvisionRequestAmount1Desired* | :heavy_check_mark: | The desired amount of the second token to deposit | 0 |
38
+ | `amount0Min` | *components.AerodromeSlipstreamMintLiquidityProvisionRequestAmount0Min* | :heavy_check_mark: | The minimum amount of the first token to deposit | 0 |
39
+ | `amount1Min` | *components.AerodromeSlipstreamMintLiquidityProvisionRequestAmount1Min* | :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 | 0x46D00E3Dc6E9B788B9730Ab38433a16CB55EDd7a |
41
+ | `chain` | [components.AerodromeSlipstreamMintLiquidityProvisionRequestChain](../../models/components/aerodromeslipstreammintliquidityprovisionrequestchain.md) | :heavy_check_mark: | N/A | base |
42
+ | `sender` | *string* | :heavy_check_mark: | The address of the transaction sender. | 0x46D00E3Dc6E9B788B9730Ab38433a16CB55EDd7a |
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 |
@@ -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.01;
12
12
  ```
13
13
 
14
14
  ### `string`
15
15
 
16
16
  ```typescript
17
- const value: string = "<value>";
17
+ const value: string = "0.01";
18
18
  ```
19
19