@compass-labs/api-sdk 0.0.7 → 0.0.8

package/dist/esm/sdk/universal.js

@@ -3,13 +3,9 @@
  */
 import { universalAllowance } from "../funcs/universalAllowance.js";
 import { universalAllowanceSet } from "../funcs/universalAllowanceSet.js";
-import { universalBalance } from "../funcs/universalBalance.js";
 import { universalEns } from "../funcs/universalEns.js";
 import { universalPortfolio } from "../funcs/universalPortfolio.js";
-import { universalPriceUsd } from "../funcs/universalPriceUsd.js";
 import { universalSupportedTokens } from "../funcs/universalSupportedTokens.js";
-import { universalTransferErc20 } from "../funcs/universalTransferErc20.js";
-import { universalTransferNativeToken } from "../funcs/universalTransferNativeToken.js";
 import { universalUnwrapWeth } from "../funcs/universalUnwrapWeth.js";
 import { universalVisualizePortfolio } from "../funcs/universalVisualizePortfolio.js";
 import { universalWrapEth } from "../funcs/universalWrapEth.js";
@@ -41,20 +37,6 @@ export class Universal extends ClientSDK {
     async visualizePortfolio(request, options) {
         return unwrapAsync(universalVisualizePortfolio(this, request, options));
     }
-    /**
-     * Token price
-     *
-     * @remarks
-     * Retrieves the price of the specified token relative to USD using Chainlink's on-
-     * chain price feeds.
-     *
-     * Chainlink is a decentralized oracle that aggregates price data from off-chain
-     * sources. This ensures the price is tamper-resistant but the price might be stale
-     * with the update frequency of the oracle.
-     */
-    async priceUsd(request, options) {
-        return unwrapAsync(universalPriceUsd(this, request, options));
-    }
     /**
      * List supported tokens
      *
@@ -64,15 +46,6 @@ export class Universal extends ClientSDK {
     async supportedTokens(request, options) {
         return unwrapAsync(universalSupportedTokens(this, request, options));
     }
-    /**
-     * User Token Balance
-     *
-     * @remarks
-     * Returns the balance of a specific ERC20 token for a given user address.
-     */
-    async balance(request, options) {
-        return unwrapAsync(universalBalance(this, request, options));
-    }
     /**
      * Get allowance - Protocol
      *
@@ -120,24 +93,6 @@ export class Universal extends ClientSDK {
     async unwrapWeth(request, options) {
         return unwrapAsync(universalUnwrapWeth(this, request, options));
     }
-    /**
-     * Transfer Token
-     *
-     * @remarks
-     * Sends ERC20 tokens from the sender's address to the specified recipient.
-     */
-    async transferErc20(request, options) {
-        return unwrapAsync(universalTransferErc20(this, request, options));
-    }
-    /**
-     * Transfer ETH
-     *
-     * @remarks
-     * Sends native ETH from the sender's address to the specified recipient.
-     */
-    async transferNativeToken(request, options) {
-        return unwrapAsync(universalTransferNativeToken(this, request, options));
-    }
     /**
      * Set Allowance - Protocol
      *

package/dist/esm/sdk/universal.js.map

@@ -1 +1 @@
-{"version":3,"file":"universal.js","sourceRoot":"","sources":["../../../src/sdk/universal.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,wBAAwB,EAAE,MAAM,sCAAsC,CAAC;AAChF,OAAO,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAC5E,OAAO,EAAE,4BAA4B,EAAE,MAAM,0CAA0C,CAAC;AACxF,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,2BAA2B,EAAE,MAAM,yCAAyC,CAAC;AACtF,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,SAAU,SAAQ,SAAS;IACtC;;;;;;;;OAQG;IACH,KAAK,CAAC,SAAS,CACb,OAA2C,EAC3C,OAAwB;QAExB,OAAO,WAAW,CAAC,kBAAkB,CACnC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,kBAAkB,CACtB,OAAoD,EACpD,OAAwB;QAExB,OAAO,WAAW,CAAC,2BAA2B,CAC5C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,QAAQ,CACZ,OAA0C,EAC1C,OAAwB;QAExB,OAAO,WAAW,CAAC,iBAAiB,CAClC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,eAAe,CACnB,OAAiD,EACjD,OAAwB;QAExB,OAAO,WAAW,CAAC,wBAAwB,CACzC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,OAAO,CACX,OAAyC,EACzC,OAAwB;QAExB,OAAO,WAAW,CAAC,gBAAgB,CACjC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,SAAS,CACb,OAA2C,EAC3C,OAAwB;QAExB,OAAO,WAAW,CAAC,kBAAkB,CACnC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,GAAG,CACP,OAAqC,EACrC,OAAwB;QAExB,OAAO,WAAW,CAAC,YAAY,CAC7B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,OAAO,CACX,OAAkC,EAClC,OAAwB;QAExB,OAAO,WAAW,CAAC,gBAAgB,CACjC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,UAAU,CACd,OAAqC,EACrC,OAAwB;QAExB,OAAO,WAAW,CAAC,mBAAmB,CACpC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CACjB,OAAwC,EACxC,OAAwB;QAExB,OAAO,WAAW,CAAC,sBAAsB,CACvC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,mBAAmB,CACvB,OAAsC,EACtC,OAAwB;QAExB,OAAO,WAAW,CAAC,4BAA4B,CAC7C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,YAAY,CAChB,OAA4C,EAC5C,OAAwB;QAExB,OAAO,WAAW,CAAC,qBAAqB,CACtC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"universal.js","sourceRoot":"","sources":["../../../src/sdk/universal.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EAAE,wBAAwB,EAAE,MAAM,sCAAsC,CAAC;AAChF,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,2BAA2B,EAAE,MAAM,yCAAyC,CAAC;AACtF,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,SAAU,SAAQ,SAAS;IACtC;;;;;;;;OAQG;IACH,KAAK,CAAC,SAAS,CACb,OAA2C,EAC3C,OAAwB;QAExB,OAAO,WAAW,CAAC,kBAAkB,CACnC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,kBAAkB,CACtB,OAAoD,EACpD,OAAwB;QAExB,OAAO,WAAW,CAAC,2BAA2B,CAC5C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,eAAe,CACnB,OAAiD,EACjD,OAAwB;QAExB,OAAO,WAAW,CAAC,wBAAwB,CACzC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,SAAS,CACb,OAA2C,EAC3C,OAAwB;QAExB,OAAO,WAAW,CAAC,kBAAkB,CACnC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,GAAG,CACP,OAAqC,EACrC,OAAwB;QAExB,OAAO,WAAW,CAAC,YAAY,CAC7B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,OAAO,CACX,OAAkC,EAClC,OAAwB;QAExB,OAAO,WAAW,CAAC,gBAAgB,CACjC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,UAAU,CACd,OAAqC,EACrC,OAAwB;QAExB,OAAO,WAAW,CAAC,mBAAmB,CACpC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,YAAY,CAChB,OAA4C,EAC5C,OAAwB;QAExB,OAAO,WAAW,CAAC,qBAAqB,CACtC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}

package/docs/sdks/aavev3/README.md

@@ -216,6 +216,7 @@ const compassApiSDK = new CompassApiSDK({
 async function run() {
   const result = await compassApiSDK.aaveV3.userPositionSummary({
     chain: "arbitrum:mainnet",
+    user: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
   // Handle the result
@@ -242,6 +243,7 @@ const compassApiSDK = new CompassApiSDKCore({
 async function run() {
   const res = await aaveV3UserPositionSummary(compassApiSDK, {
     chain: "arbitrum:mainnet",
+    user: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
   if (!res.ok) {
@@ -301,6 +303,7 @@ const compassApiSDK = new CompassApiSDK({
 async function run() {
   const result = await compassApiSDK.aaveV3.userPositionPerToken({
     chain: "arbitrum:mainnet",
+    user: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
     token: "USDC",
   });
 
@@ -328,6 +331,7 @@ const compassApiSDK = new CompassApiSDKCore({
 async function run() {
   const res = await aaveV3UserPositionPerToken(compassApiSDK, {
     chain: "arbitrum:mainnet",
+    user: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
     token: "USDC",
   });
 

package/docs/sdks/transactionbatching/README.md

@@ -0,0 +1,221 @@
+# TransactionBatching
+(*transactionBatching*)
+
+## Overview
+
+### Available Operations
+
+* [authorization](#authorization) - Get EIP-7702 Authorization
+* [execute](#execute) - Execute Tx Batching
+
+## authorization
+
+Get authorization data for EIP-7702 batching operations.
+
+This authorization is required to prevent replay attacks and ensure transaction
+ordering when batching multiple actions into a single transaction. The authorization
+includes a nonce and chain ID to guarantee transaction uniqueness and proper network
+targeting.
+
+### 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.transactionBatching.authorization({
+    chain: "ethereum:local",
+    sender: "<value>",
+    address: "5176 Grange Avenue",
+  });
+
+  // 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 { transactionBatchingAuthorization } from "@compass-labs/api-sdk/funcs/transactionBatchingAuthorization.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 transactionBatchingAuthorization(compassApiSDK, {
+    chain: "ethereum:local",
+    sender: "<value>",
+    address: "5176 Grange Avenue",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.MulticallAuthorizationRequest](../../models/components/multicallauthorizationrequest.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.MulticallAuthorizationResponse](../../models/components/multicallauthorizationresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## execute
+
+Execute a batch of transactions in a single multicall using EIP-7702.
+
+This endpoint allows bundling multiple contract calls into a single atomic
+transaction, reducing gas costs and ensuring all operations succeed or fail
+together. The transaction must be authorized using the /authorization endpoint to
+prevent replay attacks.
+
+### 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.transactionBatching.execute({
+    chain: "ethereum:mainnet",
+    sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+    signedAuthorization: {
+      nonce: 259799,
+      address: "91533 Simonis View",
+      chainId: 7933,
+      r: "<value>",
+      s: "<value>",
+      yParity: 755397,
+    },
+    contractAddress: "<value>",
+    actions: [
+      {
+        actionType: "UNWRAP_WETH",
+        body: {
+          tokenIn: "KNC",
+          tokenOut: "MKR",
+          tickSpacing: 400,
+          amountOut: 1.5,
+          amountInMaximum: 1.6,
+        },
+      },
+    ],
+  });
+
+  // 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 { transactionBatchingExecute } from "@compass-labs/api-sdk/funcs/transactionBatchingExecute.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 transactionBatchingExecute(compassApiSDK, {
+    chain: "ethereum:mainnet",
+    sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+    signedAuthorization: {
+      nonce: 259799,
+      address: "91533 Simonis View",
+      chainId: 7933,
+      r: "<value>",
+      s: "<value>",
+      yParity: 755397,
+    },
+    contractAddress: "<value>",
+    actions: [
+      {
+        actionType: "UNWRAP_WETH",
+        body: {
+          tokenIn: "KNC",
+          tokenOut: "MKR",
+          tickSpacing: 400,
+          amountOut: 1.5,
+          amountInMaximum: 1.6,
+        },
+      },
+    ],
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.MulticallExecuteRequest](../../models/components/multicallexecuterequest.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.UnsignedMulticallTransaction](../../models/components/unsignedmulticalltransaction.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |