@bosonprotocol/core-sdk 1.44.0-alpha.8 → 1.44.0

package/src/orchestration/mixin.ts

@@ -1,6 +1,7 @@
 import {
   ConditionStruct,
   TransactionResponse,
+  TransactionRequest,
   Web3LibAdapter
 } from "@bosonprotocol/common";
 import { BigNumberish } from "@ethersproject/bignumber";
@@ -19,21 +20,57 @@ export class OrchestrationMixin<
    * @param overrides - Optional overrides.
    * @returns Transaction response.
    */
+  // Overload: returnTxInfo is true → returns TransactionRequest
   public async createOfferWithCondition(
     offerToCreate: offers.CreateOfferArgs,
     condition: ConditionStruct,
     overrides: Partial<{
       contractAddress: string;
+      returnTxInfo: true;
+    }>
+  ): Promise<TransactionRequest>;
+
+  // Overload: returnTxInfo is false or undefined → returns TransactionResponse
+  public async createOfferWithCondition(
+    offerToCreate: offers.CreateOfferArgs,
+    condition: ConditionStruct,
+    overrides?: Partial<{
+      contractAddress: string;
+      returnTxInfo?: false;
+    }>
+  ): Promise<TransactionResponse>;
+
+  // Implementation
+  public async createOfferWithCondition(
+    offerToCreate: offers.CreateOfferArgs,
+    condition: ConditionStruct,
+    overrides: Partial<{
+      contractAddress: string;
+      returnTxInfo?: boolean;
     }> = {}
-  ): Promise<TransactionResponse> {
-    return handler.createOfferWithCondition({
+  ): Promise<TransactionResponse | TransactionRequest> {
+    const { returnTxInfo } = overrides;
+
+    const createArgs = {
       offerToCreate,
-      contractAddress: overrides.contractAddress || this._protocolDiamond,
+      condition,
       web3Lib: this._web3Lib,
       metadataStorage: this._metadataStorage,
       theGraphStorage: this._theGraphStorage,
-      condition
-    });
+      contractAddress: overrides.contractAddress || this._protocolDiamond
+    } as const satisfies Parameters<typeof handler.createOfferWithCondition>[0];
+
+    if (returnTxInfo === true) {
+      return handler.createOfferWithCondition({
+        ...createArgs,
+        returnTxInfo: true
+      });
+    } else {
+      return handler.createOfferWithCondition({
+        ...createArgs,
+        returnTxInfo: false
+      });
+    }
   }
   /**
    * Creates a seller account and offer with a specific conditions
@@ -44,50 +81,130 @@ export class OrchestrationMixin<
    * @param overrides - Optional overrides.
    * @returns Transaction response.
    */
+  // Overload: returnTxInfo is true → returns TransactionRequest
   public async createSellerAndOfferWithCondition(
     sellerToCreate: accounts.CreateSellerArgs,
     offerToCreate: offers.CreateOfferArgs,
     condition: ConditionStruct,
     overrides: Partial<{
       contractAddress: string;
+      returnTxInfo: true;
+    }>
+  ): Promise<TransactionRequest>;
+
+  // Overload: returnTxInfo is false or undefined → returns TransactionResponse
+  public async createSellerAndOfferWithCondition(
+    sellerToCreate: accounts.CreateSellerArgs,
+    offerToCreate: offers.CreateOfferArgs,
+    condition: ConditionStruct,
+    overrides?: Partial<{
+      contractAddress: string;
+      returnTxInfo?: false;
+    }>
+  ): Promise<TransactionResponse>;
+
+  // Implementation
+  public async createSellerAndOfferWithCondition(
+    sellerToCreate: accounts.CreateSellerArgs,
+    offerToCreate: offers.CreateOfferArgs,
+    condition: ConditionStruct,
+    overrides: Partial<{
+      contractAddress: string;
+      returnTxInfo?: boolean;
     }> = {}
-  ): Promise<TransactionResponse> {
-    return handler.createSellerAndOfferWithCondition({
+  ): Promise<TransactionResponse | TransactionRequest> {
+    const { returnTxInfo } = overrides;
+
+    const createArgs = {
       sellerToCreate,
       offerToCreate,
-      contractAddress: overrides.contractAddress || this._protocolDiamond,
+      condition,
       web3Lib: this._web3Lib,
       metadataStorage: this._metadataStorage,
       theGraphStorage: this._theGraphStorage,
-      condition
-    });
+      contractAddress: overrides.contractAddress || this._protocolDiamond
+    } as const satisfies Parameters<
+      typeof handler.createSellerAndOfferWithCondition
+    >[0];
+
+    if (returnTxInfo === true) {
+      return handler.createSellerAndOfferWithCondition({
+        ...createArgs,
+        returnTxInfo: true
+      });
+    } else {
+      return handler.createSellerAndOfferWithCondition({
+        ...createArgs,
+        returnTxInfo: false
+      });
+    }
   }
 
   /**
    * Creates a preminted offer and adds it to an existing group
    * @param offerToCreate - Offer arguments.
-   * @param reservedRangeLength - Already reserved range length.
+   * @param premintParameters - Premint parameters.
    * @param groupId -  Group ID the offer will be added to
    * @param overrides - Optional overrides.
    * @returns Transaction response.
    */
+  // Overload: returnTxInfo is true → returns TransactionRequest
+  public async createPremintedOfferAddToGroup(
+    offerToCreate: offers.CreateOfferArgs,
+    premintParameters: PremintParametersStruct,
+    groupId: BigNumberish,
+    overrides: Partial<{
+      contractAddress: string;
+      returnTxInfo: true;
+    }>
+  ): Promise<TransactionRequest>;
+
+  // Overload: returnTxInfo is false or undefined → returns TransactionResponse
+  public async createPremintedOfferAddToGroup(
+    offerToCreate: offers.CreateOfferArgs,
+    premintParameters: PremintParametersStruct,
+    groupId: BigNumberish,
+    overrides?: Partial<{
+      contractAddress: string;
+      returnTxInfo?: false;
+    }>
+  ): Promise<TransactionResponse>;
+
+  // Implementation
   public async createPremintedOfferAddToGroup(
     offerToCreate: offers.CreateOfferArgs,
     premintParameters: PremintParametersStruct,
     groupId: BigNumberish,
     overrides: Partial<{
       contractAddress: string;
+      returnTxInfo?: boolean;
     }> = {}
-  ): Promise<TransactionResponse> {
-    return handler.createPremintedOfferAddToGroup({
+  ): Promise<TransactionResponse | TransactionRequest> {
+    const { returnTxInfo } = overrides;
+
+    const createArgs = {
       offerToCreate,
       premintParameters,
       groupId,
-      contractAddress: overrides.contractAddress || this._protocolDiamond,
       web3Lib: this._web3Lib,
       metadataStorage: this._metadataStorage,
-      theGraphStorage: this._theGraphStorage
-    });
+      theGraphStorage: this._theGraphStorage,
+      contractAddress: overrides.contractAddress || this._protocolDiamond
+    } as const satisfies Parameters<
+      typeof handler.createPremintedOfferAddToGroup
+    >[0];
+
+    if (returnTxInfo === true) {
+      return handler.createPremintedOfferAddToGroup({
+        ...createArgs,
+        returnTxInfo: true
+      });
+    } else {
+      return handler.createPremintedOfferAddToGroup({
+        ...createArgs,
+        returnTxInfo: false
+      });
+    }
   }
 
   /**
@@ -95,54 +212,134 @@ export class OrchestrationMixin<
    * This transaction only succeeds if there is no existing seller account for the connected signer.
    * @param sellerToCreate - Addresses to set in the seller account.
    * @param offerToCreate - Offer arguments.
-   * @param condition -  contract condition applied to the offer
+   * @param premintParameters - Premint parameters.
    * @param overrides - Optional overrides.
    * @returns Transaction response.
    */
+  // Overload: returnTxInfo is true → returns TransactionRequest
+  public async createSellerAndPremintedOffer(
+    sellerToCreate: accounts.CreateSellerArgs,
+    offerToCreate: offers.CreateOfferArgs,
+    premintParameters: PremintParametersStruct,
+    overrides: Partial<{
+      contractAddress: string;
+      returnTxInfo: true;
+    }>
+  ): Promise<TransactionRequest>;
+
+  // Overload: returnTxInfo is false or undefined → returns TransactionResponse
+  public async createSellerAndPremintedOffer(
+    sellerToCreate: accounts.CreateSellerArgs,
+    offerToCreate: offers.CreateOfferArgs,
+    premintParameters: PremintParametersStruct,
+    overrides?: Partial<{
+      contractAddress: string;
+      returnTxInfo?: false;
+    }>
+  ): Promise<TransactionResponse>;
+
+  // Implementation
   public async createSellerAndPremintedOffer(
     sellerToCreate: accounts.CreateSellerArgs,
     offerToCreate: offers.CreateOfferArgs,
     premintParameters: PremintParametersStruct,
     overrides: Partial<{
       contractAddress: string;
+      returnTxInfo?: boolean;
     }> = {}
-  ): Promise<TransactionResponse> {
-    return handler.createSellerAndPremintedOffer({
+  ): Promise<TransactionResponse | TransactionRequest> {
+    const { returnTxInfo } = overrides;
+
+    const createArgs = {
       sellerToCreate,
       offerToCreate,
       premintParameters,
-      contractAddress: overrides.contractAddress || this._protocolDiamond,
       web3Lib: this._web3Lib,
       metadataStorage: this._metadataStorage,
-      theGraphStorage: this._theGraphStorage
-    });
+      theGraphStorage: this._theGraphStorage,
+      contractAddress: overrides.contractAddress || this._protocolDiamond
+    } as const satisfies Parameters<
+      typeof handler.createSellerAndPremintedOffer
+    >[0];
+
+    if (returnTxInfo === true) {
+      return handler.createSellerAndPremintedOffer({
+        ...createArgs,
+        returnTxInfo: true
+      });
+    } else {
+      return handler.createSellerAndPremintedOffer({
+        ...createArgs,
+        returnTxInfo: false
+      });
+    }
   }
 
   /**
-   * Creates a preminted offer and adds it to an existing group
+   * Creates a preminted offer with condition
    * @param offerToCreate - Offer arguments.
-   * @param reservedRangeLength - Already reserved range length.
-   * @param groupId -  Group ID the offer will be added to
+   * @param premintParameters - Premint parameters.
+   * @param condition - Contract condition applied to the offer.
    * @param overrides - Optional overrides.
    * @returns Transaction response.
    */
+  // Overload: returnTxInfo is true → returns TransactionRequest
+  public async createPremintedOfferWithCondition(
+    offerToCreate: offers.CreateOfferArgs,
+    premintParameters: PremintParametersStruct,
+    condition: ConditionStruct,
+    overrides: Partial<{
+      contractAddress: string;
+      returnTxInfo: true;
+    }>
+  ): Promise<TransactionRequest>;
+
+  // Overload: returnTxInfo is false or undefined → returns TransactionResponse
+  public async createPremintedOfferWithCondition(
+    offerToCreate: offers.CreateOfferArgs,
+    premintParameters: PremintParametersStruct,
+    condition: ConditionStruct,
+    overrides?: Partial<{
+      contractAddress: string;
+      returnTxInfo?: false;
+    }>
+  ): Promise<TransactionResponse>;
+
+  // Implementation
   public async createPremintedOfferWithCondition(
     offerToCreate: offers.CreateOfferArgs,
     premintParameters: PremintParametersStruct,
     condition: ConditionStruct,
     overrides: Partial<{
       contractAddress: string;
+      returnTxInfo?: boolean;
     }> = {}
-  ): Promise<TransactionResponse> {
-    return handler.createPremintedOfferWithCondition({
+  ): Promise<TransactionResponse | TransactionRequest> {
+    const { returnTxInfo } = overrides;
+
+    const createArgs = {
       offerToCreate,
       premintParameters,
       condition,
-      contractAddress: overrides.contractAddress || this._protocolDiamond,
       web3Lib: this._web3Lib,
       metadataStorage: this._metadataStorage,
-      theGraphStorage: this._theGraphStorage
-    });
+      theGraphStorage: this._theGraphStorage,
+      contractAddress: overrides.contractAddress || this._protocolDiamond
+    } as const satisfies Parameters<
+      typeof handler.createPremintedOfferWithCondition
+    >[0];
+
+    if (returnTxInfo === true) {
+      return handler.createPremintedOfferWithCondition({
+        ...createArgs,
+        returnTxInfo: true
+      });
+    } else {
+      return handler.createPremintedOfferWithCondition({
+        ...createArgs,
+        returnTxInfo: false
+      });
+    }
   }
 
   /**
@@ -150,11 +347,36 @@ export class OrchestrationMixin<
    * This transaction only succeeds if there is no existing seller account for the connected signer.
    * @param sellerToCreate - Addresses to set in the seller account.
    * @param offerToCreate - Offer arguments.
-   * @param reservedRangeLength -  Already reserved range length.
-   * @param condition -  contract condition applied to the offer
+   * @param premintParameters - Premint parameters.
+   * @param condition - Contract condition applied to the offer.
    * @param overrides - Optional overrides.
    * @returns Transaction response.
    */
+  // Overload: returnTxInfo is true → returns TransactionRequest
+  public async createSellerAndPremintedOfferWithCondition(
+    sellerToCreate: accounts.CreateSellerArgs,
+    offerToCreate: offers.CreateOfferArgs,
+    premintParameters: PremintParametersStruct,
+    condition: ConditionStruct,
+    overrides: Partial<{
+      contractAddress: string;
+      returnTxInfo: true;
+    }>
+  ): Promise<TransactionRequest>;
+
+  // Overload: returnTxInfo is false or undefined → returns TransactionResponse
+  public async createSellerAndPremintedOfferWithCondition(
+    sellerToCreate: accounts.CreateSellerArgs,
+    offerToCreate: offers.CreateOfferArgs,
+    premintParameters: PremintParametersStruct,
+    condition: ConditionStruct,
+    overrides?: Partial<{
+      contractAddress: string;
+      returnTxInfo?: false;
+    }>
+  ): Promise<TransactionResponse>;
+
+  // Implementation
   public async createSellerAndPremintedOfferWithCondition(
     sellerToCreate: accounts.CreateSellerArgs,
     offerToCreate: offers.CreateOfferArgs,
@@ -162,18 +384,35 @@ export class OrchestrationMixin<
     condition: ConditionStruct,
     overrides: Partial<{
       contractAddress: string;
+      returnTxInfo?: boolean;
     }> = {}
-  ): Promise<TransactionResponse> {
-    return handler.createSellerAndPremintedOfferWithCondition({
+  ): Promise<TransactionResponse | TransactionRequest> {
+    const { returnTxInfo } = overrides;
+
+    const createArgs = {
       sellerToCreate,
       offerToCreate,
       premintParameters,
-      contractAddress: overrides.contractAddress || this._protocolDiamond,
+      condition,
       web3Lib: this._web3Lib,
       metadataStorage: this._metadataStorage,
       theGraphStorage: this._theGraphStorage,
-      condition
-    });
+      contractAddress: overrides.contractAddress || this._protocolDiamond
+    } as const satisfies Parameters<
+      typeof handler.createSellerAndPremintedOfferWithCondition
+    >[0];
+
+    if (returnTxInfo === true) {
+      return handler.createSellerAndPremintedOfferWithCondition({
+        ...createArgs,
+        returnTxInfo: true
+      });
+    } else {
+      return handler.createSellerAndPremintedOfferWithCondition({
+        ...createArgs,
+        returnTxInfo: false
+      });
+    }
   }
 
   /**
@@ -182,18 +421,52 @@ export class OrchestrationMixin<
    * @param overrides - Optional overrides.
    * @returns Transaction response.
    */
+  // Overload: returnTxInfo is true → returns TransactionRequest
+  public async raiseAndEscalateDispute(
+    exchangeId: BigNumberish,
+    overrides: Partial<{
+      contractAddress: string;
+      returnTxInfo: true;
+    }>
+  ): Promise<TransactionRequest>;
+
+  // Overload: returnTxInfo is false or undefined → returns TransactionResponse
+  public async raiseAndEscalateDispute(
+    exchangeId: BigNumberish,
+    overrides?: Partial<{
+      contractAddress: string;
+      returnTxInfo?: false;
+    }>
+  ): Promise<TransactionResponse>;
+
+  // Implementation
   public async raiseAndEscalateDispute(
     exchangeId: BigNumberish,
     overrides: Partial<{
       contractAddress: string;
+      returnTxInfo?: boolean;
     }> = {}
-  ): Promise<TransactionResponse> {
-    return handler.raiseAndEscalateDispute({
+  ): Promise<TransactionResponse | TransactionRequest> {
+    const { returnTxInfo } = overrides;
+
+    const disputeArgs = {
       exchangeId,
-      contractAddress: overrides.contractAddress || this._protocolDiamond,
       web3Lib: this._web3Lib,
       metadataStorage: this._metadataStorage,
-      theGraphStorage: this._theGraphStorage
-    });
+      theGraphStorage: this._theGraphStorage,
+      contractAddress: overrides.contractAddress || this._protocolDiamond
+    } as const satisfies Parameters<typeof handler.raiseAndEscalateDispute>[0];
+
+    if (returnTxInfo === true) {
+      return handler.raiseAndEscalateDispute({
+        ...disputeArgs,
+        returnTxInfo: true
+      });
+    } else {
+      return handler.raiseAndEscalateDispute({
+        ...disputeArgs,
+        returnTxInfo: false
+      });
+    }
   }
 }