@compass-labs/api-sdk 0.5.6 → 0.5.8

package/docs/sdks/universal/README.md

@@ -31,11 +31,8 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.universal.portfolio({
-    chain: "arbitrum:mainnet",
-  });
+  const result = await compassApiSDK.universal.portfolio({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -57,18 +54,13 @@ const compassApiSDK = new CompassApiSDKCore({
 });
 
 async function run() {
-  const res = await universalPortfolio(compassApiSDK, {
-    chain: "arbitrum:mainnet",
-  });
-
-  if (!res.ok) {
-    throw res.error;
+  const res = await universalPortfolio(compassApiSDK, {});
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("universalPortfolio failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -112,11 +104,8 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.universal.visualizePortfolio({
-    chain: "arbitrum:mainnet",
-  });
+  const result = await compassApiSDK.universal.visualizePortfolio({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -138,18 +127,13 @@ const compassApiSDK = new CompassApiSDKCore({
 });
 
 async function run() {
-  const res = await universalVisualizePortfolio(compassApiSDK, {
-    chain: "arbitrum:mainnet",
-  });
-
-  if (!res.ok) {
-    throw res.error;
+  const res = await universalVisualizePortfolio(compassApiSDK, {});
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("universalVisualizePortfolio failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -189,11 +173,8 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.universal.supportedTokens({
-    chain: "arbitrum:mainnet",
-  });
+  const result = await compassApiSDK.universal.supportedTokens({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -215,18 +196,13 @@ const compassApiSDK = new CompassApiSDKCore({
 });
 
 async function run() {
-  const res = await universalSupportedTokens(compassApiSDK, {
-    chain: "arbitrum:mainnet",
-  });
-
-  if (!res.ok) {
-    throw res.error;
+  const res = await universalSupportedTokens(compassApiSDK, {});
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("universalSupportedTokens failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -272,13 +248,8 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.universal.allowance({
-    chain: "arbitrum:mainnet",
-    token: "USDC",
-    contractName: "AaveV3Pool",
-  });
+  const result = await compassApiSDK.universal.allowance({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -300,20 +271,13 @@ const compassApiSDK = new CompassApiSDKCore({
 });
 
 async function run() {
-  const res = await universalAllowance(compassApiSDK, {
-    chain: "arbitrum:mainnet",
-    token: "USDC",
-    contractName: "AaveV3Pool",
-  });
-
-  if (!res.ok) {
-    throw res.error;
+  const res = await universalAllowance(compassApiSDK, {});
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("universalAllowance failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -356,11 +320,8 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.universal.ens({
-    chain: "ethereum:mainnet",
-  });
+  const result = await compassApiSDK.universal.ens({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -382,18 +343,13 @@ const compassApiSDK = new CompassApiSDKCore({
 });
 
 async function run() {
-  const res = await universalEns(compassApiSDK, {
-    chain: "ethereum:mainnet",
-  });
-
-  if (!res.ok) {
-    throw res.error;
+  const res = await universalEns(compassApiSDK, {});
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("universalEns failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -440,7 +396,6 @@ async function run() {
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -467,15 +422,12 @@ async function run() {
     chain: "arbitrum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("universalWrapEth failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -522,7 +474,6 @@ async function run() {
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -549,15 +500,12 @@ async function run() {
     chain: "arbitrum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("universalUnwrapWeth failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -611,7 +559,6 @@ async function run() {
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -640,15 +587,12 @@ async function run() {
     chain: "base:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("universalAllowanceSet failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/jsr.json

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

package/package.json

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

package/src/funcs/transactionBatchingAaveLoop.ts

@@ -25,7 +25,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Execute Aave Loop Strategy
+ * AAVE leverage long/short
  *
  * @remarks
  * Execute an Aave looping strategy that involves repeated supply and borrow

package/src/funcs/transactionBatchingAuthorization.ts

@@ -25,15 +25,15 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get EIP-7702 Authorization
+ * Enable transaction bundling.
  *
  * @remarks
- * Get authorization data for EIP-7702 batching operations.
+ * Get authorization for bundling transactions.
  *
- * 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.
+ * Currently this is required for every transaction bundle 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.
  */
 export function transactionBatchingAuthorization(
   client: CompassApiSDKCore,

package/src/funcs/transactionBatchingExecute.ts

@@ -25,10 +25,11 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Execute Tx Batching
+ * Construct Bundled Transaction
  *
  * @remarks
- * Execute a batch of transactions in a single multicall using EIP-7702.
+ * Bundle arbitrary transactions together into a single multicall transaction 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

package/src/lib/config.ts

@@ -61,8 +61,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.0.1",
-  sdkVersion: "0.5.6",
-  genVersion: "2.618.0",
+  sdkVersion: "0.5.8",
+  genVersion: "2.620.2",
   userAgent:
-    "speakeasy-sdk/typescript 0.5.6 2.618.0 0.0.1 @compass-labs/api-sdk",
+    "speakeasy-sdk/typescript 0.5.8 2.620.2 0.0.1 @compass-labs/api-sdk",
 } as const;

package/src/mcp-server/mcp-server.ts

@@ -19,7 +19,7 @@ const routes = buildRouteMap({
 export const app = buildApplication(routes, {
   name: "mcp",
   versionInfo: {
-    currentVersion: "0.5.6",
+    currentVersion: "0.5.8",
   },
 });
 

package/src/mcp-server/server.ts

@@ -98,7 +98,7 @@ export function createMCPServer(deps: {
 }) {
   const server = new McpServer({
     name: "CompassApiSDK",
-    version: "0.5.6",
+    version: "0.5.8",
   });
 
   const client = new CompassApiSDKCore({

package/src/mcp-server/tools/transactionBatchingAaveLoop.ts

@@ -12,7 +12,7 @@ const args = {
 
 export const tool$transactionBatchingAaveLoop: ToolDefinition<typeof args> = {
   name: "transaction-batching-aave-loop",
-  description: `Execute Aave Loop Strategy
+  description: `AAVE leverage long/short
 
 Execute an Aave looping strategy that involves repeated supply and borrow
 operations.

package/src/mcp-server/tools/transactionBatchingAuthorization.ts

@@ -14,14 +14,14 @@ export const tool$transactionBatchingAuthorization: ToolDefinition<
   typeof args
 > = {
   name: "transaction-batching-authorization",
-  description: `Get EIP-7702 Authorization
+  description: `Enable transaction bundling.
 
-Get authorization data for EIP-7702 batching operations.
+Get authorization for bundling transactions.
 
-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.`,
+Currently this is required for every transaction bundle 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.`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await transactionBatchingAuthorization(

package/src/mcp-server/tools/transactionBatchingExecute.ts

@@ -12,9 +12,10 @@ const args = {
 
 export const tool$transactionBatchingExecute: ToolDefinition<typeof args> = {
   name: "transaction-batching-execute",
-  description: `Execute Tx Batching
+  description: `Construct Bundled Transaction
 
-Execute a batch of transactions in a single multicall using EIP-7702.
+Bundle arbitrary transactions together into a single multicall transaction 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

package/src/models/errors/apierror.ts

@@ -3,22 +3,37 @@
  */
 
 export class APIError extends Error {
+  /**
+   * HTTP status code
+   */
   public readonly statusCode: number;
+  /**
+   * HTTP content type
+   */
   public readonly contentType: string;
+  /**
+   * HTTP body
+   */
+  public readonly body: string;
+  /**
+   * Raw response
+   */
+  public readonly rawResponse: Response;
 
   constructor(
     message: string,
-    public readonly rawResponse: Response,
-    public readonly body: string = "",
+    rawResponse: Response,
+    body: string = "",
   ) {
     const statusCode = rawResponse.status;
     const contentType = rawResponse.headers.get("content-type") || "";
     const bodyString = body.length > 0 ? `\n${body}` : "";
-
     super(
       `${message}: Status ${statusCode} Content-Type ${contentType} Body ${bodyString}`,
     );
 
+    this.body = body;
+    this.rawResponse = rawResponse;
     this.statusCode = statusCode;
     this.contentType = contentType;
 

package/src/sdk/transactionbatching.ts

@@ -11,15 +11,15 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class TransactionBatching extends ClientSDK {
   /**
-   * Get EIP-7702 Authorization
+   * Enable transaction bundling.
    *
    * @remarks
-   * Get authorization data for EIP-7702 batching operations.
+   * Get authorization for bundling transactions.
    *
-   * 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.
+   * Currently this is required for every transaction bundle 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.
    */
   async authorization(
     request: components.MulticallAuthorizationRequest,
@@ -33,10 +33,11 @@ export class TransactionBatching extends ClientSDK {
   }
 
   /**
-   * Execute Tx Batching
+   * Construct Bundled Transaction
    *
    * @remarks
-   * Execute a batch of transactions in a single multicall using EIP-7702.
+   * Bundle arbitrary transactions together into a single multicall transaction 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
@@ -55,7 +56,7 @@ export class TransactionBatching extends ClientSDK {
   }
 
   /**
-   * Execute Aave Loop Strategy
+   * AAVE leverage long/short
    *
    * @remarks
    * Execute an Aave looping strategy that involves repeated supply and borrow