From 3932311d322f01384396b393bffccdef47e9370c Mon Sep 17 00:00:00 2001 From: Michael Heuer Date: Mon, 23 Oct 2023 15:49:53 +0200 Subject: [PATCH] style: formatting --- .vscode/extensions.json | 8 +++ .vscode/settings.json | 7 +++ contracts/.solcover.js | 4 +- contracts/hardhat.config.ts | 62 +++++++++---------- .../plugin/majority-voting/majority-voting.ts | 8 +-- .../plugin/majority-voting/voting-helpers.ts | 4 +- .../token/erc20/governance-wrapped-erc20.ts | 8 +-- contracts/test/utils/addresslist.ts | 12 ++-- .../test/utils/version-comparison-lib.ts | 8 +-- contracts/utils/etherscan.ts | 4 +- contracts/utils/helpers.ts | 2 +- contracts/utils/ipfs.ts | 4 +- subgraph/src/ids/permissions.ts | 4 +- subgraph/src/ids/pluginRepo.ts | 4 +- subgraph/tests/ids/permissions.test.ts | 4 +- subgraph/tests/ids/pluginRepo.test.ts | 2 +- 16 files changed, 80 insertions(+), 65 deletions(-) create mode 100644 .vscode/extensions.json create mode 100644 .vscode/settings.json diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 00000000..11c72005 --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,8 @@ +{ + "recommendations": [ + "esbenp.prettier-vscode", + "NomicFoundation.hardhat-solidity", + "KnisterPeter.vscode-commitizen", + "tintinweb.solidity-visual-auditor" + ] +} diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 00000000..c447ad0c --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,7 @@ +{ + "editor.defaultFormatter": "esbenp.prettier-vscode", + "editor.formatOnSave": true, + "prettier.documentSelectors": ["**/*.sol"], + "solidity.formatter": "prettier", + "editor.tabSize": 4 +} diff --git a/contracts/.solcover.js b/contracts/.solcover.js index 90c0b251..6d73c020 100644 --- a/contracts/.solcover.js +++ b/contracts/.solcover.js @@ -1,7 +1,7 @@ module.exports = { istanbulReporter: ['html', 'lcov'], providerOptions: { - privateKey: process.env.PRIVATE_KEY, + privateKey: process.env.PRIVATE_KEY }, - skipFiles: ['test'], + skipFiles: ['test'] }; diff --git a/contracts/hardhat.config.ts b/contracts/hardhat.config.ts index ea468df2..5a0f63de 100644 --- a/contracts/hardhat.config.ts +++ b/contracts/hardhat.config.ts @@ -28,7 +28,7 @@ const apiUrls: {[index: string]: string} = { polygon: 'https://polygon-mainnet.infura.io/v3/', polygonMumbai: 'https://polygon-mumbai.infura.io/v3/', base: 'https://mainnet.base.org', - baseGoerli: 'https://goerli.base.org', + baseGoerli: 'https://goerli.base.org' }; export const networks: {[index: string]: NetworkUserConfig} = { @@ -37,39 +37,39 @@ export const networks: {[index: string]: NetworkUserConfig} = { forking: { url: `${ apiUrls[process.env.NETWORK_NAME ? process.env.NETWORK_NAME : 'mainnet'] - }${process.env.INFURA_API_KEY}`, - }, + }${process.env.INFURA_API_KEY}` + } }, mainnet: { chainId: 1, - url: `${apiUrls.mainnet}${process.env.INFURA_API_KEY}`, + url: `${apiUrls.mainnet}${process.env.INFURA_API_KEY}` }, goerli: { chainId: 5, - url: `${apiUrls.goerli}${process.env.INFURA_API_KEY}`, + url: `${apiUrls.goerli}${process.env.INFURA_API_KEY}` }, sepolia: { chainId: 11155111, - url: `${apiUrls.sepolia}${process.env.INFURA_API_KEY}`, + url: `${apiUrls.sepolia}${process.env.INFURA_API_KEY}` }, polygon: { chainId: 137, - url: `${apiUrls.polygon}${process.env.INFURA_API_KEY}`, + url: `${apiUrls.polygon}${process.env.INFURA_API_KEY}` }, polygonMumbai: { chainId: 80001, - url: `${apiUrls.polygonMumbai}${process.env.INFURA_API_KEY}`, + url: `${apiUrls.polygonMumbai}${process.env.INFURA_API_KEY}` }, base: { chainId: 8453, url: `${apiUrls.base}`, - gasPrice: ethers.utils.parseUnits('0.001', 'gwei').toNumber(), + gasPrice: ethers.utils.parseUnits('0.001', 'gwei').toNumber() }, baseGoerli: { chainId: 84531, url: `${apiUrls.baseGoerli}`, - gasPrice: ethers.utils.parseUnits('0.0000001', 'gwei').toNumber(), - }, + gasPrice: ethers.utils.parseUnits('0.0000001', 'gwei').toNumber() + } }; // Uses hardhats private key if none is set. DON'T USE THIS ACCOUNT FOR DEPLOYMENTS @@ -81,7 +81,7 @@ for (const network in networks) { // special treatement for hardhat if (network.startsWith('hardhat')) { networks[network].accounts = { - mnemonic: 'test test test test test test test test test test test junk', + mnemonic: 'test test test test test test test test test test test junk' }; continue; } @@ -103,7 +103,7 @@ const config: HardhatUserConfig = { polygon: process.env.POLYGONSCAN_API_KEY || '', polygonMumbai: process.env.POLYGONSCAN_API_KEY || '', base: process.env.BASESCAN_API_KEY || '', - baseGoerli: process.env.BASESCAN_API_KEY || '', + baseGoerli: process.env.BASESCAN_API_KEY || '' }, customChains: [ { @@ -111,26 +111,26 @@ const config: HardhatUserConfig = { chainId: 11155111, urls: { apiURL: 'https://api-sepolia.etherscan.io/api', - browserURL: 'https://sepolia.etherscan.io', - }, + browserURL: 'https://sepolia.etherscan.io' + } }, { network: 'base', chainId: 8453, urls: { apiURL: 'https://api.basescan.org/api', - browserURL: 'https://basescan.org', - }, + browserURL: 'https://basescan.org' + } }, { network: 'baseGoerli', chainId: 84531, urls: { apiURL: 'https://api-goerli.basescan.org/api', - browserURL: 'https://goerli.basescan.org', - }, - }, - ], + browserURL: 'https://goerli.basescan.org' + } + } + ] }, namedAccounts: { @@ -145,7 +145,7 @@ const config: HardhatUserConfig = { harold: 7, ivan: 8, judy: 9, - mallory: 10, + mallory: 10 }, gasReporter: { @@ -153,7 +153,7 @@ const config: HardhatUserConfig = { enabled: process.env.REPORT_GAS === 'true' ? true : false, excludeContracts: [], src: './contracts', - coinmarketcap: process.env.COINMARKETCAP_API_KEY, + coinmarketcap: process.env.COINMARKETCAP_API_KEY }, networks, paths: { @@ -161,7 +161,7 @@ const config: HardhatUserConfig = { cache: './cache', sources: './src', tests: './test', - deploy: './deploy', + deploy: './deploy' }, solidity: { @@ -170,19 +170,19 @@ const config: HardhatUserConfig = { metadata: { // Not including the metadata hash // https://github.com/paulrberg/hardhat-template/issues/31 - bytecodeHash: 'none', + bytecodeHash: 'none' }, // Disable the optimizer when debugging // https://hardhat.org/hardhat-network/#solidity-optimizer-support optimizer: { enabled: true, - runs: 800, - }, - }, + runs: 800 + } + } }, typechain: { outDir: 'typechain', - target: 'ethers-v5', + target: 'ethers-v5' }, docgen: { outputDir: 'docs/developer-portal/reference-guide', @@ -190,8 +190,8 @@ const config: HardhatUserConfig = { pages: 'files', templates: 'docs/templates', collapseNewlines: true, - exclude: ['test'], - }, + exclude: ['test'] + } }; export default config; diff --git a/contracts/test/plugin/majority-voting/majority-voting.ts b/contracts/test/plugin/majority-voting/majority-voting.ts index c3655fc9..6956b3e3 100644 --- a/contracts/test/plugin/majority-voting/majority-voting.ts +++ b/contracts/test/plugin/majority-voting/majority-voting.ts @@ -7,7 +7,7 @@ import { IMajorityVoting__factory, DAO__factory, MajorityVotingMock__factory, - IProtocolVersion__factory, + IProtocolVersion__factory } from '../../../typechain'; import {deployUUPSProxy} from '../../../utils/helpers'; import {getInterfaceId} from '../../../utils/interfaces'; @@ -24,7 +24,7 @@ export const MAJORITY_VOTING_BASE_INTERFACE = new ethers.utils.Interface([ 'function totalVotingPower(uint256)', 'function getProposal(uint256)', 'function updateVotingSettings(tuple(uint8,uint32,uint32,uint64,uint256))', - 'function createProposal(bytes,tuple(address,uint256,bytes)[],uint256,uint64,uint64,uint8,bool)', + 'function createProposal(bytes,tuple(address,uint256,bytes)[],uint256,uint64,uint64,uint8,bool)' ]); describe('MajorityVotingMock', function () { @@ -40,7 +40,7 @@ describe('MajorityVotingMock', function () { dao = await deployUUPSProxy(new DAO__factory(signers[0]), { initializerName: 'initialize', - args: [[], ownerAddress, ethers.constants.AddressZero, 'examplURI'], + args: [[], ownerAddress, ethers.constants.AddressZero, 'examplURI'] }); }); @@ -50,7 +50,7 @@ describe('MajorityVotingMock', function () { supportThreshold: pctToRatio(50), minParticipation: pctToRatio(20), minDuration: ONE_HOUR, - minProposerVotingPower: 0, + minProposerVotingPower: 0 }; const MajorityVotingBase = new MajorityVotingMock__factory(signers[0]); diff --git a/contracts/test/plugin/majority-voting/voting-helpers.ts b/contracts/test/plugin/majority-voting/voting-helpers.ts index 5df99417..a4ef2e8d 100644 --- a/contracts/test/plugin/majority-voting/voting-helpers.ts +++ b/contracts/test/plugin/majority-voting/voting-helpers.ts @@ -7,13 +7,13 @@ export enum VoteOption { None, Abstain, Yes, - No, + No } export enum VotingMode { Standard, EarlyExecution, - VoteReplacement, + VoteReplacement } export type VotingSettings = { diff --git a/contracts/test/token/erc20/governance-wrapped-erc20.ts b/contracts/test/token/erc20/governance-wrapped-erc20.ts index b278e169..79a280b4 100644 --- a/contracts/test/token/erc20/governance-wrapped-erc20.ts +++ b/contracts/test/token/erc20/governance-wrapped-erc20.ts @@ -7,7 +7,7 @@ import { IGovernanceWrappedERC20__factory, IERC20Upgradeable__factory, IERC20PermitUpgradeable__factory, - IVotesUpgradeable__factory, + IVotesUpgradeable__factory } from '../../../typechain'; import {getInterfaceId} from '../../../utils/interfaces'; import {SignerWithAddress} from '@nomiclabs/hardhat-ethers/signers'; @@ -53,7 +53,7 @@ describe('GovernanceWrappedERC20', function () { defaultBalances = [ {account: signers[0].address, amount: 123}, {account: signers[1].address, amount: 456}, - {account: signers[2].address, amount: 789}, + {account: signers[2].address, amount: 789} ]; from = signers[0]; @@ -73,7 +73,7 @@ describe('GovernanceWrappedERC20', function () { defaultGovernanceWrappedERC20InitData = [ erc20.address, governanceWrappedERC20Name, - governanceWrappedERC20Symbol, + governanceWrappedERC20Symbol ]; governanceToken = await GovernanceWrappedERC20.deploy( @@ -151,7 +151,7 @@ describe('GovernanceWrappedERC20', function () { const iface = new ethers.utils.Interface([ 'function name()', 'function symbol()', - 'function decimals()', + 'function decimals()' ]); expect(await governanceToken.supportsInterface(getInterfaceId(iface))).to .be.true; diff --git a/contracts/test/utils/addresslist.ts b/contracts/test/utils/addresslist.ts index 4c84aa99..b05665d8 100644 --- a/contracts/test/utils/addresslist.ts +++ b/contracts/test/utils/addresslist.ts @@ -31,7 +31,7 @@ describe('AddresslistMock', function () { await addresslist.addAddresses([ signers[0].address, signers[1].address, - signers[2].address, + signers[2].address ]); expect(await addresslist.addresslistLength()).to.equal(3); @@ -40,7 +40,7 @@ describe('AddresslistMock', function () { await addresslist.removeAddresses([ signers[1].address, - signers[2].address, + signers[2].address ]); expect(await addresslist.addresslistLength()).to.equal(0); }); @@ -53,7 +53,7 @@ describe('AddresslistMock', function () { const tx2 = await addresslist.addAddresses([ signers[1].address, - signers[2].address, + signers[2].address ]); await ethers.provider.send('evm_mine', []); @@ -74,7 +74,7 @@ describe('AddresslistMock', function () { const tx1 = await addresslist.addAddresses([ signers[0].address, signers[1].address, - signers[2].address, + signers[2].address ]); await ethers.provider.send('evm_mine', []); @@ -83,14 +83,14 @@ describe('AddresslistMock', function () { const tx3 = await addresslist.removeAddresses([ signers[1].address, - signers[2].address, + signers[2].address ]); await ethers.provider.send('evm_mine', []); const [rc1, rc2, rc3] = await Promise.all([ tx1.wait(), tx2.wait(), - tx3.wait(), + tx3.wait() ]); expect(rc1.blockNumber).to.be.lt(rc2.blockNumber); diff --git a/contracts/test/utils/version-comparison-lib.ts b/contracts/test/utils/version-comparison-lib.ts index b551721f..e2d58672 100644 --- a/contracts/test/utils/version-comparison-lib.ts +++ b/contracts/test/utils/version-comparison-lib.ts @@ -1,6 +1,6 @@ import { VersionComparisonLibTest, - VersionComparisonLibTest__factory, + VersionComparisonLibTest__factory } from '../../typechain'; import {expect} from 'chai'; import {ethers} from 'hardhat'; @@ -121,7 +121,7 @@ async function eqChecks( func([0, 1, 0], [0, 1, 0]), func([0, 0, 1], [0, 0, 1]), // - func([0, 0, 0], [0, 0, 0]), + func([0, 0, 0], [0, 0, 0]) ]); // Check that all results match the expected value @@ -155,7 +155,7 @@ async function ltChecks( // func([1, 0, 0], [2, 0, 0]), func([0, 1, 0], [0, 2, 0]), - func([0, 0, 1], [0, 0, 2]), + func([0, 0, 1], [0, 0, 2]) ]); // Check that all results match the expected value @@ -187,7 +187,7 @@ async function gtChecks( // func([2, 0, 0], [1, 0, 0]), func([0, 2, 0], [0, 1, 0]), - func([0, 0, 2], [0, 0, 1]), + func([0, 0, 2], [0, 0, 1]) ]); // Check that all results match the expected value diff --git a/contracts/utils/etherscan.ts b/contracts/utils/etherscan.ts index b09324e0..1d611d7e 100644 --- a/contracts/utils/etherscan.ts +++ b/contracts/utils/etherscan.ts @@ -18,7 +18,7 @@ export const verifyContract = async ( // Write a temporal file to host complex parameters for hardhat-etherscan https://github.com/nomiclabs/hardhat/tree/master/packages/hardhat-etherscan#complex-arguments const {fd, path, cleanup} = await file({ prefix: 'verify-params-', - postfix: '.js', + postfix: '.js' }); fs.writeSync( fd, @@ -27,7 +27,7 @@ export const verifyContract = async ( const params = { address: address, - constructorArgs: path, + constructorArgs: path }; await runTaskWithRetry('verify', params, times, msDelay, cleanup); } catch (error) { diff --git a/contracts/utils/helpers.ts b/contracts/utils/helpers.ts index 036b30c1..9e30fe3c 100644 --- a/contracts/utils/helpers.ts +++ b/contracts/utils/helpers.ts @@ -5,7 +5,7 @@ import { Interface, LogDescription, defaultAbiCoder, - keccak256, + keccak256 } from 'ethers/lib/utils'; import {ethers} from 'hardhat'; diff --git a/contracts/utils/ipfs.ts b/contracts/utils/ipfs.ts index 2739b9bd..2a4bcf99 100644 --- a/contracts/utils/ipfs.ts +++ b/contracts/utils/ipfs.ts @@ -5,8 +5,8 @@ export async function uploadToIPFS(content: string): Promise { const client = IPFS.create({ url: 'https://prod.ipfs.aragon.network/api/v0', headers: { - 'X-API-KEY': 'b477RhECf8s8sdM7XrkLBs2wHc4kCMwpbcFC55Kt', - }, + 'X-API-KEY': 'b477RhECf8s8sdM7XrkLBs2wHc4kCMwpbcFC55Kt' + } }); const res = await client.add(content); diff --git a/subgraph/src/ids/permissions.ts b/subgraph/src/ids/permissions.ts index d529af32..0c75f563 100644 --- a/subgraph/src/ids/permissions.ts +++ b/subgraph/src/ids/permissions.ts @@ -20,7 +20,7 @@ export function generatePermissionEntityId( emittingContract.toHexString(), permissionId.toHexString(), where.toHexString(), - who.toHexString(), + who.toHexString() ]; return ids.join('_'); } @@ -48,7 +48,7 @@ export function generatePluginPermissionEntityId( operationId, where.toHexString(), who.toHexString(), - permissionId.toHexString(), + permissionId.toHexString() ]; return ids.join('_'); diff --git a/subgraph/src/ids/pluginRepo.ts b/subgraph/src/ids/pluginRepo.ts index 55e5f8aa..18865d7a 100644 --- a/subgraph/src/ids/pluginRepo.ts +++ b/subgraph/src/ids/pluginRepo.ts @@ -4,7 +4,7 @@ import { ByteArray, Bytes, crypto, - ethereum, + ethereum } from '@graphprotocol/graph-ts'; /** @@ -105,7 +105,7 @@ export function generatePluginVersionEntityId( const ids = [ generatePluginRepoEntityId(pluginRepo), release.toString(), - build.toString(), + build.toString() ]; return ids.join('_'); } diff --git a/subgraph/tests/ids/permissions.test.ts b/subgraph/tests/ids/permissions.test.ts index b48a0830..c12409ae 100644 --- a/subgraph/tests/ids/permissions.test.ts +++ b/subgraph/tests/ids/permissions.test.ts @@ -1,14 +1,14 @@ import { generatePermissionEntityId, generatePluginPermissionEntityId, - generatePluginPreparationEntityId, + generatePluginPreparationEntityId } from '../../src'; import {PERMISSION_OPERATIONS} from '../../src/utils/constants'; import { ADDRESS_ZERO, ADDRESS_ONE, ADDRESS_TWO, - DUMMY_BYTES32_HEX, + DUMMY_BYTES32_HEX } from '../constants'; import {Address, Bytes} from '@graphprotocol/graph-ts'; import {assert, describe, test} from 'matchstick-as/assembly/index'; diff --git a/subgraph/tests/ids/pluginRepo.test.ts b/subgraph/tests/ids/pluginRepo.test.ts index d2012817..975ee1b1 100644 --- a/subgraph/tests/ids/pluginRepo.test.ts +++ b/subgraph/tests/ids/pluginRepo.test.ts @@ -4,7 +4,7 @@ import { generatePluginInstallationEntityId, generatePluginPreparationEntityId, generatePluginReleaseEntityId, - generatePluginVersionEntityId, + generatePluginVersionEntityId } from '../../src'; import {ADDRESS_ONE, ADDRESS_TWO, DUMMY_BYTES32_HEX} from '../constants'; import {Address, Bytes, crypto} from '@graphprotocol/graph-ts';