Add support for Blockscout #1313

kronosapiens · 2024-12-10T17:41:38Z

Closes #1286

Instructions:

Starting Blockscout (1 tab)

Clone the Blockscout repo (https://github.com/blockscout/blockscout)
Cd into blockscout/docker-compose and run docker compose -f hardhat-network.yml up (-d to daemonize)

Blockscout will start running on localhost:80 by default

Starting Hardhat (2 tabs)

Run npx hardhat node as per usual
Run npx hardhat deploy --network development as per usual

At this point Blockscout will start picking up the transactions

Todo:

Currently, contract verification is not working. This is as far as I've gotten:

>> npx hardhat verify --network development 0x777760996135F0791E2e1a74aFAa060711197777  --contract contracts/common/EtherRouter.sol:EtherRouter        
Successfully submitted source code for contract
contracts/common/EtherRouter.sol:EtherRouter at 0x777760996135F0791E2e1a74aFAa060711197777
for verification on the block explorer. Waiting for verification result...

We tried verifying your contract EtherRouter without including any unrelated one, but it failed.
Trying again with the full solc input used to compile and deploy it.
This means that unrelated contracts may be displayed on Etherscan...

hardhat-verify found one or more errors during the verification process:

Etherscan:
A network request failed. This is an error from the block explorer, not Hardhat. Error: Unexpected token '<', "<html>
<h"... is not valid JSON

I've debugged enough to confirm that the API is live, but for some reason the 2nd step (verifying with the full solc input) returns an HTML response, which breaks the verifier.

Resources:

https://hardhat.org/hardhat-runner/plugins/nomicfoundation-hardhat-verify

https://docs.blockscout.com/devs/verification/hardhat-verification-plugin

Blockscout's issue tracking proxy contract support

area · 2024-12-16T12:33:31Z

The error in the second step is

<html>
<head><title>413 Request Entity Too Large</title></head>
<body>
<center><h1>413 Request Entity Too Large</h1></center>
<hr><center>nginx/1.27.3</center>
</body>
</html>

i.e. the concatenation of all the solidity files is too big to be posted to the API (no idea who's enforcing that limit, though).

kronosapiens · 2024-12-16T16:52:21Z

Suggestion is to try and validate contracts through the Blockscout UI directly

area · 2024-12-18T10:06:41Z

Suggestion is to try and validate contracts through the Blockscout UI directly

Well, to start there and if that works then potentially write our own script to validate automatically in a more judicious way than the plugin tries to.

area · 2025-01-06T11:58:36Z

For anyone else testing this, if you run the docker-compose command, the containers have a restart policy of 'always', which means they will start whenever docker does. I only discovered this when something got in to a crash loop when I restarted my machine and started using all my CPU.

grep -irl "restart: always" | xargs sed -i.bak "s/restart: always/restart: on-failure/g"

run in the directory with the docker files will cause them to only restart on failure.

area · 2025-01-10T11:41:23Z

https://medium.com/@shaiv/testnet-faucets-sucks-try-this-block-explorer-with-your-local-hardhat-f434384d5244

This is a lot lighter weight, and supports at least some of what we want... maybe it does enough? I did have to edit it to ignore warnings when verifying a contract

-    if (compiledOutput.errors) {
+    if (compiledOutput.errors && compiledOutput.errors.filter(e => !e.formattedMessage.startsWith('Warning:')).length > 0) {

kronosapiens · 2025-01-15T22:01:39Z

Noting that the Standard JSON Input for a contract build can be pulled out of Hardhat via:

> buildInfo = await hre.artifacts.getBuildInfo("contracts/colony/Colony.sol:Colony")
> require('fs').writeFileSync('input.json', JSON.stringify(buildInfo.input, null, 2));

kronosapiens · 2025-01-22T20:22:16Z

Testing for contract-level verification, using the dependency contract at contracts/testHelpers/ChainId.sol

const ChainId = await ethers.getContractFactory("ChainId")
const chainId = await ChainId.deploy()
await chainId.deployed()
console.log("Contract deployed to:", chainId.address)
>>> Contract deployed to: 0x78876Ba649623A5cC3a370509fe4AD5aCa26dfB4

Was able to verify this contract, under the paris EVM version. For some reason, it gave a "partial match" whatever that means.

@area any idea why we're compiling for paris? I don't see that as an explicit setting in our hardhat config.

kronosapiens · 2025-01-22T21:17:17Z

Now trying with Standard JSON Input:

buildInfo = await hre.artifacts.getBuildInfo("contracts/testHelpers/ChainId.sol:ChainId")
require('fs').writeFileSync('input.json', JSON.stringify(buildInfo.input, null, 2));

Then manually going into input.json and deleting all the sources except for

    "contracts/testHelpers/ChainId.sol": {
      "content": "// SPDX-License-Identifier: GPL-3.0-or-later\n/*\n  This file is part of The Colony Network.\n\n  The Colony Network is free software: you can redistribute it and/or modify\n  it under the terms of the GNU General Public License as published by\n  the Free Software Foundation, either version 3 of the License, or\n  (at your option) any later version.\n\n  The Colony Network is distributed in the hope that it will be useful,\n  but WITHOUT ANY WARRANTY; without even the implied warranty of\n  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n  GNU General Public License for more details.\n\n  You should have received a copy of the GNU General Public License\n  along with The Colony Network. If not, see <http://www.gnu.org/licenses/>.\n*/\n\npragma solidity 0.8.27;\n\ncontract ChainId {\n  function getChainId() public view returns (uint256) {\n    return block.chainid;\n  }\n}\n"
    }

And then uploading the input.json to Blockscout. Now we have an exact match!

area · 2025-01-23T09:30:40Z

@area any idea why we're compiling for paris? I don't see that as an explicit setting in our hardhat config.

It's the hardhat default. The setting is conservative to stop people accidentally deploying contracts compiled to chains that they do not run on, as adding new opcodes to chains requires a hardfork and happens slowly. CreateX, for example, is only compiled for Paris.

kronosapiens · 2025-01-24T16:40:56Z

Tried using hardhat-verify again. This time, I deleted every contract in contracts/ except for ChainId.sol and re-compiled:

const ChainId = await ethers.getContractFactory("ChainId")
const chainId = await ChainId.deploy()
await chainId.deployed()
console.log("Contract deployed to:", chainId.address)
>>> Contract deployed to: 0xefC85459223d1a30eFC4cEb01Af496A976A7D5b5

Then attempted to verify using command line, which works:

$ npx hardhat verify --network localhost 0xefC85459223d1a30eFC4cEb01Af496A976A7D5b5  --contract contracts/ChainId.sol:ChainId      
Successfully submitted source code for contract
contracts/ChainId.sol:ChainId at 0xefC85459223d1a30eFC4cEb01Af496A976A7D5b5
for verification on the block explorer. Waiting for verification result...

Successfully verified contract ChainId on the block explorer.
http://localhost:80/address/0xefC85459223d1a30eFC4cEb01Af496A976A7D5b5#code

kronosapiens · 2025-02-03T15:22:30Z

kronosapiens mentioned this pull request Dec 10, 2024

Explore chain visualizers #1286

Open

4 tasks

kronosapiens added the in-progress label Dec 10, 2024

Add @nomicfoundation/hardhat-verify

f753f74

kronosapiens force-pushed the feat/blockscout branch from 1daef28 to f753f74 Compare January 22, 2025 20:01

Introduce common/CommonDataTypes.sol

35b5734

kronosapiens force-pushed the feat/blockscout branch 2 times, most recently from 064b8d4 to f251da1 Compare January 29, 2025 22:00

Introduce /interfaces directory

307a0ef

kronosapiens force-pushed the feat/blockscout branch from f251da1 to 307a0ef Compare January 29, 2025 22:50

Update clean:contracts

8aa6cd6

kronosapiens force-pushed the feat/blockscout branch from 062b714 to 5ebc8fa Compare February 3, 2025 14:28

Add contracts/dataTypes

3ec85b0

kronosapiens force-pushed the feat/blockscout branch from 5ebc8fa to 3ec85b0 Compare February 3, 2025 17:04

kronosapiens added 2 commits February 3, 2025 12:15

Additional reorganization

ea66ec8

Move ColonyExtension*.sol to common/

593ba8d

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add support for Blockscout #1313

Add support for Blockscout #1313

Uh oh!

kronosapiens commented Dec 10, 2024 •

edited

Loading

Uh oh!

area commented Dec 16, 2024

Uh oh!

kronosapiens commented Dec 16, 2024

Uh oh!

area commented Dec 18, 2024

Uh oh!

area commented Jan 6, 2025 •

edited

Loading

Uh oh!

area commented Jan 10, 2025

Uh oh!

kronosapiens commented Jan 15, 2025

Uh oh!

kronosapiens commented Jan 22, 2025 •

edited

Loading

Uh oh!

kronosapiens commented Jan 22, 2025

Uh oh!

area commented Jan 23, 2025

Uh oh!

kronosapiens commented Jan 24, 2025 •

edited

Loading

Uh oh!

kronosapiens commented Feb 3, 2025 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Add support for Blockscout #1313

Are you sure you want to change the base?

Add support for Blockscout #1313

Uh oh!

Conversation

kronosapiens commented Dec 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Instructions:

Starting Blockscout (1 tab)

Starting Hardhat (2 tabs)

Todo:

Resources:

Uh oh!

area commented Dec 16, 2024

Uh oh!

kronosapiens commented Dec 16, 2024

Uh oh!

area commented Dec 18, 2024

Uh oh!

area commented Jan 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

area commented Jan 10, 2025

Uh oh!

kronosapiens commented Jan 15, 2025

Uh oh!

kronosapiens commented Jan 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kronosapiens commented Jan 22, 2025

Uh oh!

area commented Jan 23, 2025

Uh oh!

kronosapiens commented Jan 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kronosapiens commented Feb 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

kronosapiens commented Dec 10, 2024 •

edited

Loading

area commented Jan 6, 2025 •

edited

Loading

kronosapiens commented Jan 22, 2025 •

edited

Loading

kronosapiens commented Jan 24, 2025 •

edited

Loading

kronosapiens commented Feb 3, 2025 •

edited

Loading