@compass-labs/api-sdk 0.0.16 → 0.0.18

package/docs/sdks/aavev3/README.md

@@ -9,6 +9,7 @@
 * [liquidityChange](#liquiditychange) - Liquidity index
 * [userPositionSummary](#userpositionsummary) - Positions - total
 * [userPositionPerToken](#userpositionpertoken) - Positions - per token
+* [historicalTransactions](#historicaltransactions) - Historical transactions
 * [supply](#supply) - Supply/Lend
 * [borrow](#borrow) - Borrow
 * [repay](#repay) - Repay loans
@@ -368,6 +369,90 @@ run();
 | errors.HTTPValidationError | 422                        | application/json           |
 | errors.APIError            | 4XX, 5XX                   | \*/\*                      |
 
+## historicalTransactions
+
+This endpoint retrieves historical transactions for a user on the AAVE platform.
+
+It returns a list of transactions including deposits, withdrawals, borrows, and
+repayments. Each transaction includes details such as the token, amount, timestamp,
+and transaction type. This provides a comprehensive view of the user's historical
+activity within the AAVE protocol.
+
+### 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.aaveV3.historicalTransactions({
+    chain: "arbitrum:mainnet",
+    userAddress: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+  });
+
+  // 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 { aaveV3HistoricalTransactions } from "@compass-labs/api-sdk/funcs/aaveV3HistoricalTransactions.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 aaveV3HistoricalTransactions(compassApiSDK, {
+    chain: "arbitrum:mainnet",
+    userAddress: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.AaveHistoricalTransactionsRequest](../../models/operations/aavehistoricaltransactionsrequest.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.AaveHistoricalTransactionsResponse](../../models/components/aavehistoricaltransactionsresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
 ## supply
 
 By supplying assets, users can earn interest on their deposits.

package/docs/sdks/transactionbatching/README.md

@@ -130,7 +130,7 @@ async function run() {
           tokenOut: "USDC",
           fee: "0.01",
           amountOut: 1.5,
-          amountInMaximum: 1.6,
+          maxSlippagePercent: 0.5,
           wrapEth: true,
         },
       },
@@ -178,7 +178,7 @@ async function run() {
           tokenOut: "USDC",
           fee: "0.01",
           amountOut: 1.5,
-          amountInMaximum: 1.6,
+          maxSlippagePercent: 0.5,
           wrapEth: true,
         },
       },

package/docs/sdks/uniswapv3/README.md

@@ -473,7 +473,7 @@ async function run() {
     tokenOut: "cbETH",
     fee: "1.0",
     amountOut: 1.5,
-    amountInMaximum: 1.6,
+    maxSlippagePercent: 0.5,
     chain: "ethereum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
@@ -505,7 +505,7 @@ async function run() {
     tokenOut: "cbETH",
     fee: "1.0",
     amountOut: 1.5,
-    amountInMaximum: 1.6,
+    maxSlippagePercent: 0.5,
     chain: "ethereum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
@@ -567,8 +567,8 @@ async function run() {
     tokenIn: "FXS",
     tokenOut: "LUSD",
     fee: "0.05",
-    amountIn: 1.5,
-    amountOutMinimum: 1.4,
+    amount: 1.5,
+    maxSlippagePercent: 0.5,
     chain: "arbitrum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
@@ -599,8 +599,8 @@ async function run() {
     tokenIn: "FXS",
     tokenOut: "LUSD",
     fee: "0.05",
-    amountIn: 1.5,
-    amountOutMinimum: 1.4,
+    amount: 1.5,
+    maxSlippagePercent: 0.5,
     chain: "arbitrum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "@compass-labs/api-sdk",
-  "version": "0.0.16",
+  "version": "0.0.18",
   "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.0.16",
+  "version": "0.0.18",
   "author": "royalnine",
   "type": "module",
   "bin": {

package/src/funcs/aaveV3HistoricalTransactions.ts

@@ -0,0 +1,177 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { CompassApiSDKCore } from "../core.js";
+import { encodeFormQuery } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import { APIError } from "../models/errors/apierror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Historical transactions
+ *
+ * @remarks
+ * This endpoint retrieves historical transactions for a user on the AAVE platform.
+ *
+ * It returns a list of transactions including deposits, withdrawals, borrows, and
+ * repayments. Each transaction includes details such as the token, amount, timestamp,
+ * and transaction type. This provides a comprehensive view of the user's historical
+ * activity within the AAVE protocol.
+ */
+export function aaveV3HistoricalTransactions(
+  client: CompassApiSDKCore,
+  request: operations.AaveHistoricalTransactionsRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.AaveHistoricalTransactionsResponse,
+    | errors.HTTPValidationError
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: CompassApiSDKCore,
+  request: operations.AaveHistoricalTransactionsRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.AaveHistoricalTransactionsResponse,
+      | errors.HTTPValidationError
+      | APIError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.AaveHistoricalTransactionsRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/v0/aave/historical_transactions/get")();
+
+  const query = encodeFormQuery({
+    "chain": payload.chain,
+    "limit": payload.limit,
+    "offset": payload.offset,
+    "user_address": payload.user_address,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKeyAuth);
+  const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "aave_historical_transactions",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKeyAuth,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["422", "4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    components.AaveHistoricalTransactionsResponse,
+    | errors.HTTPValidationError
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, components.AaveHistoricalTransactionsResponse$inboundSchema),
+    M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/lib/config.ts

@@ -57,8 +57,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.0.1",
-  sdkVersion: "0.0.16",
+  sdkVersion: "0.0.18",
   genVersion: "2.597.9",
   userAgent:
-    "speakeasy-sdk/typescript 0.0.16 2.597.9 0.0.1 @compass-labs/api-sdk",
+    "speakeasy-sdk/typescript 0.0.18 2.597.9 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.0.16",
+    currentVersion: "0.0.18",
   },
 });
 

package/src/mcp-server/server.ts

@@ -14,6 +14,7 @@ import {
 import { MCPScope } from "./scopes.js";
 import { createRegisterTool } from "./tools.js";
 import { tool$aaveV3Borrow } from "./tools/aaveV3Borrow.js";
+import { tool$aaveV3HistoricalTransactions } from "./tools/aaveV3HistoricalTransactions.js";
 import { tool$aaveV3LiquidityChange } from "./tools/aaveV3LiquidityChange.js";
 import { tool$aaveV3Repay } from "./tools/aaveV3Repay.js";
 import { tool$aaveV3Supply } from "./tools/aaveV3Supply.js";
@@ -79,7 +80,7 @@ export function createMCPServer(deps: {
 }) {
   const server = new McpServer({
     name: "CompassApiSDK",
-    version: "0.0.16",
+    version: "0.0.18",
   });
 
   const client = new CompassApiSDKCore({
@@ -113,6 +114,7 @@ export function createMCPServer(deps: {
   tool(tool$aaveV3LiquidityChange);
   tool(tool$aaveV3UserPositionSummary);
   tool(tool$aaveV3UserPositionPerToken);
+  tool(tool$aaveV3HistoricalTransactions);
   tool(tool$aaveV3Supply);
   tool(tool$aaveV3Borrow);
   tool(tool$aaveV3Repay);

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

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { aaveV3HistoricalTransactions } from "../../funcs/aaveV3HistoricalTransactions.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.AaveHistoricalTransactionsRequest$inboundSchema,
+};
+
+export const tool$aaveV3HistoricalTransactions: ToolDefinition<typeof args> = {
+  name: "aave-v3-historical-transactions",
+  description: `Historical transactions
+
+This endpoint retrieves historical transactions for a user on the AAVE platform.
+
+It returns a list of transactions including deposits, withdrawals, borrows, and
+repayments. Each transaction includes details such as the token, amount, timestamp,
+and transaction type. This provides a comprehensive view of the user's historical
+activity within the AAVE protocol.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await aaveV3HistoricalTransactions(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/models/components/aavehistoricaltransactionbase.ts

@@ -0,0 +1,155 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  Action,
+  Action$inboundSchema,
+  Action$outboundSchema,
+} from "./action.js";
+import {
+  Borrow,
+  Borrow$inboundSchema,
+  Borrow$Outbound,
+  Borrow$outboundSchema,
+} from "./borrow.js";
+import {
+  LiquidationCall,
+  LiquidationCall$inboundSchema,
+  LiquidationCall$Outbound,
+  LiquidationCall$outboundSchema,
+} from "./liquidationcall.js";
+import {
+  RedeemUnderlying,
+  RedeemUnderlying$inboundSchema,
+  RedeemUnderlying$Outbound,
+  RedeemUnderlying$outboundSchema,
+} from "./redeemunderlying.js";
+import {
+  Repay,
+  Repay$inboundSchema,
+  Repay$Outbound,
+  Repay$outboundSchema,
+} from "./repay.js";
+import {
+  Supply,
+  Supply$inboundSchema,
+  Supply$Outbound,
+  Supply$outboundSchema,
+} from "./supply.js";
+import {
+  SwapBorrowRate,
+  SwapBorrowRate$inboundSchema,
+  SwapBorrowRate$Outbound,
+  SwapBorrowRate$outboundSchema,
+} from "./swapborrowrate.js";
+import {
+  UsageAsCollateral,
+  UsageAsCollateral$inboundSchema,
+  UsageAsCollateral$Outbound,
+  UsageAsCollateral$outboundSchema,
+} from "./usageascollateral.js";
+
+export type AaveHistoricalTransactionBase = {
+  id: string;
+  timestamp: number;
+  txHash: string;
+  action: Action;
+  supply?: Supply | null | undefined;
+  redeemUnderlying?: RedeemUnderlying | null | undefined;
+  borrow?: Borrow | null | undefined;
+  usageAsCollateral?: UsageAsCollateral | null | undefined;
+  repay?: Repay | null | undefined;
+  swapBorrowRate?: SwapBorrowRate | null | undefined;
+  liquidationCall?: LiquidationCall | null | undefined;
+};
+
+/** @internal */
+export const AaveHistoricalTransactionBase$inboundSchema: z.ZodType<
+  AaveHistoricalTransactionBase,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  timestamp: z.number().int(),
+  txHash: z.string(),
+  action: Action$inboundSchema,
+  supply: z.nullable(Supply$inboundSchema).optional(),
+  redeemUnderlying: z.nullable(RedeemUnderlying$inboundSchema).optional(),
+  borrow: z.nullable(Borrow$inboundSchema).optional(),
+  usageAsCollateral: z.nullable(UsageAsCollateral$inboundSchema).optional(),
+  repay: z.nullable(Repay$inboundSchema).optional(),
+  swapBorrowRate: z.nullable(SwapBorrowRate$inboundSchema).optional(),
+  liquidationCall: z.nullable(LiquidationCall$inboundSchema).optional(),
+});
+
+/** @internal */
+export type AaveHistoricalTransactionBase$Outbound = {
+  id: string;
+  timestamp: number;
+  txHash: string;
+  action: string;
+  supply?: Supply$Outbound | null | undefined;
+  redeemUnderlying?: RedeemUnderlying$Outbound | null | undefined;
+  borrow?: Borrow$Outbound | null | undefined;
+  usageAsCollateral?: UsageAsCollateral$Outbound | null | undefined;
+  repay?: Repay$Outbound | null | undefined;
+  swapBorrowRate?: SwapBorrowRate$Outbound | null | undefined;
+  liquidationCall?: LiquidationCall$Outbound | null | undefined;
+};
+
+/** @internal */
+export const AaveHistoricalTransactionBase$outboundSchema: z.ZodType<
+  AaveHistoricalTransactionBase$Outbound,
+  z.ZodTypeDef,
+  AaveHistoricalTransactionBase
+> = z.object({
+  id: z.string(),
+  timestamp: z.number().int(),
+  txHash: z.string(),
+  action: Action$outboundSchema,
+  supply: z.nullable(Supply$outboundSchema).optional(),
+  redeemUnderlying: z.nullable(RedeemUnderlying$outboundSchema).optional(),
+  borrow: z.nullable(Borrow$outboundSchema).optional(),
+  usageAsCollateral: z.nullable(UsageAsCollateral$outboundSchema).optional(),
+  repay: z.nullable(Repay$outboundSchema).optional(),
+  swapBorrowRate: z.nullable(SwapBorrowRate$outboundSchema).optional(),
+  liquidationCall: z.nullable(LiquidationCall$outboundSchema).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AaveHistoricalTransactionBase$ {
+  /** @deprecated use `AaveHistoricalTransactionBase$inboundSchema` instead. */
+  export const inboundSchema = AaveHistoricalTransactionBase$inboundSchema;
+  /** @deprecated use `AaveHistoricalTransactionBase$outboundSchema` instead. */
+  export const outboundSchema = AaveHistoricalTransactionBase$outboundSchema;
+  /** @deprecated use `AaveHistoricalTransactionBase$Outbound` instead. */
+  export type Outbound = AaveHistoricalTransactionBase$Outbound;
+}
+
+export function aaveHistoricalTransactionBaseToJSON(
+  aaveHistoricalTransactionBase: AaveHistoricalTransactionBase,
+): string {
+  return JSON.stringify(
+    AaveHistoricalTransactionBase$outboundSchema.parse(
+      aaveHistoricalTransactionBase,
+    ),
+  );
+}
+
+export function aaveHistoricalTransactionBaseFromJSON(
+  jsonString: string,
+): SafeParseResult<AaveHistoricalTransactionBase, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AaveHistoricalTransactionBase$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AaveHistoricalTransactionBase' from JSON`,
+  );
+}