@portal-hq/web 3.4.1 → 3.5.0-alpha

package/src/integrations/yield/yieldxyz.ts

@@ -0,0 +1,122 @@
+import Mpc from 'src/mpc'
+import {
+  YieldXyzGetBalancesRequest,
+  YieldXyzGetBalancesResponse,
+  YieldXyzGetHistoricalActionsRequest,
+  YieldXyzGetHistoricalActionsResponse,
+  YieldXyzManageYieldRequest,
+  YieldXyzManageYieldResponse,
+  YieldXyzTrackTransactionRequest,
+  YieldXyzTrackTransactionResponse,
+  YieldXyzGetTransactionResponse,
+  YieldXyzGetYieldsRequest,
+  YieldXyzGetYieldsResponse,
+  YieldXyzEnterRequest,
+  YieldXyzEnterYieldResponse,
+  YieldXyzExitRequest,
+  YieldXyzExitResponse,
+} from '../../../yieldxyz-types'
+
+export default class YieldXyz {
+  private mpc: Mpc
+
+  constructor({ mpc }: { mpc: Mpc }) {
+    this.mpc = mpc
+  }
+
+  /**
+   * Retrieves yield balances for specified addresses and networks.
+   * @param data - The parameters for the yield balances request.
+   * @returns A `YieldXyzGetBalancesResponse` promise, resolving to balance information.
+   * @throws An error if the operation fails.
+   */
+  public async getBalances(
+    data: YieldXyzGetBalancesRequest,
+  ): Promise<YieldXyzGetBalancesResponse> {
+    return this.mpc?.getYieldXyzBalances(data)
+  }
+
+  /**
+   * Retrieves historical yield actions with optional filtering.
+   * @param data - The parameters for the historical yield actions request.
+   * @returns A `YieldXyzGetHistoricalActionsResponse` promise, resolving to historical actions.
+   * @throws An error if the operation fails.
+   */
+  public async getHistoricalActions(
+    data: YieldXyzGetHistoricalActionsRequest,
+  ): Promise<YieldXyzGetHistoricalActionsResponse> {
+    return this.mpc?.getYieldXyzHistoricalActions(data)
+  }
+
+  /**
+   * Manages a yield opportunity with the specified parameters.
+   * @param data - The parameters for managing a yield opportunity.
+   * @returns A `YieldXyzManageYieldResponse` promise, resolving to the action details.
+   * @throws An error if the operation fails.
+   */
+  public async manage(
+    data: YieldXyzManageYieldRequest,
+  ): Promise<YieldXyzManageYieldResponse> {
+    return this.mpc?.manageYieldXyzYield(data)
+  }
+
+  /**
+   * Enters a yield opportunity with the specified parameters.
+   * @param data - The parameters for entering a yield opportunity.
+   * @returns A `YieldXyzEnterYieldResponse` promise, resolving to the action details.
+   * @throws An error if the operation fails.
+   */
+  public async enter(
+    data: YieldXyzEnterRequest,
+  ): Promise<YieldXyzEnterYieldResponse> {
+    return this.mpc?.enterYieldXyzYield(data)
+  }
+
+  /**
+   * Exits a yield opportunity with the specified parameters.
+   * @param data - The parameters for exiting a yield opportunity.
+   * @returns A `YieldXyzExitResponse` promise, resolving to the action details.
+   * @throws An error if the operation fails.
+   */
+  public async exit(data: YieldXyzExitRequest): Promise<YieldXyzExitResponse> {
+    return this.mpc?.exitYieldXyzYield(data)
+  }
+
+  /**
+   * Discovers yield opportunities based on the provided parameters.
+   * @param data - Optional parameters for yield discovery. If undefined, uses default parameters.
+   * @returns A `YieldXyzGetYieldsResponse` promise, resolving to available yield opportunities.
+   * @throws An error if the operation fails.
+   */
+  public async discover(
+    data: YieldXyzGetYieldsRequest,
+  ): Promise<YieldXyzGetYieldsResponse> {
+    return this.mpc?.getYieldXyzYields(data)
+  }
+
+  /**
+   * Tracks a transaction by submitting its hash to the Yield.xyz integration.
+   * @param data - The parameters for tracking a transaction:
+   *   - transactionId: The ID of the transaction to track.
+   *   - txHash: The hash of the transaction to submit.
+   * @returns A `YieldXyzTrackTransactionResponse` promise.
+   * @throws An error if the operation fails.
+   */
+  public async track(
+    data: YieldXyzTrackTransactionRequest,
+  ): Promise<YieldXyzTrackTransactionResponse> {
+    return this.mpc?.trackYieldXyzTransaction(data)
+  }
+
+  /**
+   * Retrieves a single yield action transaction by its ID.
+   * @param transactionId - The ID of the transaction to retrieve.
+   * @returns A `YieldXyzGetTransactionResponse` promise, resolving to transaction details.
+   * @throws An error if the operation fails.
+   */
+  public async getTransaction(
+    transactionId: string,
+  ): Promise<YieldXyzGetTransactionResponse> {
+    return this.mpc?.getYieldXyzTransaction(transactionId)
+  }
+}