Skip to content

Add support for Blockscout - #1313

Open
kronosapiens wants to merge 7 commits into
developfrom
feat/blockscout
Open

Add support for Blockscout #1313
kronosapiens wants to merge 7 commits into
developfrom
feat/blockscout

Conversation

@kronosapiens

@kronosapiens kronosapiens commented Dec 10, 2024 •
edited
Loading

Copy link
Copy Markdown
Contributor

Closes #1286

Instructions:

Starting Blockscout (1 tab)

  1. Clone the Blockscout repo (https://github.com/blockscout/blockscout)
  2. 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)

  1. Run npx hardhat node as per usual
  2. 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

@kronosapiens kronosapiens mentioned this pull request Dec 10, 2024
Open
4 tasks
@kronosapiens

kronosapiens commented Dec 16, 2024

Copy link
Copy Markdown
Contributor Author

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

@kronosapiens

kronosapiens commented Jan 15, 2025

Copy link
Copy Markdown
Contributor Author

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

kronosapiens commented Jan 22, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

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
Screenshot 2025-01-22 at 4 00 36 PM

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

kronosapiens commented Jan 22, 2025

Copy link
Copy Markdown
Contributor Author

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!

Screenshot 2025-01-22 at 4 16 56 PM

@kronosapiens

kronosapiens commented Jan 24, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

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
Screenshot 2025-01-24 at 11 40 32 AM

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

kronosapiens commented Feb 3, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Currently working on isolating the various contract subdirectories so we can iteratively compile and verify the contracts without hitting the file upload limit. The following subdirectories have been isolated (can compile repo without them):

  • bridging
  • colony - used by ColonyNetworkDeployer.sol
  • colonyNetwork
  • common
  • dataTypes (new)
  • ens
  • extensions
  • interfaces (new)
  • metaTxToken - used by ColonyNetworkDeployer.sol
  • patriciaTree - used by ColonyRewards.sol
  • reputationMiningCycle
  • testHelpers
  • tokenLocking

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

in-progress

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Explore chain visualizers

1 participant

@kronosapiens