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

package/src/disputes/handler.ts

@@ -1,6 +1,7 @@
 import { Web3LibAdapter, TransactionResponse } from "@bosonprotocol/common";
 import { BigNumberish } from "@ethersproject/bignumber";
 import { BytesLike } from "@ethersproject/bytes";
+
 import {
   encodeRaiseDispute,
   encodeDecideDispute,
@@ -13,6 +14,7 @@ import {
   encodeResolveDispute,
   encodeRetractDispute
 } from "./interface";
+import { prepareDataSignatureParameters } from "../utils/signature";
 
 export async function raiseDispute(args: {
   exchangeId: BigNumberish;
@@ -130,3 +132,32 @@ 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/meta-tx/handler.ts

@@ -1,9 +1,8 @@
 import { Web3LibAdapter } from "@bosonprotocol/common";
-import { isHexString, hexZeroPad } from "@ethersproject/bytes";
-import { BigNumber, BigNumberish } from "@ethersproject/bignumber";
+import { BigNumberish } from "@ethersproject/bignumber";
 
 import { bosonExchangeHandlerIface } from "../exchanges/interface";
-import { bosonFundsHandlerIface } from "../funds/interface";
+import { prepareDataSignatureParameters } from "../utils/signature";
 
 type BaseMetaTxArgs = {
   web3Lib: Web3LibAdapter;
@@ -26,7 +25,7 @@ export async function signExecuteMetaTx(
     { name: "functionSignature", type: "bytes" }
   ];
 
-  const customTransactionType = {
+  const customSignatureType = {
     MetaTransaction: metaTransactionType
   };
 
@@ -42,7 +41,8 @@ export async function signExecuteMetaTx(
 
   return prepareDataSignatureParameters({
     ...args,
-    customTransactionType,
+    verifyingContractAddress: args.metaTxHandlerAddress,
+    customSignatureType,
     primaryType: "MetaTransaction",
     message
   });
@@ -68,7 +68,7 @@ export async function signExecuteMetaTxCommitToOffer(
     { name: "offerDetails", type: "MetaTxOfferDetails" }
   ];
 
-  const customTransactionType = {
+  const customSignatureType = {
     MetaTxCommitToOffer: metaTransactionType,
     MetaTxOfferDetails: offerType
   };
@@ -88,7 +88,8 @@ export async function signExecuteMetaTxCommitToOffer(
 
   const signatureParams = await prepareDataSignatureParameters({
     ...args,
-    customTransactionType,
+    verifyingContractAddress: args.metaTxHandlerAddress,
+    customSignatureType,
     primaryType: "MetaTxCommitToOffer",
     message
   });
@@ -162,7 +163,7 @@ export async function signExecuteMetaTxRaiseDispute(
     { name: "disputeDetails", type: "MetaTxDisputeDetails" }
   ];
 
-  const customTransactionType = {
+  const customSignatureType = {
     MetaTxDispute: metaTransactionType,
     MetaTxDisputeDetails: disputeType
   };
@@ -181,7 +182,8 @@ export async function signExecuteMetaTxRaiseDispute(
   // TODO: encode function data when adding dispute resolver module
   return prepareDataSignatureParameters({
     ...args,
-    customTransactionType,
+    verifyingContractAddress: args.metaTxHandlerAddress,
+    customSignatureType,
     primaryType: "MetaTxDispute",
     message
   });
@@ -214,7 +216,7 @@ export async function signExecuteMetaTxResolveDispute(
     { name: "disputeResolutionDetails", type: "MetaTxDisputeResolutionDetails" }
   ];
 
-  const customTransactionType = {
+  const customSignatureType = {
     MetaTxDisputeResolution: metaTransactionType,
     MetaTxDisputeResolutionDetails: disputeResolutionType
   };
@@ -236,7 +238,8 @@ export async function signExecuteMetaTxResolveDispute(
   // TODO: encode function data when adding dispute resolver module
   return prepareDataSignatureParameters({
     ...args,
-    customTransactionType,
+    verifyingContractAddress: args.metaTxHandlerAddress,
+    customSignatureType,
     primaryType: "MetaTxDisputeResolution",
     message
   });
@@ -265,7 +268,7 @@ export async function signExecuteMetaTxWithdrawFunds(
     { name: "fundDetails", type: "MetaTxFundDetails" }
   ];
 
-  const customTransactionType = {
+  const customSignatureType = {
     MetaTxFund: metaTransactionType,
     MetaTxFundDetails: fundType
   };
@@ -284,7 +287,8 @@ export async function signExecuteMetaTxWithdrawFunds(
 
   const signatureParams = await prepareDataSignatureParameters({
     ...args,
-    customTransactionType,
+    verifyingContractAddress: args.metaTxHandlerAddress,
+    customSignatureType,
     primaryType: "MetaTxFund",
     message
   });
@@ -322,7 +326,7 @@ function makeExchangeMetaTxSigner(
       { name: "exchangeDetails", type: "MetaTxExchangeDetails" }
     ];
 
-    const customTransactionType = {
+    const customSignatureType = {
       MetaTxExchange: metaTransactionType,
       MetaTxExchangeDetails: exchangeType
     };
@@ -341,7 +345,8 @@ function makeExchangeMetaTxSigner(
 
     const signatureParams = await prepareDataSignatureParameters({
       ...args,
-      customTransactionType,
+      verifyingContractAddress: args.metaTxHandlerAddress,
+      customSignatureType,
       primaryType: "MetaTxExchange",
       message
     });
@@ -357,62 +362,3 @@ 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/utils/signature.ts

@@ -0,0 +1,65 @@
+import { Web3LibAdapter } from "@bosonprotocol/common";
+import { isHexString, hexZeroPad } from "@ethersproject/bytes";
+import { BigNumber } from "@ethersproject/bignumber";
+
+type SignatureArgs = {
+  web3Lib: Web3LibAdapter;
+  verifyingContractAddress: string;
+  chainId: number;
+  customSignatureType?: Record<string, unknown>;
+  primaryType: string;
+  message: Record<string, unknown>;
+};
+
+export async function prepareDataSignatureParameters(args: SignatureArgs) {
+  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.verifyingContractAddress,
+    salt: hexZeroPad(BigNumber.from(args.chainId).toHexString(), 32)
+  };
+
+  const signatureTypes = {
+    EIP712Domain: domainType,
+    ...args.customSignatureType
+  };
+
+  const dataToSign = JSON.stringify({
+    types: signatureTypes,
+    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
+  };
+}