Linting and cleanup for account-integrations/safe #86
Conversation
voltrevo
changed the title
| let safeProxyFactory: SafeProxyFactory; | ||
| let safe: Safe; | ||
| let entryPoint: EntryPoint; |
There was a problem hiding this comment.
These variables fit much more neatly into the existing pattern with setupTests. Declaring uninitialized globals like this means typescript cannot know they have been initialized and puts downward pressure on typing accuracy.
| @@ -95,13 +87,14 @@ describe("SafeBlsPlugin", () => { | |||
| ]); | |||
|
|
|||
| const deployedAddress = await calculateProxyAddress( | |||
| safeProxyFactory as any, | |||
| safeProxyFactory, | |||
There was a problem hiding this comment.
Being able to remove as any is linked to the use of *__factory.connect(addr, runner) over ethers.getContractFactory(...).attach(addr).connect(runner) discussed elsewhere.
| @@ -140,19 +133,19 @@ describe("SafeBlsPlugin", () => { | |||
| maxPriorityFeePerGas, | |||
| paymasterAndData: "0x", | |||
| signature: "", | |||
| }; | |||
| } satisfies UserOperationStruct; | |||
There was a problem hiding this comment.
This is a good case study demonstrating the utility of the new satisfies keyword. If it's unclear, I recommend this video for background, and taking a look what happens when you modify this statement back to using : UserOperationStruct.
| const factory = await hre.ethers.getContractFactory("SafeProxyFactory"); | ||
| const singleton = await hre.ethers.getContractFactory("Safe"); |
There was a problem hiding this comment.
See replacements in return statement.
| factory: factory.attach(SAFE_FACTORY_ADDRESS).connect(userWallet), | ||
| singleton: singleton.attach(SINGLETON_ADDRESS).connect(provider), | ||
| factory: SafeProxyFactory__factory.connect( | ||
| SAFE_FACTORY_ADDRESS, | ||
| userWallet, | ||
| ), | ||
| singleton: Safe__factory.connect(SINGLETON_ADDRESS, provider), |
There was a problem hiding this comment.
This results in the same JS entities, but doing it this way results in better type information. I recommend avoiding getContractFactory in general, because the way it works is less robust than the typechain alternatives.
# Conflicts: # account-integrations/safe/test/hardhat/integration/SafeWebAuthnPlugin.test.ts
I'm finding myself doing some work in here as part of #74. As part of that, I've cleaned up the typing errors and added linting.
Highly recommended to use an IDE that can autofix most linting errors whenever you save the file. Please reach out if you have any trouble with this.
I've manually tested these changes with
yarn hardhat testusing the eth-infinitism bundler.