@bosonprotocol/core-sdk 1.25.0-alpha.12 → 1.25.0-alpha.14

package/src/accounts/mixin.ts

@@ -34,17 +34,17 @@ export class AccountsMixin extends BaseCoreSDK {
 
   /**
    * Returns seller entity from subgraph.
-   * @param operator - Operator address of seller entity to query for.
+   * @param assistant - Assistant address of seller entity to query for.
    * @param queryVars - Optional query variables to skip, order or filter.
    * @returns Seller entity from subgraph.
    */
-  public async getSellerByOperator(
-    operator: string,
+  public async getSellerByAssistant(
+    assistant: string,
     queryVars?: subgraph.GetSellersQueryQueryVariables
   ): Promise<subgraph.SellerFieldsFragment> {
-    return accounts.subgraph.getSellerByOperator(
+    return accounts.subgraph.getSellerByAssistant(
       this._subgraphUrl,
-      operator,
+      assistant,
       queryVars
     );
   }
@@ -101,7 +101,7 @@ export class AccountsMixin extends BaseCoreSDK {
   }
 
   /**
-   * Returns seller entity from subgraph. Matches `operator`, `clerk`, `admin` or `treasury`.
+   * Returns seller entity from subgraph. Matches `assistant`, `clerk`, `admin` or `treasury`.
    * @param address - Address of seller entity to query for.
    * @param queryVars - Optional query variables to skip, order or filter.
    * @returns Seller entity from subgraph.
@@ -318,7 +318,8 @@ export class AccountsMixin extends BaseCoreSDK {
       await this._web3Lib.getSignerAddress()
     ).toLowerCase();
     const fieldsToUpdate = {
-      operator: currentAccount === pendingSellerUpdate.operator?.toLowerCase(),
+      assistant:
+        currentAccount === pendingSellerUpdate.assistant?.toLowerCase(),
       clerk: currentAccount === pendingSellerUpdate.clerk?.toLowerCase(),
       admin: currentAccount === pendingSellerUpdate.admin?.toLowerCase(),
       authToken:
@@ -327,7 +328,7 @@ export class AccountsMixin extends BaseCoreSDK {
         pendingSellerUpdate.tokenType !== AuthTokenType.NONE
     };
     if (
-      fieldsToUpdate.operator ||
+      fieldsToUpdate.assistant ||
       fieldsToUpdate.clerk ||
       fieldsToUpdate.admin ||
       fieldsToUpdate.authToken
@@ -335,8 +336,8 @@ export class AccountsMixin extends BaseCoreSDK {
       return this.optInToSellerUpdate({
         id: sellerUpdates.id,
         fieldsToUpdate: {
-          operator:
-            currentAccount === pendingSellerUpdate.operator.toLowerCase(),
+          assistant:
+            currentAccount === pendingSellerUpdate.assistant.toLowerCase(),
           clerk: currentAccount === pendingSellerUpdate.clerk.toLowerCase(),
           admin: currentAccount === pendingSellerUpdate.admin.toLowerCase(),
           authToken: pendingSellerUpdate.tokenType !== AuthTokenType.NONE
@@ -414,7 +415,7 @@ export class AccountsMixin extends BaseCoreSDK {
    * @returns Created exchange id.
    */
   public getPendingSellerUpdateFromLogs(logs: Log[]): {
-    operator: string;
+    assistant: string;
     clerk: string;
     admin: string;
     tokenType: number;
@@ -424,7 +425,7 @@ export class AccountsMixin extends BaseCoreSDK {
     // SellerUpdatePending or SellerUpdateApplied events
     const valuesFromLogs = getValuesFromLogsExt<
       | {
-          operator: string;
+          assistant: string;
           clerk: string;
           admin: string;
         }
@@ -440,7 +441,7 @@ export class AccountsMixin extends BaseCoreSDK {
     });
     const pendingSellerStruct = (
       valuesFromLogs["pendingSeller"] as {
-        operator: string;
+        assistant: string;
         clerk: string;
         admin: string;
       }[]
@@ -452,7 +453,7 @@ export class AccountsMixin extends BaseCoreSDK {
       }[]
     )?.[0];
     return {
-      operator: pendingSellerStruct?.operator,
+      assistant: pendingSellerStruct?.assistant,
       admin: pendingSellerStruct?.admin,
       clerk: pendingSellerStruct?.clerk,
       tokenId: pendingAuthTokenStruct?.tokenId,

package/src/accounts/queries.graphql

@@ -235,7 +235,7 @@ fragment SellerFields on Seller {
 
 fragment BaseSellerFields on Seller {
   id
-  operator
+  assistant
   admin
   clerk
   treasury
@@ -248,7 +248,7 @@ fragment BaseSellerFields on Seller {
 }
 
 fragment PendingSellerFields on PendingSeller {
-  operator
+  assistant
   admin
   clerk
   authTokenId
@@ -323,7 +323,7 @@ fragment BaseDisputeResolverFields on DisputeResolver {
   admin
   clerk
   treasury
-  operator
+  assistant
   metadataUri
   active
   sellerAllowList
@@ -333,7 +333,7 @@ fragment BaseDisputeResolverFields on DisputeResolver {
 }
 
 fragment PendingDisputeResolverFields on PendingDisputeResolver {
-  operator
+  assistant
   admin
   clerk
 }

package/src/accounts/subgraph.ts

@@ -71,15 +71,15 @@ export async function getSellers(
   return sellers;
 }
 
-export async function getSellerByOperator(
+export async function getSellerByAssistant(
   subgraphUrl: string,
-  operatorAddress: string,
+  assistantAddress: string,
   queryVars: GetSellersQueryQueryVariables = {}
 ): Promise<SellerFieldsFragment | undefined> {
   const sellers = await getSellers(subgraphUrl, {
     sellersFilter: {
       ...queryVars.sellersFilter,
-      operator: operatorAddress.toLowerCase()
+      assistant: assistantAddress.toLowerCase()
     },
     ...queryVars
   });
@@ -153,13 +153,13 @@ export async function getSellerByAddress(
   address: string,
   queryVars: GetSellersQueryQueryVariables = {}
 ): Promise<SellerFieldsFragment> {
-  const [operator, admin, clerk] = await Promise.all([
-    getSellerByOperator(subgraphUrl, address, queryVars),
+  const [assistant, admin, clerk] = await Promise.all([
+    getSellerByAssistant(subgraphUrl, address, queryVars),
     getSellerByAdmin(subgraphUrl, address, queryVars),
     getSellerByClerk(subgraphUrl, address, queryVars)
   ]);
 
-  return operator || admin || clerk;
+  return assistant || admin || clerk;
 }
 
 export async function getDisputeResolverById(

package/src/accounts/types.ts

@@ -18,7 +18,7 @@ export {
 
 export type CreateDisputeResolverArgs = {
   escalationResponsePeriodInMS: number;
-  operator: string;
+  assistant: string;
   admin: string;
   clerk: string;
   treasury: string;

package/src/exchanges/handler.ts

@@ -123,7 +123,7 @@ export async function revokeVoucher(
 
   assertExchange(args.exchangeId, exchange);
   assertExchangeState(exchange, ExchangeState.Committed);
-  assertSignerIsOperator(signerAddress, exchange);
+  assertSignerIsAssistant(signerAddress, exchange);
 
   return args.web3Lib.sendTransaction({
     to: args.contractAddress,
@@ -218,13 +218,13 @@ function assertExchangeState(
   }
 }
 
-function assertSignerIsOperator(
+function assertSignerIsAssistant(
   signer: string,
   exchange: ExchangeFieldsFragment
 ) {
-  if (exchange.seller.operator.toLowerCase() !== signer.toLowerCase()) {
+  if (exchange.seller.assistant.toLowerCase() !== signer.toLowerCase()) {
     throw new Error(
-      `Signer ${signer} is not the operator ${exchange.seller.operator}`
+      `Signer ${signer} is not the assistant ${exchange.seller.assistant}`
     );
   }
 }
@@ -237,24 +237,24 @@ function assertSignerIsBuyer(signer: string, exchange: ExchangeFieldsFragment) {
   }
 }
 
-function assertSignerIsBuyerOrOperator(
+function assertSignerIsBuyerOrAssistant(
   signer: string,
   exchange: ExchangeFieldsFragment
 ) {
   const { seller, buyer } = exchange;
   const buyerAddress = buyer.wallet;
-  const operatorAddress = seller.operator;
-  const isSignerOperator =
-    signer.toLowerCase() === operatorAddress.toLowerCase();
+  const assistantAddress = seller.assistant;
+  const isSignerAssistant =
+    signer.toLowerCase() === assistantAddress.toLowerCase();
   const isSignerBuyer = signer.toLowerCase() === buyerAddress.toLowerCase();
 
-  if (!isSignerOperator && !isSignerBuyer) {
+  if (!isSignerAssistant && !isSignerBuyer) {
     throw new Error(
-      `Signer ${signer} is required to be the buyer ${buyerAddress} or operator ${operatorAddress}`
+      `Signer ${signer} is required to be the buyer ${buyerAddress} or assistant ${assistantAddress}`
     );
   }
 
-  return { isSignerBuyer, isSignerOperator };
+  return { isSignerBuyer, isSignerAssistant };
 }
 
 function assertCompletableExchange(
@@ -264,12 +264,12 @@ function assertCompletableExchange(
 ) {
   assertExchange(exchangeId, exchange);
 
-  const { isSignerOperator, isSignerBuyer } = assertSignerIsBuyerOrOperator(
+  const { isSignerAssistant, isSignerBuyer } = assertSignerIsBuyerOrAssistant(
     signer,
     exchange
   );
 
-  if (isSignerOperator && !isSignerBuyer) {
+  if (isSignerAssistant && !isSignerBuyer) {
     const elapsedSinceRedeemMS =
       Date.now() - Number(exchange.redeemedDate || "0") * 1000;
     const didDisputePeriodElapse =

package/src/exchanges/mixin.ts

@@ -83,7 +83,7 @@ export class ExchangesMixin extends BaseCoreSDK {
 
   /**
    * Revokes an existing voucher by calling the `ExchangeHandlerContract`.
-   * Callable by seller `operator`.
+   * Callable by seller `assistant`.
    * @param exchangeId - ID of exchange to revoke.
    * @returns Transaction response.
    */
@@ -134,7 +134,7 @@ export class ExchangesMixin extends BaseCoreSDK {
 
   /**
    * Completes an existing voucher by calling the `ExchangeHandlerContract`.
-   * Callable by buyer or seller operator.
+   * Callable by buyer or seller assistant.
    * @param exchangeId - ID of exchange to complete.
    * @returns Transaction response.
    */
@@ -151,7 +151,7 @@ export class ExchangesMixin extends BaseCoreSDK {
 
   /**
    * Completes a batch of existing vouchers by calling the `ExchangeHandlerContract`.
-   * Callable by buyer or seller operator.
+   * Callable by buyer or seller assistant.
    * @param exchangeIds - IDs of exchange to complete.
    * @returns Transaction response.
    */

package/src/index.ts

@@ -13,6 +13,7 @@ export * as subgraph from "./subgraph";
 export * as groups from "./groups";
 export * as forwarder from "./forwarder";
 export * as voucher from "./voucher";
+export * as seaport from "./seaport";
 
 export {
   defaultConfigs,

package/src/meta-tx/handler.ts

@@ -37,7 +37,12 @@ import { encodeDepositFunds, encodeWithdrawFunds } from "../funds/interface";
 import { bosonDisputeHandlerIface } from "../disputes/interface";
 import { encodeCreateGroup } from "../groups/interface";
 import { encodeCreateOfferWithCondition } from "../orchestration/interface";
-import { encodePreMint, encodeSetApprovalForAll } from "../voucher/interface";
+import {
+  encodeCallExternalContract,
+  encodePreMint,
+  encodeSetApprovalForAll,
+  encodeSetApprovalForAllToContract
+} from "../voucher/interface";
 import { hexZeroPad } from "@ethersproject/bytes";
 import { keccak256 } from "@ethersproject/keccak256";
 import { id } from "@ethersproject/hash";
@@ -460,6 +465,38 @@ export async function signMetaTxVoidOfferBatch(
   });
 }
 
+export async function signMetaTxExtendOffer(
+  args: BaseMetaTxArgs & {
+    offerId: BigNumberish;
+    validUntil: BigNumberish;
+  }
+) {
+  return signMetaTx({
+    ...args,
+    functionName: "extendOffer(uint256,uint256)",
+    functionSignature: bosonOfferHandlerIface.encodeFunctionData(
+      "extendOffer",
+      [args.offerId, args.validUntil]
+    )
+  });
+}
+
+export async function signMetaTxExtendOfferBatch(
+  args: BaseMetaTxArgs & {
+    offerIds: BigNumberish[];
+    validUntil: BigNumberish;
+  }
+) {
+  return signMetaTx({
+    ...args,
+    functionName: "extendOfferBatch(uint256[],uint256)",
+    functionSignature: bosonOfferHandlerIface.encodeFunctionData(
+      "extendOfferBatch",
+      [args.offerIds, args.validUntil]
+    )
+  });
+}
+
 export async function signMetaTxCompleteExchangeBatch(
   args: BaseMetaTxArgs & {
     exchangeIds: BigNumberish[];
@@ -522,12 +559,13 @@ export async function signMetaTxReserveRange(
   args: BaseMetaTxArgs & {
     offerId: BigNumberish;
     length: BigNumberish;
+    to: string;
   }
 ) {
   return signMetaTx({
     ...args,
-    functionName: "reserveRange(uint256,uint256)",
-    functionSignature: encodeReserveRange(args.offerId, args.length)
+    functionName: "reserveRange(uint256,uint256,address)",
+    functionSignature: encodeReserveRange(args.offerId, args.length, args.to)
   });
 }
 
@@ -592,6 +630,73 @@ export async function signMetaTxSetApprovalForAll(
   });
 }
 
+export async function signMetaTxSetApprovalForAllToContract(
+  args: BaseVoucherMetaTxArgs & {
+    operator: string;
+    approved: boolean;
+    batchId: BigNumberish;
+    forwarderAbi:
+      | typeof abis.MockForwarderABI
+      | typeof abis.BiconomyForwarderABI;
+  },
+  overrides: {
+    txGas?: number;
+  } = {}
+): Promise<SignedVoucherMetaTx> {
+  const localConfig = defaultConfigs.find(
+    (config) => config.envName === "local"
+  );
+  const isLocal = localConfig.chainId === args.chainId;
+  const functionSignature = encodeSetApprovalForAllToContract(
+    args.operator,
+    args.approved
+  );
+  if (isLocal) {
+    return signVoucherMetaTx({
+      ...args,
+      functionSignature
+    });
+  }
+  const txGas = overrides.txGas || 100000; // TODO: estimate the gas needed
+  return signBiconomyVoucherMetaTx({
+    ...args,
+    functionSignature,
+    txGas
+  });
+}
+
+export async function signMetaTxCallExternalContract(
+  args: BaseVoucherMetaTxArgs & {
+    to: string;
+    data: string;
+    batchId: BigNumberish;
+    forwarderAbi:
+      | typeof abis.MockForwarderABI
+      | typeof abis.BiconomyForwarderABI;
+  },
+  overrides: {
+    txGas?: number;
+  } = {}
+): Promise<SignedVoucherMetaTx> {
+  const localConfig = defaultConfigs.find(
+    (config) => config.envName === "local"
+  );
+  const isLocal = localConfig.chainId === args.chainId;
+  const functionSignature = encodeCallExternalContract(args.to, args.data);
+  if (isLocal) {
+    return signVoucherMetaTx({
+      ...args,
+      functionSignature
+    });
+  }
+  const txGas = overrides.txGas || 500000; // TODO: estimate the gas needed
+  return signBiconomyVoucherMetaTx({
+    ...args,
+    functionSignature,
+    txGas
+  });
+}
+
 export async function signMetaTxCreateOfferWithCondition(
   args: BaseMetaTxArgs & {
     offerToCreate: CreateOfferArgs;

package/src/meta-tx/mixin.ts

@@ -142,14 +142,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
     });
   }
 
@@ -236,6 +242,102 @@ export class MetaTxMixin extends BaseCoreSDK {
     });
   }
 
+  public async signMetaTxSetApprovalForAllToContract(
+    args: Omit<
+      Parameters<typeof handler.signMetaTxSetApprovalForAllToContract>[0],
+      | "web3Lib"
+      | "bosonVoucherAddress"
+      | "chainId"
+      | "nonce"
+      | "forwarderAddress"
+      | "batchId"
+      | "forwarderAbi"
+    >,
+    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;
+    const nonce = await getNonce({
+      contractAddress: forwarderAddress,
+      user: sellerAddress,
+      web3Lib: this._web3Lib,
+      batchId,
+      forwarderAbi: this._metaTxConfig.forwarderAbi
+    });
+
+    return handler.signMetaTxSetApprovalForAllToContract(
+      {
+        web3Lib: this._web3Lib,
+        bosonVoucherAddress: seller.voucherCloneAddress,
+        chainId: this._chainId,
+        nonce,
+        forwarderAddress,
+        batchId,
+        forwarderAbi: this._metaTxConfig.forwarderAbi,
+        ...args
+      },
+      {
+        txGas: overrides.txGas
+      }
+    );
+  }
+
+  public async signMetaTxCallExternalContract(
+    args: Omit<
+      Parameters<typeof handler.signMetaTxCallExternalContract>[0],
+      | "web3Lib"
+      | "bosonVoucherAddress"
+      | "chainId"
+      | "nonce"
+      | "forwarderAddress"
+      | "batchId"
+      | "forwarderAbi"
+    >,
+    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;
+    const nonce = await getNonce({
+      contractAddress: forwarderAddress,
+      user: sellerAddress,
+      web3Lib: this._web3Lib,
+      batchId,
+      forwarderAbi: this._metaTxConfig.forwarderAbi
+    });
+
+    return handler.signMetaTxCallExternalContract(
+      {
+        web3Lib: this._web3Lib,
+        bosonVoucherAddress: seller.voucherCloneAddress,
+        chainId: this._chainId,
+        nonce,
+        forwarderAddress,
+        batchId,
+        forwarderAbi: this._metaTxConfig.forwarderAbi,
+        ...args
+      },
+      {
+        txGas: overrides.txGas
+      }
+    );
+  }
+
   public async relayBiconomyMetaTransaction(
     contractAddress: string,
     metaTxParams: {
@@ -340,6 +442,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/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
   ]);
 }