@bosonprotocol/core-sdk 1.12.0-alpha.17 → 1.12.0-alpha.3

package/src/core-sdk.ts

@@ -1,4 +1,3 @@
-import { ITokenInfo, TokenInfoManager } from "./utils/tokenInfoManager";
 import {
   Web3LibAdapter,
   TransactionResponse,
@@ -32,7 +31,6 @@ export class CoreSDK {
   private _subgraphUrl: string;
   private _protocolDiamond: string;
   private _chainId: number;
-  private _tokenInfoManager: TokenInfoManager;
 
   /**
    * Creates an instance of `CoreSDK`
@@ -574,31 +572,6 @@ export class CoreSDK {
     );
   }
 
-  /**
-   * Utility method to retrieve the created `sellerId` from logs after calling `createSeller`
-   * or `createOfferAndSeller`.
-   * @param logs - Logs to search in.
-   * @returns Created offer id.
-   */
-  public getCreatedSellerIdFromLogs(logs: Log[]): string | null {
-    const sellerId = getValueFromLogs({
-      iface: accounts.iface.bosonAccountHandlerIface,
-      logs,
-      eventArgsKey: "sellerId",
-      eventName: "SellerCreated"
-    });
-
-    return (
-      sellerId ||
-      getValueFromLogs({
-        iface: orchestration.iface.bosonOrchestrationHandlerIface,
-        logs,
-        eventArgsKey: "sellerId",
-        eventName: "SellerCreated"
-      })
-    );
-  }
-
   /**
    * Voids an existing offer by calling the `OfferHandlerFacet` contract.
    * This transaction only succeeds if the connected signer is the `operator`.
@@ -674,21 +647,22 @@ export class CoreSDK {
    * @param exchangeToken - Address exchange token.
    * @returns Decimals, name and symbol.
    */
-  public async getExchangeTokenInfo(
-    exchangeToken: string
-  ): Promise<ITokenInfo> {
-    if (this._chainId === undefined) {
-      this._chainId = await this._web3Lib.getChainId();
-    }
-
-    if (this._tokenInfoManager === undefined) {
-      this._tokenInfoManager = new TokenInfoManager(
-        this._chainId,
-        this._web3Lib
-      );
-    }
+  public async getExchangeTokenInfo(exchangeToken: string): Promise<{
+    name: string;
+    decimals: number;
+    symbol: string;
+  }> {
+    const args = {
+      web3Lib: this._web3Lib,
+      contractAddress: exchangeToken
+    };
+    const [decimals, name, symbol] = await Promise.all([
+      erc20.handler.getDecimals(args),
+      erc20.handler.getName(args),
+      erc20.handler.getSymbol(args)
+    ]);
 
-    return this._tokenInfoManager.getExchangeTokenInfo(exchangeToken);
+    return { decimals, name, symbol };
   }
 
   /**
@@ -1082,19 +1056,37 @@ export class CoreSDK {
     });
   }
 
-  public async signDisputeResolutionProposal(args: {
-    exchangeId: BigNumberish;
-    buyerPercent: BigNumberish;
+  public async signMutualAgreement(args: {
+    exchangeId: string;
+    buyerPercent: string;
   }) {
+    // Set the message Type, needed for signature
+    const resolutionType = [
+      { name: "exchangeId", type: "uint256" },
+      { name: "buyerPercent", type: "uint256" }
+    ];
+
+    const customSignatureType = {
+      Resolution: resolutionType
+    };
+
+    const message = {
+      exchangeId: args.exchangeId,
+      buyerPercent: args.buyerPercent
+    };
+
     if (this._chainId === undefined) {
       this._chainId = await this._web3Lib.getChainId();
     }
 
-    return disputes.handler.signResolutionProposal({
-      ...args,
+    return metaTx.handler.prepareDataSignatureParameters({
       web3Lib: this._web3Lib,
-      contractAddress: this._protocolDiamond,
-      chainId: this._chainId
+      metaTxHandlerAddress: this._protocolDiamond,
+      chainId: this._chainId,
+      customTransactionType: customSignatureType,
+      primaryType: "Resolution",
+      message,
+      nonce: "" // not used in this case
     });
   }
 
@@ -1158,22 +1150,4 @@ export class CoreSDK {
       ...args
     });
   }
-
-  public async renderContractualAgreementForOffer(
-    offerId: BigNumberish
-  ): Promise<string> {
-    const offerData = await offers.subgraph.getOfferById(
-      this._subgraphUrl,
-      offerId
-    );
-    return offers.renderContractualAgreementForOffer(offerData);
-  }
-
-  public async renderContractualAgreement(
-    template: string,
-    offerData: offers.CreateOfferArgs
-  ): Promise<string> {
-    const tokenInfo = await this.getExchangeTokenInfo(offerData.exchangeToken);
-    return offers.renderContractualAgreement(template, offerData, tokenInfo);
-  }
 }

package/src/disputes/handler.ts

@@ -1,7 +1,6 @@
 import { Web3LibAdapter, TransactionResponse } from "@bosonprotocol/common";
 import { BigNumberish } from "@ethersproject/bignumber";
 import { BytesLike } from "@ethersproject/bytes";
-
 import {
   encodeRaiseDispute,
   encodeDecideDispute,
@@ -14,7 +13,6 @@ import {
   encodeResolveDispute,
   encodeRetractDispute
 } from "./interface";
-import { prepareDataSignatureParameters } from "../utils/signature";
 
 export async function raiseDispute(args: {
   exchangeId: BigNumberish;
@@ -132,32 +130,3 @@ export async function expireEscalatedDispute(args: {
     data: encodeExpireEscalatedDispute(args.exchangeId)
   });
 }
-
-export async function signResolutionProposal(args: {
-  exchangeId: BigNumberish;
-  buyerPercent: BigNumberish;
-  contractAddress: string;
-  web3Lib: Web3LibAdapter;
-  chainId: number;
-}) {
-  const customSignatureType = {
-    Resolution: [
-      { name: "exchangeId", type: "uint256" },
-      { name: "buyerPercent", type: "uint256" }
-    ]
-  };
-
-  const message = {
-    exchangeId: args.exchangeId,
-    buyerPercent: args.buyerPercent
-  };
-
-  return prepareDataSignatureParameters({
-    message,
-    customSignatureType,
-    web3Lib: args.web3Lib,
-    verifyingContractAddress: args.contractAddress,
-    chainId: args.chainId,
-    primaryType: "Resolution"
-  });
-}

package/src/exchanges/handler.ts

@@ -48,7 +48,6 @@ export async function commitToOffer(
   }
 
   return args.web3Lib.sendTransaction({
-    from: args.buyer,
     to: args.contractAddress,
     data: encodeCommitToOffer(args.buyer, args.offerId),
     value: offer.exchangeToken.address === AddressZero ? offer.price : "0"

package/src/meta-tx/handler.ts

@@ -1,8 +1,9 @@
 import { Web3LibAdapter } from "@bosonprotocol/common";
-import { BigNumberish } from "@ethersproject/bignumber";
+import { isHexString, hexZeroPad } from "@ethersproject/bytes";
+import { BigNumber, BigNumberish } from "@ethersproject/bignumber";
 
 import { bosonExchangeHandlerIface } from "../exchanges/interface";
-import { prepareDataSignatureParameters } from "../utils/signature";
+import { bosonFundsHandlerIface } from "../funds/interface";
 
 type BaseMetaTxArgs = {
   web3Lib: Web3LibAdapter;
@@ -25,7 +26,7 @@ export async function signExecuteMetaTx(
     { name: "functionSignature", type: "bytes" }
   ];
 
-  const customSignatureType = {
+  const customTransactionType = {
     MetaTransaction: metaTransactionType
   };
 
@@ -41,8 +42,7 @@ export async function signExecuteMetaTx(
 
   return prepareDataSignatureParameters({
     ...args,
-    verifyingContractAddress: args.metaTxHandlerAddress,
-    customSignatureType,
+    customTransactionType,
     primaryType: "MetaTransaction",
     message
   });
@@ -68,7 +68,7 @@ export async function signExecuteMetaTxCommitToOffer(
     { name: "offerDetails", type: "MetaTxOfferDetails" }
   ];
 
-  const customSignatureType = {
+  const customTransactionType = {
     MetaTxCommitToOffer: metaTransactionType,
     MetaTxOfferDetails: offerType
   };
@@ -88,8 +88,7 @@ export async function signExecuteMetaTxCommitToOffer(
 
   const signatureParams = await prepareDataSignatureParameters({
     ...args,
-    verifyingContractAddress: args.metaTxHandlerAddress,
-    customSignatureType,
+    customTransactionType,
     primaryType: "MetaTxCommitToOffer",
     message
   });
@@ -163,7 +162,7 @@ export async function signExecuteMetaTxRaiseDispute(
     { name: "disputeDetails", type: "MetaTxDisputeDetails" }
   ];
 
-  const customSignatureType = {
+  const customTransactionType = {
     MetaTxDispute: metaTransactionType,
     MetaTxDisputeDetails: disputeType
   };
@@ -182,8 +181,7 @@ export async function signExecuteMetaTxRaiseDispute(
   // TODO: encode function data when adding dispute resolver module
   return prepareDataSignatureParameters({
     ...args,
-    verifyingContractAddress: args.metaTxHandlerAddress,
-    customSignatureType,
+    customTransactionType,
     primaryType: "MetaTxDispute",
     message
   });
@@ -216,7 +214,7 @@ export async function signExecuteMetaTxResolveDispute(
     { name: "disputeResolutionDetails", type: "MetaTxDisputeResolutionDetails" }
   ];
 
-  const customSignatureType = {
+  const customTransactionType = {
     MetaTxDisputeResolution: metaTransactionType,
     MetaTxDisputeResolutionDetails: disputeResolutionType
   };
@@ -238,8 +236,7 @@ export async function signExecuteMetaTxResolveDispute(
   // TODO: encode function data when adding dispute resolver module
   return prepareDataSignatureParameters({
     ...args,
-    verifyingContractAddress: args.metaTxHandlerAddress,
-    customSignatureType,
+    customTransactionType,
     primaryType: "MetaTxDisputeResolution",
     message
   });
@@ -268,7 +265,7 @@ export async function signExecuteMetaTxWithdrawFunds(
     { name: "fundDetails", type: "MetaTxFundDetails" }
   ];
 
-  const customSignatureType = {
+  const customTransactionType = {
     MetaTxFund: metaTransactionType,
     MetaTxFundDetails: fundType
   };
@@ -287,8 +284,7 @@ export async function signExecuteMetaTxWithdrawFunds(
 
   const signatureParams = await prepareDataSignatureParameters({
     ...args,
-    verifyingContractAddress: args.metaTxHandlerAddress,
-    customSignatureType,
+    customTransactionType,
     primaryType: "MetaTxFund",
     message
   });
@@ -326,7 +322,7 @@ function makeExchangeMetaTxSigner(
       { name: "exchangeDetails", type: "MetaTxExchangeDetails" }
     ];
 
-    const customSignatureType = {
+    const customTransactionType = {
       MetaTxExchange: metaTransactionType,
       MetaTxExchangeDetails: exchangeType
     };
@@ -345,8 +341,7 @@ function makeExchangeMetaTxSigner(
 
     const signatureParams = await prepareDataSignatureParameters({
       ...args,
-      verifyingContractAddress: args.metaTxHandlerAddress,
-      customSignatureType,
+      customTransactionType,
       primaryType: "MetaTxExchange",
       message
     });
@@ -362,3 +357,62 @@ function makeExchangeMetaTxSigner(
     };
   };
 }
+
+export async function prepareDataSignatureParameters(
+  args: BaseMetaTxArgs & {
+    customTransactionType?: Record<string, unknown>;
+    primaryType: string;
+    message: Record<string, unknown>;
+  }
+) {
+  const domainType = [
+    { name: "name", type: "string" },
+    { name: "version", type: "string" },
+    { name: "verifyingContract", type: "address" },
+    { name: "salt", type: "bytes32" }
+  ];
+
+  const domainData = {
+    name: "BosonProtocolDiamond",
+    version: "V1",
+    verifyingContract: args.metaTxHandlerAddress,
+    salt: hexZeroPad(BigNumber.from(args.chainId).toHexString(), 32)
+  };
+
+  const metaTxTypes = {
+    EIP712Domain: domainType,
+    ...args.customTransactionType
+  };
+
+  const dataToSign = JSON.stringify({
+    types: metaTxTypes,
+    domain: domainData,
+    primaryType: args.primaryType,
+    message: args.message
+  });
+
+  const signer = await args.web3Lib.getSignerAddress();
+  const signature = await args.web3Lib.send("eth_signTypedData_v4", [
+    signer,
+    dataToSign
+  ]);
+
+  return getSignatureParameters(signature);
+}
+
+export function getSignatureParameters(signature: string) {
+  if (!isHexString(signature)) {
+    throw new Error(`Value "${signature}" is not a valid hex string`);
+  }
+
+  signature = signature.substring(2);
+  const r = "0x" + signature.substring(0, 64);
+  const s = "0x" + signature.substring(64, 128);
+  const v = parseInt(signature.substring(128, 130), 16);
+
+  return {
+    r,
+    s,
+    v
+  };
+}

package/src/metadata/product-v1.graphql

@@ -107,9 +107,6 @@ fragment BaseProductV1MetadataEntityFields on ProductV1MetadataEntity {
   productV1Seller {
     ...BaseProductV1SellerFields
   }
-  exchangePolicy {
-    ...BaseProductV1ExchangePolicyFields
-  }
 }
 
 fragment BaseProductV1ProductFields on ProductV1Product {

package/src/offers/getOfferStatus.ts

@@ -1,4 +1,4 @@
-import { OfferFieldsFragment } from "../subgraph";
+import { subgraph } from "..";
 
 export enum OfferState {
   VOIDED = "VOIDED",
@@ -7,7 +7,7 @@ export enum OfferState {
   VALID = "VALID"
 }
 
-export function getOfferStatus(offer: OfferFieldsFragment) {
+export function getOfferStatus(offer: subgraph.OfferFieldsFragment) {
   const toTimeStamp = (numberString: string) => Number(numberString) * 1000;
   const timeNow = Date.now();
 

package/src/offers/index.ts

@@ -6,10 +6,7 @@ export * as iface from "./interface";
 export * as storage from "./storage";
 export * from "./types";
 export * from "./getOfferStatus";
-export * from "./renderContractualAgreement";
 
-export const validation: {
-  createOfferArgsSchema: typeof utils.validation.createOfferArgsSchema;
-} = {
+export const validation = {
   createOfferArgsSchema: utils.validation.createOfferArgsSchema
 };

package/src/offers/interface.ts

@@ -25,15 +25,13 @@ export function createOfferArgsToStructs(
   Partial<OfferStruct>,
   Partial<OfferDatesStruct>,
   Partial<OfferDurationsStruct>,
-  BigNumberish,
   BigNumberish
 ] {
   return [
     argsToOfferStruct(args),
     argsToOfferDatesStruct(args),
     argsToOfferDurationsStruct(args),
-    args.disputeResolverId,
-    args.agentId
+    args.disputeResolverId
   ];
 }
 
@@ -54,8 +52,7 @@ export function argsToOfferDatesStruct(
   const {
     validFromDateInMS,
     validUntilDateInMS,
-    voucherRedeemableFromDateInMS,
-    voucherRedeemableUntilDateInMS
+    voucherRedeemableFromDateInMS
   } = args;
 
   return {
@@ -64,9 +61,10 @@ export function argsToOfferDatesStruct(
     voucherRedeemableFrom: utils.timestamp.msToSec(
       voucherRedeemableFromDateInMS
     ),
-    voucherRedeemableUntil: utils.timestamp.msToSec(
-      voucherRedeemableUntilDateInMS
-    )
+    voucherRedeemableUntil:
+      // NOTE: Field `voucherRedeemableUntil` not yet fully supported in protocol.
+      // Therefore converting to `voucherValid` field.
+      "0"
   };
 }
 
@@ -75,13 +73,22 @@ export function argsToOfferDurationsStruct(
 ): Partial<OfferDurationsStruct> {
   const {
     fulfillmentPeriodDurationInMS,
+    voucherRedeemableUntilDateInMS,
+    voucherRedeemableFromDateInMS,
     voucherValidDurationInMS = 0,
     resolutionPeriodDurationInMS
   } = args;
 
   return {
     fulfillmentPeriod: utils.timestamp.msToSec(fulfillmentPeriodDurationInMS),
-    voucherValid: utils.timestamp.msToSec(voucherValidDurationInMS),
+    voucherValid: utils.timestamp.msToSec(
+      voucherValidDurationInMS ||
+        // NOTE: Field `voucherRedeemableUntil` not yet fully supported in protocol.
+        // Therefore converting to `voucherValid` field.
+        BigNumber.from(voucherRedeemableUntilDateInMS).sub(
+          BigNumber.from(voucherRedeemableFromDateInMS)
+        )
+    ),
     resolutionPeriod: utils.timestamp.msToSec(resolutionPeriodDurationInMS)
   };
 }

package/src/offers/queries.graphql

@@ -55,8 +55,6 @@ fragment BaseOfferFields on Offer {
   price
   sellerDeposit
   protocolFee
-  agentFee
-  agentId
   buyerCancelPenalty
   quantityAvailable
   quantityInitial
@@ -89,34 +87,5 @@ fragment BaseOfferFields on Offer {
     externalUrl
     schemaUrl
     type
-    ... on ProductV1MetadataEntity {
-      image
-      attributes {
-        traitType
-        value
-        displayType
-      }
-      createdAt
-      voided
-      validFromDate
-      validUntilDate
-      quantityAvailable
-      uuid
-      product {
-        ...BaseProductV1ProductFields
-      }
-      variations {
-        ...BaseProductV1VariationFields
-      }
-      productV1Seller {
-        ...BaseProductV1SellerFields
-      }
-      exchangePolicy {
-        ...BaseProductV1ExchangePolicyFields
-      }
-      shipping {
-        ...BaseProductV1ShippingOptionFields
-      }
-    }
   }
 }

package/src/offers/subgraph.ts

@@ -21,6 +21,7 @@ export async function getOfferById(
     offerId: offerId.toString(),
     ...queryVars
   });
+
   return offer;
 }
 

package/src/orchestration/interface.ts

@@ -14,19 +14,12 @@ export function encodeCreateSellerAndOffer(
   seller: CreateSellerArgs,
   offer: CreateOfferArgs
 ) {
-  const sellerArgs = createSellerArgsToStruct(seller);
-  const offerArgs = createOfferArgsToStructs(offer);
   return bosonOrchestrationHandlerIface.encodeFunctionData(
     "createSellerAndOffer",
     [
-      sellerArgs.sellerStruct,
+      createSellerArgsToStruct(seller),
       seller.contractUri,
-      offerArgs[0], // offer
-      offerArgs[1], // offerDates
-      offerArgs[2], // offerDurations
-      offerArgs[3], // disputeResolverId
-      sellerArgs.authTokenStruct,
-      offerArgs[4] // agentId
+      ...createOfferArgsToStructs(offer)
     ]
   );
 }