@compass-labs/api-sdk 0.0.3

package/src/sdk/aerodromeslipstream.ts

@@ -0,0 +1,194 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { aerodromeSlipstreamSlipstreamLiquidityProvisionIncrease } from "../funcs/aerodromeSlipstreamSlipstreamLiquidityProvisionIncrease.js";
+import { aerodromeSlipstreamSlipstreamLiquidityProvisionMint } from "../funcs/aerodromeSlipstreamSlipstreamLiquidityProvisionMint.js";
+import { aerodromeSlipstreamSlipstreamLiquidityProvisionPositions } from "../funcs/aerodromeSlipstreamSlipstreamLiquidityProvisionPositions.js";
+import { aerodromeSlipstreamSlipstreamLiquidityProvisionWithdraw } from "../funcs/aerodromeSlipstreamSlipstreamLiquidityProvisionWithdraw.js";
+import { aerodromeSlipstreamSlipstreamPoolPrice } from "../funcs/aerodromeSlipstreamSlipstreamPoolPrice.js";
+import { aerodromeSlipstreamSlipstreamSwapBuyExactly } from "../funcs/aerodromeSlipstreamSlipstreamSwapBuyExactly.js";
+import { aerodromeSlipstreamSlipstreamSwapSellExactly } from "../funcs/aerodromeSlipstreamSlipstreamSwapSellExactly.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class AerodromeSlipstream extends ClientSDK {
+  /**
+   * List LP positions
+   *
+   * @remarks
+   * Retrieve the total number of Liquidity Provider (LP) positions associated with a
+   * specific sender.
+   *
+   * This endpoint allows users to query and obtain detailed information about their LP
+   * positions, including the number of active positions they hold. The response model,
+   * AerodromeLPPositionsInfo, provides a structured representation of the LP positions
+   * data, ensuring clarity and ease of use. This functionality is essential for users
+   * managing their liquidity provision activities, enabling them to make informed
+   * decisions based on their current positions.
+   */
+  async slipstreamLiquidityProvisionPositions(
+    request: operations.AerodromeSlipstreamLiquidityProvisionPositionsRequest,
+    options?: RequestOptions,
+  ): Promise<components.AerodromeLPPositionsResponse> {
+    return unwrapAsync(aerodromeSlipstreamSlipstreamLiquidityProvisionPositions(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Pool price
+   *
+   * @remarks
+   * This endpoint retrieves the current price of a pool, indicating how many token0
+   * you can purchase for 1 token1.
+   *
+   * Note that this is an instantaneous price and may change during any trade. For a more
+   * accurate representation of the trade ratios between the two assets, consider using
+   * the quote endpoint.
+   */
+  async slipstreamPoolPrice(
+    request: operations.AerodromeSlipstreamPoolPriceRequest,
+    options?: RequestOptions,
+  ): Promise<components.AerodromeSlipstreamPoolPriceResponse> {
+    return unwrapAsync(aerodromeSlipstreamSlipstreamPoolPrice(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Swap - from specified amount
+   *
+   * @remarks
+   * This endpoint allows users to trade a specific amount of one token into another
+   * token using the Aerodrome Slipstream protocol.
+   *
+   * The transaction is executed by specifying the exact amount of the input token to be
+   * sold, and the system calculates the amount of the output token that will be
+   * received. The operation ensures that the trade is conducted within the constraints
+   * of the current market conditions, taking into account the liquidity and price
+   * impact. This endpoint is suitable for users who want to sell a precise quantity of a
+   * token and are willing to accept the resulting amount of the other token.
+   */
+  async slipstreamSwapSellExactly(
+    request: components.AerodromeSlipstreamSellExactlyRequest,
+    options?: RequestOptions,
+  ): Promise<components.UnsignedTransaction> {
+    return unwrapAsync(aerodromeSlipstreamSlipstreamSwapSellExactly(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Swap - into specified amount
+   *
+   * @remarks
+   * This endpoint facilitates the trading of tokens by allowing users to specify the
+   * exact amount of the output token they wish to receive.
+   *
+   * Utilizing the Aerodrome Slipstream protocol, the system calculates the necessary
+   * amount of the input token required to achieve the desired output. This operation is
+   * particularly useful for users who have a specific target amount of the output token
+   * in mind and are willing to provide the corresponding input token amount. The
+   * transaction is executed with consideration of current market conditions, including
+   * liquidity and price impact, ensuring that the trade is completed efficiently and
+   * effectively.
+   */
+  async slipstreamSwapBuyExactly(
+    request: components.AerodromeSlipstreamBuyExactlyRequest,
+    options?: RequestOptions,
+  ): Promise<components.UnsignedTransaction> {
+    return unwrapAsync(aerodromeSlipstreamSlipstreamSwapBuyExactly(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Open a new LP position
+   *
+   * @remarks
+   * Initiate a new Liquidity Provider (LP) position by minting tokens.
+   *
+   * This endpoint allows users to open a new LP position, enabling them to participate
+   * in liquidity provision. The minting process involves creating a new position with
+   * specified parameters, such as token amounts and pool details. The response will
+   * confirm the successful creation of the LP position, providing users with the
+   * necessary information to manage their newly minted position. This functionality is
+   * crucial for users looking to expand their liquidity provision activities, offering
+   * them the opportunity to engage in decentralized finance (DeFi) markets effectively.
+   */
+  async slipstreamLiquidityProvisionMint(
+    request: components.AerodromeSlipstreamMintLiquidityProvisionRequest,
+    options?: RequestOptions,
+  ): Promise<components.UnsignedTransaction> {
+    return unwrapAsync(aerodromeSlipstreamSlipstreamLiquidityProvisionMint(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Increase an LP position
+   *
+   * @remarks
+   * Increase the liquidity of an existing Liquidity Provider (LP) position.
+   *
+   * This endpoint allows users to add more tokens to their current LP position,
+   * enhancing their participation in liquidity provision. By increasing liquidity, users
+   * can potentially earn more rewards and improve their position in the pool. The
+   * process involves specifying additional token amounts and updating the pool details.
+   * The response will confirm the successful increase of the LP position, providing
+   * users with updated information about their enhanced position. This functionality is
+   * vital for users aiming to optimize their liquidity provision strategy, enabling them
+   * to adapt to market conditions and maximize their returns in decentralized finance
+   * (DeFi) markets.
+   */
+  async slipstreamLiquidityProvisionIncrease(
+    request: components.AerodromeSlipstreamIncreaseLiquidityProvisionRequest,
+    options?: RequestOptions,
+  ): Promise<components.UnsignedTransaction> {
+    return unwrapAsync(aerodromeSlipstreamSlipstreamLiquidityProvisionIncrease(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Withdraw an LP position
+   *
+   * @remarks
+   * Withdraw an existing Liquidity Provider (LP) position.
+   *
+   * This endpoint allows users to remove their tokens from an LP position, effectively
+   * closing their participation in the liquidity pool. The withdrawal process involves
+   * specifying the LP position to be closed, and the response will confirm the
+   * successful removal of liquidity, providing users with details about the withdrawn
+   * tokens and any remaining balances. This functionality is essential for users who
+   * wish to exit their liquidity provision activities, enabling them to reclaim their
+   * assets and potentially reallocate them to other investment opportunities. The
+   * endpoint ensures a smooth and secure withdrawal process, facilitating users'
+   * strategic management of their decentralized finance (DeFi) portfolios.
+   */
+  async slipstreamLiquidityProvisionWithdraw(
+    request: components.AerodromeSlipstreamWithdrawLiquidityProvisionRequest,
+    options?: RequestOptions,
+  ): Promise<components.UnsignedTransaction> {
+    return unwrapAsync(aerodromeSlipstreamSlipstreamLiquidityProvisionWithdraw(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/index.ts

@@ -0,0 +1,5 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export * from "./sdk.js";

package/src/sdk/morpho.ts

@@ -0,0 +1,264 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { morphoAllowance } from "../funcs/morphoAllowance.js";
+import { morphoBorrow } from "../funcs/morphoBorrow.js";
+import { morphoDeposit } from "../funcs/morphoDeposit.js";
+import { morphoMarketPosition } from "../funcs/morphoMarketPosition.js";
+import { morphoMarkets } from "../funcs/morphoMarkets.js";
+import { morphoRepay } from "../funcs/morphoRepay.js";
+import { morphoSupplyCollateral } from "../funcs/morphoSupplyCollateral.js";
+import { morphoVaultPosition } from "../funcs/morphoVaultPosition.js";
+import { morphoVaults } from "../funcs/morphoVaults.js";
+import { morphoWithdraw } from "../funcs/morphoWithdraw.js";
+import { morphoWithdrawCollateral } from "../funcs/morphoWithdrawCollateral.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Morpho extends ClientSDK {
+  /**
+   * Get Vaults
+   *
+   * @remarks
+   * Query a list of vaults you can deposit into.
+   *
+   * Each vault has one unique token that can be deposited. In exchange for depositing
+   * tokens into a vault you receive shares. You earn yield on these shares by their
+   * exchange value increasing over time.
+   */
+  async vaults(
+    request: operations.MorphoVaultsRequest,
+    options?: RequestOptions,
+  ): Promise<components.MorphoGetVaultsResponse> {
+    return unwrapAsync(morphoVaults(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Check Vault Position
+   *
+   * @remarks
+   * Check how many shares you own and the equivalent token amount of a given
+   * vault.
+   */
+  async vaultPosition(
+    request: operations.MorphoVaultPositionRequest,
+    options?: RequestOptions,
+  ): Promise<components.MorphoCheckVaultPositionResponse> {
+    return unwrapAsync(morphoVaultPosition(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get Markets
+   *
+   * @remarks
+   * Query a list of markets you can borrow from.
+   *
+   * Each market has one unique token that can be borrowed against one unique token that
+   * can be used as collateral.
+   */
+  async markets(
+    request: operations.MorphoMarketsRequest,
+    options?: RequestOptions,
+  ): Promise<components.MorphoGetMarketsResponse> {
+    return unwrapAsync(morphoMarkets(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Check Market Position
+   *
+   * @remarks
+   * Check how many shares you've borrowed and the equivalent token amount of a given
+   * market.
+   */
+  async marketPosition(
+    request: operations.MorphoMarketPositionRequest,
+    options?: RequestOptions,
+  ): Promise<components.MorphoCheckMarketPositionResponse> {
+    return unwrapAsync(morphoMarketPosition(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Set Allowance for Vault
+   *
+   * @remarks
+   * Set an allowance for a Morpho vault. You must set this for at least the amount you wish to deposit - before depositing.
+   *
+   * Each vault has only one associated token that can be deposited.
+   *
+   * Use the 'Get Vaults' endpoint to query a list of vaults you can deposit into.
+   */
+  async allowance(
+    request: components.MorphoSetVaultAllowanceRequest,
+    options?: RequestOptions,
+  ): Promise<components.UnsignedTransaction> {
+    return unwrapAsync(morphoAllowance(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Deposit to Vault
+   *
+   * @remarks
+   * Deposit tokens into a Morpho Vault to earn passive yield from interest paid by
+   * borrowers.
+   *
+   * Each vault accepts one unique token that can be deposited.
+   *
+   * A Morpho Vault has one loan asset and can allocate deposits to multiple Morpho
+   * markets. Users can deposit into a vault to start earning passive yield from interest
+   * paid by borrowers. Vaults feature automated risk management, actively curating risk
+   * exposure for all deposited assets so users don't need to make these decisions
+   * themselves. Users maintain full control over their assets, can monitor the vault's
+   * state at any time, and withdraw their liquidity at their discretion.
+   */
+  async deposit(
+    request: components.MorphoDepositRequest,
+    options?: RequestOptions,
+  ): Promise<components.UnsignedTransaction> {
+    return unwrapAsync(morphoDeposit(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Withdraw from Vault
+   *
+   * @remarks
+   * Withdraw deposited tokens from a Morpho Vault.
+   *
+   * The passive yield earned on token deposits is represented by the increased value of
+   * the shares received upon depositing tokens.
+   *
+   * A Morpho Vault has one loan asset and can allocate deposits to multiple Morpho
+   * markets. Users can deposit into a vault to start earning passive yield from interest
+   * paid by borrowers. Vaults feature automated risk management, actively curating risk
+   * exposure for all deposited assets so users don't need to make these decisions
+   * themselves. Users maintain full control over their assets, can monitor the vault's
+   * state at any time, and withdraw their liquidity at their discretion.
+   */
+  async withdraw(
+    request: components.MorphoWithdrawRequest,
+    options?: RequestOptions,
+  ): Promise<components.UnsignedTransaction> {
+    return unwrapAsync(morphoWithdraw(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Supply Collateral to Market
+   *
+   * @remarks
+   * Supply collateral to a Morpho Market in order to borrow against it.
+   *
+   * A Morpho Market is a primitive lending pool that pairs one collateral asset with one
+   * loan asset. Each market is isolated (meaning risks are contained within each
+   * individual market), immutable (cannot be changed after deployment), and will persist
+   * as long as the blockchain it is deployed on is live.
+   */
+  async supplyCollateral(
+    request: components.MorphoSupplyCollateralRequest,
+    options?: RequestOptions,
+  ): Promise<components.UnsignedTransaction> {
+    return unwrapAsync(morphoSupplyCollateral(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Withdraw Collateral from Market
+   *
+   * @remarks
+   * Withdraw collateral that has been supplied to a Morpho Market.
+   *
+   * A Morpho Market is a primitive lending pool that pairs one collateral asset with one
+   * loan asset. Each market is isolated (meaning risks are contained within each
+   * individual market), immutable (cannot be changed after deployment), and will persist
+   * as long as the blockchain it is deployed on is live.
+   */
+  async withdrawCollateral(
+    request: components.MorphoWithdrawCollateralRequest,
+    options?: RequestOptions,
+  ): Promise<components.UnsignedTransaction> {
+    return unwrapAsync(morphoWithdrawCollateral(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Borrow from Market
+   *
+   * @remarks
+   * Borrow tokens from a Morpho Market against supplied collateral.
+   *
+   * The position could be liquidated when a borrower's Loan-To-Value (LTV) exceeds the
+   * Liquidation Loan-To-Value (LLTV) threshold of the market.
+   *
+   * A Morpho Market is a primitive lending pool that pairs one collateral asset with one
+   * loan asset. Each market is isolated (meaning risks are contained within each
+   * individual market), immutable (cannot be changed after deployment), and will persist
+   * as long as the blockchain it is deployed on is live.
+   */
+  async borrow(
+    request: components.MorphoBorrowRequest,
+    options?: RequestOptions,
+  ): Promise<components.UnsignedTransaction> {
+    return unwrapAsync(morphoBorrow(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Repay to Market
+   *
+   * @remarks
+   * Repay borrowed tokens to a market in order to reduce or eliminate debt.
+   *
+   * A Morpho Market is a primitive lending pool that pairs one collateral asset with one
+   * loan asset. Each market is isolated (meaning risks are contained within each
+   * individual market), immutable (cannot be changed after deployment), and will persist
+   * as long as the blockchain it is deployed on is live.
+   */
+  async repay(
+    request: components.MorphoRepayRequest,
+    options?: RequestOptions,
+  ): Promise<components.UnsignedTransaction> {
+    return unwrapAsync(morphoRepay(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { ClientSDK } from "../lib/sdks.js";
+import { AaveV3 } from "./aavev3.js";
+import { AerodromeSlipstream } from "./aerodromeslipstream.js";
+import { Morpho } from "./morpho.js";
+import { Token } from "./token.js";
+import { UniswapV3 } from "./uniswapv3.js";
+import { Universal } from "./universal.js";
+
+export class CompassApiSDK extends ClientSDK {
+  private _aaveV3?: AaveV3;
+  get aaveV3(): AaveV3 {
+    return (this._aaveV3 ??= new AaveV3(this._options));
+  }
+
+  private _aerodromeSlipstream?: AerodromeSlipstream;
+  get aerodromeSlipstream(): AerodromeSlipstream {
+    return (this._aerodromeSlipstream ??= new AerodromeSlipstream(
+      this._options,
+    ));
+  }
+
+  private _morpho?: Morpho;
+  get morpho(): Morpho {
+    return (this._morpho ??= new Morpho(this._options));
+  }
+
+  private _token?: Token;
+  get token(): Token {
+    return (this._token ??= new Token(this._options));
+  }
+
+  private _uniswapV3?: UniswapV3;
+  get uniswapV3(): UniswapV3 {
+    return (this._uniswapV3 ??= new UniswapV3(this._options));
+  }
+
+  private _universal?: Universal;
+  get universal(): Universal {
+    return (this._universal ??= new Universal(this._options));
+  }
+}

package/src/sdk/token.ts

@@ -0,0 +1,86 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { tokenAddress } from "../funcs/tokenAddress.js";
+import { tokenBalance } from "../funcs/tokenBalance.js";
+import { tokenPrice } from "../funcs/tokenPrice.js";
+import { tokenTransfer } from "../funcs/tokenTransfer.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Token extends ClientSDK {
+  /**
+   * Token Address
+   *
+   * @remarks
+   * This endpoint retrieves the address for a token supported by us.
+   */
+  async address(
+    request: operations.TokenAddressRequest,
+    options?: RequestOptions,
+  ): Promise<components.TokenAddressResponse> {
+    return unwrapAsync(tokenAddress(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Token Price
+   *
+   * @remarks
+   * Retrieves the price of a token in 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 price(
+    request: operations.TokenPriceRequest,
+    options?: RequestOptions,
+  ): Promise<components.TokenPriceResponse> {
+    return unwrapAsync(tokenPrice(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Token Balance
+   *
+   * @remarks
+   * Returns the balance of a specific ERC20 token for a given user address.
+   */
+  async balance(
+    request: operations.TokenBalanceRequest,
+    options?: RequestOptions,
+  ): Promise<components.TokenBalanceResponse> {
+    return unwrapAsync(tokenBalance(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Transfer ETH or ERC20 Tokens
+   *
+   * @remarks
+   * Sends native ETH or ERC20 tokens from the sender's address to another address.
+   */
+  async transfer(
+    request: components.TokenTransferRequest,
+    options?: RequestOptions,
+  ): Promise<components.UnsignedTransaction> {
+    return unwrapAsync(tokenTransfer(
+      this,
+      request,
+      options,
+    ));
+  }
+}