feat: add optional expression logging to GRE

[tmigone]

Adds an optional wrapper for GRE contract calls, the wrapper will:

• make the contract call and wait for confirmation using provider.waitForTransaction
• log transaction details to the console in a "pretty" human readable form
• log transaction details to a file in the projects root directory (tx-<DATE>.log)

This will be disabled for now (unless explicitly enabled) because CLI based scripts already have this type of logging using the sendTransaction utility. Until we consolidate those (or solve any potential double logging) we shouldn't enable this feature by default.

Example usage

To try it out simply initialize GRE with enableTxLogging = true. Note that running the same script with enableTXLogging = false will print nothing to the console.

  const graph = hre.graph({ enableTxLogging: true })
  const deployer = await graph.getDeployer()
  await graph.l1.contracts.GraphToken.connect(deployer).addMinter(deployer.address)

Console output:

> Sent transaction GraphToken.addMinter
   sender: 0x90F8bf6A479f320ead074411a4B0e7944Ea8c9C1
   contract: 0x9561C133DD8580860B6b7E504bC5Aa500f0f06a7
   params: [ 0x90F8bf6A479f320ead074411a4B0e7944Ea8c9C1 ]
   txHash: 0xbcdef6ebd4e743a3a11b20ba738c45ec95bd9875e2fa903258f5349b565ade8e
✔ Transaction succeeded: 0xbcdef6ebd4e743a3a11b20ba738c45ec95bd9875e2fa903258f5349b565ade8e

Log file contents:

[2022-10-03T21:14:34.957Z] > Sent transaction GraphToken.addMinter
[2022-10-03T21:14:34.957Z]    sender: 0x90F8bf6A479f320ead074411a4B0e7944Ea8c9C1
[2022-10-03T21:14:34.957Z]    contract: 0x9561C133DD8580860B6b7E504bC5Aa500f0f06a7
[2022-10-03T21:14:34.957Z]    params: [ 0x90F8bf6A479f320ead074411a4B0e7944Ea8c9C1 ]
[2022-10-03T21:14:34.957Z]    txHash: 0xbcdef6ebd4e743a3a11b20ba738c45ec95bd9875e2fa903258f5349b565ade8e
[2022-10-03T21:14:50.972Z] ✔ Transaction succeeded: 0xbcdef6ebd4e743a3a11b20ba738c45ec95bd9875e2fa903258f5349b565ade8e
[2022-10-03T21:15:24.780Z] > Sent transaction GraphToken.addMinter
[2022-10-03T21:15:24.780Z]    sender: 0x90F8bf6A479f320ead074411a4B0e7944Ea8c9C1
[2022-10-03T21:15:24.780Z]    contract: 0x9561C133DD8580860B6b7E504bC5Aa500f0f06a7
[2022-10-03T21:15:24.780Z]    params: [ 0x90F8bf6A479f320ead074411a4B0e7944Ea8c9C1 ]
[2022-10-03T21:15:24.780Z]    txHash: 0xbcdef6ebd4e743a3a11b20ba738c45ec95bd9875e2fa903258f5349b565ade8e
[2022-10-03T21:15:40.813Z] ✔ Transaction succeeded: 0xbcdef6ebd4e743a3a11b20ba738c45ec95bd9875e2fa903258f5349b565ade8e

Closes: #702
Signed-off-by: Tomás Migone tomas@edgeandnode.com

[codecov]

Codecov Report

Base: 90.57% // Head: 90.57% // No change to project coverage 👍

Coverage data is based on head (bdeba91) compared to base (b6219d3).
Patch has no changes to coverable lines.

Additional details and impacted files

@@           Coverage Diff           @@
##              dev     #728   +/-   ##
=======================================
  Coverage   90.57%   90.57%           
=======================================
  Files          35       35           
  Lines        1762     1762           
  Branches      296      296           
=======================================
  Hits         1596     1596           
  Misses        166      166           

Flag	Coverage Δ
unittests	90.57% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

[abarmat]

I've been thinking for a while about removing all the sendTransactions calls for the improved and more expressive calls that ethers supports through typechain. This is a great improvement.

We might need to think about a way to override it in case we want to do something like:

// send tx1 and tx2 immediately 
const txs = await Promise.all([tx1, tx2])
// wait for both tx1 and tx2 receipts
await Promise.all([tx1.wait(), tx2.wait()])

[tmigone]

yes, an override for those cases can be tricky but doable. I'll merge this as is since we are not enabling it just yet, then we can keep thinking about this stuff.