{"id":40673286,"url":"https://github.com/tryethernal/hardhat-ethernal","last_synced_at":"2026-01-21T09:37:12.556Z","repository":{"id":40423014,"uuid":"339132831","full_name":"tryethernal/hardhat-ethernal","owner":"tryethernal","description":"Hardhat plugin for Ethernal","archived":false,"fork":false,"pushed_at":"2025-02-22T09:44:00.000Z","size":452,"stargazers_count":105,"open_issues_count":2,"forks_count":17,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-10-19T05:03:01.149Z","etag":null,"topics":["hardhat","hardhat-plugin","web3"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tryethernal.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-02-15T16:12:21.000Z","updated_at":"2025-07-25T08:46:51.000Z","dependencies_parsed_at":"2024-06-18T16:43:58.415Z","dependency_job_id":"5d4a1eac-bef8-4c8e-99d3-dc2554294f74","html_url":"https://github.com/tryethernal/hardhat-ethernal","commit_stats":{"total_commits":175,"total_committers":3,"mean_commits":"58.333333333333336","dds":0.02285714285714291,"last_synced_commit":"89d1c995ac7be66566f85851a4781c70cc42b15d"},"previous_names":[],"tags_count":43,"template":false,"template_full_name":null,"purl":"pkg:github/tryethernal/hardhat-ethernal","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tryethernal%2Fhardhat-ethernal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tryethernal%2Fhardhat-ethernal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tryethernal%2Fhardhat-ethernal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tryethernal%2Fhardhat-ethernal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tryethernal","download_url":"https://codeload.github.com/tryethernal/hardhat-ethernal/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tryethernal%2Fhardhat-ethernal/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28631316,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-21T04:47:28.174Z","status":"ssl_error","status_checked_at":"2026-01-21T04:47:22.943Z","response_time":86,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hardhat","hardhat-plugin","web3"],"created_at":"2026-01-21T09:37:12.477Z","updated_at":"2026-01-21T09:37:12.536Z","avatar_url":"https://github.com/tryethernal.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Hardhat plugin for Ethernal\n\n[Ethernal](https://www.tryethernal.com) is a block explorer for EVM-based chains. You can use it with your local chains (the Hardhat network for example), or for chains deployed on remote servers.\n\nIt allows you to interact with contracts by automatically generating an UI for all read/write methods. You can also read contract variables in any blocks.\n\nTo use Ethernal, you need to synchronize blocks, transactions \u0026 artifacts with the dashboard. This plugin allows you to easily do that instead of having to run the CLI separately.\n\nIf you are looking for more detailed doc about Ethernal: https://doc.tryethernal.com\n\n## Installation\n\nAdd ```hardhat-ethernal``` to your ```package.json```, and run ```npm install``` or ```yarn```\n\n\nIn your ```hardhat-config.js```file, require the plugin:\n```js\nrequire('hardhat-ethernal');\n````\n\nTo authenticate, you need to set `ETHERNAL_API_TOKEN` in your env variables. You can find the token by logging in at https://app.tryethernal.com \u003e Settings \u003e Account\nYou can also set them in the config object:\n```js\nmodule.exports = {\n    ethernal: {\n        apiToken: process.env.ETHERNAL_API_TOKEN\n    }\n};\n```\n\n## Synchronize blocks \u0026 transactions\n\nOnce you've installed the plugin and authenticated, the plugin will automatically sync blocks and transactions going through your node.\nBy default, it will synchronize to the latest workspace you've used in the dashboard. See next section to learn how to set the workspace manually.\n\n## Options\n\nAll options need to be under the optional `ethernal` key in the Hardhat config object, default values are shown below:\n```js\nmodule.exports = {\n    ethernal: {\n        disableSync: false, // If set to true, plugin will not sync blocks \u0026 txs\n        workspace: undefined, // Set the workspace to use, will default to the default workspace (latest one used in the dashboard). It is also possible to set it through the ETHERNAL_WORKSPACE env variable\n        uploadAst: false, // If set to true, plugin will upload AST, and you'll be able to use the storage feature (longer sync time though)\n        disabled: false, // If set to true, the plugin will be disabled, nohting will be synced, ethernal.push won't do anything either\n        resetOnStart: undefined, // Pass a workspace name to reset it automatically when restarting the node, note that if the workspace doesn't exist it won't error\n        serverSync: false, // Only available on public explorer plans - If set to true, blocks \u0026 txs will be synced by the server. For this to work, your chain needs to be accessible from the internet.\n        skipFirstBlock: false, // If set to true, the first block will be skipped. This is mostly useful to avoid having the first block synced with its tx when starting a mainnet fork\n        verbose: false // If set to true, will display this config object on start and the full error object\n    }\n};\n```\n\n## Synchronize artifacts\n\nIn your deploy script, first require the plugin:\n```js\nconst ethernal = require('hardhat-ethernal');\n```\nThen, push your artifacts to Ethernal, after deploying your contract:\n\n/!\\ The name parameter needs to match the name of the contract\n```js\nconst Greeter = await hre.ethers.getContractFactory(\"Greeter\");\nconst greeter = await Greeter.deploy(\"Hello, Hardhat!\");\nawait hre.ethernal.push({\n    name: 'Greeter',\n    address: greeter.address,\n    workspace: 'hardhat' // Optional, will override the workspace set in hardhat.config for this call only\n});\n```\n\nBy default, the push function is not going to upload AST to Ethernal. If you want to use \"Storage\" tab on contracts pages, you'll need to activate it. To do so, set the ```hre.ethernalUploadAst = true``` flag in your Hardhat config file (this will upload the ast field, as well as the source field).\n\n## Reset a workspace programmatically\n\nYou can reset a workspace programmatically by calling: `hre.ethernal.resetWorkspace(workspaceName)` (async function). All accounts/blocks/transactions/contracts will be deleted.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftryethernal%2Fhardhat-ethernal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftryethernal%2Fhardhat-ethernal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftryethernal%2Fhardhat-ethernal/lists"}