Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add contracts verification script #46

Closed
wants to merge 7 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,12 @@ Run:
```
npx hardhat deploy --network <name>
```

### Verify contracts

```
VOUCHER_UPGRADER_ADDRESS=<address> \
VOUCHER_MANAGER_ADDRESS=<address> \
VOUCHER_MINTER_ADDRESS=<address> \
npx hardhat run scripts/verify.ts --network <name>
```
19 changes: 19 additions & 0 deletions hardhat.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ const config: HardhatUserConfig = {
{
version: '0.8.27',
settings: {
evmVersion: 'berlin',
/**
* Enable Intermediate Representation (IR) to reduce `Stack too deep` occurrences
* at compile time (e.g.: too many local variables in `matchOrdersBoost`).
Expand Down Expand Up @@ -94,6 +95,24 @@ const config: HardhatUserConfig = {
pages: 'items',
exclude: ['mocks', 'NonTransferableERC20Upgradeable.sol', 'beacon/VoucherProxy.sol'],
},
etherscan: {
apiKey: {
'<network>': 'nothing', // hardhat-verify requires a non-empty string.
},
customChains: [
{
network: '<network>',
chainId: 0,
urls: {
apiURL: '<url>',
browserURL: '<url>',
},
},
],
},
sourcify: {
enabled: false,
},
};

export default config;
70 changes: 70 additions & 0 deletions scripts/verify.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
// SPDX-FileCopyrightText: 2024 IEXEC BLOCKCHAIN TECH <[email protected]>
// SPDX-License-Identifier: Apache-2.0

import hre, { deployments, ethers } from 'hardhat';
import { UpgradeableBeacon__factory, VoucherHub__factory } from '../typechain-types';

/**
* Note: When verifying a proxy contract, Hardhat-verify combined with Openzeppelin Upgrades
* plugin is "generally" able to automatically detect and verify the implementation contract.
* Here we explicitly verify the implementation because some issues have been observed.
*/

(async () => {
const upgraderAddress = process.env.VOUCHER_UPGRADER_ADDRESS || '';
const managerAddress = process.env.VOUCHER_MANAGER_ADDRESS || '';
const minterAddress = process.env.VOUCHER_MINTER_ADDRESS || '';

const voucherImplAddress = (await deployments.get('VoucherImpl')).address;
const voucherUpgradableBeaconAddress = (await deployments.get('VoucherUpgradeableBeacon'))
.address;
const voucherHubImplAddress = (await deployments.get('VoucherHubImpl')).address;
const voucherHubERC1967ProxyAddress = (await deployments.get('VoucherHubERC1967Proxy')).address;

const beaconInitialOwnerAddress = await UpgradeableBeacon__factory.connect(
voucherUpgradableBeaconAddress,
ethers.provider,
).owner(); // Will not work if the owner was changed after deployment.
const voucherHub = VoucherHub__factory.connect(voucherHubERC1967ProxyAddress, ethers.provider);
const iexecPocoAddress = await voucherHub.getIexecPoco();

const contracts = [
{
name: 'VoucherImpl',
address: voucherImplAddress,
args: [],
},
{
name: 'VoucherUpgradeableBeacon',
address: voucherUpgradableBeaconAddress,
args: [[voucherImplAddress, beaconInitialOwnerAddress]],
},
{
name: 'VoucherHubImpl',
address: voucherHubImplAddress,
args: [],
},
{
name: 'VoucherHubERC1967Proxy',
address: voucherHubERC1967ProxyAddress,
args: [
voucherHubImplAddress,
VoucherHub__factory.createInterface().encodeFunctionData('initialize', [
upgraderAddress,
managerAddress,
minterAddress,
iexecPocoAddress,
voucherUpgradableBeaconAddress,
]),
],
},
];

for (const contract of contracts) {
console.log(`<> Verifying ${contract.name}`);
await hre.run('verify:verify', {
address: contract.address,
constructorArguments: contract.args,
});
}
})().catch((error) => console.log(error));
2 changes: 1 addition & 1 deletion scripts/voucherHubUtils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,6 @@ export async function getExpectedVoucherProxyCodeHash(voucherBeaconAddress: stri
* Note: Look very carefully before updating this value to avoid messing with
* existing vouchers already deployed in production.
*/
return '0x386d2735c0e7b2144a00e43bc5451acd8063573f30f1edc7b8e8891039cbd84f';
return '0xba1aec6240a4c35e4711b8ed9013b7204c7d65e1caa6f364b3793946146e8aaf';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why this change ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The CI would fail without this.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mmh ok I see, if it's fails then we should change it ! But I don't get what are the root cause of this change. That was due to a modification, evmVersion: 'berlin', ?

}
}