@bosonprotocol/core-sdk 1.44.0-alpha.9 → 1.44.1-alpha.0

package/src/offers/interface.ts

@@ -5,12 +5,15 @@ import {
   OfferDatesStruct,
   OfferDurationsStruct,
   PriceType,
-  RoyaltyInfo
+  RoyaltyInfo,
+  OfferCreator,
+  DRParametersStruct
 } from "@bosonprotocol/common";
 import { Interface } from "@ethersproject/abi";
 import { getAddress } from "@ethersproject/address";
 import { BigNumberish } from "@ethersproject/bignumber";
 import { CreateOfferArgs } from "./types";
+import { AddressZero } from "@ethersproject/constants";
 
 export const bosonOfferHandlerIface = new Interface(abis.IBosonOfferHandlerABI);
 
@@ -46,7 +49,7 @@ export function encodeCreateOfferBatch(argsBatch: CreateOfferArgs[]) {
     Partial<OfferStruct>,
     Partial<OfferDatesStruct>,
     Partial<OfferDurationsStruct>,
-    BigNumberish,
+    Partial<DRParametersStruct>,
     BigNumberish,
     BigNumberish
   ][] = argsBatch.map((args) => createOfferArgsToStructs(args));
@@ -54,23 +57,32 @@ export function encodeCreateOfferBatch(argsBatch: CreateOfferArgs[]) {
     offers,
     offerDates,
     offerDurations,
-    disputeResolverIds,
+    drParameters,
     agentIds,
     feeLimits
   ]: [
     Partial<OfferStruct>[],
     Partial<OfferDatesStruct>[],
     Partial<OfferDurationsStruct>[],
-    BigNumberish[],
+    Partial<DRParametersStruct>[],
     BigNumberish[],
     BigNumberish[]
-  ] = argsTuples.reduce(
+  ] = argsTuples.reduce<
+    [
+      Partial<OfferStruct>[],
+      Partial<OfferDatesStruct>[],
+      Partial<OfferDurationsStruct>[],
+      Partial<DRParametersStruct>[],
+      BigNumberish[],
+      BigNumberish[]
+    ]
+  >(
     (acc, tuple) => {
       const [
         offer,
         offerDates,
         offerDurations,
-        disputeResolverId,
+        drParameters,
         agentId,
         feeLimit
       ] = tuple;
@@ -78,7 +90,7 @@ export function encodeCreateOfferBatch(argsBatch: CreateOfferArgs[]) {
         [...acc[0], offer],
         [...acc[1], offerDates],
         [...acc[2], offerDurations],
-        [...acc[3], disputeResolverId],
+        [...acc[3], drParameters],
         [...acc[4], agentId],
         [...acc[5], feeLimit]
       ];
@@ -90,7 +102,7 @@ export function encodeCreateOfferBatch(argsBatch: CreateOfferArgs[]) {
     offers,
     offerDates,
     offerDurations,
-    disputeResolverIds,
+    drParameters,
     agentIds,
     feeLimits
   ]);
@@ -102,7 +114,7 @@ export function createOfferArgsToStructs(
   Partial<OfferStruct>,
   Partial<OfferDatesStruct>,
   Partial<OfferDurationsStruct>,
-  BigNumberish,
+  Partial<DRParametersStruct>,
   BigNumberish,
   BigNumberish
 ] {
@@ -111,7 +123,7 @@ export function createOfferArgsToStructs(
     argsToOfferStruct(args),
     argsToOfferDatesStruct(args),
     argsToOfferDurationsStruct(args),
-    args.disputeResolverId,
+    argsToDRParametersStruct(args),
     args.agentId,
     feeLimit
   ];
@@ -122,6 +134,8 @@ export function argsToOfferStruct(args: CreateOfferArgs): Partial<OfferStruct> {
 
   const priceType =
     args.priceType !== undefined ? args.priceType : PriceType.Static;
+  const creator =
+    args.creator !== undefined ? args.creator : OfferCreator.Seller;
   const royaltyInfo =
     args.royaltyInfo !== undefined
       ? args.royaltyInfo
@@ -135,6 +149,7 @@ export function argsToOfferStruct(args: CreateOfferArgs): Partial<OfferStruct> {
   return {
     id: "0",
     sellerId: "0",
+    buyerId: "0",
     ...restArgs,
     exchangeToken: getAddress(exchangeToken),
     priceType,
@@ -145,7 +160,8 @@ export function argsToOfferStruct(args: CreateOfferArgs): Partial<OfferStruct> {
           getAddress(recipient)
         )
       };
-    })
+    }),
+    creator
   };
 }
 
@@ -187,6 +203,15 @@ export function argsToOfferDurationsStruct(
   };
 }
 
+export function argsToDRParametersStruct(
+  args: CreateOfferArgs
+): Partial<DRParametersStruct> {
+  return {
+    disputeResolverId: args.disputeResolverId,
+    mutualizerAddress: args.mutualizerAddress || AddressZero
+  };
+}
+
 export function encodeReserveRange(
   offerId: BigNumberish,
   length: BigNumberish,

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
+      });
+    }
   }
 }

package/src/utils/signature.ts

@@ -117,3 +117,27 @@ export function getSignatureParameters(signature: string): {
     signature
   };
 }
+
+export function rebuildSignature({
+  r,
+  s,
+  v
+}: {
+  r: string;
+  s: string;
+  v: number;
+}): string {
+  if (!isHexString(r) || !isHexString(s)) {
+    throw new Error("r and s must be valid hex strings");
+  }
+
+  // Remove '0x' prefix if present
+  const rValue = r.startsWith("0x") ? r.substring(2) : r;
+  const sValue = s.startsWith("0x") ? s.substring(2) : s;
+
+  // Convert v to two digit hex, handle Ledger signature conversion
+  const vValue = v.toString(16).padStart(2, "0");
+
+  // Concatenate the signature parts
+  return "0x" + rValue + sValue + vValue;
+}