@compass-labs/api-sdk 0.0.16 → 0.0.17

package/src/models/operations/aavehistoricaltransactions.ts

@@ -0,0 +1,139 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * The chain to use.
+ */
+export const AaveHistoricalTransactionsChain = {
+  BaseMainnet: "base:mainnet",
+  EthereumMainnet: "ethereum:mainnet",
+  ArbitrumMainnet: "arbitrum:mainnet",
+  EthereumLocal: "ethereum:local",
+  ArbitrumLocal: "arbitrum:local",
+  BaseLocal: "base:local",
+} as const;
+/**
+ * The chain to use.
+ */
+export type AaveHistoricalTransactionsChain = ClosedEnum<
+  typeof AaveHistoricalTransactionsChain
+>;
+
+export type AaveHistoricalTransactionsRequest = {
+  offset?: number | undefined;
+  limit?: number | undefined;
+  /**
+   * The chain to use.
+   */
+  chain?: AaveHistoricalTransactionsChain | undefined;
+  userAddress?: string | undefined;
+};
+
+/** @internal */
+export const AaveHistoricalTransactionsChain$inboundSchema: z.ZodNativeEnum<
+  typeof AaveHistoricalTransactionsChain
+> = z.nativeEnum(AaveHistoricalTransactionsChain);
+
+/** @internal */
+export const AaveHistoricalTransactionsChain$outboundSchema: z.ZodNativeEnum<
+  typeof AaveHistoricalTransactionsChain
+> = AaveHistoricalTransactionsChain$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AaveHistoricalTransactionsChain$ {
+  /** @deprecated use `AaveHistoricalTransactionsChain$inboundSchema` instead. */
+  export const inboundSchema = AaveHistoricalTransactionsChain$inboundSchema;
+  /** @deprecated use `AaveHistoricalTransactionsChain$outboundSchema` instead. */
+  export const outboundSchema = AaveHistoricalTransactionsChain$outboundSchema;
+}
+
+/** @internal */
+export const AaveHistoricalTransactionsRequest$inboundSchema: z.ZodType<
+  AaveHistoricalTransactionsRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  offset: z.number().int().default(0),
+  limit: z.number().int().default(100),
+  chain: AaveHistoricalTransactionsChain$inboundSchema.default(
+    "arbitrum:mainnet",
+  ),
+  user_address: z.string().default(
+    "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+  ),
+}).transform((v) => {
+  return remap$(v, {
+    "user_address": "userAddress",
+  });
+});
+
+/** @internal */
+export type AaveHistoricalTransactionsRequest$Outbound = {
+  offset: number;
+  limit: number;
+  chain: string;
+  user_address: string;
+};
+
+/** @internal */
+export const AaveHistoricalTransactionsRequest$outboundSchema: z.ZodType<
+  AaveHistoricalTransactionsRequest$Outbound,
+  z.ZodTypeDef,
+  AaveHistoricalTransactionsRequest
+> = z.object({
+  offset: z.number().int().default(0),
+  limit: z.number().int().default(100),
+  chain: AaveHistoricalTransactionsChain$outboundSchema.default(
+    "arbitrum:mainnet",
+  ),
+  userAddress: z.string().default("0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"),
+}).transform((v) => {
+  return remap$(v, {
+    userAddress: "user_address",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AaveHistoricalTransactionsRequest$ {
+  /** @deprecated use `AaveHistoricalTransactionsRequest$inboundSchema` instead. */
+  export const inboundSchema = AaveHistoricalTransactionsRequest$inboundSchema;
+  /** @deprecated use `AaveHistoricalTransactionsRequest$outboundSchema` instead. */
+  export const outboundSchema =
+    AaveHistoricalTransactionsRequest$outboundSchema;
+  /** @deprecated use `AaveHistoricalTransactionsRequest$Outbound` instead. */
+  export type Outbound = AaveHistoricalTransactionsRequest$Outbound;
+}
+
+export function aaveHistoricalTransactionsRequestToJSON(
+  aaveHistoricalTransactionsRequest: AaveHistoricalTransactionsRequest,
+): string {
+  return JSON.stringify(
+    AaveHistoricalTransactionsRequest$outboundSchema.parse(
+      aaveHistoricalTransactionsRequest,
+    ),
+  );
+}
+
+export function aaveHistoricalTransactionsRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<AaveHistoricalTransactionsRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AaveHistoricalTransactionsRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AaveHistoricalTransactionsRequest' from JSON`,
+  );
+}

package/src/models/operations/aaveliquiditychange.ts

@@ -16,6 +16,9 @@ export const AaveLiquidityChangeChain = {
   BaseMainnet: "base:mainnet",
   EthereumMainnet: "ethereum:mainnet",
   ArbitrumMainnet: "arbitrum:mainnet",
+  EthereumLocal: "ethereum:local",
+  ArbitrumLocal: "arbitrum:local",
+  BaseLocal: "base:local",
 } as const;
 /**
  * The chain to use.

package/src/models/operations/aavetokenprice.ts

@@ -15,6 +15,9 @@ export const AaveTokenPriceChain = {
   BaseMainnet: "base:mainnet",
   EthereumMainnet: "ethereum:mainnet",
   ArbitrumMainnet: "arbitrum:mainnet",
+  EthereumLocal: "ethereum:local",
+  ArbitrumLocal: "arbitrum:local",
+  BaseLocal: "base:local",
 } as const;
 /**
  * The chain to use.

package/src/models/operations/aaveuserpositionpertoken.ts

@@ -15,6 +15,9 @@ export const AaveUserPositionPerTokenChain = {
   BaseMainnet: "base:mainnet",
   EthereumMainnet: "ethereum:mainnet",
   ArbitrumMainnet: "arbitrum:mainnet",
+  EthereumLocal: "ethereum:local",
+  ArbitrumLocal: "arbitrum:local",
+  BaseLocal: "base:local",
 } as const;
 /**
  * The chain to use.

package/src/models/operations/aaveuserpositionsummary.ts

@@ -15,6 +15,9 @@ export const AaveUserPositionSummaryChain = {
   BaseMainnet: "base:mainnet",
   EthereumMainnet: "ethereum:mainnet",
   ArbitrumMainnet: "arbitrum:mainnet",
+  EthereumLocal: "ethereum:local",
+  ArbitrumLocal: "arbitrum:local",
+  BaseLocal: "base:local",
 } as const;
 /**
  * The chain to use.

package/src/models/operations/aerodromeslipstreamliquidityprovisionpositions.ts

@@ -15,6 +15,9 @@ export const AerodromeSlipstreamLiquidityProvisionPositionsChain = {
   BaseMainnet: "base:mainnet",
   EthereumMainnet: "ethereum:mainnet",
   ArbitrumMainnet: "arbitrum:mainnet",
+  EthereumLocal: "ethereum:local",
+  ArbitrumLocal: "arbitrum:local",
+  BaseLocal: "base:local",
 } as const;
 /**
  * The chain to use.

package/src/models/operations/aerodromeslipstreampoolprice.ts

@@ -16,6 +16,9 @@ export const AerodromeSlipstreamPoolPriceChain = {
   BaseMainnet: "base:mainnet",
   EthereumMainnet: "ethereum:mainnet",
   ArbitrumMainnet: "arbitrum:mainnet",
+  EthereumLocal: "ethereum:local",
+  ArbitrumLocal: "arbitrum:local",
+  BaseLocal: "base:local",
 } as const;
 /**
  * The chain to use.

package/src/models/operations/genericallowance.ts

@@ -16,6 +16,9 @@ export const GenericAllowanceChain = {
   BaseMainnet: "base:mainnet",
   EthereumMainnet: "ethereum:mainnet",
   ArbitrumMainnet: "arbitrum:mainnet",
+  EthereumLocal: "ethereum:local",
+  ArbitrumLocal: "arbitrum:local",
+  BaseLocal: "base:local",
 } as const;
 /**
  * The chain to use.

package/src/models/operations/genericens.ts

@@ -16,6 +16,9 @@ export const GenericEnsChain = {
   BaseMainnet: "base:mainnet",
   EthereumMainnet: "ethereum:mainnet",
   ArbitrumMainnet: "arbitrum:mainnet",
+  EthereumLocal: "ethereum:local",
+  ArbitrumLocal: "arbitrum:local",
+  BaseLocal: "base:local",
 } as const;
 /**
  * The chain to use.

package/src/models/operations/genericportfolio.ts

@@ -15,6 +15,9 @@ export const GenericPortfolioChain = {
   BaseMainnet: "base:mainnet",
   EthereumMainnet: "ethereum:mainnet",
   ArbitrumMainnet: "arbitrum:mainnet",
+  EthereumLocal: "ethereum:local",
+  ArbitrumLocal: "arbitrum:local",
+  BaseLocal: "base:local",
 } as const;
 /**
  * The chain to use.

package/src/models/operations/genericsupportedtokens.ts

@@ -15,6 +15,9 @@ export const GenericSupportedTokensChain = {
   BaseMainnet: "base:mainnet",
   EthereumMainnet: "ethereum:mainnet",
   ArbitrumMainnet: "arbitrum:mainnet",
+  EthereumLocal: "ethereum:local",
+  ArbitrumLocal: "arbitrum:local",
+  BaseLocal: "base:local",
 } as const;
 /**
  * The chain to use.

package/src/models/operations/genericvisualizeportfolio.ts

@@ -15,6 +15,9 @@ export const GenericVisualizePortfolioChain = {
   BaseMainnet: "base:mainnet",
   EthereumMainnet: "ethereum:mainnet",
   ArbitrumMainnet: "arbitrum:mainnet",
+  EthereumLocal: "ethereum:local",
+  ArbitrumLocal: "arbitrum:local",
+  BaseLocal: "base:local",
 } as const;
 /**
  * The chain to use.

package/src/models/operations/index.ts

@@ -2,6 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+export * from "./aavehistoricaltransactions.js";
 export * from "./aaveliquiditychange.js";
 export * from "./aavetokenprice.js";
 export * from "./aaveuserpositionpertoken.js";

package/src/models/operations/morphomarketposition.ts

@@ -16,6 +16,9 @@ export const MorphoMarketPositionChain = {
   BaseMainnet: "base:mainnet",
   EthereumMainnet: "ethereum:mainnet",
   ArbitrumMainnet: "arbitrum:mainnet",
+  EthereumLocal: "ethereum:local",
+  ArbitrumLocal: "arbitrum:local",
+  BaseLocal: "base:local",
 } as const;
 /**
  * The chain to use.

package/src/models/operations/morphomarkets.ts

@@ -16,6 +16,9 @@ export const MorphoMarketsChain = {
   BaseMainnet: "base:mainnet",
   EthereumMainnet: "ethereum:mainnet",
   ArbitrumMainnet: "arbitrum:mainnet",
+  EthereumLocal: "ethereum:local",
+  ArbitrumLocal: "arbitrum:local",
+  BaseLocal: "base:local",
 } as const;
 /**
  * The chain to use.

package/src/models/operations/morphovaultposition.ts

@@ -16,6 +16,9 @@ export const MorphoVaultPositionChain = {
   BaseMainnet: "base:mainnet",
   EthereumMainnet: "ethereum:mainnet",
   ArbitrumMainnet: "arbitrum:mainnet",
+  EthereumLocal: "ethereum:local",
+  ArbitrumLocal: "arbitrum:local",
+  BaseLocal: "base:local",
 } as const;
 /**
  * The chain to use.

package/src/models/operations/morphovaults.ts

@@ -16,6 +16,9 @@ export const MorphoVaultsChain = {
   BaseMainnet: "base:mainnet",
   EthereumMainnet: "ethereum:mainnet",
   ArbitrumMainnet: "arbitrum:mainnet",
+  EthereumLocal: "ethereum:local",
+  ArbitrumLocal: "arbitrum:local",
+  BaseLocal: "base:local",
 } as const;
 /**
  * The chain to use.

package/src/models/operations/tokenaddress.ts

@@ -15,6 +15,9 @@ export const TokenAddressChain = {
   BaseMainnet: "base:mainnet",
   EthereumMainnet: "ethereum:mainnet",
   ArbitrumMainnet: "arbitrum:mainnet",
+  EthereumLocal: "ethereum:local",
+  ArbitrumLocal: "arbitrum:local",
+  BaseLocal: "base:local",
 } as const;
 /**
  * The chain to use.

package/src/models/operations/tokenbalance.ts

@@ -16,6 +16,9 @@ export const TokenBalanceChain = {
   BaseMainnet: "base:mainnet",
   EthereumMainnet: "ethereum:mainnet",
   ArbitrumMainnet: "arbitrum:mainnet",
+  EthereumLocal: "ethereum:local",
+  ArbitrumLocal: "arbitrum:local",
+  BaseLocal: "base:local",
 } as const;
 /**
  * The chain to use.

package/src/models/operations/tokenprice.ts

@@ -15,6 +15,9 @@ export const TokenPriceChain = {
   BaseMainnet: "base:mainnet",
   EthereumMainnet: "ethereum:mainnet",
   ArbitrumMainnet: "arbitrum:mainnet",
+  EthereumLocal: "ethereum:local",
+  ArbitrumLocal: "arbitrum:local",
+  BaseLocal: "base:local",
 } as const;
 /**
  * The chain to use.

package/src/models/operations/uniswapliquidityprovisioninrange.ts

@@ -16,6 +16,9 @@ export const UniswapLiquidityProvisionInRangeChain = {
   BaseMainnet: "base:mainnet",
   EthereumMainnet: "ethereum:mainnet",
   ArbitrumMainnet: "arbitrum:mainnet",
+  EthereumLocal: "ethereum:local",
+  ArbitrumLocal: "arbitrum:local",
+  BaseLocal: "base:local",
 } as const;
 /**
  * The chain to use.

package/src/models/operations/uniswapliquidityprovisionpositions.ts

@@ -15,6 +15,9 @@ export const UniswapLiquidityProvisionPositionsChain = {
   BaseMainnet: "base:mainnet",
   EthereumMainnet: "ethereum:mainnet",
   ArbitrumMainnet: "arbitrum:mainnet",
+  EthereumLocal: "ethereum:local",
+  ArbitrumLocal: "arbitrum:local",
+  BaseLocal: "base:local",
 } as const;
 /**
  * The chain to use.

package/src/models/operations/uniswappoolprice.ts

@@ -16,6 +16,9 @@ export const UniswapPoolPriceChain = {
   BaseMainnet: "base:mainnet",
   EthereumMainnet: "ethereum:mainnet",
   ArbitrumMainnet: "arbitrum:mainnet",
+  EthereumLocal: "ethereum:local",
+  ArbitrumLocal: "arbitrum:local",
+  BaseLocal: "base:local",
 } as const;
 /**
  * The chain to use.

package/src/models/operations/uniswapquotebuyexactly.ts

@@ -16,6 +16,9 @@ export const UniswapQuoteBuyExactlyChain = {
   BaseMainnet: "base:mainnet",
   EthereumMainnet: "ethereum:mainnet",
   ArbitrumMainnet: "arbitrum:mainnet",
+  EthereumLocal: "ethereum:local",
+  ArbitrumLocal: "arbitrum:local",
+  BaseLocal: "base:local",
 } as const;
 /**
  * The chain to use.

package/src/models/operations/uniswapquotesellexactly.ts

@@ -16,6 +16,9 @@ export const UniswapQuoteSellExactlyChain = {
   BaseMainnet: "base:mainnet",
   EthereumMainnet: "ethereum:mainnet",
   ArbitrumMainnet: "arbitrum:mainnet",
+  EthereumLocal: "ethereum:local",
+  ArbitrumLocal: "arbitrum:local",
+  BaseLocal: "base:local",
 } as const;
 /**
  * The chain to use.

package/src/sdk/aavev3.ts

@@ -3,6 +3,7 @@
  */
 
 import { aaveV3Borrow } from "../funcs/aaveV3Borrow.js";
+import { aaveV3HistoricalTransactions } from "../funcs/aaveV3HistoricalTransactions.js";
 import { aaveV3LiquidityChange } from "../funcs/aaveV3LiquidityChange.js";
 import { aaveV3Repay } from "../funcs/aaveV3Repay.js";
 import { aaveV3Supply } from "../funcs/aaveV3Supply.js";
@@ -116,6 +117,28 @@ export class AaveV3 extends ClientSDK {
     ));
   }
 
+  /**
+   * 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.
+   */
+  async historicalTransactions(
+    request: operations.AaveHistoricalTransactionsRequest,
+    options?: RequestOptions,
+  ): Promise<components.AaveHistoricalTransactionsResponse> {
+    return unwrapAsync(aaveV3HistoricalTransactions(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Supply/Lend
    *