@bosonprotocol/core-sdk 1.43.3 → 1.44.0-alpha.1

package/src/subgraph/mixin.ts

@@ -1,5 +1,9 @@
 import { GraphQLClient, gql } from "graphql-request";
-import { TransactionReceipt, TransactionResponse } from "@bosonprotocol/common";
+import {
+  TransactionReceipt,
+  TransactionResponse,
+  Web3LibAdapter
+} from "@bosonprotocol/common";
 import { BaseCoreSDK } from "./../mixins/base-core-sdk";
 
 const DELAYS_PER_CHAINID: {
@@ -78,7 +82,7 @@ const DELAYS_PER_CHAINID: {
   }
 };
 
-export class SubgraphMixin extends BaseCoreSDK {
+export class SubgraphMixin<T extends Web3LibAdapter> extends BaseCoreSDK<T> {
   public async waitForGraphNodeIndexing(
     blockNumberOrTransaction?: number | TransactionResponse | TransactionReceipt
   ) {

package/src/voucher/handler.ts

@@ -1,4 +1,8 @@
-import { TransactionResponse, Web3LibAdapter } from "@bosonprotocol/common";
+import {
+  TransactionRequest,
+  TransactionResponse,
+  Web3LibAdapter
+} from "@bosonprotocol/common";
 import { Range } from "@bosonprotocol/common/src/types";
 import { BigNumberish } from "@ethersproject/bignumber";
 import {
@@ -21,16 +25,40 @@ import {
   encodeWithdrawToProtocol
 } from "./interface";
 
+// burnPremintedVouchers overloads
+export async function burnPremintedVouchers(args: {
+  offerId: BigNumberish;
+  amount: BigNumberish;
+  contractAddress: string;
+  web3Lib: Web3LibAdapter;
+  returnTxInfo: true;
+}): Promise<TransactionRequest>;
+
+export async function burnPremintedVouchers(args: {
+  offerId: BigNumberish;
+  amount: BigNumberish;
+  contractAddress: string;
+  web3Lib: Web3LibAdapter;
+  returnTxInfo?: false | undefined;
+}): Promise<TransactionResponse>;
+
 export async function burnPremintedVouchers(args: {
   offerId: BigNumberish;
   amount: BigNumberish;
   contractAddress: string;
   web3Lib: Web3LibAdapter;
-}): Promise<TransactionResponse> {
-  return args.web3Lib.sendTransaction({
+  returnTxInfo?: boolean;
+}): Promise<TransactionRequest | TransactionResponse> {
+  const transactionRequest = {
     to: args.contractAddress,
     data: encodeBurnPremintedVouchers(args.offerId, args.amount)
-  });
+  } satisfies TransactionRequest;
+
+  if (args.returnTxInfo) {
+    return transactionRequest;
+  } else {
+    return args.web3Lib.sendTransaction(transactionRequest);
+  }
 }
 
 export async function owner(args: {
@@ -87,29 +115,79 @@ export async function getRangeByOfferId(args: {
   };
 }
 
+// preMint overloads
+export async function preMint(args: {
+  offerId: BigNumberish;
+  amount: BigNumberish;
+  contractAddress: string;
+  web3Lib: Web3LibAdapter;
+  returnTxInfo: true;
+}): Promise<TransactionRequest>;
+
 export async function preMint(args: {
   offerId: BigNumberish;
   amount: BigNumberish;
   contractAddress: string;
   web3Lib: Web3LibAdapter;
-}): Promise<TransactionResponse> {
-  return args.web3Lib.sendTransaction({
+  returnTxInfo?: false | undefined;
+}): Promise<TransactionResponse>;
+
+export async function preMint(args: {
+  offerId: BigNumberish;
+  amount: BigNumberish;
+  contractAddress: string;
+  web3Lib: Web3LibAdapter;
+  returnTxInfo?: boolean;
+}): Promise<TransactionRequest | TransactionResponse> {
+  const transactionRequest = {
     to: args.contractAddress,
     data: encodePreMint(args.offerId, args.amount)
-  });
+  } satisfies TransactionRequest;
+
+  if (args.returnTxInfo) {
+    return transactionRequest;
+  } else {
+    return args.web3Lib.sendTransaction(transactionRequest);
+  }
 }
 
+// transferFrom overloads
+export async function transferFrom(args: {
+  from: BigNumberish;
+  to: BigNumberish;
+  tokenId: BigNumberish;
+  contractAddress: string;
+  web3Lib: Web3LibAdapter;
+  returnTxInfo: true;
+}): Promise<TransactionRequest>;
+
+export async function transferFrom(args: {
+  from: BigNumberish;
+  to: BigNumberish;
+  tokenId: BigNumberish;
+  contractAddress: string;
+  web3Lib: Web3LibAdapter;
+  returnTxInfo?: false | undefined;
+}): Promise<TransactionResponse>;
+
 export async function transferFrom(args: {
   from: BigNumberish;
   to: BigNumberish;
   tokenId: BigNumberish;
   contractAddress: string;
   web3Lib: Web3LibAdapter;
-}): Promise<TransactionResponse> {
-  return args.web3Lib.sendTransaction({
+  returnTxInfo?: boolean;
+}): Promise<TransactionRequest | TransactionResponse> {
+  const transactionRequest = {
     to: args.contractAddress,
     data: encodeTransferFrom(args.from, args.to, args.tokenId)
-  });
+  } satisfies TransactionRequest;
+
+  if (args.returnTxInfo) {
+    return transactionRequest;
+  } else {
+    return args.web3Lib.sendTransaction(transactionRequest);
+  }
 }
 
 export async function isApprovedForAll(args: {
@@ -126,48 +204,140 @@ export async function isApprovedForAll(args: {
   return isApproved;
 }
 
+// setContractURI overloads
 export async function setContractURI(args: {
   contractURI: string;
   contractAddress: string;
   web3Lib: Web3LibAdapter;
-}): Promise<TransactionResponse> {
-  return await args.web3Lib.sendTransaction({
+  returnTxInfo: true;
+}): Promise<TransactionRequest>;
+
+export async function setContractURI(args: {
+  contractURI: string;
+  contractAddress: string;
+  web3Lib: Web3LibAdapter;
+  returnTxInfo?: false | undefined;
+}): Promise<TransactionResponse>;
+
+export async function setContractURI(args: {
+  contractURI: string;
+  contractAddress: string;
+  web3Lib: Web3LibAdapter;
+  returnTxInfo?: boolean;
+}): Promise<TransactionRequest | TransactionResponse> {
+  const transactionRequest = {
     to: args.contractAddress,
     data: encodeSetContractURI(args.contractURI)
-  });
+  } satisfies TransactionRequest;
+
+  if (args.returnTxInfo) {
+    return transactionRequest;
+  } else {
+    return args.web3Lib.sendTransaction(transactionRequest);
+  }
 }
 
+// callExternalContract overloads
+export async function callExternalContract(args: {
+  to: string;
+  data: string;
+  contractAddress: string;
+  web3Lib: Web3LibAdapter;
+  returnTxInfo: true;
+}): Promise<TransactionRequest>;
+
+export async function callExternalContract(args: {
+  to: string;
+  data: string;
+  contractAddress: string;
+  web3Lib: Web3LibAdapter;
+  returnTxInfo?: false | undefined;
+}): Promise<TransactionResponse>;
+
 export async function callExternalContract(args: {
   to: string;
   data: string;
   contractAddress: string;
   web3Lib: Web3LibAdapter;
-}): Promise<TransactionResponse> {
-  return args.web3Lib.sendTransaction({
+  returnTxInfo?: boolean;
+}): Promise<TransactionRequest | TransactionResponse> {
+  const transactionRequest = {
     to: args.contractAddress,
     data: encodeCallExternalContract(args.to, args.data)
-  });
+  } satisfies TransactionRequest;
+
+  if (args.returnTxInfo) {
+    return transactionRequest;
+  } else {
+    return args.web3Lib.sendTransaction(transactionRequest);
+  }
 }
 
+// setApprovalForAllToContract overloads
+export async function setApprovalForAllToContract(args: {
+  operator: string;
+  approved: boolean;
+  contractAddress: string;
+  web3Lib: Web3LibAdapter;
+  returnTxInfo: true;
+}): Promise<TransactionRequest>;
+
+export async function setApprovalForAllToContract(args: {
+  operator: string;
+  approved: boolean;
+  contractAddress: string;
+  web3Lib: Web3LibAdapter;
+  returnTxInfo?: false | undefined;
+}): Promise<TransactionResponse>;
+
 export async function setApprovalForAllToContract(args: {
   operator: string;
   approved: boolean;
   contractAddress: string;
   web3Lib: Web3LibAdapter;
-}): Promise<TransactionResponse> {
-  return args.web3Lib.sendTransaction({
+  returnTxInfo?: boolean;
+}): Promise<TransactionRequest | TransactionResponse> {
+  const transactionRequest = {
     to: args.contractAddress,
     data: encodeSetApprovalForAllToContract(args.operator, args.approved)
-  });
+  } satisfies TransactionRequest;
+
+  if (args.returnTxInfo) {
+    return transactionRequest;
+  } else {
+    return args.web3Lib.sendTransaction(transactionRequest);
+  }
 }
 
+// withdrawToProtocol overloads
 export async function withdrawToProtocol(args: {
   tokenList: string[];
   contractAddress: string;
   web3Lib: Web3LibAdapter;
-}): Promise<TransactionResponse> {
-  return args.web3Lib.sendTransaction({
+  returnTxInfo: true;
+}): Promise<TransactionRequest>;
+
+export async function withdrawToProtocol(args: {
+  tokenList: string[];
+  contractAddress: string;
+  web3Lib: Web3LibAdapter;
+  returnTxInfo?: false | undefined;
+}): Promise<TransactionResponse>;
+
+export async function withdrawToProtocol(args: {
+  tokenList: string[];
+  contractAddress: string;
+  web3Lib: Web3LibAdapter;
+  returnTxInfo?: boolean;
+}): Promise<TransactionRequest | TransactionResponse> {
+  const transactionRequest = {
     to: args.contractAddress,
     data: encodeWithdrawToProtocol(args.tokenList)
-  });
+  } satisfies TransactionRequest;
+
+  if (args.returnTxInfo) {
+    return transactionRequest;
+  } else {
+    return args.web3Lib.sendTransaction(transactionRequest);
+  }
 }