feat: make transaction logging optional

Signed-off-by: Tomás Migone <[email protected]>

Author: tmigone

packages/hardhat-graph-protocol/CHANGELOG.md

@@ -1,5 +1,12 @@
 # hardhat-graph-protocol
 
+## 0.1.13
+
+### Patch Changes
+
+- Updated dependencies
+  - @graphprotocol/toolshed@0.4.0
+
 ## 0.1.12
 
 ### Patch Changes

packages/hardhat-graph-protocol/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hardhat-graph-protocol",
-  "version": "0.1.12",
+  "version": "0.1.13",
   "publishConfig": {
     "access": "public"
   },

packages/horizon/package.json

@@ -55,7 +55,7 @@
     "hardhat": "^2.22.18",
     "hardhat-contract-sizer": "^2.10.0",
     "hardhat-gas-reporter": "^1.0.8",
-    "hardhat-graph-protocol": "workspace:^0.1.12",
+    "hardhat-graph-protocol": "workspace:^0.1.13",
     "hardhat-secure-accounts": "^1.0.5",
     "lint-staged": "^15.2.2",
     "prettier": "^3.2.5",

packages/subgraph-service/package.json

@@ -56,7 +56,7 @@
     "hardhat": "^2.22.18",
     "hardhat-contract-sizer": "^2.10.0",
     "hardhat-gas-reporter": "^1.0.8",
-    "hardhat-graph-protocol": "workspace:^0.1.12",
+    "hardhat-graph-protocol": "workspace:^0.1.13",
     "hardhat-secure-accounts": "^1.0.5",
     "json5": "^2.2.3",
     "lint-staged": "^15.2.2",

packages/toolshed/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @graphprotocol/toolshed
 
+## 0.4.0
+
+### Minor Changes
+
+- Make transaction logging optional, default to false for connect methods
+
+### Patch Changes
+
+- @graphprotocol/horizon@0.3.2
+- @graphprotocol/subgraph-service@0.3.4
+
 ## 0.3.2
 
 ### Patch Changes

packages/toolshed/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphprotocol/toolshed",
-  "version": "0.3.2",
+  "version": "0.4.0",
   "publishConfig": {
     "access": "public"
   },

packages/toolshed/src/deployments/address-book.ts

@@ -175,11 +175,13 @@ export abstract class AddressBook<
    *
    * @param addressBook Address book to use
    * @param signerOrProvider Signer or provider to use
+   * @param enableTxLogging Enable transaction logging to console and output file. Defaults to false.
    * @returns the loaded contracts
    */
   _loadContracts(
     artifactsPath: string | string[] | Record<ContractName, string>,
     signerOrProvider?: Signer | Provider,
+    enableTxLogging?: boolean,
   ): ContractList<ContractName> {
     const contracts = {} as ContractList<ContractName>
     if (this.listEntries().length == 0) {
@@ -205,6 +207,7 @@ export abstract class AddressBook<
         this.getEntry(contractName).address,
         artifactPath,
         signerOrProvider,
+        enableTxLogging,
       )
       contracts[contractName] = contract
     }

packages/toolshed/src/deployments/contract.ts

@@ -10,7 +10,7 @@ export type ContractList<T extends string = string> = Partial<Record<T, unknown>
  * @param name Name of the contract
  * @param addressBook Address book to use
  * @param signerOrProvider Signer or provider to use
- * @param enableTxLogging Enable transaction logging to console and output file. Defaults to `true`
+ * @param enableTxLogging Enable transaction logging to console and output file. Defaults to false.
  * @param optional If true, the contract is optional and will not throw if it cannot be loaded
  * @returns the loaded contract
  *
@@ -21,6 +21,7 @@ export function loadContract<ContractName extends string = string>(
   address: string,
   artifactsPath: string | string[],
   signerOrProvider?: Signer | Provider,
+  enableTxLogging?: boolean,
 ): Contract {
   try {
     let contract = new Contract(address, loadArtifact(name, artifactsPath).abi, signerOrProvider)
@@ -29,7 +30,9 @@ export function loadContract<ContractName extends string = string>(
       contract = contract.connect(signerOrProvider) as Contract
     }
 
-    contract = wrapTransactionCalls(contract, name)
+    if (enableTxLogging) {
+      contract = wrapTransactionCalls(contract, name)
+    }
 
     return contract
   } catch (err: unknown) {

packages/toolshed/src/deployments/horizon/address-book.ts

@@ -21,12 +21,14 @@ export class GraphHorizonAddressBook extends AddressBook<number, GraphHorizonCon
 
   loadContracts(
     signerOrProvider?: Signer | Provider,
+    enableTxLogging?: boolean,
   ): GraphHorizonContracts {
     logDebug('Loading Graph Horizon contracts...')
 
     const contracts = this._loadContracts(
       GraphHorizonArtifactsMap,
       signerOrProvider,
+      enableTxLogging,
     )
 
     // rewire HorizonStaking to include HorizonStakingExtension abi

packages/toolshed/src/deployments/horizon/index.ts

@@ -26,7 +26,7 @@ export type { GraphHorizonContractName, GraphHorizonContracts } from './contract
 
 export function loadGraphHorizon(addressBookPath: string, chainId: number, provider: HardhatEthersProvider) {
   const addressBook = new GraphHorizonAddressBook(addressBookPath, chainId)
-  const contracts = addressBook.loadContracts(provider)
+  const contracts = addressBook.loadContracts(provider, true)
   return {
     addressBook: addressBook,
     contracts: contracts,
@@ -39,5 +39,5 @@ export function connectGraphHorizon(chainId: number, signerOrProvider: Signer |
     addressBookPath ?? require.resolve('@graphprotocol/horizon/addresses.json'),
     chainId,
   )
-  return addressBook.loadContracts(signerOrProvider)
+  return addressBook.loadContracts(signerOrProvider, false)
 }

packages/toolshed/src/deployments/subgraph-service/address-book.ts

@@ -20,6 +20,7 @@ export class SubgraphServiceAddressBook extends AddressBook<number, SubgraphServ
 
   loadContracts(
     signerOrProvider?: Signer | Provider,
+    enableTxLogging?: boolean,
   ): SubgraphServiceContracts {
     logDebug('Loading Subgraph Service contracts...')
 
@@ -29,6 +30,7 @@ export class SubgraphServiceAddressBook extends AddressBook<number, SubgraphServ
     const contracts = this._loadContracts(
       filteredArtifactsMap as typeof SubgraphServiceArtifactsMap,
       signerOrProvider,
+      enableTxLogging,
     )
 
     // Aliases

packages/toolshed/src/deployments/subgraph-service/index.ts

@@ -10,10 +10,11 @@ export type { LegacyDisputeManager } from './types'
 
 export function loadSubgraphService(addressBookPath: string, chainId: number, provider: HardhatEthersProvider) {
   const addressBook = new SubgraphServiceAddressBook(addressBookPath, chainId)
+  const contracts = addressBook.loadContracts(provider, true)
   return {
     addressBook: addressBook,
-    contracts: addressBook.loadContracts(provider),
-    actions: loadActions(addressBook.loadContracts(provider)),
+    contracts: contracts,
+    actions: loadActions(contracts),
   }
 }
 
@@ -22,5 +23,5 @@ export function connectSubgraphService(chainId: number, signerOrProvider: Signer
     addressBookPath ?? require.resolve('@graphprotocol/subgraph-service/addresses.json'),
     chainId,
   )
-  return addressBook.loadContracts(signerOrProvider)
+  return addressBook.loadContracts(signerOrProvider, false)
 }