@bosonprotocol/core-sdk 1.30.0-alpha.2 → 1.30.0-alpha.21

package/src/exchanges/handler.ts

@@ -8,11 +8,16 @@ import {
   encodeCompleteExchangeBatch,
   encodeRevokeVoucher,
   encodeExpireVoucher,
-  encodeRedeemVoucher
+  encodeRedeemVoucher,
+  encodeCommitToConditionalOffer
 } from "./interface";
 import { getOfferById } from "../offers/subgraph";
 import { getExchangeById, getExchanges } from "../exchanges/subgraph";
-import { ExchangeFieldsFragment, ExchangeState } from "../subgraph";
+import {
+  ExchangeFieldsFragment,
+  ExchangeState,
+  OfferFieldsFragment
+} from "../subgraph";
 import { ensureAllowance } from "../erc20/handler";
 
 type BaseExchangeHandlerArgs = {
@@ -21,32 +26,47 @@ type BaseExchangeHandlerArgs = {
   web3Lib: Web3LibAdapter;
 };
 
-export async function commitToOffer(
-  args: BaseExchangeHandlerArgs & {
-    buyer: string;
-    offerId: BigNumberish;
-  }
-): Promise<TransactionResponse> {
-  const offer = await getOfferById(args.subgraphUrl, args.offerId);
-
+function checkOfferIsCommittable(
+  offerId: BigNumberish,
+  offer: OfferFieldsFragment
+) {
   if (!offer) {
-    throw new Error(`Offer with id ${args.offerId} does not exist`);
+    throw new Error(`Offer with id ${offerId.toString()} does not exist`);
   }
 
   if (offer.voidedAt) {
-    throw new Error(`Offer with id ${args.offerId} has been voided`);
+    throw new Error(`Offer with id ${offerId.toString()} has been voided`);
   }
 
   if (Date.now() < Number(offer.validFromDate) * 1000) {
-    throw new Error(`Offer with id ${args.offerId} is not valid yet`);
+    throw new Error(`Offer with id ${offerId.toString()} is not valid yet`);
   }
 
   if (Date.now() >= Number(offer.validUntilDate) * 1000) {
-    throw new Error(`Offer with id ${args.offerId} is not valid anymore`);
+    throw new Error(`Offer with id ${offerId.toString()} is not valid anymore`);
   }
 
   if (Number(offer.quantityAvailable) === 0) {
-    throw new Error(`Offer with id ${args.offerId} is sold out`);
+    throw new Error(`Offer with id ${offerId.toString()} is sold out`);
+  }
+}
+
+export async function commitToOffer(
+  args: BaseExchangeHandlerArgs & {
+    buyer: string;
+    offerId: BigNumberish;
+  }
+): Promise<TransactionResponse> {
+  const offer = await getOfferById(args.subgraphUrl, args.offerId);
+
+  await checkOfferIsCommittable(args.offerId, offer);
+
+  if (offer.condition) {
+    // keep compatibility with previous version
+    return commitToConditionalOffer({
+      ...args,
+      tokenId: offer.condition.minTokenId
+    });
   }
 
   if (offer.exchangeToken.address !== AddressZero) {
@@ -69,6 +89,41 @@ export async function commitToOffer(
   });
 }
 
+export async function commitToConditionalOffer(
+  args: BaseExchangeHandlerArgs & {
+    buyer: string;
+    offerId: BigNumberish;
+    tokenId: BigNumberish;
+  }
+): Promise<TransactionResponse> {
+  const offer = await getOfferById(args.subgraphUrl, args.offerId);
+
+  await checkOfferIsCommittable(args.offerId, offer);
+
+  if (offer.exchangeToken.address !== AddressZero) {
+    const owner = await args.web3Lib.getSignerAddress();
+    // check if we need the committer to approve the token first
+    await ensureAllowance({
+      owner,
+      spender: args.contractAddress,
+      contractAddress: offer.exchangeToken.address,
+      value: offer.price,
+      web3Lib: args.web3Lib
+    });
+  }
+
+  return args.web3Lib.sendTransaction({
+    from: args.buyer,
+    to: args.contractAddress,
+    data: encodeCommitToConditionalOffer(
+      args.buyer,
+      args.offerId,
+      args.tokenId
+    ),
+    value: offer.exchangeToken.address === AddressZero ? offer.price : "0"
+  });
+}
+
 export async function completeExchange(
   args: BaseExchangeHandlerArgs & {
     exchangeId: BigNumberish;

package/src/exchanges/interface.ts

@@ -13,6 +13,17 @@ export function encodeCommitToOffer(buyer: string, offerId: BigNumberish) {
   ]);
 }
 
+export function encodeCommitToConditionalOffer(
+  buyer: string,
+  offerId: BigNumberish,
+  tokenId: BigNumberish
+) {
+  return bosonExchangeHandlerIface.encodeFunctionData(
+    "commitToConditionalOffer",
+    [buyer, offerId, tokenId]
+  );
+}
+
 export function encodeCompleteExchange(exchangeId: BigNumberish) {
   return bosonExchangeHandlerIface.encodeFunctionData("completeExchange", [
     exchangeId

package/src/exchanges/mixin.ts

@@ -10,7 +10,8 @@ import {
   redeemVoucher,
   completeExchange,
   completeExchangeBatch,
-  expireVoucher
+  expireVoucher,
+  commitToConditionalOffer
 } from "./handler";
 import { getExchangeById, getExchanges } from "./subgraph";
 import { bosonExchangeHandlerIface } from "./interface";
@@ -67,6 +68,32 @@ export class ExchangesMixin extends BaseCoreSDK {
     });
   }
 
+  /**
+   * Commits to a conditional offer by calling the `ExchangeHandlerContract`.
+   * This transaction only succeeds if the seller has deposited funds.
+   * @param offerId - ID of offer to commit to.
+   * @param tokenId - ID of the token to use for the conditional commit
+   * @param overrides - Optional overrides.
+   * @returns Transaction response.
+   */
+  public async commitToConditionalOffer(
+    offerId: BigNumberish,
+    tokenId: BigNumberish,
+    overrides: Partial<{
+      buyer: string;
+    }> = {}
+  ): Promise<TransactionResponse> {
+    const buyer = overrides.buyer || (await this._web3Lib.getSignerAddress());
+    return commitToConditionalOffer({
+      buyer,
+      offerId,
+      tokenId,
+      web3Lib: this._web3Lib,
+      subgraphUrl: this._subgraphUrl,
+      contractAddress: this._protocolDiamond
+    });
+  }
+
   /**
    * Utility method to retrieve the created `exchangeId` from logs after calling `commitToOffer`.
    * @param logs - Logs to search in.

package/src/groups/interface.ts

@@ -17,20 +17,28 @@ export function encodeCreateGroup(args: CreateGroupArgs) {
 
 export function createGroupArgsToStructs(
   args: CreateGroupArgs
-): [GroupStruct, ConditionStruct] {
+): [GroupStruct, Omit<ConditionStruct, "gatingType"> & { gating: number }] {
   return [
     {
       id: "0",
       sellerId: "0",
       offerIds: args.offerIds
     },
-    {
-      method: args.method,
-      tokenType: args.tokenType,
-      tokenAddress: args.tokenAddress,
-      tokenId: args.tokenId,
-      threshold: args.threshold,
-      maxCommits: args.maxCommits
-    }
+    conditionArgsToStructs(args)
   ];
 }
+
+export function conditionArgsToStructs(
+  args: ConditionStruct
+): Omit<ConditionStruct, "gatingType"> & { gating: number } {
+  return {
+    method: args.method,
+    tokenType: args.tokenType,
+    tokenAddress: args.tokenAddress,
+    gating: args.gatingType,
+    minTokenId: args.minTokenId,
+    maxTokenId: args.maxTokenId,
+    threshold: args.threshold,
+    maxCommits: args.maxCommits
+  };
+}

package/src/groups/queries.graphql

@@ -3,7 +3,9 @@ fragment BaseConditionFields on ConditionEntity {
   method
   tokenType
   tokenAddress
-  tokenId
+  gatingType
+  minTokenId
+  maxTokenId
   threshold
   maxCommits
 }

package/src/meta-tx/biconomy.ts

@@ -169,7 +169,6 @@ export class Biconomy {
         });
       }
     }
-    console.log("[Biconomy.wait] resubmittedResponse", resubmittedResponse);
     return resubmittedResponse;
   }
 }

package/src/meta-tx/handler.ts

@@ -398,7 +398,7 @@ export async function signMetaTxCreateSeller(
   return signMetaTx({
     ...args,
     functionName:
-      "createSeller((uint256,address,address,address,address,bool,string),(uint256,uint8),(string,uint256))",
+      "createSeller((uint256,address,address,address,address,bool,string),(uint256,uint8),(string,uint256,bytes32))",
     functionSignature: encodeCreateSeller(args.createSellerArgs)
   });
 }
@@ -455,7 +455,7 @@ export async function signMetaTxCreateOffer(
   return signMetaTx({
     ...args,
     functionName:
-      "createOffer((uint256,uint256,uint256,uint256,uint256,uint256,address,string,string,bool),(uint256,uint256,uint256,uint256),(uint256,uint256,uint256),uint256,uint256)",
+      "createOffer((uint256,uint256,uint256,uint256,uint256,uint256,address,string,string,bool,uint256),(uint256,uint256,uint256,uint256),(uint256,uint256,uint256),uint256,uint256)",
     functionSignature: encodeCreateOffer(args.createOfferArgs)
   });
 }
@@ -486,7 +486,7 @@ export async function signMetaTxCreateOfferBatch(
   return signMetaTx({
     ...args,
     functionName:
-      "createOfferBatch((uint256,uint256,uint256,uint256,uint256,uint256,address,string,string,bool)[],(uint256,uint256,uint256,uint256)[],(uint256,uint256,uint256)[],uint256[],uint256[])",
+      "createOfferBatch((uint256,uint256,uint256,uint256,uint256,uint256,address,string,string,bool,uint256)[],(uint256,uint256,uint256,uint256)[],(uint256,uint256,uint256)[],uint256[],uint256[])",
     functionSignature: encodeCreateOfferBatch(args.createOffersArgs)
   });
 }
@@ -605,7 +605,7 @@ export async function signMetaTxCreateGroup(
   return signMetaTx({
     ...args,
     functionName:
-      "createGroup((uint256,uint256,uint256[]),(uint8,uint8,address,uint256,uint256,uint256))",
+      "createGroup((uint256,uint256,uint256[]),(uint8,uint8,address,uint8,uint256,uint256,uint256,uint256))",
     functionSignature: encodeCreateGroup(args.createGroupArgs)
   });
 }
@@ -786,7 +786,7 @@ export async function signMetaTxCreateOfferWithCondition(
   return signMetaTx({
     ...args,
     functionName:
-      "createOfferWithCondition((uint256,uint256,uint256,uint256,uint256,uint256,address,string,string,bool),(uint256,uint256,uint256,uint256),(uint256,uint256,uint256),uint256,(uint8,uint8,address,uint256,uint256,uint256),uint256)",
+      "createOfferWithCondition((uint256,uint256,uint256,uint256,uint256,uint256,address,string,string,bool,uint256),(uint256,uint256,uint256,uint256),(uint256,uint256,uint256),uint256,(uint8,uint8,address,uint8,uint256,uint256,uint256,uint256),uint256)",
     functionSignature: encodeCreateOfferWithCondition(
       args.offerToCreate,
       args.condition
@@ -850,6 +850,65 @@ export async function signMetaTxCommitToOffer(
   };
 }
 
+export async function signMetaTxCommitToConditionalOffer(
+  args: BaseMetaTxArgs & {
+    offerId: BigNumberish;
+    tokenId: BigNumberish;
+  }
+): Promise<SignedMetaTx> {
+  const functionName = "commitToConditionalOffer(address,uint256,uint256)";
+
+  const offerType = [
+    { name: "buyer", type: "address" },
+    { name: "offerId", type: "uint256" },
+    { name: "tokenId", type: "uint256" }
+  ];
+
+  const metaTransactionType = [
+    { name: "nonce", type: "uint256" },
+    { name: "from", type: "address" },
+    { name: "contractAddress", type: "address" },
+    { name: "functionName", type: "string" },
+    { name: "offerDetails", type: "MetaTxConditionalOfferDetails" }
+  ];
+
+  const customSignatureType = {
+    MetaTxCommitToConditionalOffer: metaTransactionType,
+    MetaTxConditionalOfferDetails: offerType
+  };
+
+  const buyerAddress = await args.web3Lib.getSignerAddress();
+
+  const message = {
+    nonce: args.nonce.toString(),
+    from: buyerAddress,
+    contractAddress: args.metaTxHandlerAddress,
+    functionName,
+    offerDetails: {
+      buyer: buyerAddress,
+      offerId: args.offerId.toString(),
+      tokenId: args.tokenId.toString()
+    }
+  };
+
+  const signatureParams = await prepareDataSignatureParameters({
+    ...args,
+    verifyingContractAddress: args.metaTxHandlerAddress,
+    customSignatureType,
+    primaryType: "MetaTxCommitToConditionalOffer",
+    message
+  });
+
+  return {
+    ...signatureParams,
+    functionName,
+    functionSignature: bosonExchangeHandlerIface.encodeFunctionData(
+      "commitToConditionalOffer",
+      [buyerAddress, args.offerId, args.tokenId]
+    )
+  };
+}
+
 export async function signMetaTxCancelVoucher(
   args: BaseMetaTxArgs & {
     exchangeId: BigNumberish;
@@ -1193,7 +1252,6 @@ export async function relayMetaTransaction(args: {
 
       const txHash = waitResponse.data.newHash;
       const txReceipt = await args.web3LibAdapter.getTransactionReceipt(txHash);
-      console.log("[relayBiconomyMetaTransaction.wait] txReceipt", txReceipt);
       return {
         to: txReceipt?.to || contractAddress,
         from: txReceipt?.from || metaTx.params.userAddress,

package/src/meta-tx/mixin.ts

@@ -131,7 +131,6 @@ export class MetaTxMixin extends BaseCoreSDK {
     const fieldsToUpdate = {
       assistant:
         currentAccount === pendingSellerUpdate.assistant?.toLowerCase(),
-      clerk: currentAccount === pendingSellerUpdate.clerk?.toLowerCase(),
       admin: currentAccount === pendingSellerUpdate.admin?.toLowerCase(),
       authToken:
         pendingSellerUpdate.authTokenType !== undefined &&
@@ -140,7 +139,6 @@ export class MetaTxMixin extends BaseCoreSDK {
     };
     if (
       fieldsToUpdate.assistant ||
-      fieldsToUpdate.clerk ||
       fieldsToUpdate.admin ||
       fieldsToUpdate.authToken
     ) {
@@ -151,7 +149,6 @@ export class MetaTxMixin extends BaseCoreSDK {
           fieldsToUpdate: {
             assistant:
               currentAccount === pendingSellerUpdate.assistant.toLowerCase(),
-            clerk: currentAccount === pendingSellerUpdate.clerk.toLowerCase(),
             admin: currentAccount === pendingSellerUpdate.admin.toLowerCase(),
             authToken: pendingSellerUpdate.authTokenType !== AuthTokenType.NONE
           }
@@ -596,6 +593,16 @@ export class MetaTxMixin extends BaseCoreSDK {
       "web3Lib" | "metaTxHandlerAddress" | "chainId"
     >
   ) {
+    const offer = await getOfferById(this._subgraphUrl, args.offerId);
+
+    if (offer.condition) {
+      // keep compatibility with previous version
+      return this.signMetaTxCommitToConditionalOffer({
+        ...args,
+        tokenId: offer.condition.minTokenId
+      });
+    }
+
     return handler.signMetaTxCommitToOffer({
       web3Lib: this._web3Lib,
       metaTxHandlerAddress: this._protocolDiamond,
@@ -604,6 +611,25 @@ export class MetaTxMixin extends BaseCoreSDK {
     });
   }
 
+  /**
+   * Encodes and signs a meta transaction for `commitToConditionalOffer` that can be relayed.
+   * @param args - Meta transaction args.
+   * @returns Signature.
+   */
+  public async signMetaTxCommitToConditionalOffer(
+    args: Omit<
+      Parameters<typeof handler.signMetaTxCommitToConditionalOffer>[0],
+      "web3Lib" | "metaTxHandlerAddress" | "chainId"
+    >
+  ) {
+    return handler.signMetaTxCommitToConditionalOffer({
+      web3Lib: this._web3Lib,
+      metaTxHandlerAddress: this._protocolDiamond,
+      chainId: this._chainId,
+      ...args
+    });
+  }
+
   /**
    * Encodes and signs a meta transaction for `cancelVoucher` that can be relayed.
    * @param args - Meta transaction args.

package/src/offers/mixin.ts

@@ -408,8 +408,13 @@ export class OfferMixin extends BaseCoreSDK {
     offerCondition: subgraph.OfferFieldsFragment["condition"],
     buyerAddress: string
   ): Promise<boolean> {
-    const { tokenId, tokenType, threshold, method, tokenAddress } =
-      offerCondition;
+    const {
+      minTokenId: tokenId,
+      tokenType,
+      threshold,
+      method,
+      tokenAddress
+    } = offerCondition;
     if (tokenType === TokenType.FungibleToken) {
       const balance: string = await erc20.handler.balanceOf({
         contractAddress: tokenAddress,

package/src/offers/queries.graphql

@@ -71,6 +71,7 @@ fragment BaseOfferFields on Offer {
   metadataHash
   voided
   voidedAt
+  collectionIndex
   disputeResolverId
   numberOfCommits
   numberOfRedemptions

package/src/offers/renderContractualAgreement.ts

@@ -4,7 +4,6 @@ import { BigNumber, BigNumberish } from "@ethersproject/bignumber";
 import { utils } from "@bosonprotocol/common";
 import Mustache from "mustache";
 import { formatUnits } from "@ethersproject/units";
-import { productV1 } from "@bosonprotocol/metadata";
 
 import { CreateOfferArgs } from "./types";
 import {

package/src/orchestration/interface.ts

@@ -6,6 +6,7 @@ import { createOfferArgsToStructs } from "../offers/interface";
 import { CreateSellerArgs } from "../accounts/types";
 import { CreateOfferArgs } from "../offers/types";
 import { BigNumberish } from "@ethersproject/bignumber";
+import { conditionArgsToStructs } from "../groups/interface";
 
 export const bosonOrchestrationHandlerIface = new Interface(
   abis.IBosonOrchestrationHandlerABI
@@ -44,7 +45,7 @@ export function encodeCreateOfferWithCondition(
       offerArgs[1], // offerDates
       offerArgs[2], // offerDurations
       offerArgs[3], // disputeResolverId
-      condition,
+      conditionArgsToStructs(condition),
       offerArgs[4] // agentId
     ]
   );
@@ -65,7 +66,7 @@ export function encodeCreateSellerAndOfferWithCondition(
       offerArgs[1], // offerDates
       offerArgs[2], // offerDurations
       offerArgs[3], // disputeResolverId
-      condition,
+      conditionArgsToStructs(condition),
       sellerArgs.authTokenStruct,
       sellerArgs.voucherInitValues,
       offerArgs[4] // agentId
@@ -108,7 +109,7 @@ export function encodeCreatePremintedOfferWithCondition(
       offerArgs[2], // offerDurations
       offerArgs[3], // disputeResolverId
       reservedRangeLength,
-      condition,
+      conditionArgsToStructs(condition),
       offerArgs[4] // agentId
     ]
   );
@@ -154,7 +155,7 @@ export function encodeCreateSellerAndPremintedOfferWithCondition(
       offerArgs[2], // offerDurations
       offerArgs[3], // disputeResolverId
       reservedRangeLength,
-      condition,
+      conditionArgsToStructs(condition),
       sellerArgs.authTokenStruct,
       sellerArgs.voucherInitValues,
       offerArgs[4] // agentId