@bosonprotocol/core-sdk 1.45.0-alpha.0 → 1.45.0-alpha.2

package/src/offers/handler.ts

@@ -5,15 +5,21 @@ import {
   MetadataStorage,
   utils,
   RoyaltyInfo,
-  TransactionRequest
+  TransactionRequest,
+  FullOfferArgs,
+  OfferCreator
 } from "@bosonprotocol/common";
 import {
   bosonOfferHandlerIface,
+  decodeGetOfferHash,
   encodeCreateOffer,
   encodeCreateOfferBatch,
+  encodeGetOfferHash,
   encodeReserveRange,
   encodeUpdateOfferRoyaltyRecipients,
-  encodeUpdateOfferRoyaltyRecipientsBatch
+  encodeUpdateOfferRoyaltyRecipientsBatch,
+  encodeVoidNonListedOffer,
+  encodeVoidNonListedOfferBatch
 } from "./interface";
 import { getOfferById, getOffers } from "./subgraph";
 import { storeMetadataOnTheGraph } from "./storage";
@@ -328,6 +334,124 @@ export async function voidOfferBatch(args: {
   }
 }
 
+// Overload: returnTxInfo is true → returns TransactionRequest
+export async function voidNonListedOffer(args: {
+  contractAddress: string;
+  subgraphUrl: string;
+  fullOffer: Omit<
+    FullOfferArgs,
+    | "offerCreator"
+    | "committer"
+    | "signature"
+    | "conditionalTokenId"
+    | "sellerOfferParams"
+  >;
+  web3Lib: Web3LibAdapter;
+  returnTxInfo: true;
+}): Promise<TransactionRequest>;
+
+// Overload: returnTxInfo is false or undefined → returns TransactionResponse
+export async function voidNonListedOffer(args: {
+  contractAddress: string;
+  subgraphUrl: string;
+  fullOffer: Omit<
+    FullOfferArgs,
+    | "offerCreator"
+    | "committer"
+    | "signature"
+    | "conditionalTokenId"
+    | "sellerOfferParams"
+  >;
+  web3Lib: Web3LibAdapter;
+  returnTxInfo?: false | undefined;
+}): Promise<TransactionResponse>;
+
+// Implementation
+export async function voidNonListedOffer(args: {
+  contractAddress: string;
+  subgraphUrl: string;
+  fullOffer: Omit<
+    FullOfferArgs,
+    | "offerCreator"
+    | "committer"
+    | "signature"
+    | "conditionalTokenId"
+    | "sellerOfferParams"
+  >;
+  web3Lib: Web3LibAdapter;
+  returnTxInfo?: boolean;
+}): Promise<TransactionRequest | TransactionResponse> {
+  const transactionRequest = {
+    to: args.contractAddress,
+    data: encodeVoidNonListedOffer(args.fullOffer)
+  } satisfies TransactionRequest;
+
+  if (args.returnTxInfo) {
+    return transactionRequest;
+  } else {
+    return args.web3Lib.sendTransaction(transactionRequest);
+  }
+}
+
+// Overload: returnTxInfo is true → returns TransactionRequest
+export async function voidNonListedOfferBatch(args: {
+  contractAddress: string;
+  subgraphUrl: string;
+  fullOffers: Omit<
+    FullOfferArgs,
+    | "offerCreator"
+    | "committer"
+    | "signature"
+    | "conditionalTokenId"
+    | "sellerOfferParams"
+  >[];
+  web3Lib: Web3LibAdapter;
+  returnTxInfo: true;
+}): Promise<TransactionRequest>;
+
+// Overload: returnTxInfo is false or undefined → returns TransactionResponse
+export async function voidNonListedOfferBatch(args: {
+  contractAddress: string;
+  subgraphUrl: string;
+  fullOffers: Omit<
+    FullOfferArgs,
+    | "offerCreator"
+    | "committer"
+    | "signature"
+    | "conditionalTokenId"
+    | "sellerOfferParams"
+  >[];
+  web3Lib: Web3LibAdapter;
+  returnTxInfo?: false | undefined;
+}): Promise<TransactionResponse>;
+
+// Implementation
+export async function voidNonListedOfferBatch(args: {
+  contractAddress: string;
+  subgraphUrl: string;
+  fullOffers: Omit<
+    FullOfferArgs,
+    | "offerCreator"
+    | "committer"
+    | "signature"
+    | "conditionalTokenId"
+    | "sellerOfferParams"
+  >[];
+  web3Lib: Web3LibAdapter;
+  returnTxInfo?: boolean;
+}): Promise<TransactionRequest | TransactionResponse> {
+  const transactionRequest = {
+    to: args.contractAddress,
+    data: encodeVoidNonListedOfferBatch(args.fullOffers)
+  } satisfies TransactionRequest;
+
+  if (args.returnTxInfo) {
+    return transactionRequest;
+  } else {
+    return args.web3Lib.sendTransaction(transactionRequest);
+  }
+}
+
 // Overload: returnTxInfo is true → returns TransactionRequest
 export async function extendOffer(args: {
   contractAddress: string;
@@ -506,13 +630,24 @@ function checkIfOfferVoidable(
   }
 
   if (
+    offerFromSubgraph.creator === OfferCreator.Seller &&
     offerFromSubgraph.seller.assistant.toLowerCase() !==
-    signerAddress.toLowerCase()
+      signerAddress.toLowerCase()
   ) {
     throw new Error(
       `Signer with address "${signerAddress}" is not the assistant "${offerFromSubgraph.seller.assistant}" of offer with id "${offerId}"`
     );
   }
+
+  if (
+    offerFromSubgraph.creator === OfferCreator.Buyer &&
+    offerFromSubgraph.buyer?.wallet.toLowerCase() !==
+      signerAddress.toLowerCase()
+  ) {
+    throw new Error(
+      `Signer with address "${signerAddress}" is not the creator's wallet "${offerFromSubgraph.buyer?.wallet}" of offer with id "${offerId}"`
+    );
+  }
 }
 
 function checkIfOfferReservable(
@@ -531,3 +666,15 @@ function checkIfOfferReservable(
     throw new Error(`Range length is too large`);
   }
 }
+
+export async function getOfferHash(args: {
+  fullOfferArgsUnsigned: Omit<FullOfferArgs, "signature">;
+  contractAddress: string;
+  web3Lib: Web3LibAdapter;
+}): Promise<string> {
+  const result = await args.web3Lib.call({
+    to: args.contractAddress,
+    data: encodeGetOfferHash(args.fullOfferArgsUnsigned)
+  });
+  return decodeGetOfferHash(result);
+}

package/src/offers/interface.ts

@@ -7,13 +7,15 @@ import {
   PriceType,
   RoyaltyInfo,
   OfferCreator,
-  DRParametersStruct
+  DRParametersStruct,
+  FullOfferArgs
 } 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";
+import { fullOfferArgsToStruct } from "../exchanges/interface";
 
 export const bosonOfferHandlerIface = new Interface(abis.IBosonOfferHandlerABI);
 
@@ -150,6 +152,7 @@ export function argsToOfferStruct(args: CreateOfferArgs): Partial<OfferStruct> {
     id: "0",
     sellerId: "0",
     buyerId: "0",
+    voided: false,
     ...restArgs,
     exchangeToken: getAddress(exchangeToken),
     priceType,
@@ -223,3 +226,57 @@ export function encodeReserveRange(
     to
   ]);
 }
+
+export function encodeVoidNonListedOffer(
+  fullOfferArgsUnsigned: Omit<
+    FullOfferArgs,
+    | "offerCreator"
+    | "committer"
+    | "signature"
+    | "conditionalTokenId"
+    | "sellerOfferParams"
+  >
+) {
+  return bosonOfferHandlerIface.encodeFunctionData("voidNonListedOffer", [
+    fullOfferArgsToStruct(fullOfferArgsUnsigned)
+  ]);
+}
+
+export function encodeVoidNonListedOfferBatch(
+  argsBatch: Omit<
+    FullOfferArgs,
+    | "offerCreator"
+    | "committer"
+    | "signature"
+    | "conditionalTokenId"
+    | "sellerOfferParams"
+  >[]
+) {
+  const argsStructs = argsBatch.map((args) => fullOfferArgsToStruct(args));
+  return bosonOfferHandlerIface.encodeFunctionData("voidNonListedOfferBatch", [
+    argsStructs
+  ]);
+}
+
+export function encodeGetOfferHash(
+  fullOfferArgsUnsigned: Omit<
+    FullOfferArgs,
+    | "offerCreator"
+    | "committer"
+    | "signature"
+    | "conditionalTokenId"
+    | "sellerOfferParams"
+  >
+) {
+  return bosonOfferHandlerIface.encodeFunctionData("getOfferHash", [
+    fullOfferArgsToStruct(fullOfferArgsUnsigned)
+  ]);
+}
+
+export function decodeGetOfferHash(result: string): string {
+  const [offerHash] = bosonOfferHandlerIface.decodeFunctionResult(
+    "getOfferHash",
+    result
+  );
+  return offerHash;
+}

package/src/offers/mixin.ts

@@ -15,7 +15,8 @@ import {
   GatingType,
   RoyaltyInfo,
   TransactionRequest,
-  Web3LibAdapter
+  Web3LibAdapter,
+  FullOfferArgs
 } from "@bosonprotocol/common";
 import groupBy from "lodash/groupBy";
 import { BigNumber, BigNumberish } from "@ethersproject/bignumber";
@@ -225,6 +226,31 @@ export class OfferMixin<T extends Web3LibAdapter> extends BaseCoreSDK<T> {
     )?.toString();
   }
 
+  /**
+   * Utility method to retrieve the created `buyerId` from logs after calling `createBuyer`
+   *
+   * @param logs - Logs to search in.
+   * @returns Created buyer id.
+   */
+  public getCreatedBuyerIdFromLogs(logs: Log[]): string | null {
+    const buyerId = getValueFromLogs<BigNumber>({
+      iface: accounts.iface.bosonAccountHandlerIface,
+      logs,
+      eventArgsKey: "buyerId",
+      eventName: "BuyerCreated"
+    });
+
+    return (
+      buyerId ||
+      getValueFromLogs<BigNumber>({
+        iface: orchestration.iface.bosonOrchestrationHandlerIface,
+        logs,
+        eventArgsKey: "buyerId",
+        eventName: "BuyerCreated"
+      })
+    )?.toString();
+  }
+
   /**
    * Voids an existing offer by calling the `OfferHandlerFacet` contract.
    * This transaction only succeeds if the connected signer is the `assistant`.
@@ -336,6 +362,148 @@ export class OfferMixin<T extends Web3LibAdapter> extends BaseCoreSDK<T> {
     }
   }
 
+  // Overload: returnTxInfo is true → returns TransactionRequest
+  public async voidNonListedOffer(
+    fullOffer: Omit<
+      FullOfferArgs,
+      | "offerCreator"
+      | "committer"
+      | "signature"
+      | "conditionalTokenId"
+      | "sellerOfferParams"
+    >,
+    overrides: Partial<{
+      contractAddress: string;
+      returnTxInfo: true;
+    }>
+  ): Promise<TransactionRequest>;
+
+  // Overload: returnTxInfo is false or undefined → returns TransactionResponse
+  public async voidNonListedOffer(
+    fullOffer: Omit<
+      FullOfferArgs,
+      | "offerCreator"
+      | "committer"
+      | "signature"
+      | "conditionalTokenId"
+      | "sellerOfferParams"
+    >,
+    overrides?: Partial<{
+      contractAddress: string;
+      returnTxInfo?: false | undefined;
+    }>
+  ): Promise<TransactionResponse>;
+
+  // Implementation
+  public async voidNonListedOffer(
+    fullOffer: Omit<
+      FullOfferArgs,
+      | "offerCreator"
+      | "committer"
+      | "signature"
+      | "conditionalTokenId"
+      | "sellerOfferParams"
+    >,
+    overrides: Partial<{
+      contractAddress: string;
+      returnTxInfo?: boolean;
+    }> = {}
+  ): Promise<TransactionResponse | TransactionRequest> {
+    const { returnTxInfo } = overrides;
+
+    const voidArgs = {
+      fullOffer,
+      web3Lib: this._web3Lib,
+      subgraphUrl: this._subgraphUrl,
+      contractAddress: overrides.contractAddress || this._protocolDiamond
+    } as const satisfies Parameters<
+      typeof offers.handler.voidNonListedOffer
+    >[0];
+
+    if (returnTxInfo === true) {
+      return offers.handler.voidNonListedOffer({
+        ...voidArgs,
+        returnTxInfo: true
+      });
+    } else {
+      return offers.handler.voidNonListedOffer({
+        ...voidArgs,
+        returnTxInfo: false
+      });
+    }
+  }
+
+  // Overload: returnTxInfo is true → returns TransactionRequest
+  public async voidNonListedOfferBatch(
+    fullOffers: Omit<
+      FullOfferArgs,
+      | "offerCreator"
+      | "committer"
+      | "signature"
+      | "conditionalTokenId"
+      | "sellerOfferParams"
+    >[],
+    overrides: Partial<{
+      contractAddress: string;
+      returnTxInfo: true;
+    }>
+  ): Promise<TransactionRequest>;
+
+  // Overload: returnTxInfo is false or undefined → returns TransactionResponse
+  public async voidNonListedOfferBatch(
+    fullOffers: Omit<
+      FullOfferArgs,
+      | "offerCreator"
+      | "committer"
+      | "signature"
+      | "conditionalTokenId"
+      | "sellerOfferParams"
+    >[],
+    overrides?: Partial<{
+      contractAddress: string;
+      returnTxInfo?: false | undefined;
+    }>
+  ): Promise<TransactionResponse>;
+
+  // Implementation
+  public async voidNonListedOfferBatch(
+    fullOffers: Omit<
+      FullOfferArgs,
+      | "offerCreator"
+      | "committer"
+      | "signature"
+      | "conditionalTokenId"
+      | "sellerOfferParams"
+    >[],
+    overrides: Partial<{
+      contractAddress: string;
+      returnTxInfo?: boolean;
+    }> = {}
+  ): Promise<TransactionResponse | TransactionRequest> {
+    const { returnTxInfo } = overrides;
+
+    const voidArgs = {
+      fullOffers,
+      web3Lib: this._web3Lib,
+      subgraphUrl: this._subgraphUrl,
+      contractAddress: overrides.contractAddress || this._protocolDiamond
+    } as const satisfies Parameters<
+      typeof offers.handler.voidNonListedOfferBatch
+    >[0];
+
+    if (returnTxInfo === true) {
+      return offers.handler.voidNonListedOfferBatch({
+        ...voidArgs,
+        returnTxInfo: true
+      });
+    } else {
+      return offers.handler.voidNonListedOfferBatch({
+        ...voidArgs,
+        returnTxInfo: false
+      });
+    }
+  }
+
   /**
    * Extends an existing offer by calling the `OfferHandlerFacet` contract.
    * This transaction only succeeds if the connected signer is the `assistant`.
@@ -1093,4 +1261,17 @@ export class OfferMixin<T extends Web3LibAdapter> extends BaseCoreSDK<T> {
       });
     }
   }
+
+  public async getOfferHash(
+    fullOfferArgsUnsigned: Omit<FullOfferArgs, "signature">,
+    overrides: Partial<{
+      contractAddress: string;
+    }> = {}
+  ) {
+    return offers.handler.getOfferHash({
+      fullOfferArgsUnsigned,
+      web3Lib: this._web3Lib,
+      contractAddress: overrides.contractAddress || this._protocolDiamond
+    });
+  }
 }

package/src/offers/types.ts

@@ -1 +1,5 @@
-export { CreateOfferArgs, PriceType } from "@bosonprotocol/common";
+export {
+  CreateOfferArgs,
+  PriceType,
+  FullOfferArgs
+} from "@bosonprotocol/common";