npm - @compass-labs/api-sdk - Versions diffs - 0.0.39 → 0.1.1 - Mend

@compass-labs/api-sdk 0.0.39 → 0.1.1

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 (437) hide show

package/docs/sdks/morpho/README.md CHANGED Viewed

@@ -660,7 +660,7 @@ run();
 ### Response
-**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
 ### Errors
@@ -753,7 +753,7 @@ run();
 ### Response
-**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
 ### Errors
@@ -846,7 +846,7 @@ run();
 ### Response
-**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
 ### Errors
@@ -934,7 +934,7 @@ run();
 ### Response
-**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
 ### Errors
@@ -1022,7 +1022,7 @@ run();
 ### Response
-**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
 ### Errors
@@ -1113,7 +1113,7 @@ run();
 ### Response
-**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
 ### Errors
@@ -1201,7 +1201,7 @@ run();
 ### Response
-**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
 ### Errors

package/docs/sdks/sky/README.md CHANGED Viewed

@@ -166,7 +166,7 @@ run();
 ### Response
-**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
 ### Errors
@@ -253,7 +253,7 @@ run();
 ### Response
-**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
 ### Errors
@@ -334,7 +334,7 @@ run();
 ### Response
-**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
 ### Errors
@@ -413,7 +413,7 @@ run();
 ### Response
-**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
 ### Errors

package/docs/sdks/smartaccount/README.md ADDED Viewed

@@ -0,0 +1,105 @@
+# SmartAccount
+(*smartAccount*)
+## Overview
+### Available Operations
+* [accountBatchedUserOperations](#accountbatcheduseroperations) - Get Smart Account Batched User Operations
+## accountBatchedUserOperations
+Generate a list of user operations for smart account batching.
+### Example Usage
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+async function run() {
+  const result = await compassApiSDK.smartAccount.accountBatchedUserOperations({
+    chain: "base:mainnet",
+    operations: [
+      {
+        actionType: "ALLOWANCE_INCREASE",
+        body: {
+          token: "WETH",
+          contractName: "UniswapV3Router",
+          amount: "1000",
+        },
+      },
+    ],
+  });
+  // Handle the result
+  console.log(result);
+}
+run();
+```
+### Standalone function
+The standalone function version of this method:
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { smartAccountAccountBatchedUserOperations } from "@compass-labs/api-sdk/funcs/smartAccountAccountBatchedUserOperations.js";
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+async function run() {
+  const res = await smartAccountAccountBatchedUserOperations(compassApiSDK, {
+    chain: "base:mainnet",
+    operations: [
+      {
+        actionType: "ALLOWANCE_INCREASE",
+        body: {
+          token: "WETH",
+          contractName: "UniswapV3Router",
+          amount: "1000",
+        },
+      },
+    ],
+  });
+  if (!res.ok) {
+    throw res.error;
+  }
+  const { value: result } = res;
+  // Handle the result
+  console.log(result);
+}
+run();
+```
+### Parameters
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.BatchedUserOperationsRequest](../../models/components/batcheduseroperationsrequest.md)                                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+### Response
+**Promise\<[components.BatchedUserOperationsResponse](../../models/components/batcheduseroperationsresponse.md)\>**
+### Errors
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |

package/docs/sdks/token/README.md CHANGED Viewed

@@ -329,7 +329,7 @@ run();
 ### Response
-**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
 ### Errors

package/docs/sdks/transactionbatching/README.md CHANGED Viewed

@@ -125,14 +125,11 @@ async function run() {
     },
     actions: [
       {
-        actionType: "UNISWAP_BUY_EXACTLY",
+        actionType: "ALLOWANCE_INCREASE",
         body: {
-          tokenIn: "WETH",
-          tokenOut: "USDC",
-          fee: "0.01",
-          amount: 1.5,
-          maxSlippagePercent: 0.5,
-          wrapEth: true,
+          token: "WETH",
+          contractName: "UniswapV3Router",
+          amount: "1000",
         },
       },
     ],
@@ -173,14 +170,11 @@ async function run() {
     },
     actions: [
       {
-        actionType: "UNISWAP_BUY_EXACTLY",
+        actionType: "ALLOWANCE_INCREASE",
         body: {
-          tokenIn: "WETH",
-          tokenOut: "USDC",
-          fee: "0.01",
-          amount: 1.5,
-          maxSlippagePercent: 0.5,
-          wrapEth: true,
+          token: "WETH",
+          contractName: "UniswapV3Router",
+          amount: "1000",
         },
       },
     ],
@@ -259,7 +253,7 @@ async function run() {
     collateralAmount: "1000",
     loopCount: 2,
     maxSlippagePercent: 2.5,
-    loanToValue: 50.6,
+    loanToValue: 20.5,
   });
   // Handle the result
@@ -300,7 +294,7 @@ async function run() {
     collateralAmount: "1000",
     loopCount: 2,
     maxSlippagePercent: 2.5,
-    loanToValue: 50.6,
+    loanToValue: 20.5,
   });
   if (!res.ok) {

package/docs/sdks/uniswapv3/README.md CHANGED Viewed

@@ -534,7 +534,7 @@ run();
 ### Response
-**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
 ### Errors
@@ -629,7 +629,7 @@ run();
 ### Response
-**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
 ### Errors
@@ -726,7 +726,7 @@ run();
 ### Response
-**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
 ### Errors
@@ -833,7 +833,7 @@ run();
 ### Response
-**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
 ### Errors
@@ -867,7 +867,7 @@ const compassApiSDK = new CompassApiSDK({
 async function run() {
   const result = await compassApiSDK.uniswapV3.liquidityProvisionWithdraw({
     tokenId: 719537,
-    percentageForWithdrawal: "100",
+    percentageForWithdrawal: "25",
     chain: "arbitrum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
@@ -896,7 +896,7 @@ const compassApiSDK = new CompassApiSDKCore({
 async function run() {
   const res = await uniswapV3LiquidityProvisionWithdraw(compassApiSDK, {
     tokenId: 719537,
-    percentageForWithdrawal: "100",
+    percentageForWithdrawal: "25",
     chain: "arbitrum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
@@ -925,7 +925,7 @@ run();
 ### Response
-**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
 ### Errors

package/docs/sdks/universal/README.md CHANGED Viewed

@@ -492,7 +492,7 @@ run();
 ### Response
-**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
 ### Errors
@@ -574,7 +574,7 @@ run();
 ### Response
-**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
 ### Errors
@@ -665,7 +665,7 @@ run();
 ### Response
-**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
 ### Errors

package/jsr.json CHANGED Viewed

@@ -2,7 +2,7 @@
 {
   "name": "@compass-labs/api-sdk",
-  "version": "0.0.39",
+  "version": "0.1.1",
   "exports": {
     ".": "./src/index.ts",
     "./models/errors": "./src/models/errors/index.ts",

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@compass-labs/api-sdk",
-  "version": "0.0.39",
+  "version": "0.1.1",
   "author": "royalnine",
   "type": "module",
   "bin": {

package/src/funcs/aaveV3Borrow.ts CHANGED Viewed

@@ -39,7 +39,7 @@ export function aaveV3Borrow(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -64,7 +64,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      components.UnsignedTransaction,
+      components.TxResponse,
       | errors.HTTPValidationError
       | APIError
       | SDKValidationError
@@ -143,7 +143,7 @@ async function $do(
   };
   const [result] = await M.match<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -153,7 +153,7 @@ async function $do(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.json(200, components.UnsignedTransaction$inboundSchema),
+    M.json(200, components.TxResponse$inboundSchema),
     M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),

package/src/funcs/aaveV3Repay.ts CHANGED Viewed

@@ -43,7 +43,7 @@ export function aaveV3Repay(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -68,7 +68,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      components.UnsignedTransaction,
+      components.TxResponse,
       | errors.HTTPValidationError
       | APIError
       | SDKValidationError
@@ -147,7 +147,7 @@ async function $do(
   };
   const [result] = await M.match<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -157,7 +157,7 @@ async function $do(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.json(200, components.UnsignedTransaction$inboundSchema),
+    M.json(200, components.TxResponse$inboundSchema),
     M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),

package/src/funcs/aaveV3Supply.ts CHANGED Viewed

@@ -44,7 +44,7 @@ export function aaveV3Supply(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -69,7 +69,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      components.UnsignedTransaction,
+      components.TxResponse,
       | errors.HTTPValidationError
       | APIError
       | SDKValidationError
@@ -148,7 +148,7 @@ async function $do(
   };
   const [result] = await M.match<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -158,7 +158,7 @@ async function $do(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.json(200, components.UnsignedTransaction$inboundSchema),
+    M.json(200, components.TxResponse$inboundSchema),
     M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),

package/src/funcs/aaveV3Withdraw.ts CHANGED Viewed

@@ -44,7 +44,7 @@ export function aaveV3Withdraw(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -69,7 +69,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      components.UnsignedTransaction,
+      components.TxResponse,
       | errors.HTTPValidationError
       | APIError
       | SDKValidationError
@@ -148,7 +148,7 @@ async function $do(
   };
   const [result] = await M.match<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -158,7 +158,7 @@ async function $do(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.json(200, components.UnsignedTransaction$inboundSchema),
+    M.json(200, components.TxResponse$inboundSchema),
     M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),

package/src/funcs/aerodromeSlipstreamSlipstreamLiquidityProvisionIncrease.ts CHANGED Viewed

@@ -46,7 +46,7 @@ export function aerodromeSlipstreamSlipstreamLiquidityProvisionIncrease(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -71,7 +71,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      components.UnsignedTransaction,
+      components.TxResponse,
       | errors.HTTPValidationError
       | APIError
       | SDKValidationError
@@ -155,7 +155,7 @@ async function $do(
   };
   const [result] = await M.match<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -165,7 +165,7 @@ async function $do(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.json(200, components.UnsignedTransaction$inboundSchema),
+    M.json(200, components.TxResponse$inboundSchema),
     M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),

package/src/funcs/aerodromeSlipstreamSlipstreamLiquidityProvisionMint.ts CHANGED Viewed

@@ -44,7 +44,7 @@ export function aerodromeSlipstreamSlipstreamLiquidityProvisionMint(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -69,7 +69,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      components.UnsignedTransaction,
+      components.TxResponse,
       | errors.HTTPValidationError
       | APIError
       | SDKValidationError
@@ -152,7 +152,7 @@ async function $do(
   };
   const [result] = await M.match<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -162,7 +162,7 @@ async function $do(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.json(200, components.UnsignedTransaction$inboundSchema),
+    M.json(200, components.TxResponse$inboundSchema),
     M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),

package/src/funcs/aerodromeSlipstreamSlipstreamLiquidityProvisionWithdraw.ts CHANGED Viewed

@@ -46,7 +46,7 @@ export function aerodromeSlipstreamSlipstreamLiquidityProvisionWithdraw(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -71,7 +71,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      components.UnsignedTransaction,
+      components.TxResponse,
       | errors.HTTPValidationError
       | APIError
       | SDKValidationError
@@ -155,7 +155,7 @@ async function $do(
   };
   const [result] = await M.match<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -165,7 +165,7 @@ async function $do(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.json(200, components.UnsignedTransaction$inboundSchema),
+    M.json(200, components.TxResponse$inboundSchema),
     M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),

package/src/funcs/aerodromeSlipstreamSlipstreamSwapBuyExactly.ts CHANGED Viewed

@@ -45,7 +45,7 @@ export function aerodromeSlipstreamSlipstreamSwapBuyExactly(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -70,7 +70,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      components.UnsignedTransaction,
+      components.TxResponse,
       | errors.HTTPValidationError
       | APIError
       | SDKValidationError
@@ -152,7 +152,7 @@ async function $do(
   };
   const [result] = await M.match<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -162,7 +162,7 @@ async function $do(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.json(200, components.UnsignedTransaction$inboundSchema),
+    M.json(200, components.TxResponse$inboundSchema),
     M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),