@compass-labs/api-sdk 2.1.14 → 2.1.15-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 (140) hide show
  1. package/README.md +20 -18
  2. package/codeSamples_typescript.yaml +8 -2
  3. package/dist/commonjs/funcs/earnEarnBundle.d.ts +33 -0
  4. package/dist/commonjs/funcs/earnEarnBundle.d.ts.map +1 -0
  5. package/dist/commonjs/funcs/earnEarnBundle.js +133 -0
  6. package/dist/commonjs/funcs/earnEarnBundle.js.map +1 -0
  7. package/dist/commonjs/lib/config.d.ts +2 -2
  8. package/dist/commonjs/lib/config.js +2 -2
  9. package/dist/commonjs/models/components/earnmanageparams.d.ts +63 -0
  10. package/dist/commonjs/models/components/earnmanageparams.d.ts.map +1 -0
  11. package/dist/commonjs/models/components/earnmanageparams.js +74 -0
  12. package/dist/commonjs/models/components/earnmanageparams.js.map +1 -0
  13. package/dist/commonjs/models/components/earnmanagerequest.d.ts +25 -13
  14. package/dist/commonjs/models/components/earnmanagerequest.d.ts.map +1 -1
  15. package/dist/commonjs/models/components/earnmanagerequest.js +9 -7
  16. package/dist/commonjs/models/components/earnmanagerequest.js.map +1 -1
  17. package/dist/commonjs/models/components/earnswapparams.d.ts +60 -0
  18. package/dist/commonjs/models/components/earnswapparams.d.ts.map +1 -0
  19. package/dist/commonjs/models/components/earnswapparams.js +73 -0
  20. package/dist/commonjs/models/components/earnswapparams.js.map +1 -0
  21. package/dist/commonjs/models/components/earnswaprequest.d.ts +26 -14
  22. package/dist/commonjs/models/components/earnswaprequest.d.ts.map +1 -1
  23. package/dist/commonjs/models/components/earnswaprequest.js +10 -8
  24. package/dist/commonjs/models/components/earnswaprequest.js.map +1 -1
  25. package/dist/commonjs/models/components/index.d.ts +5 -0
  26. package/dist/commonjs/models/components/index.d.ts.map +1 -1
  27. package/dist/commonjs/models/components/index.js +5 -0
  28. package/dist/commonjs/models/components/index.js.map +1 -1
  29. package/dist/commonjs/models/components/useroperation.d.ts +4 -4
  30. package/dist/commonjs/models/components/useroperation.d.ts.map +1 -1
  31. package/dist/commonjs/models/components/useroperation.js +5 -5
  32. package/dist/commonjs/models/components/useroperation.js.map +1 -1
  33. package/dist/commonjs/models/components/v2bundlerequest.d.ts +43 -0
  34. package/dist/commonjs/models/components/v2bundlerequest.d.ts.map +1 -0
  35. package/dist/commonjs/models/components/v2bundlerequest.js +59 -0
  36. package/dist/commonjs/models/components/v2bundlerequest.js.map +1 -0
  37. package/dist/commonjs/models/components/v2bundleresponse.d.ts +31 -0
  38. package/dist/commonjs/models/components/v2bundleresponse.d.ts.map +1 -0
  39. package/dist/commonjs/models/components/v2bundleresponse.js +61 -0
  40. package/dist/commonjs/models/components/v2bundleresponse.js.map +1 -0
  41. package/dist/commonjs/models/components/v2useroperation.d.ts +23 -0
  42. package/dist/commonjs/models/components/v2useroperation.d.ts.map +1 -0
  43. package/dist/commonjs/models/components/v2useroperation.js +60 -0
  44. package/dist/commonjs/models/components/v2useroperation.js.map +1 -0
  45. package/dist/commonjs/sdk/earn.d.ts +22 -0
  46. package/dist/commonjs/sdk/earn.d.ts.map +1 -1
  47. package/dist/commonjs/sdk/earn.js +25 -0
  48. package/dist/commonjs/sdk/earn.js.map +1 -1
  49. package/dist/esm/funcs/earnEarnBundle.d.ts +33 -0
  50. package/dist/esm/funcs/earnEarnBundle.d.ts.map +1 -0
  51. package/dist/esm/funcs/earnEarnBundle.js +97 -0
  52. package/dist/esm/funcs/earnEarnBundle.js.map +1 -0
  53. package/dist/esm/lib/config.d.ts +2 -2
  54. package/dist/esm/lib/config.js +2 -2
  55. package/dist/esm/models/components/earnmanageparams.d.ts +63 -0
  56. package/dist/esm/models/components/earnmanageparams.d.ts.map +1 -0
  57. package/dist/esm/models/components/earnmanageparams.js +36 -0
  58. package/dist/esm/models/components/earnmanageparams.js.map +1 -0
  59. package/dist/esm/models/components/earnmanagerequest.d.ts +25 -13
  60. package/dist/esm/models/components/earnmanagerequest.d.ts.map +1 -1
  61. package/dist/esm/models/components/earnmanagerequest.js +7 -5
  62. package/dist/esm/models/components/earnmanagerequest.js.map +1 -1
  63. package/dist/esm/models/components/earnswapparams.d.ts +60 -0
  64. package/dist/esm/models/components/earnswapparams.d.ts.map +1 -0
  65. package/dist/esm/models/components/earnswapparams.js +34 -0
  66. package/dist/esm/models/components/earnswapparams.js.map +1 -0
  67. package/dist/esm/models/components/earnswaprequest.d.ts +26 -14
  68. package/dist/esm/models/components/earnswaprequest.d.ts.map +1 -1
  69. package/dist/esm/models/components/earnswaprequest.js +8 -6
  70. package/dist/esm/models/components/earnswaprequest.js.map +1 -1
  71. package/dist/esm/models/components/index.d.ts +5 -0
  72. package/dist/esm/models/components/index.d.ts.map +1 -1
  73. package/dist/esm/models/components/index.js +5 -0
  74. package/dist/esm/models/components/index.js.map +1 -1
  75. package/dist/esm/models/components/useroperation.d.ts +4 -4
  76. package/dist/esm/models/components/useroperation.d.ts.map +1 -1
  77. package/dist/esm/models/components/useroperation.js +3 -3
  78. package/dist/esm/models/components/useroperation.js.map +1 -1
  79. package/dist/esm/models/components/v2bundlerequest.d.ts +43 -0
  80. package/dist/esm/models/components/v2bundlerequest.d.ts.map +1 -0
  81. package/dist/esm/models/components/v2bundlerequest.js +22 -0
  82. package/dist/esm/models/components/v2bundlerequest.js.map +1 -0
  83. package/dist/esm/models/components/v2bundleresponse.d.ts +31 -0
  84. package/dist/esm/models/components/v2bundleresponse.d.ts.map +1 -0
  85. package/dist/esm/models/components/v2bundleresponse.js +24 -0
  86. package/dist/esm/models/components/v2bundleresponse.js.map +1 -0
  87. package/dist/esm/models/components/v2useroperation.d.ts +23 -0
  88. package/dist/esm/models/components/v2useroperation.d.ts.map +1 -0
  89. package/dist/esm/models/components/v2useroperation.js +22 -0
  90. package/dist/esm/models/components/v2useroperation.js.map +1 -0
  91. package/dist/esm/sdk/earn.d.ts +22 -0
  92. package/dist/esm/sdk/earn.d.ts.map +1 -1
  93. package/dist/esm/sdk/earn.js +25 -0
  94. package/dist/esm/sdk/earn.js.map +1 -1
  95. package/docs/models/components/earnmanageparams.md +31 -0
  96. package/docs/models/components/earnmanageparamsaction.md +17 -0
  97. package/docs/models/components/{venue.md → earnmanageparamsvenue.md} +1 -1
  98. package/docs/models/components/earnmanagerequest.md +12 -6
  99. package/docs/models/components/earnmanagerequestvenue.md +25 -0
  100. package/docs/models/components/earnswapparams.md +29 -0
  101. package/docs/models/components/earnswapparamsamountin.md +19 -0
  102. package/docs/models/components/{slippage.md → earnswapparamsslippage.md} +3 -3
  103. package/docs/models/components/earnswaprequest.md +10 -5
  104. package/docs/models/components/earnswaprequestslippage.md +19 -0
  105. package/docs/models/components/useroperation.md +3 -3
  106. package/docs/models/components/{body.md → useroperationbody.md} +1 -1
  107. package/docs/models/components/v2bundlerequest.md +52 -0
  108. package/docs/models/components/v2bundleresponse.md +24 -0
  109. package/docs/models/components/v2useroperation.md +27 -0
  110. package/docs/models/components/v2useroperationbody.md +31 -0
  111. package/docs/sdks/aavev3/README.md +0 -1
  112. package/docs/sdks/aerodromeslipstream/README.md +0 -1
  113. package/docs/sdks/bridge/README.md +0 -1
  114. package/docs/sdks/earn/README.md +150 -11
  115. package/docs/sdks/erc4626vaults/README.md +1 -2
  116. package/docs/sdks/ethena/README.md +0 -1
  117. package/docs/sdks/gassponsorship/README.md +0 -1
  118. package/docs/sdks/morpho/README.md +0 -1
  119. package/docs/sdks/pendle/README.md +0 -1
  120. package/docs/sdks/sky/README.md +0 -1
  121. package/docs/sdks/smartaccount/README.md +0 -1
  122. package/docs/sdks/swap/README.md +0 -1
  123. package/docs/sdks/token/README.md +0 -1
  124. package/docs/sdks/transactionbundler/README.md +0 -1
  125. package/docs/sdks/uniswapv3/README.md +0 -1
  126. package/docs/sdks/universal/README.md +0 -1
  127. package/docs/sdks/wildcat/README.md +0 -1
  128. package/package.json +1 -1
  129. package/src/funcs/earnEarnBundle.ts +184 -0
  130. package/src/lib/config.ts +2 -2
  131. package/src/models/components/earnmanageparams.ts +118 -0
  132. package/src/models/components/earnmanagerequest.ts +38 -18
  133. package/src/models/components/earnswapparams.ts +115 -0
  134. package/src/models/components/earnswaprequest.ts +38 -20
  135. package/src/models/components/index.ts +5 -0
  136. package/src/models/components/useroperation.ts +52 -45
  137. package/src/models/components/v2bundlerequest.ts +72 -0
  138. package/src/models/components/v2bundleresponse.ts +67 -0
  139. package/src/models/components/v2useroperation.ts +67 -0
  140. package/src/sdk/earn.ts +33 -0
package/README.md CHANGED
@@ -139,7 +139,7 @@ run();
139
139
  <details open>
140
140
  <summary>Available methods</summary>
141
141
 
142
- ### [aaveV3](docs/sdks/aavev3/README.md)
142
+ ### [AaveV3](docs/sdks/aavev3/README.md)
143
143
 
144
144
  * [aaveAaveSupportedTokens](docs/sdks/aavev3/README.md#aaveaavesupportedtokens) - Aave Supported Tokens
145
145
  * [aaveRate](docs/sdks/aavev3/README.md#aaverate) - Interest Rates
@@ -156,7 +156,7 @@ run();
156
156
  * [aaveRepay](docs/sdks/aavev3/README.md#aaverepay) - Repay Loans
157
157
  * [aaveWithdraw](docs/sdks/aavev3/README.md#aavewithdraw) - Unstake
158
158
 
159
- ### [aerodromeSlipstream](docs/sdks/aerodromeslipstream/README.md)
159
+ ### [AerodromeSlipstream](docs/sdks/aerodromeslipstream/README.md)
160
160
 
161
161
  * [aerodromeSlipstreamLiquidityProvisionPositions](docs/sdks/aerodromeslipstream/README.md#aerodromeslipstreamliquidityprovisionpositions) - List LP Positions
162
162
  * [aerodromeSlipstreamPoolPrice](docs/sdks/aerodromeslipstream/README.md#aerodromeslipstreampoolprice) - Pool Price
@@ -166,12 +166,12 @@ run();
166
166
  * [aerodromeSlipstreamLiquidityProvisionIncrease](docs/sdks/aerodromeslipstream/README.md#aerodromeslipstreamliquidityprovisionincrease) - Increase an LP Position
167
167
  * [aerodromeSlipstreamLiquidityProvisionWithdraw](docs/sdks/aerodromeslipstream/README.md#aerodromeslipstreamliquidityprovisionwithdraw) - Withdraw an LP Position
168
168
 
169
- ### [bridge](docs/sdks/bridge/README.md)
169
+ ### [Bridge](docs/sdks/bridge/README.md)
170
170
 
171
171
  * [cctpBurn](docs/sdks/bridge/README.md#cctpburn) - Initiate USDC bridging
172
172
  * [cctpMint](docs/sdks/bridge/README.md#cctpmint) - Complete USDC bridging
173
173
 
174
- ### [earn](docs/sdks/earn/README.md)
174
+ ### [Earn](docs/sdks/earn/README.md)
175
175
 
176
176
  * [earnPositions](docs/sdks/earn/README.md#earnpositions) - List earn positions
177
177
  * [earnPositionsPositionId](docs/sdks/earn/README.md#earnpositionspositionid) - Get earn position
@@ -181,26 +181,27 @@ run();
181
181
  * [earnTransfer](docs/sdks/earn/README.md#earntransfer) - Transfer tokens to/from account
182
182
  * [earnManage](docs/sdks/earn/README.md#earnmanage) - Manage earn position
183
183
  * [earnSwap](docs/sdks/earn/README.md#earnswap) - Swap tokens within Earn Account
184
+ * [earnBundle](docs/sdks/earn/README.md#earnbundle) - Bundle multiple actions into a single transaction
184
185
 
185
- ### [erc4626Vaults](docs/sdks/erc4626vaults/README.md)
186
+ ### [ERC4626Vaults](docs/sdks/erc4626vaults/README.md)
186
187
 
187
188
  * [vaultsVault](docs/sdks/erc4626vaults/README.md#vaultsvault) - Get Vault & User Position
188
189
  * [vaultsDeposit](docs/sdks/erc4626vaults/README.md#vaultsdeposit) - Deposit to Vault
189
190
  * [vaultsWithdraw](docs/sdks/erc4626vaults/README.md#vaultswithdraw) - Withdraw from Vault
190
191
 
191
- ### [ethena](docs/sdks/ethena/README.md)
192
+ ### [Ethena](docs/sdks/ethena/README.md)
192
193
 
193
194
  * [ethenaVault](docs/sdks/ethena/README.md#ethenavault) - Get Vault & User Position
194
195
  * [ethenaDeposit](docs/sdks/ethena/README.md#ethenadeposit) - Deposit USDe
195
196
  * [ethenaRequest](docs/sdks/ethena/README.md#ethenarequest) - Request to Withdraw USDe
196
197
  * [ethenaUnstake](docs/sdks/ethena/README.md#ethenaunstake) - Unstake USDe
197
198
 
198
- ### [gasSponsorship](docs/sdks/gassponsorship/README.md)
199
+ ### [GasSponsorship](docs/sdks/gassponsorship/README.md)
199
200
 
200
201
  * [gasSponsorshipPrepare](docs/sdks/gassponsorship/README.md#gassponsorshipprepare) - Prepare gas-sponsored transaction
201
202
  * [gasSponsorshipApproveTransfer](docs/sdks/gassponsorship/README.md#gassponsorshipapprovetransfer) - Approve token transfer
202
203
 
203
- ### [morpho](docs/sdks/morpho/README.md)
204
+ ### [Morpho](docs/sdks/morpho/README.md)
204
205
 
205
206
  * [morphoVaults](docs/sdks/morpho/README.md#morphovaults) - Get Vaults
206
207
  * [morphoVault](docs/sdks/morpho/README.md#morphovault) - Get Vault & User Position
@@ -215,7 +216,7 @@ run();
215
216
  * [morphoBorrow](docs/sdks/morpho/README.md#morphoborrow) - Borrow from Market
216
217
  * [morphoRepay](docs/sdks/morpho/README.md#morphorepay) - Repay to Market
217
218
 
218
- ### [pendle](docs/sdks/pendle/README.md)
219
+ ### [Pendle](docs/sdks/pendle/README.md)
219
220
 
220
221
  * [pendleMarket](docs/sdks/pendle/README.md#pendlemarket) - Get Market & User Position
221
222
  * [pendlePositions](docs/sdks/pendle/README.md#pendlepositions) - List User's Market Positions
@@ -225,7 +226,7 @@ run();
225
226
  * [pendleLiquidity](docs/sdks/pendle/README.md#pendleliquidity) - Manage Liquidity (LP)
226
227
  * [pendleRedeemYield](docs/sdks/pendle/README.md#pendleredeemyield) - Redeem Claimable Yield
227
228
 
228
- ### [sky](docs/sdks/sky/README.md)
229
+ ### [Sky](docs/sdks/sky/README.md)
229
230
 
230
231
  * [skyPosition](docs/sdks/sky/README.md#skyposition) - Check USDS Position
231
232
  * [skyBuy](docs/sdks/sky/README.md#skybuy) - Buy USDS
@@ -233,15 +234,15 @@ run();
233
234
  * [skyDeposit](docs/sdks/sky/README.md#skydeposit) - Deposit USDS
234
235
  * [skyWithdraw](docs/sdks/sky/README.md#skywithdraw) - Withdraw USDS
235
236
 
236
- ### [smartAccount](docs/sdks/smartaccount/README.md)
237
+ ### [SmartAccount](docs/sdks/smartaccount/README.md)
237
238
 
238
239
  * [smartAccountBatchedUserOperations](docs/sdks/smartaccount/README.md#smartaccountbatcheduseroperations) - Get Smart Account Batched User Operations
239
240
 
240
- ### [swap](docs/sdks/swap/README.md)
241
+ ### [Swap](docs/sdks/swap/README.md)
241
242
 
242
243
  * [swapOdos](docs/sdks/swap/README.md#swapodos) - Odos Swap
243
244
 
244
- ### [token](docs/sdks/token/README.md)
245
+ ### [Token](docs/sdks/token/README.md)
245
246
 
246
247
  * [tokenPrice](docs/sdks/token/README.md#tokenprice) - Token Price
247
248
  * [tokenBalance](docs/sdks/token/README.md#tokenbalance) - Token Balance
@@ -250,13 +251,13 @@ run();
250
251
  * [tokenWrapEth](docs/sdks/token/README.md#tokenwrapeth) - Wrap ETH
251
252
  * [tokenUnwrapWeth](docs/sdks/token/README.md#tokenunwrapweth) - Unwrap WETH
252
253
 
253
- ### [transactionBundler](docs/sdks/transactionbundler/README.md)
254
+ ### [TransactionBundler](docs/sdks/transactionbundler/README.md)
254
255
 
255
256
  * [transactionBundlerAuthorization](docs/sdks/transactionbundler/README.md#transactionbundlerauthorization) - Enable Transaction Bundling
256
257
  * [transactionBundlerExecute](docs/sdks/transactionbundler/README.md#transactionbundlerexecute) - Construct Bundled Transaction
257
258
  * [transactionBundlerAaveLoop](docs/sdks/transactionbundler/README.md#transactionbundleraaveloop) - AAVE Leverage Long/Short
258
259
 
259
- ### [uniswapV3](docs/sdks/uniswapv3/README.md)
260
+ ### [UniswapV3](docs/sdks/uniswapv3/README.md)
260
261
 
261
262
  * [uniswapQuoteBuyExactly](docs/sdks/uniswapv3/README.md#uniswapquotebuyexactly) - Get Quote - to Specified Amount
262
263
  * [uniswapQuoteSellExactly](docs/sdks/uniswapv3/README.md#uniswapquotesellexactly) - Get quote - From Specified Amount
@@ -269,7 +270,7 @@ run();
269
270
  * [uniswapLiquidityProvisionIncrease](docs/sdks/uniswapv3/README.md#uniswapliquidityprovisionincrease) - Increase an LP position
270
271
  * [uniswapLiquidityProvisionWithdraw](docs/sdks/uniswapv3/README.md#uniswapliquidityprovisionwithdraw) - Withdraw an LP position
271
272
 
272
- ### [universal](docs/sdks/universal/README.md)
273
+ ### [Universal](docs/sdks/universal/README.md)
273
274
 
274
275
  * [genericPortfolio](docs/sdks/universal/README.md#genericportfolio) - List User Portfolio
275
276
  * [genericSupportedChains](docs/sdks/universal/README.md#genericsupportedchains) - List Supported Chains
@@ -277,7 +278,7 @@ run();
277
278
  * [genericEns](docs/sdks/universal/README.md#genericens) - Resolve ENS
278
279
  * [genericAllowanceSet](docs/sdks/universal/README.md#genericallowanceset) - Set Allowance
279
280
 
280
- ### [wildcat](docs/sdks/wildcat/README.md)
281
+ ### [Wildcat](docs/sdks/wildcat/README.md)
281
282
 
282
283
  * [wildcatMarket](docs/sdks/wildcat/README.md#wildcatmarket) - Get Market & User Position
283
284
 
@@ -323,6 +324,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
323
324
  - [`bridgeCctpBurn`](docs/sdks/bridge/README.md#cctpburn) - Initiate USDC bridging
324
325
  - [`bridgeCctpMint`](docs/sdks/bridge/README.md#cctpmint) - Complete USDC bridging
325
326
  - [`earnEarnAaveTokenRates`](docs/sdks/earn/README.md#earnaavetokenrates) - Get token rates on Aave
327
+ - [`earnEarnBundle`](docs/sdks/earn/README.md#earnbundle) - Bundle multiple actions into a single transaction
326
328
  - [`earnEarnCreateAccount`](docs/sdks/earn/README.md#earncreateaccount) - Create earn account
327
329
  - [`earnEarnManage`](docs/sdks/earn/README.md#earnmanage) - Manage earn position
328
330
  - [`earnEarnPositions`](docs/sdks/earn/README.md#earnpositions) - List earn positions
@@ -529,7 +531,7 @@ run();
529
531
 
530
532
 
531
533
  **Inherit from [`CompassAPISDKError`](./src/models/errors/compassapisdkerror.ts)**:
532
- * [`MintPrepareNotFoundResponseError`](./src/models/errors/mintpreparenotfoundresponseerror.ts): Response when the burn event has not been found yet. This means the burn transaction hasn't been confirmed on-chain yet, or the user hasn't broadcast the burn transaction. Status code `404`. Applicable to 1 of 91 methods.*
534
+ * [`MintPrepareNotFoundResponseError`](./src/models/errors/mintpreparenotfoundresponseerror.ts): Response when the burn event has not been found yet. This means the burn transaction hasn't been confirmed on-chain yet, or the user hasn't broadcast the burn transaction. Status code `404`. Applicable to 1 of 92 methods.*
533
535
  * [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
534
536
 
535
537
  </details>
@@ -495,6 +495,12 @@ actions:
495
495
  - "lang": "typescript"
496
496
  "label": "Typescript (SDK)"
497
497
  "source": "import { CompassApiSDK } from \"@compass-labs/api-sdk\";\n\nconst compassApiSDK = new CompassApiSDK({\n apiKeyAuth: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await compassApiSDK.earn.earnAaveTokenRates({\n token: \"USDC\",\n });\n\n console.log(result);\n}\n\nrun();"
498
+ - target: $["paths"]["/v2/earn/bundle"]["post"]
499
+ update:
500
+ "x-codeSamples":
501
+ - "lang": "typescript"
502
+ "label": "Typescript (SDK)"
503
+ "source": "import { CompassApiSDK } from \"@compass-labs/api-sdk\";\n\nconst compassApiSDK = new CompassApiSDK({\n apiKeyAuth: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await compassApiSDK.earn.earnBundle({\n owner: \"0x0B8A11cF0679F163087802c4428F640cA7C89926\",\n chain: \"base\",\n actions: [\n {\n body: {\n actionType: \"V2_SWAP\",\n tokenIn: \"USDC\",\n tokenOut: \"0xB0fFa8000886e57F86dd5264b9582b2Ad87b2b91\",\n amountIn: \"100\",\n slippage: \"0.5\",\n },\n },\n {\n body: {\n actionType: \"V2_MANAGE\",\n venue: {\n type: \"VAULT\",\n vaultAddress: \"0x7BfA7C4f149E7415b73bdeDfe609237e29CBF34A\",\n },\n action: \"DEPOSIT\",\n amount: \"ALL\",\n },\n },\n ],\n gasSponsorship: false,\n });\n\n console.log(result);\n}\n\nrun();"
498
504
  - target: $["paths"]["/v2/earn/create_account"]["post"]
499
505
  update:
500
506
  "x-codeSamples":
@@ -506,7 +512,7 @@ actions:
506
512
  "x-codeSamples":
507
513
  - "lang": "typescript"
508
514
  "label": "Typescript (SDK)"
509
- "source": "import { CompassApiSDK } from \"@compass-labs/api-sdk\";\n\nconst compassApiSDK = new CompassApiSDK({\n apiKeyAuth: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await compassApiSDK.earn.earnManage({\n owner: \"0xe5310C39a8A8f16E6126ee6B1006bf6eD58B3A49\",\n chain: \"base\",\n venue: {\n type: \"VAULT\",\n vaultAddress: \"0x7BfA7C4f149E7415b73bdeDfe609237e29CBF34A\",\n },\n action: \"WITHDRAW\",\n amount: \"0.01\",\n });\n\n console.log(result);\n}\n\nrun();"
515
+ "source": "import { CompassApiSDK } from \"@compass-labs/api-sdk\";\n\nconst compassApiSDK = new CompassApiSDK({\n apiKeyAuth: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await compassApiSDK.earn.earnManage({\n venue: {\n type: \"VAULT\",\n vaultAddress: \"0x7BfA7C4f149E7415b73bdeDfe609237e29CBF34A\",\n },\n action: \"DEPOSIT\",\n amount: \"0.01\",\n owner: \"0xe5310C39a8A8f16E6126ee6B1006bf6eD58B3A49\",\n chain: \"base\",\n gasSponsorship: false,\n });\n\n console.log(result);\n}\n\nrun();"
510
516
  - target: $["paths"]["/v2/earn/positions"]["get"]
511
517
  update:
512
518
  "x-codeSamples":
@@ -524,7 +530,7 @@ actions:
524
530
  "x-codeSamples":
525
531
  - "lang": "typescript"
526
532
  "label": "Typescript (SDK)"
527
- "source": "import { CompassApiSDK } from \"@compass-labs/api-sdk\";\n\nconst compassApiSDK = new CompassApiSDK({\n apiKeyAuth: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await compassApiSDK.earn.earnSwap({\n owner: \"0xC1be8f91480648De355a45f3E2562811b4e2D3FF\",\n chain: \"base\",\n tokenIn: \"USDC\",\n tokenOut: \"USDT\",\n amountIn: \"0.01\",\n slippage: \"0.5\",\n gasSponsorship: false,\n });\n\n console.log(result);\n}\n\nrun();"
533
+ "source": "import { CompassApiSDK } from \"@compass-labs/api-sdk\";\n\nconst compassApiSDK = new CompassApiSDK({\n apiKeyAuth: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await compassApiSDK.earn.earnSwap({\n tokenIn: \"USDC\",\n tokenOut: \"USDT\",\n amountIn: \"0.01\",\n slippage: \"0.5\",\n owner: \"0xC1be8f91480648De355a45f3E2562811b4e2D3FF\",\n chain: \"base\",\n gasSponsorship: false,\n });\n\n console.log(result);\n}\n\nrun();"
528
534
  - target: $["paths"]["/v2/earn/transfer"]["post"]
529
535
  update:
530
536
  "x-codeSamples":
@@ -0,0 +1,33 @@
1
+ import { CompassApiSDKCore } from "../core.js";
2
+ import { RequestOptions } from "../lib/sdks.js";
3
+ import * as components from "../models/components/index.js";
4
+ import { CompassAPISDKError } from "../models/errors/compassapisdkerror.js";
5
+ import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
6
+ import * as errors from "../models/errors/index.js";
7
+ import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
8
+ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
9
+ import { APIPromise } from "../types/async.js";
10
+ import { Result } from "../types/fp.js";
11
+ /**
12
+ * Bundle multiple actions into a single transaction
13
+ *
14
+ * @remarks
15
+ * Bundle multiple earn actions into a single atomic Safe transaction.
16
+ *
17
+ * This endpoint allows combining multiple actions (swaps, vault deposits/withdrawals,
18
+ * Aave deposits/withdrawals) into a single atomic transaction executed via the
19
+ * owner's Safe smart account (Earn Account).
20
+ *
21
+ * **Example Use Case:** Swap USDC to AUSD, then deposit AUSD into a vault - all in one transaction.
22
+ *
23
+ * Actions are executed in the order they are provided. Each action type has its own parameters:
24
+ *
25
+ * - **V2_SWAP**: Swap between tokens using 1inch aggregator
26
+ * - **V2_MANAGE**: Manage positions - deposit/withdraw to ERC-4626 vaults or Aave lending pool
27
+ *
28
+ * The bundled transaction can be gas-sponsored by setting `gas_sponsorship=true`.
29
+ * This returns EIP-712 typed data that the owner must sign and submit to
30
+ * `/gas_sponsorship/prepare` for execution by a gas sponsor.
31
+ */
32
+ export declare function earnEarnBundle(client: CompassApiSDKCore, request: components.V2BundleRequest, options?: RequestOptions): APIPromise<Result<components.V2BundleResponse, errors.HTTPValidationError | CompassAPISDKError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
33
+ //# sourceMappingURL=earnEarnBundle.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"earnEarnBundle.d.ts","sourceRoot":"","sources":["../../../src/funcs/earnEarnBundle.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAK/C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,uBAAuB,EAAE,MAAM,6CAA6C,CAAC;AACtF,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,cAAc,CAC5B,MAAM,EAAE,iBAAiB,EACzB,OAAO,EAAE,UAAU,CAAC,eAAe,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,UAAU,CAAC,gBAAgB,EACzB,MAAM,CAAC,mBAAmB,GAC1B,kBAAkB,GAClB,uBAAuB,GACvB,eAAe,GACf,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,kBAAkB,CACrB,CACF,CAMA"}
@@ -0,0 +1,133 @@
1
+ "use strict";
2
+ /*
3
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
4
+ */
5
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
6
+ if (k2 === undefined) k2 = k;
7
+ var desc = Object.getOwnPropertyDescriptor(m, k);
8
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
9
+ desc = { enumerable: true, get: function() { return m[k]; } };
10
+ }
11
+ Object.defineProperty(o, k2, desc);
12
+ }) : (function(o, m, k, k2) {
13
+ if (k2 === undefined) k2 = k;
14
+ o[k2] = m[k];
15
+ }));
16
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
17
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
18
+ }) : function(o, v) {
19
+ o["default"] = v;
20
+ });
21
+ var __importStar = (this && this.__importStar) || (function () {
22
+ var ownKeys = function(o) {
23
+ ownKeys = Object.getOwnPropertyNames || function (o) {
24
+ var ar = [];
25
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
26
+ return ar;
27
+ };
28
+ return ownKeys(o);
29
+ };
30
+ return function (mod) {
31
+ if (mod && mod.__esModule) return mod;
32
+ var result = {};
33
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
34
+ __setModuleDefault(result, mod);
35
+ return result;
36
+ };
37
+ })();
38
+ Object.defineProperty(exports, "__esModule", { value: true });
39
+ exports.earnEarnBundle = earnEarnBundle;
40
+ const encodings_js_1 = require("../lib/encodings.js");
41
+ const M = __importStar(require("../lib/matchers.js"));
42
+ const primitives_js_1 = require("../lib/primitives.js");
43
+ const schemas_js_1 = require("../lib/schemas.js");
44
+ const security_js_1 = require("../lib/security.js");
45
+ const url_js_1 = require("../lib/url.js");
46
+ const components = __importStar(require("../models/components/index.js"));
47
+ const errors = __importStar(require("../models/errors/index.js"));
48
+ const async_js_1 = require("../types/async.js");
49
+ /**
50
+ * Bundle multiple actions into a single transaction
51
+ *
52
+ * @remarks
53
+ * Bundle multiple earn actions into a single atomic Safe transaction.
54
+ *
55
+ * This endpoint allows combining multiple actions (swaps, vault deposits/withdrawals,
56
+ * Aave deposits/withdrawals) into a single atomic transaction executed via the
57
+ * owner's Safe smart account (Earn Account).
58
+ *
59
+ * **Example Use Case:** Swap USDC to AUSD, then deposit AUSD into a vault - all in one transaction.
60
+ *
61
+ * Actions are executed in the order they are provided. Each action type has its own parameters:
62
+ *
63
+ * - **V2_SWAP**: Swap between tokens using 1inch aggregator
64
+ * - **V2_MANAGE**: Manage positions - deposit/withdraw to ERC-4626 vaults or Aave lending pool
65
+ *
66
+ * The bundled transaction can be gas-sponsored by setting `gas_sponsorship=true`.
67
+ * This returns EIP-712 typed data that the owner must sign and submit to
68
+ * `/gas_sponsorship/prepare` for execution by a gas sponsor.
69
+ */
70
+ function earnEarnBundle(client, request, options) {
71
+ return new async_js_1.APIPromise($do(client, request, options));
72
+ }
73
+ async function $do(client, request, options) {
74
+ const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.V2BundleRequest$outboundSchema.parse(value), "Input validation failed");
75
+ if (!parsed.ok) {
76
+ return [parsed, { status: "invalid" }];
77
+ }
78
+ const payload = parsed.value;
79
+ const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true });
80
+ const path = (0, url_js_1.pathToFunc)("/v2/earn/bundle")();
81
+ const headers = new Headers((0, primitives_js_1.compactMap)({
82
+ "Content-Type": "application/json",
83
+ Accept: "application/json",
84
+ }));
85
+ const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKeyAuth);
86
+ const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
87
+ const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput);
88
+ const context = {
89
+ options: client._options,
90
+ baseURL: options?.serverURL ?? client._baseURL ?? "",
91
+ operationID: "v2_earn_bundle",
92
+ oAuth2Scopes: null,
93
+ resolvedSecurity: requestSecurity,
94
+ securitySource: client._options.apiKeyAuth,
95
+ retryConfig: options?.retries
96
+ || client._options.retryConfig
97
+ || { strategy: "none" },
98
+ retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
99
+ };
100
+ const requestRes = client._createRequest(context, {
101
+ security: requestSecurity,
102
+ method: "POST",
103
+ baseURL: options?.serverURL,
104
+ path: path,
105
+ headers: headers,
106
+ body: body,
107
+ userAgent: client._options.userAgent,
108
+ timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
109
+ }, options);
110
+ if (!requestRes.ok) {
111
+ return [requestRes, { status: "invalid" }];
112
+ }
113
+ const req = requestRes.value;
114
+ const doResult = await client._do(req, {
115
+ context,
116
+ errorCodes: ["422", "4XX", "5XX"],
117
+ retryConfig: context.retryConfig,
118
+ retryCodes: context.retryCodes,
119
+ });
120
+ if (!doResult.ok) {
121
+ return [doResult, { status: "request-error", request: req }];
122
+ }
123
+ const response = doResult.value;
124
+ const responseFields = {
125
+ HttpMeta: { Response: response, Request: req },
126
+ };
127
+ const [result] = await M.match(M.json(200, components.V2BundleResponse$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields });
128
+ if (!result.ok) {
129
+ return [result, { status: "complete", request: req, response }];
130
+ }
131
+ return [result, { status: "complete", request: req, response }];
132
+ }
133
+ //# sourceMappingURL=earnEarnBundle.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"earnEarnBundle.js","sourceRoot":"","sources":["../../../src/funcs/earnEarnBundle.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8CH,wCAuBC;AAlED,sDAAiD;AACjD,sDAAwC;AACxC,wDAAkD;AAClD,kDAA8C;AAE9C,oDAA4E;AAC5E,0CAA2C;AAC3C,0EAA4D;AAS5D,kEAAoD;AAGpD,gDAAwD;AAGxD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,SAAgB,cAAc,CAC5B,MAAyB,EACzB,OAAmC,EACnC,OAAwB;IAexB,OAAO,IAAI,qBAAU,CAAC,GAAG,CACvB,MAAM,EACN,OAAO,EACP,OAAO,CACR,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,GAAG,CAChB,MAAyB,EACzB,OAAmC,EACnC,OAAwB;IAkBxB,MAAM,MAAM,GAAG,IAAA,sBAAS,EACtB,OAAO,EACP,CAAC,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,8BAA8B,CAAC,KAAK,CAAC,KAAK,CAAC,EACjE,yBAAyB,CAC1B,CAAC;IACF,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IACzC,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;IAC7B,MAAM,IAAI,GAAG,IAAA,yBAAU,EAAC,MAAM,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IAE5D,MAAM,IAAI,GAAG,IAAA,mBAAU,EAAC,iBAAiB,CAAC,EAAE,CAAC;IAE7C,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAA,0BAAU,EAAC;QACrC,cAAc,EAAE,kBAAkB;QAClC,MAAM,EAAE,kBAAkB;KAC3B,CAAC,CAAC,CAAC;IAEJ,MAAM,SAAS,GAAG,MAAM,IAAA,6BAAe,EAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;IACpE,MAAM,aAAa,GAAG,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC;IACzE,MAAM,eAAe,GAAG,IAAA,mCAAqB,EAAC,aAAa,CAAC,CAAC;IAE7D,MAAM,OAAO,GAAG;QACd,OAAO,EAAE,MAAM,CAAC,QAAQ;QACxB,OAAO,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,IAAI,EAAE;QACpD,WAAW,EAAE,gBAAgB;QAC7B,YAAY,EAAE,IAAI;QAElB,gBAAgB,EAAE,eAAe;QAEjC,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC,UAAU;QAC1C,WAAW,EAAE,OAAO,EAAE,OAAO;eACxB,MAAM,CAAC,QAAQ,CAAC,WAAW;eAC3B,EAAE,QAAQ,EAAE,MAAM,EAAE;QACzB,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;KACvE,CAAC;IAEF,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE;QAChD,QAAQ,EAAE,eAAe;QACzB,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,OAAO,EAAE,SAAS;QAC3B,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,OAAO;QAChB,IAAI,EAAE,IAAI;QACV,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,SAAS;QACpC,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,CAAC,SAAS,IAAI,CAAC,CAAC;KACjE,EAAE,OAAO,CAAC,CAAC;IACZ,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;QACnB,OAAO,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC7C,CAAC;IACD,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC;IAE7B,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE;QACrC,OAAO;QACP,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;QACjC,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,OAAO,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC;IAC/D,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC;IAEhC,MAAM,cAAc,GAAG;QACrB,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE;KAC/C,CAAC;IAEF,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,CAY5B,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,UAAU,CAAC,8BAA8B,CAAC,EACtD,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,iCAAiC,CAAC,EACxD,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EACb,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CACd,CAAC,QAAQ,EAAE,GAAG,EAAE,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;IAClD,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;AAClE,CAAC"}
@@ -32,7 +32,7 @@ export declare const SDK_METADATA: {
32
32
  readonly language: "typescript";
33
33
  readonly openapiDocVersion: "0.0.1";
34
34
  readonly sdkVersion: "2.0.0";
35
- readonly genVersion: "2.770.0";
36
- readonly userAgent: "speakeasy-sdk/typescript 2.0.0 2.770.0 0.0.1 @compass-labs/api-sdk";
35
+ readonly genVersion: "2.772.0";
36
+ readonly userAgent: "speakeasy-sdk/typescript 2.0.0 2.772.0 0.0.1 @compass-labs/api-sdk";
37
37
  };
38
38
  //# sourceMappingURL=config.d.ts.map
@@ -32,7 +32,7 @@ exports.SDK_METADATA = {
32
32
  language: "typescript",
33
33
  openapiDocVersion: "0.0.1",
34
34
  sdkVersion: "2.0.0",
35
- genVersion: "2.770.0",
36
- userAgent: "speakeasy-sdk/typescript 2.0.0 2.770.0 0.0.1 @compass-labs/api-sdk",
35
+ genVersion: "2.772.0",
36
+ userAgent: "speakeasy-sdk/typescript 2.0.0 2.772.0 0.0.1 @compass-labs/api-sdk",
37
37
  };
38
38
  //# sourceMappingURL=config.js.map
@@ -0,0 +1,63 @@
1
+ import * as z from "zod/v3";
2
+ import { ClosedEnum } from "../../types/enums.js";
3
+ import { AaveVenue, AaveVenue$Outbound } from "./aavevenue.js";
4
+ import { VaultVenue, VaultVenue$Outbound } from "./vaultvenue.js";
5
+ /**
6
+ * The earn venue.
7
+ */
8
+ export type EarnManageParamsVenue = AaveVenue | VaultVenue;
9
+ /**
10
+ * Whether you are depositing into or withdrawing from the given Earn `venue`.
11
+ */
12
+ export declare const EarnManageParamsAction: {
13
+ readonly Deposit: "DEPOSIT";
14
+ readonly Withdraw: "WITHDRAW";
15
+ };
16
+ /**
17
+ * Whether you are depositing into or withdrawing from the given Earn `venue`.
18
+ */
19
+ export type EarnManageParamsAction = ClosedEnum<typeof EarnManageParamsAction>;
20
+ /**
21
+ * Parameters for earn manage operations (deposit/withdraw to vault/Aave).
22
+ *
23
+ * @remarks
24
+ *
25
+ * Used by multicall/bundle endpoint to specify manage actions. EarnManageRequest
26
+ * inherits from this class.
27
+ */
28
+ export type EarnManageParams = {
29
+ /**
30
+ * Action type identifier for manage operations.
31
+ */
32
+ actionType: "V2_MANAGE";
33
+ /**
34
+ * The earn venue.
35
+ */
36
+ venue: AaveVenue | VaultVenue;
37
+ /**
38
+ * Whether you are depositing into or withdrawing from the given Earn `venue`.
39
+ */
40
+ action: EarnManageParamsAction;
41
+ /**
42
+ * Amount of the underlying asset to act on (deposit or withdraw). For VAULT, this is the vault's underlying token; for AAVE, this is the Aave reserve asset. Provide as a decimal in token units (not wei); must be > 0.
43
+ */
44
+ amount?: any | undefined;
45
+ };
46
+ /** @internal */
47
+ export type EarnManageParamsVenue$Outbound = AaveVenue$Outbound | VaultVenue$Outbound;
48
+ /** @internal */
49
+ export declare const EarnManageParamsVenue$outboundSchema: z.ZodType<EarnManageParamsVenue$Outbound, z.ZodTypeDef, EarnManageParamsVenue>;
50
+ export declare function earnManageParamsVenueToJSON(earnManageParamsVenue: EarnManageParamsVenue): string;
51
+ /** @internal */
52
+ export declare const EarnManageParamsAction$outboundSchema: z.ZodNativeEnum<typeof EarnManageParamsAction>;
53
+ /** @internal */
54
+ export type EarnManageParams$Outbound = {
55
+ action_type: "V2_MANAGE";
56
+ venue: AaveVenue$Outbound | VaultVenue$Outbound;
57
+ action: string;
58
+ amount?: any | undefined;
59
+ };
60
+ /** @internal */
61
+ export declare const EarnManageParams$outboundSchema: z.ZodType<EarnManageParams$Outbound, z.ZodTypeDef, EarnManageParams>;
62
+ export declare function earnManageParamsToJSON(earnManageParams: EarnManageParams): string;
63
+ //# sourceMappingURL=earnmanageparams.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"earnmanageparams.d.ts","sourceRoot":"","sources":["../../../../src/models/components/earnmanageparams.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EACL,SAAS,EACT,kBAAkB,EAEnB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,UAAU,EACV,mBAAmB,EAEpB,MAAM,iBAAiB,CAAC;AAEzB;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,SAAS,GAAG,UAAU,CAAC;AAE3D;;GAEG;AACH,eAAO,MAAM,sBAAsB;;;CAGzB,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,UAAU,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAE/E;;;;;;;GAOG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,UAAU,EAAE,WAAW,CAAC;IACxB;;OAEG;IACH,KAAK,EAAE,SAAS,GAAG,UAAU,CAAC;IAC9B;;OAEG;IACH,MAAM,EAAE,sBAAsB,CAAC;IAC/B;;OAEG;IACH,MAAM,CAAC,EAAE,GAAG,GAAG,SAAS,CAAC;CAC1B,CAAC;AAEF,gBAAgB;AAChB,MAAM,MAAM,8BAA8B,GACtC,kBAAkB,GAClB,mBAAmB,CAAC;AAExB,gBAAgB;AAChB,eAAO,MAAM,oCAAoC,EAAE,CAAC,CAAC,OAAO,CAC1D,8BAA8B,EAC9B,CAAC,CAAC,UAAU,EACZ,qBAAqB,CAC2C,CAAC;AAEnE,wBAAgB,2BAA2B,CACzC,qBAAqB,EAAE,qBAAqB,GAC3C,MAAM,CAIR;AAED,gBAAgB;AAChB,eAAO,MAAM,qCAAqC,EAAE,CAAC,CAAC,aAAa,CACjE,OAAO,sBAAsB,CACS,CAAC;AAEzC,gBAAgB;AAChB,MAAM,MAAM,yBAAyB,GAAG;IACtC,WAAW,EAAE,WAAW,CAAC;IACzB,KAAK,EAAE,kBAAkB,GAAG,mBAAmB,CAAC;IAChD,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,GAAG,GAAG,SAAS,CAAC;CAC1B,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,+BAA+B,EAAE,CAAC,CAAC,OAAO,CACrD,yBAAyB,EACzB,CAAC,CAAC,UAAU,EACZ,gBAAgB,CAUhB,CAAC;AAEH,wBAAgB,sBAAsB,CACpC,gBAAgB,EAAE,gBAAgB,GACjC,MAAM,CAIR"}
@@ -0,0 +1,74 @@
1
+ "use strict";
2
+ /*
3
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
4
+ */
5
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
6
+ if (k2 === undefined) k2 = k;
7
+ var desc = Object.getOwnPropertyDescriptor(m, k);
8
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
9
+ desc = { enumerable: true, get: function() { return m[k]; } };
10
+ }
11
+ Object.defineProperty(o, k2, desc);
12
+ }) : (function(o, m, k, k2) {
13
+ if (k2 === undefined) k2 = k;
14
+ o[k2] = m[k];
15
+ }));
16
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
17
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
18
+ }) : function(o, v) {
19
+ o["default"] = v;
20
+ });
21
+ var __importStar = (this && this.__importStar) || (function () {
22
+ var ownKeys = function(o) {
23
+ ownKeys = Object.getOwnPropertyNames || function (o) {
24
+ var ar = [];
25
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
26
+ return ar;
27
+ };
28
+ return ownKeys(o);
29
+ };
30
+ return function (mod) {
31
+ if (mod && mod.__esModule) return mod;
32
+ var result = {};
33
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
34
+ __setModuleDefault(result, mod);
35
+ return result;
36
+ };
37
+ })();
38
+ Object.defineProperty(exports, "__esModule", { value: true });
39
+ exports.EarnManageParams$outboundSchema = exports.EarnManageParamsAction$outboundSchema = exports.EarnManageParamsVenue$outboundSchema = exports.EarnManageParamsAction = void 0;
40
+ exports.earnManageParamsVenueToJSON = earnManageParamsVenueToJSON;
41
+ exports.earnManageParamsToJSON = earnManageParamsToJSON;
42
+ const z = __importStar(require("zod/v3"));
43
+ const primitives_js_1 = require("../../lib/primitives.js");
44
+ const aavevenue_js_1 = require("./aavevenue.js");
45
+ const vaultvenue_js_1 = require("./vaultvenue.js");
46
+ /**
47
+ * Whether you are depositing into or withdrawing from the given Earn `venue`.
48
+ */
49
+ exports.EarnManageParamsAction = {
50
+ Deposit: "DEPOSIT",
51
+ Withdraw: "WITHDRAW",
52
+ };
53
+ /** @internal */
54
+ exports.EarnManageParamsVenue$outboundSchema = z.union([aavevenue_js_1.AaveVenue$outboundSchema, vaultvenue_js_1.VaultVenue$outboundSchema]);
55
+ function earnManageParamsVenueToJSON(earnManageParamsVenue) {
56
+ return JSON.stringify(exports.EarnManageParamsVenue$outboundSchema.parse(earnManageParamsVenue));
57
+ }
58
+ /** @internal */
59
+ exports.EarnManageParamsAction$outboundSchema = z.nativeEnum(exports.EarnManageParamsAction);
60
+ /** @internal */
61
+ exports.EarnManageParams$outboundSchema = z.object({
62
+ actionType: z.literal("V2_MANAGE"),
63
+ venue: z.union([aavevenue_js_1.AaveVenue$outboundSchema, vaultvenue_js_1.VaultVenue$outboundSchema]),
64
+ action: exports.EarnManageParamsAction$outboundSchema,
65
+ amount: z.any().optional(),
66
+ }).transform((v) => {
67
+ return (0, primitives_js_1.remap)(v, {
68
+ actionType: "action_type",
69
+ });
70
+ });
71
+ function earnManageParamsToJSON(earnManageParams) {
72
+ return JSON.stringify(exports.EarnManageParams$outboundSchema.parse(earnManageParams));
73
+ }
74
+ //# sourceMappingURL=earnmanageparams.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"earnmanageparams.js","sourceRoot":"","sources":["../../../../src/models/components/earnmanageparams.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwEH,kEAMC;AA+BD,wDAMC;AAjHD,0CAA4B;AAC5B,2DAA0D;AAE1D,iDAIwB;AACxB,mDAIyB;AAOzB;;GAEG;AACU,QAAA,sBAAsB,GAAG;IACpC,OAAO,EAAE,SAAS;IAClB,QAAQ,EAAE,UAAU;CACZ,CAAC;AAsCX,gBAAgB;AACH,QAAA,oCAAoC,GAI7C,CAAC,CAAC,KAAK,CAAC,CAAC,uCAAwB,EAAE,yCAAyB,CAAC,CAAC,CAAC;AAEnE,SAAgB,2BAA2B,CACzC,qBAA4C;IAE5C,OAAO,IAAI,CAAC,SAAS,CACnB,4CAAoC,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAClE,CAAC;AACJ,CAAC;AAED,gBAAgB;AACH,QAAA,qCAAqC,GAE9C,CAAC,CAAC,UAAU,CAAC,8BAAsB,CAAC,CAAC;AAUzC,gBAAgB;AACH,QAAA,+BAA+B,GAIxC,CAAC,CAAC,MAAM,CAAC;IACX,UAAU,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC;IAClC,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,uCAAwB,EAAE,yCAAyB,CAAC,CAAC;IACrE,MAAM,EAAE,6CAAqC;IAC7C,MAAM,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;CAC3B,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,UAAU,EAAE,aAAa;KAC1B,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,SAAgB,sBAAsB,CACpC,gBAAkC;IAElC,OAAO,IAAI,CAAC,SAAS,CACnB,uCAA+B,CAAC,KAAK,CAAC,gBAAgB,CAAC,CACxD,CAAC;AACJ,CAAC"}
@@ -7,7 +7,7 @@ import { VaultVenue, VaultVenue$Outbound } from "./vaultvenue.js";
7
7
  /**
8
8
  * The earn venue.
9
9
  */
10
- export type Venue = AaveVenue | VaultVenue;
10
+ export type EarnManageRequestVenue = AaveVenue | VaultVenue;
11
11
  /**
12
12
  * Whether you are depositing into or withdrawing from the given Earn `venue`.
13
13
  */
@@ -19,15 +19,18 @@ export declare const EarnManageRequestAction: {
19
19
  * Whether you are depositing into or withdrawing from the given Earn `venue`.
20
20
  */
21
21
  export type EarnManageRequestAction = ClosedEnum<typeof EarnManageRequestAction>;
22
+ /**
23
+ * Request model for the unified manage endpoint.
24
+ *
25
+ * @remarks
26
+ *
27
+ * Inherits from EarnManageParams and adds context fields (owner, chain, etc).
28
+ */
22
29
  export type EarnManageRequest = {
23
30
  /**
24
- * The primary wallet address that owns and controls the Earn Account.
25
- */
26
- owner: string;
27
- /**
28
- * The chain to use.
31
+ * Action type identifier for manage operations.
29
32
  */
30
- chain: Chain;
33
+ actionType?: "V2_MANAGE" | undefined;
31
34
  /**
32
35
  * The earn venue.
33
36
  */
@@ -37,9 +40,17 @@ export type EarnManageRequest = {
37
40
  */
38
41
  action: EarnManageRequestAction;
39
42
  /**
40
- * Amount of the underlying asset to act on (deposit or withdraw). For VAULT, this is the vaults underlying token; for AAVE, this is the Aave reserve asset. Provide as a decimal in token units (not wei); must be > 0.
43
+ * Amount of the underlying asset to act on (deposit or withdraw). For VAULT, this is the vault's underlying token; for AAVE, this is the Aave reserve asset. Provide as a decimal in token units (not wei); must be > 0.
41
44
  */
42
45
  amount?: any | undefined;
46
+ /**
47
+ * The primary wallet address that owns and controls the Earn Account.
48
+ */
49
+ owner: string;
50
+ /**
51
+ * The chain to use.
52
+ */
53
+ chain: Chain;
43
54
  /**
44
55
  * Optionally request gas sponsorship. If set to `true`, EIP-712 typed data will be returned that must be signed by the `owner` and submitted to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`).
45
56
  */
@@ -50,19 +61,20 @@ export type EarnManageRequest = {
50
61
  fee?: Fee | null | undefined;
51
62
  };
52
63
  /** @internal */
53
- export type Venue$Outbound = AaveVenue$Outbound | VaultVenue$Outbound;
64
+ export type EarnManageRequestVenue$Outbound = AaveVenue$Outbound | VaultVenue$Outbound;
54
65
  /** @internal */
55
- export declare const Venue$outboundSchema: z.ZodType<Venue$Outbound, z.ZodTypeDef, Venue>;
56
- export declare function venueToJSON(venue: Venue): string;
66
+ export declare const EarnManageRequestVenue$outboundSchema: z.ZodType<EarnManageRequestVenue$Outbound, z.ZodTypeDef, EarnManageRequestVenue>;
67
+ export declare function earnManageRequestVenueToJSON(earnManageRequestVenue: EarnManageRequestVenue): string;
57
68
  /** @internal */
58
69
  export declare const EarnManageRequestAction$outboundSchema: z.ZodNativeEnum<typeof EarnManageRequestAction>;
59
70
  /** @internal */
60
71
  export type EarnManageRequest$Outbound = {
61
- owner: string;
62
- chain: string;
72
+ action_type?: "V2_MANAGE" | undefined;
63
73
  venue: AaveVenue$Outbound | VaultVenue$Outbound;
64
74
  action: string;
65
75
  amount?: any | undefined;
76
+ owner: string;
77
+ chain: string;
66
78
  gas_sponsorship?: boolean | undefined;
67
79
  fee?: Fee$Outbound | null | undefined;
68
80
  };
@@ -1 +1 @@
1
- {"version":3,"file":"earnmanagerequest.d.ts","sourceRoot":"","sources":["../../../../src/models/components/earnmanagerequest.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EACL,SAAS,EACT,kBAAkB,EAEnB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,KAAK,EAAwB,MAAM,YAAY,CAAC;AACzD,OAAO,EAAE,GAAG,EAAE,YAAY,EAAsB,MAAM,UAAU,CAAC;AACjE,OAAO,EACL,UAAU,EACV,mBAAmB,EAEpB,MAAM,iBAAiB,CAAC;AAEzB;;GAEG;AACH,MAAM,MAAM,KAAK,GAAG,SAAS,GAAG,UAAU,CAAC;AAE3C;;GAEG;AACH,eAAO,MAAM,uBAAuB;;;CAG1B,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,UAAU,CAC9C,OAAO,uBAAuB,CAC/B,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;IACb;;OAEG;IACH,KAAK,EAAE,SAAS,GAAG,UAAU,CAAC;IAC9B;;OAEG;IACH,MAAM,EAAE,uBAAuB,CAAC;IAChC;;OAEG;IACH,MAAM,CAAC,EAAE,GAAG,GAAG,SAAS,CAAC;IACzB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACrC;;OAEG;IACH,GAAG,CAAC,EAAE,GAAG,GAAG,IAAI,GAAG,SAAS,CAAC;CAC9B,CAAC;AAEF,gBAAgB;AAChB,MAAM,MAAM,cAAc,GAAG,kBAAkB,GAAG,mBAAmB,CAAC;AAEtE,gBAAgB;AAChB,eAAO,MAAM,oBAAoB,EAAE,CAAC,CAAC,OAAO,CAC1C,cAAc,EACd,CAAC,CAAC,UAAU,EACZ,KAAK,CAC2D,CAAC;AAEnE,wBAAgB,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAEhD;AAED,gBAAgB;AAChB,eAAO,MAAM,sCAAsC,EAAE,CAAC,CAAC,aAAa,CAClE,OAAO,uBAAuB,CACS,CAAC;AAE1C,gBAAgB;AAChB,MAAM,MAAM,0BAA0B,GAAG;IACvC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,kBAAkB,GAAG,mBAAmB,CAAC;IAChD,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,GAAG,GAAG,SAAS,CAAC;IACzB,eAAe,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACtC,GAAG,CAAC,EAAE,YAAY,GAAG,IAAI,GAAG,SAAS,CAAC;CACvC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,gCAAgC,EAAE,CAAC,CAAC,OAAO,CACtD,0BAA0B,EAC1B,CAAC,CAAC,UAAU,EACZ,iBAAiB,CAajB,CAAC;AAEH,wBAAgB,uBAAuB,CACrC,iBAAiB,EAAE,iBAAiB,GACnC,MAAM,CAIR"}
1
+ {"version":3,"file":"earnmanagerequest.d.ts","sourceRoot":"","sources":["../../../../src/models/components/earnmanagerequest.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EACL,SAAS,EACT,kBAAkB,EAEnB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,KAAK,EAAwB,MAAM,YAAY,CAAC;AACzD,OAAO,EAAE,GAAG,EAAE,YAAY,EAAsB,MAAM,UAAU,CAAC;AACjE,OAAO,EACL,UAAU,EACV,mBAAmB,EAEpB,MAAM,iBAAiB,CAAC;AAEzB;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,SAAS,GAAG,UAAU,CAAC;AAE5D;;GAEG;AACH,eAAO,MAAM,uBAAuB;;;CAG1B,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,UAAU,CAC9C,OAAO,uBAAuB,CAC/B,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IACrC;;OAEG;IACH,KAAK,EAAE,SAAS,GAAG,UAAU,CAAC;IAC9B;;OAEG;IACH,MAAM,EAAE,uBAAuB,CAAC;IAChC;;OAEG;IACH,MAAM,CAAC,EAAE,GAAG,GAAG,SAAS,CAAC;IACzB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;IACb;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACrC;;OAEG;IACH,GAAG,CAAC,EAAE,GAAG,GAAG,IAAI,GAAG,SAAS,CAAC;CAC9B,CAAC;AAEF,gBAAgB;AAChB,MAAM,MAAM,+BAA+B,GACvC,kBAAkB,GAClB,mBAAmB,CAAC;AAExB,gBAAgB;AAChB,eAAO,MAAM,qCAAqC,EAAE,CAAC,CAAC,OAAO,CAC3D,+BAA+B,EAC/B,CAAC,CAAC,UAAU,EACZ,sBAAsB,CAC0C,CAAC;AAEnE,wBAAgB,4BAA4B,CAC1C,sBAAsB,EAAE,sBAAsB,GAC7C,MAAM,CAIR;AAED,gBAAgB;AAChB,eAAO,MAAM,sCAAsC,EAAE,CAAC,CAAC,aAAa,CAClE,OAAO,uBAAuB,CACS,CAAC;AAE1C,gBAAgB;AAChB,MAAM,MAAM,0BAA0B,GAAG;IACvC,WAAW,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IACtC,KAAK,EAAE,kBAAkB,GAAG,mBAAmB,CAAC;IAChD,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,GAAG,GAAG,SAAS,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,eAAe,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACtC,GAAG,CAAC,EAAE,YAAY,GAAG,IAAI,GAAG,SAAS,CAAC;CACvC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,gCAAgC,EAAE,CAAC,CAAC,OAAO,CACtD,0BAA0B,EAC1B,CAAC,CAAC,UAAU,EACZ,iBAAiB,CAejB,CAAC;AAEH,wBAAgB,uBAAuB,CACrC,iBAAiB,EAAE,iBAAiB,GACnC,MAAM,CAIR"}