@bosonprotocol/core-sdk 1.25.0-alpha.9 → 1.25.0

package/src/meta-tx/mixin.ts

@@ -1,12 +1,17 @@
-import { MetaTxConfig, TransactionResponse } from "@bosonprotocol/common";
+import {
+  AuthTokenType,
+  MetaTxConfig,
+  TransactionResponse
+} from "@bosonprotocol/common";
 import { BigNumberish } from "@ethersproject/bignumber";
 import { BytesLike } from "@ethersproject/bytes";
 import { handler } from ".";
 import { getOfferById } from "../offers/subgraph";
 import { BaseCoreSDK } from "./../mixins/base-core-sdk";
 import { GetRetriedHashesData } from "./biconomy";
-import { getNonce } from "../forwarder/handler";
 import { accounts } from "..";
+import { AccountsMixin } from "../accounts/mixin";
+import { SellerFieldsFragment } from "../subgraph";
 export class MetaTxMixin extends BaseCoreSDK {
   /* -------------------------------------------------------------------------- */
   /*                           Meta Tx related methods                          */
@@ -78,6 +83,90 @@ export class MetaTxMixin extends BaseCoreSDK {
     });
   }
 
+  public async signMetaTxUpdateSellerAndOptIn(
+    sellerUpdates: accounts.UpdateSellerArgs
+  ): Promise<TransactionResponse> {
+    let nonce = Date.now();
+    const updateMetaTx = await this.signMetaTxUpdateSeller({
+      updateSellerArgs: sellerUpdates,
+      nonce,
+      theGraphStorage: this._theGraphStorage,
+      metadataStorage: this._metadataStorage
+    });
+    const updateTx = await this.relayMetaTransaction({
+      functionName: updateMetaTx.functionName,
+      functionSignature: updateMetaTx.functionSignature,
+      sigR: updateMetaTx.r,
+      sigS: updateMetaTx.s,
+      sigV: updateMetaTx.v,
+      nonce
+    });
+    await updateTx.wait();
+    let seller: SellerFieldsFragment | undefined;
+    let count = 200;
+    while ((!seller || !seller.pendingSeller) && count-- > 0) {
+      await new Promise((resolve) => setTimeout(resolve, 300));
+      type getSellerById = typeof AccountsMixin.prototype.getSellerById;
+      seller = await (this["getSellerById"] as getSellerById)(sellerUpdates.id);
+    }
+    if (!seller) {
+      throw new Error(
+        "[signMetaTxUpdateSellerAndOptIn] seller could not be retrieved in time"
+      );
+    }
+    const pendingSellerUpdate = seller.pendingSeller;
+    if (!pendingSellerUpdate) {
+      throw new Error(
+        "[signMetaTxUpdateSellerAndOptIn] seller.pendingSeller could not be retrieved in time"
+      );
+    }
+    // Find all updates that can be opted in by the current account
+    const currentAccount = (
+      await this._web3Lib.getSignerAddress()
+    ).toLowerCase();
+    const fieldsToUpdate = {
+      assistant:
+        currentAccount === pendingSellerUpdate.assistant?.toLowerCase(),
+      clerk: currentAccount === pendingSellerUpdate.clerk?.toLowerCase(),
+      admin: currentAccount === pendingSellerUpdate.admin?.toLowerCase(),
+      authToken:
+        pendingSellerUpdate.authTokenType !== undefined &&
+        pendingSellerUpdate.authTokenType !== null &&
+        pendingSellerUpdate.authTokenType !== AuthTokenType.NONE
+    };
+    if (
+      fieldsToUpdate.assistant ||
+      fieldsToUpdate.clerk ||
+      fieldsToUpdate.admin ||
+      fieldsToUpdate.authToken
+    ) {
+      nonce = Date.now();
+      const optInMetaTx = await this.signMetaTxOptInToSellerUpdate({
+        optInToSellerUpdateArgs: {
+          id: sellerUpdates.id,
+          fieldsToUpdate: {
+            assistant:
+              currentAccount === pendingSellerUpdate.assistant.toLowerCase(),
+            clerk: currentAccount === pendingSellerUpdate.clerk.toLowerCase(),
+            admin: currentAccount === pendingSellerUpdate.admin.toLowerCase(),
+            authToken: pendingSellerUpdate.authTokenType !== AuthTokenType.NONE
+          }
+        },
+        nonce
+      });
+      return this.relayMetaTransaction({
+        functionName: optInMetaTx.functionName,
+        functionSignature: optInMetaTx.functionSignature,
+        sigR: optInMetaTx.r,
+        sigS: optInMetaTx.s,
+        sigV: optInMetaTx.v,
+        nonce
+      });
+    }
+    // If there is nothing to optIn from the current account, then return the response from updateSeller
+    return updateTx;
+  }
+
   /**
    * Encodes and signs a meta transaction for `createOffer` that can be relayed.
    * @param args - Meta transaction args.
@@ -142,14 +231,20 @@ export class MetaTxMixin extends BaseCoreSDK {
   public async signMetaTxReserveRange(
     args: Omit<
       Parameters<typeof handler.signMetaTxReserveRange>[0],
-      "web3Lib" | "metaTxHandlerAddress" | "chainId"
-    >
+      "web3Lib" | "metaTxHandlerAddress" | "chainId" | "to"
+    > & { to: "seller" | "contract" }
   ) {
+    const offer = await getOfferById(this._subgraphUrl, args.offerId);
+
     return handler.signMetaTxReserveRange({
       web3Lib: this._web3Lib,
       metaTxHandlerAddress: this._protocolDiamond,
       chainId: this._chainId,
-      ...args
+      ...args,
+      to:
+        args.to === "contract"
+          ? offer.seller.voucherCloneAddress
+          : offer.seller.assistant
     });
   }
 
@@ -159,25 +254,17 @@ export class MetaTxMixin extends BaseCoreSDK {
       | "web3Lib"
       | "bosonVoucherAddress"
       | "chainId"
-      | "nonce"
       | "forwarderAddress"
       | "batchId"
       | "forwarderAbi"
+      | "relayerUrl"
     >,
     overrides: Partial<{
       batchId: BigNumberish;
     }> = {}
   ) {
-    const signerAddress = await this._web3Lib.getSignerAddress();
     const forwarderAddress = this._contracts.forwarder;
     const batchId = overrides.batchId || 0;
-    const nonce = await getNonce({
-      contractAddress: forwarderAddress,
-      user: signerAddress,
-      web3Lib: this._web3Lib,
-      batchId,
-      forwarderAbi: this._metaTxConfig.forwarderAbi
-    });
     const offerFromSubgraph = await getOfferById(
       this._subgraphUrl,
       args.offerId
@@ -186,10 +273,10 @@ export class MetaTxMixin extends BaseCoreSDK {
       web3Lib: this._web3Lib,
       bosonVoucherAddress: offerFromSubgraph.seller.voucherCloneAddress,
       chainId: this._chainId,
-      nonce,
       forwarderAddress,
       batchId,
       forwarderAbi: this._metaTxConfig.forwarderAbi,
+      relayerUrl: this._metaTxConfig.relayerUrl,
       ...args
     });
   }
@@ -204,6 +291,7 @@ export class MetaTxMixin extends BaseCoreSDK {
       | "forwarderAddress"
       | "batchId"
       | "forwarderAbi"
+      | "relayerUrl"
     >,
     overrides: Partial<{
       batchId: BigNumberish;
@@ -216,26 +304,103 @@ export class MetaTxMixin extends BaseCoreSDK {
     );
     const forwarderAddress = this._contracts.forwarder;
     const batchId = overrides.batchId || 0;
-    const nonce = await getNonce({
-      contractAddress: forwarderAddress,
-      user: sellerAddress,
-      web3Lib: this._web3Lib,
-      batchId,
-      forwarderAbi: this._metaTxConfig.forwarderAbi
-    });
 
     return handler.signMetaTxSetApprovalForAll({
       web3Lib: this._web3Lib,
       bosonVoucherAddress: seller.voucherCloneAddress,
       chainId: this._chainId,
-      nonce,
       forwarderAddress,
       batchId,
       forwarderAbi: this._metaTxConfig.forwarderAbi,
+      relayerUrl: this._metaTxConfig.relayerUrl,
       ...args
     });
   }
 
+  public async signMetaTxSetApprovalForAllToContract(
+    args: Omit<
+      Parameters<typeof handler.signMetaTxSetApprovalForAllToContract>[0],
+      | "web3Lib"
+      | "bosonVoucherAddress"
+      | "chainId"
+      | "nonce"
+      | "forwarderAddress"
+      | "batchId"
+      | "forwarderAbi"
+      | "relayerUrl"
+    >,
+    overrides: Partial<{
+      batchId?: BigNumberish;
+      txGas?: number;
+    }> = {}
+  ) {
+    const sellerAddress = await this._web3Lib.getSignerAddress();
+    const seller = await accounts.subgraph.getSellerByAddress(
+      this._subgraphUrl,
+      sellerAddress
+    );
+    const forwarderAddress = this._contracts.forwarder;
+    const batchId = overrides.batchId || 0;
+
+    return handler.signMetaTxSetApprovalForAllToContract(
+      {
+        web3Lib: this._web3Lib,
+        bosonVoucherAddress: seller.voucherCloneAddress,
+        chainId: this._chainId,
+        forwarderAddress,
+        batchId,
+        forwarderAbi: this._metaTxConfig.forwarderAbi,
+        relayerUrl: this._metaTxConfig.relayerUrl,
+        ...args
+      },
+      {
+        txGas: overrides.txGas
+      }
+    );
+  }
+
+  public async signMetaTxCallExternalContract(
+    args: Omit<
+      Parameters<typeof handler.signMetaTxCallExternalContract>[0],
+      | "web3Lib"
+      | "bosonVoucherAddress"
+      | "chainId"
+      | "nonce"
+      | "forwarderAddress"
+      | "batchId"
+      | "forwarderAbi"
+      | "relayerUrl"
+    >,
+    overrides: Partial<{
+      batchId?: BigNumberish;
+      txGas?: number;
+    }> = {}
+  ) {
+    const sellerAddress = await this._web3Lib.getSignerAddress();
+    const seller = await accounts.subgraph.getSellerByAddress(
+      this._subgraphUrl,
+      sellerAddress
+    );
+    const forwarderAddress = this._contracts.forwarder;
+    const batchId = overrides.batchId || 0;
+
+    return handler.signMetaTxCallExternalContract(
+      {
+        web3Lib: this._web3Lib,
+        bosonVoucherAddress: seller.voucherCloneAddress,
+        chainId: this._chainId,
+        forwarderAddress,
+        batchId,
+        forwarderAbi: this._metaTxConfig.forwarderAbi,
+        relayerUrl: this._metaTxConfig.relayerUrl,
+        ...args
+      },
+      {
+        txGas: overrides.txGas
+      }
+    );
+  }
+
   public async relayBiconomyMetaTransaction(
     contractAddress: string,
     metaTxParams: {
@@ -340,6 +505,44 @@ export class MetaTxMixin extends BaseCoreSDK {
     });
   }
 
+  /**
+   * Encodes and signs a meta transaction for `extendOffer` that can be relayed.
+   * @param args - Meta transaction args.
+   * @returns Signature.
+   */
+  public async signMetaTxExtendOffer(
+    args: Omit<
+      Parameters<typeof handler.signMetaTxExtendOffer>[0],
+      "web3Lib" | "metaTxHandlerAddress" | "chainId"
+    >
+  ) {
+    return handler.signMetaTxExtendOffer({
+      web3Lib: this._web3Lib,
+      metaTxHandlerAddress: this._protocolDiamond,
+      chainId: this._chainId,
+      ...args
+    });
+  }
+
+  /**
+   * Encodes and signs a meta transaction for `extendOfferBatch` that can be relayed.
+   * @param args - Meta transaction args.
+   * @returns Signature.
+   */
+  public async signMetaTxExtendOfferBatch(
+    args: Omit<
+      Parameters<typeof handler.signMetaTxExtendOfferBatch>[0],
+      "web3Lib" | "metaTxHandlerAddress" | "chainId"
+    >
+  ) {
+    return handler.signMetaTxExtendOfferBatch({
+      web3Lib: this._web3Lib,
+      metaTxHandlerAddress: this._protocolDiamond,
+      chainId: this._chainId,
+      ...args
+    });
+  }
+
   /**
    * Encodes and signs a meta transaction for `completeExchangeBatch` that can be relayed.
    * @param args - Meta transaction args.

package/src/metadata/base.graphql

@@ -39,6 +39,9 @@ fragment BaseBaseMetadataEntityFields on BaseMetadataEntity {
   description
   externalUrl
   animationUrl
+  animationMetadata {
+    ...BaseAnimationMetadataFields
+  }
   licenseUrl
   condition
   schemaUrl

package/src/metadata/mixin.ts

@@ -1,6 +1,6 @@
 import { BaseCoreSDK } from "./../mixins/base-core-sdk";
 import * as subgraph from "../subgraph";
-import { AnyMetadata } from "..";
+import { OfferOrSellerMetadata } from "..";
 import {
   getBaseMetadataEntities,
   getProductV1MetadataEntities,
@@ -21,7 +21,7 @@ export class MetadataMixin extends BaseCoreSDK {
    * @param metadata - Offer metadata of type `BASE` or `PRODUCT_V1`.
    * @returns Metadata hash / identifier.
    */
-  public async storeMetadata(metadata: AnyMetadata): Promise<string> {
+  public async storeMetadata(metadata: OfferOrSellerMetadata): Promise<string> {
     if (!this._metadataStorage) {
       throw new Error("No metadata storage set");
     }
@@ -35,7 +35,9 @@ export class MetadataMixin extends BaseCoreSDK {
    * storage instance.
    * @returns Offer metadata.
    */
-  public async getMetadata(metadataHashOrUri: string): Promise<AnyMetadata> {
+  public async getMetadata(
+    metadataHashOrUri: string
+  ): Promise<OfferOrSellerMetadata> {
     if (!this._metadataStorage) {
       throw new Error("No metadata storage set");
     }

package/src/metadata/product-v1.graphql

@@ -180,7 +180,7 @@ fragment BaseAnimationMetadataFields on AnimationMetadata {
   id
   width
   height
-  name
+  type
 }
 
 fragment BaseProductV1ProductFields on ProductV1Product {
@@ -311,7 +311,6 @@ fragment BaseProductV1MediaFields on ProductV1Media {
   type
   width
   height
-  name
 }
 
 fragment BaseProductV1PersonalisationFields on ProductV1Personalisation {
@@ -339,6 +338,7 @@ fragment BaseProductV1SellerFields on ProductV1Seller {
   contactLinks {
     ...BaseProductV1SellerContactLinkFields
   }
+  contactPreference
   seller {
     ...BaseSellerFields
   }

package/src/offers/handler.ts

@@ -73,6 +73,7 @@ export async function reserveRange(args: {
   subgraphUrl: string;
   offerId: BigNumberish;
   length: BigNumberish;
+  to: string;
   web3Lib: Web3LibAdapter;
 }): Promise<TransactionResponse> {
   const offerFromSubgraph = await getOfferById(args.subgraphUrl, args.offerId);
@@ -87,7 +88,7 @@ export async function reserveRange(args: {
 
   return args.web3Lib.sendTransaction({
     to: args.contractAddress,
-    data: encodeReserveRange(args.offerId, args.length)
+    data: encodeReserveRange(args.offerId, args.length, args.to)
   });
 }
 
@@ -145,6 +146,38 @@ export async function voidOfferBatch(args: {
   });
 }
 
+export async function extendOffer(args: {
+  contractAddress: string;
+  subgraphUrl: string;
+  offerId: BigNumberish;
+  validUntil: BigNumberish;
+  web3Lib: Web3LibAdapter;
+}): Promise<TransactionResponse> {
+  return args.web3Lib.sendTransaction({
+    to: args.contractAddress,
+    data: bosonOfferHandlerIface.encodeFunctionData("extendOffer", [
+      args.offerId,
+      args.validUntil
+    ])
+  });
+}
+
+export async function extendOfferBatch(args: {
+  contractAddress: string;
+  subgraphUrl: string;
+  offerIds: BigNumberish[];
+  validUntil: BigNumberish;
+  web3Lib: Web3LibAdapter;
+}): Promise<TransactionResponse> {
+  return args.web3Lib.sendTransaction({
+    to: args.contractAddress,
+    data: bosonOfferHandlerIface.encodeFunctionData("extendOfferBatch", [
+      args.offerIds,
+      args.validUntil
+    ])
+  });
+}
+
 function checkIfOfferVoidable(
   offerId: BigNumberish,
   signerAddress: string,
@@ -159,11 +192,11 @@ function checkIfOfferVoidable(
   }
 
   if (
-    offerFromSubgraph.seller.operator.toLowerCase() !==
+    offerFromSubgraph.seller.assistant.toLowerCase() !==
     signerAddress.toLowerCase()
   ) {
     throw new Error(
-      `Signer with address "${signerAddress}" is not the operator "${offerFromSubgraph.seller.operator}" of offer with id "${offerId}"`
+      `Signer with address "${signerAddress}" is not the assistant "${offerFromSubgraph.seller.assistant}" of offer with id "${offerId}"`
     );
   }
 }

package/src/offers/interface.ts

@@ -132,10 +132,12 @@ export function argsToOfferDurationsStruct(
 
 export function encodeReserveRange(
   offerId: BigNumberish,
-  length: BigNumberish
+  length: BigNumberish,
+  to: string
 ) {
   return bosonOfferHandlerIface.encodeFunctionData("reserveRange", [
     offerId,
-    length
+    length,
+    to
   ]);
 }

package/src/offers/mixin.ts

@@ -146,7 +146,7 @@ export class OfferMixin extends BaseCoreSDK {
 
   /**
    * Voids an existing offer by calling the `OfferHandlerFacet` contract.
-   * This transaction only succeeds if the connected signer is the `operator`.
+   * This transaction only succeeds if the connected signer is the `assistant`.
    * @param offerId - ID of offer to void.
    * @param overrides - Optional overrides.
    * @returns Transaction response.
@@ -167,7 +167,7 @@ export class OfferMixin extends BaseCoreSDK {
 
   /**
    * Voids a batch of existing offers by calling the `OfferHandlerFacet` contract.
-   * This transaction only succeeds if the connected signer is the `operator` of all
+   * This transaction only succeeds if the connected signer is the `assistant` of all
    * provided offers.
    * @param offerIds - IDs of offers to void.
    * @param overrides - Optional overrides.
@@ -187,6 +187,55 @@ export class OfferMixin extends BaseCoreSDK {
     });
   }
 
+  /**
+   * Extends an existing offer by calling the `OfferHandlerFacet` contract.
+   * This transaction only succeeds if the connected signer is the `assistant`.
+   * @param offerId - ID of offer to void.
+   * @param validUntil - new validity date.
+   * @param overrides - Optional overrides.
+   * @returns Transaction response.
+   */
+  public async extendOffer(
+    offerId: BigNumberish,
+    validUntil: BigNumberish,
+    overrides: Partial<{
+      contractAddress: string;
+    }> = {}
+  ): Promise<TransactionResponse> {
+    return offers.handler.extendOffer({
+      offerId,
+      validUntil,
+      web3Lib: this._web3Lib,
+      subgraphUrl: this._subgraphUrl,
+      contractAddress: overrides.contractAddress || this._protocolDiamond
+    });
+  }
+
+  /**
+   * Extends a batch of existing offers by calling the `OfferHandlerFacet` contract.
+   * This transaction only succeeds if the connected signer is the `assistant` of all
+   * provided offers.
+   * @param offerIds - IDs of offers to void.
+   * @param validUntil - new validity date.
+   * @param overrides - Optional overrides.
+   * @returns Transaction response.
+   */
+  public async extendOfferBatch(
+    offerIds: BigNumberish[],
+    validUntil: BigNumberish,
+    overrides: Partial<{
+      contractAddress: string;
+    }> = {}
+  ): Promise<TransactionResponse> {
+    return offers.handler.extendOfferBatch({
+      offerIds,
+      validUntil,
+      web3Lib: this._web3Lib,
+      subgraphUrl: this._subgraphUrl,
+      contractAddress: overrides.contractAddress || this._protocolDiamond
+    });
+  }
+
   /**
    * Returns offer from subgraph.
    * @param offerId - ID of offer.
@@ -255,13 +304,19 @@ export class OfferMixin extends BaseCoreSDK {
   public async reserveRange(
     offerId: BigNumberish,
     length: BigNumberish,
+    to: "seller" | "contract",
     overrides: Partial<{
       contractAddress: string;
     }> = {}
   ): Promise<TransactionResponse> {
+    const offer = await this.getOfferById(offerId);
     return offers.handler.reserveRange({
       offerId,
       length,
+      to:
+        to === "contract"
+          ? offer.seller.voucherCloneAddress
+          : offer.seller.assistant,
       subgraphUrl: this._subgraphUrl,
       contractAddress: overrides.contractAddress || this._protocolDiamond,
       web3Lib: this._web3Lib

package/src/offers/queries.graphql

@@ -94,6 +94,9 @@ fragment BaseOfferFields on Offer {
     description
     externalUrl
     animationUrl
+    animationMetadata {
+      ...BaseAnimationMetadataFields
+    }
     licenseUrl
     condition
     schemaUrl
@@ -128,4 +131,14 @@ fragment BaseOfferFields on Offer {
       }
     }
   }
+  range {
+    ...BaseRangeFields
+  }
+}
+
+fragment BaseRangeFields on RangeEntity {
+  id
+  start
+  end
+  owner
 }

package/src/offers/renderContractualAgreement.ts

@@ -292,21 +292,18 @@ export async function renderContractualAgreementForOffer(
       `Invalid Offer Metadata: Type is not supported: '${existingOfferData.metadata.type}'`
     );
   }
-  if (
-    !(existingOfferData.metadata as productV1.ProductV1Metadata).exchangePolicy
-  ) {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  if (!(existingOfferData.metadata as any).exchangePolicy) {
     throw new Error(`Invalid Offer Metadata: exchangePolicy is not defined`);
   }
-  if (
-    !(existingOfferData.metadata as productV1.ProductV1Metadata).exchangePolicy
-      .template
-  ) {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  if (!(existingOfferData.metadata as any).exchangePolicy.template) {
     throw new Error(
       `Invalid Offer Metadata: exchangePolicy.template is not defined`
     );
   }
-  const template = (existingOfferData.metadata as productV1.ProductV1Metadata)
-    .exchangePolicy.template;
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  const template = (existingOfferData.metadata as any).exchangePolicy.template;
   const convertedOfferArgs = convertExistingOfferData(existingOfferData);
   return renderContractualAgreement(
     template,