Merge pull request #82 from paritytech/anp-docs

bee344 · web-flow · commit 8e3b243a932f · 2025-04-29T17:50:47.000-03:00
chore(docs): fix docs and update references
diff --git a/README.md b/README.md
@@ -21,17 +21,18 @@ Overview of currently available plugins and those on the roadmap.
 
 | 🔌 Plugin                     | 📄 Description                                                                                                                    |
 |-------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|
-| [hardhat-polkadot-resolc](https://github.com/paritytech/hardhat-revive/tree/main/packages/hardhat-resolc)           | Compiles solidity smart contracts for the Polkadot network, creating PolkaVM compatible hardhat artifacts.                              |
-| [hardhat-polkadot-node](https://github.com/paritytech/hardhat-revive/blob/main/packages/hardhat-revive-node/README.md)         | Run a Polkadot node locally 
+| [hardhat-polkadot](https://github.com/paritytech/hardhat-polkadot/tree/main/packages/hardhat-polkadot)           | Umbrella plugin that provides full functionality and a convenient cli.                              |
+| [hardhat-polkadot-resolc](https://github.com/paritytech/hardhat-polkadot/tree/main/packages/hardhat-polkadot-resolc)           | Compiles solidity smart contracts for the Polkadot network, creating PolkaVM compatible hardhat artifacts.                              |
+| [hardhat-polkadot-node](https://github.com/paritytech/hardhat-polkadot/blob/main/packages/hardhat-polkadot-node/README.md)         | Run a Polkadot node locally 
 
 ## Getting Started
 
 * Find instructions in [Develop -> Smart Contracts -> Dev Environments -> Hardhat](https://papermoonio.github.io/polkadot-mkdocs/develop/smart-contracts/dev-environments/hardhat/)
 
 ## Usage
 
-* See [Examples](https://github.com/paritytech/hardhat-revive/tree/main/examples)
-* Get started from a boilerplate with [create-polkadot-dapp](https://github.com/paritytech/create-polkadot-dapp).
+* See [Examples](https://github.com/paritytech/hardhat-polkadot/tree/main/examples)
+* Get started from a boilerplate by running `npx hardhat-polkadot init`.
 
 ## Getting Help
 
diff --git a/examples/README.md b/examples/README.md
@@ -5,8 +5,8 @@ configuration for different environments. This is not meant to be an extensive
 combination rather than a guide to kick start plugin usage.
 
 To know more about how to configure the compiler, take a look at the configuration
-[type](/packages/hardhat-resolc/src/types.ts) and the `resolc` compiler's 
+[type](/packages/hardhat-polkadot-resolc/src/types.ts) and the `resolc` compiler's 
 `--help` section.
 
 To know more about how to configure the node, take a look at the configuration
-[type](/packages/hardhat-revive-node/src/types.ts) andor run  `npx hardhat node-polkavm --help`.
+[type](/packages/hardhat-polkadot-node/src/types.ts) andor run  `npx hardhat node-polkadot --help`.
diff --git a/examples/forkWithAdapter.config.ts b/examples/forkWithAdapter.config.ts
@@ -1,6 +1,5 @@
 import { HardhatUserConfig } from "hardhat/config"
-import "hardhat-resolc"
-import "hardhat-revive-node"
+import "@parity/hardhat-polkadot"
 
 const config: HardhatUserConfig = {
     solidity: "0.8.26",
diff --git a/examples/forkWithoutAdapter.config.ts b/examples/forkWithoutAdapter.config.ts
@@ -1,6 +1,5 @@
 import { HardhatUserConfig } from "hardhat/config"
-import "hardhat-resolc"
-import "hardhat-revive-node"
+import "@parity/hardhat-polkadot"
 
 const config: HardhatUserConfig = {
     solidity: "0.8.26",
diff --git a/examples/localNode.config.ts b/examples/localNode.config.ts
@@ -1,6 +1,5 @@
 import { HardhatUserConfig } from "hardhat/config"
-import "../hardhat-revive/packages/hardhat-resolc/src/index"
-import "../hardhat-revive/packages/hardhat-revive-node/src/index"
+import "@parity/hardhat-polkadot"
 
 const config: HardhatUserConfig = {
     solidity: "0.8.28",
diff --git a/examples/npm.config.ts b/examples/npm.config.ts
@@ -1,5 +1,5 @@
 import { HardhatUserConfig } from "hardhat/config"
-import "hardhat-resolc"
+import "@parity/hardhat-polkadot"
 
 const config: HardhatUserConfig = {
     solidity: "0.8.28",
diff --git a/examples/npmWithoutOptimization.config.ts b/examples/npmWithoutOptimization.config.ts
@@ -1,5 +1,5 @@
 import { HardhatUserConfig } from "hardhat/config"
-import "@parity/hardhat-polkadot-resolc"
+import "@parity/hardhat-polkadot"
 
 const config: HardhatUserConfig = {
     solidity: "0.8.28",
diff --git a/packages/hardhat-polkadot-node/src/constants.ts b/packages/hardhat-polkadot-node/src/constants.ts
@@ -1,9 +1,9 @@
-export const PLUGIN_NAME = "hardhat-revive-node"
+export const PLUGIN_NAME = "hardhat-polkadot-node"
 
-export const TASK_NODE_POLKAVM = "node-polkavm"
-export const TASK_NODE_POLKAVM_CREATE_SERVER = "node-polkavm:create-server"
-export const TASK_NODE_POLKAVM_CREATE_ETH_ADAPTER = "node-polkavm:create-eth-adapter"
-export const TASK_RUN_POLKAVM_NODE_IN_SEPARATE_PROCESS = "node-polkavm:run-in-separate-process"
+export const TASK_NODE_POLKADOT = "node-polkadot"
+export const TASK_NODE_POLKADOT_CREATE_SERVER = "node-polkadot:create-server"
+export const TASK_NODE_POLKADOT_CREATE_ETH_ADAPTER = "node-polkadot:create-eth-adapter"
+export const TASK_RUN_POLKADOT_NODE_IN_SEPARATE_PROCESS = "node-polkadot:run-in-separate-process"
 
 export const PROCESS_TERMINATION_SIGNALS = ["SIGINT", "SIGTERM", "SIGKILL"]
 
@@ -13,12 +13,12 @@ export const MAX_PORT_ATTEMPTS = 10
 export const PORT_CHECK_DELAY = 500
 export const RPC_ENDPOINT_PATH = "eth_chainId"
 
-export const POLKAVM_TEST_NODE_NETWORK_NAME = "Kitchensink"
+export const POLKADOT_TEST_NODE_NETWORK_NAME = "Kitchensink"
 
 export const BASE_URL = `http://127.0.0.1`
 export const NETWORK_ACCOUNTS = {
     REMOTE: "remote",
-    POLKAVM: [
+    POLKADOT: [
         "0x5fb92d6e98884f76de468fa3f6278f8807c48bebc13595d45af5bdc4da702133",
         "0x5fb92d6e98884f76de468fa3f6278f8807c48bebc13595d45af5b0000a702133",
         "0x5fb92c48bebcd6e98884f76de468fa3f6278f880713595d45af5b0000a702133",
diff --git a/packages/hardhat-polkadot-node/src/core/global-interceptor.ts b/packages/hardhat-polkadot-node/src/core/global-interceptor.ts
@@ -2,33 +2,33 @@ import { HardhatRuntimeEnvironment, RunSuperFunction, TaskArguments } from "hard
 import { GlobalWithHardhatContext } from "hardhat/src/internal/context"
 import { HARDHAT_NETWORK_NAME } from "hardhat/plugins"
 import { configureNetwork, startServer, waitForNodeToBeReady } from "../utils"
-import { PolkaVMTasksWithWrappedNode } from "./global-task"
+import { PolkadotTasksWithWrappedNode } from "./global-task"
 import { Environment } from "hardhat/internal/core/runtime-environment"
 
 export function interceptAndWrapTasksWithNode() {
-    const polkaVMGlobal = global as PolkaVMTasksWithWrappedNode & GlobalWithHardhatContext
-    const taskMap = polkaVMGlobal.__hardhatContext.tasksDSL.getTaskDefinitions()
+    const polkadotGlobal = global as PolkadotTasksWithWrappedNode & GlobalWithHardhatContext
+    const taskMap = polkadotGlobal.__hardhatContext.tasksDSL.getTaskDefinitions()
 
-    if (!polkaVMGlobal._polkaVMTasksForWrapping) {
+    if (!polkadotGlobal._polkadotTasksForWrapping) {
         return
     }
 
-    polkaVMGlobal._polkaVMTasksForWrapping.taskNames.forEach((taskName) => {
+    polkadotGlobal._polkadotTasksForWrapping.taskNames.forEach((taskName) => {
         const foundTask = taskMap[taskName]
 
         if (!foundTask) {
             return
         }
 
         if (foundTask.isSubtask) {
-            polkaVMGlobal.__hardhatContext.tasksDSL.subtask(
+            polkadotGlobal.__hardhatContext.tasksDSL.subtask(
                 foundTask.name,
                 foundTask.description,
                 wrapTaskWithNode,
             )
         }
 
-        polkaVMGlobal.__hardhatContext.tasksDSL.task(
+        polkadotGlobal.__hardhatContext.tasksDSL.task(
             foundTask.name,
             foundTask.description,
             wrapTaskWithNode,
@@ -44,7 +44,7 @@ async function wrapTaskWithNode(
     if (env.network.polkavm !== true || env.network.name !== HARDHAT_NETWORK_NAME) {
         return await runSuper(taskArgs)
     }
-    const polkaVMGlobal = global as PolkaVMTasksWithWrappedNode;
+    const polkadotGlobal = global as PolkadotTasksWithWrappedNode;
 
     const { commandArgs, server, port } = await startServer({
         forking: env.config.networks.hardhat.forking,
@@ -58,10 +58,10 @@ async function wrapTaskWithNode(
         const oldNetwork = env.network;
         await configureNetwork(env.config, env.network, port);
         (env as unknown as Environment).injectToGlobal();
-        polkaVMGlobal._polkaVMNodeNetwork = env.network;
+        polkadotGlobal._polkadotNodeNetwork = env.network;
         const result = await runSuper(taskArgs);
         (env as unknown as Environment).network = oldNetwork;
-        delete polkaVMGlobal._polkaVMNodeNetwork;
+        delete polkadotGlobal._polkadotNodeNetwork;
         (env as unknown as Environment).injectToGlobal();
         return result
     } finally {
diff --git a/packages/hardhat-polkadot-node/src/core/global-task.ts b/packages/hardhat-polkadot-node/src/core/global-task.ts
@@ -1,11 +1,11 @@
 import { Network } from "hardhat/types"
 
-export type PolkaVMTasksWithWrappedNode = typeof global & {
-    _polkaVMTasksForWrapping: PolkaVMTasksForWrapping
-    _polkaVMNodeNetwork?: Network
+export type PolkadotTasksWithWrappedNode = typeof global & {
+    _polkadotTasksForWrapping: PolkadotTasksForWrapping
+    _polkadotNodeNetwork?: Network
 }
 
-export class PolkaVMTasksForWrapping {
+export class PolkadotTasksForWrapping {
     public taskNames: string[] = []
 
     constructor() {
diff --git a/packages/hardhat-polkadot-node/src/core/register.ts b/packages/hardhat-polkadot-node/src/core/register.ts
@@ -14,7 +14,7 @@ import { LazyInitializationProviderAdapter } from "hardhat/internal/core/provide
 import { log } from "console"
 import { createProvider } from "hardhat/internal/core/providers/construction"
 import { Artifacts } from "hardhat/internal/artifacts"
-import { BASE_URL, POLKAVM_TEST_NODE_NETWORK_NAME } from "../constants"
+import { BASE_URL, POLKADOT_TEST_NODE_NETWORK_NAME } from "../constants"
 import { getNetworkConfig } from "../utils"
 import "source-map-support/register";
 
@@ -48,9 +48,9 @@ if (!HardhatContext.isCreated()) {
         ctx.providerExtenders,
     )
 
-    const polkaVMNodePort = process.env.PolkaVMNodePort
-    const url = `${BASE_URL}:${polkaVMNodePort}`
-    const networkName = POLKAVM_TEST_NODE_NETWORK_NAME
+    const polkadotNodePort = process.env.polkadotNodePort
+    const url = `${BASE_URL}:${polkadotNodePort}`
+    const networkName = POLKADOT_TEST_NODE_NETWORK_NAME
 
     env.network.name = networkName
     Object.assign(env.network.config, getNetworkConfig(url))
diff --git a/packages/hardhat-polkadot-node/src/core/script-runner.ts b/packages/hardhat-polkadot-node/src/core/script-runner.ts
@@ -25,7 +25,7 @@ export async function runScript(
     await server.listen(commandArgs.nodeCommands, commandArgs.adapterCommands, false)
     await waitForNodeToBeReady(port)
 
-    const envVars = { ...process.env, ...extraEnvVars, PolkaVMNodePort: port.toString() }
+    const envVars = { ...process.env, ...extraEnvVars, polkadotNodePort: port.toString() }
 
     return new Promise((resolve, reject) => {
         const childProcess = fork(scriptPath, scriptArgs, {
diff --git a/packages/hardhat-polkadot-node/src/errors.ts b/packages/hardhat-polkadot-node/src/errors.ts
@@ -1,7 +1,7 @@
 import { HardhatPluginError } from "hardhat/plugins"
 import { PLUGIN_NAME } from "./constants"
 
-export class PolkaVMNodePluginError extends HardhatPluginError {
+export class PolkadotNodePluginError extends HardhatPluginError {
     constructor(message: string, parentError?: Error) {
         super(PLUGIN_NAME, message, parentError)
     }
diff --git a/packages/hardhat-polkadot-node/src/index.ts b/packages/hardhat-polkadot-node/src/index.ts
@@ -16,9 +16,9 @@ import {
     NODE_START_PORT,
     ETH_RPC_ADAPTER_START_PORT,
     MAX_PORT_ATTEMPTS,
-    TASK_NODE_POLKAVM,
-    TASK_NODE_POLKAVM_CREATE_SERVER,
-    TASK_RUN_POLKAVM_NODE_IN_SEPARATE_PROCESS,
+    TASK_NODE_POLKADOT,
+    TASK_NODE_POLKADOT_CREATE_SERVER,
+    TASK_RUN_POLKADOT_NODE_IN_SEPARATE_PROCESS,
 } from "./constants"
 import { JsonRpcServer } from "./server"
 import {
@@ -28,7 +28,7 @@ import {
     getAvailablePort,
     waitForNodeToBeReady,
 } from "./utils"
-import { PolkaVMNodePluginError } from "./errors"
+import { PolkadotNodePluginError } from "./errors"
 import { interceptAndWrapTasksWithNode } from "./core/global-interceptor"
 import { runScriptWithHardhat } from "./core/script-runner"
 import { AdapterConfig, NodeConfig, RpcServer } from "./types"
@@ -52,23 +52,23 @@ task(TASK_RUN).setAction(async (args, hre, runSuper) => {
     );
 });
 
-subtask(TASK_NODE_POLKAVM_CREATE_SERVER, 'Creates a JSON-RPC server for PolkaVM node')
+subtask(TASK_NODE_POLKADOT_CREATE_SERVER, 'Creates a JSON-RPC server for Polkadot node')
     .addOptionalParam('nodePath', 'Path to the node binary file', undefined, types.string)
     .addOptionalParam('adapterPath', 'Path to the Eth Rpc Adapter binary file', undefined, types.string)
     .setAction(async ({ nodePath, adapterPath }: { nodePath: string; adapterPath: string }) => {
         const server: JsonRpcServer = new JsonRpcServer(nodePath, adapterPath);
         return server;
     });
 
-task(TASK_NODE, 'Start a PolkaVM Node').setAction(async (args: TaskArguments, { network, run }, runSuper) => {
+task(TASK_NODE, 'Start a Polkadot Node').setAction(async (args: TaskArguments, { network, run }, runSuper) => {
     if (network.polkavm !== true || network.name !== HARDHAT_NETWORK_NAME) {
         return await runSuper();
     }
 
-    await run(TASK_NODE_POLKAVM, args);
+    await run(TASK_NODE_POLKADOT, args);
 });
 
-task(TASK_NODE_POLKAVM, 'Starts a JSON-RPC server for PolkaVM node')
+task(TASK_NODE_POLKADOT, 'Starts a JSON-RPC server for Polkadot node')
     .addOptionalParam('nodeBinaryPath', 'Path to the substrate node binary', undefined, types.string)
     .addOptionalParam('rpcPort', 'Port where the node will listen on - default: 8000', undefined, types.int)
     .addOptionalParam('adapterBinaryPath', 'Path to the eth-rpc-adapter binary', undefined, types.string)
@@ -133,7 +133,7 @@ task(TASK_NODE_POLKAVM, 'Starts a JSON-RPC server for PolkaVM node')
                 ? adapterBinaryPath
                 : userConfig.networks?.hardhat?.adapterConfig?.adapterBinaryPath;
 
-            const server: RpcServer = await run(TASK_NODE_POLKAVM_CREATE_SERVER, {
+            const server: RpcServer = await run(TASK_NODE_POLKADOT_CREATE_SERVER, {
                 nodePath,
                 adapterPath,
             })
@@ -142,21 +142,21 @@ task(TASK_NODE_POLKAVM, 'Starts a JSON-RPC server for PolkaVM node')
                 await server.listen(commandArgs.nodeCommands, commandArgs.adapterCommands)
                 // eslint-disable-next-line @typescript-eslint/no-explicit-any
             } catch (error: any) {
-                throw new PolkaVMNodePluginError(`Failed when running node: ${error.message}`)
+                throw new PolkadotNodePluginError(`Failed when running node: ${error.message}`)
             }
         },
     )
 
 subtask(
-    TASK_RUN_POLKAVM_NODE_IN_SEPARATE_PROCESS,
-    "Runs a Hardhat PolkaVM task in a separate process.",
+    TASK_RUN_POLKADOT_NODE_IN_SEPARATE_PROCESS,
+    "Runs a Hardhat Polkadot task in a separate process.",
 )
-    .addVariadicPositionalParam("taskArgs", "Arguments for the Hardhat PolkaVM task.")
+    .addVariadicPositionalParam("taskArgs", "Arguments for the Hardhat Polkadot task.")
     .setAction(async ({ taskArgs = [] }, _hre) => {
         const currentPort = await getAvailablePort(ETH_RPC_ADAPTER_START_PORT, MAX_PORT_ATTEMPTS)
         const adjustedArgs = adjustTaskArgsForPort(taskArgs, currentPort)
 
-        const taskProcess = spawn("npx", ["hardhat", TASK_NODE_POLKAVM, ...adjustedArgs], {
+        const taskProcess = spawn("npx", ["hardhat", TASK_NODE_POLKADOT, ...adjustedArgs], {
             detached: true,
         })
 
@@ -256,7 +256,7 @@ task(
             return testFailures
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         } catch (error: any) {
-            throw new PolkaVMNodePluginError(`Failed when running node: ${error.message}`)
+            throw new PolkadotNodePluginError(`Failed when running node: ${error.message}`)
         }
     },
 )
diff --git a/packages/hardhat-polkadot-node/src/server.ts b/packages/hardhat-polkadot-node/src/server.ts
@@ -3,7 +3,7 @@ import chalk from "chalk"
 
 import { NODE_START_PORT, ETH_RPC_ADAPTER_START_PORT } from "./constants"
 import { RpcServer } from "./types"
-import { PolkaVMNodePluginError } from "./errors"
+import { PolkadotNodePluginError } from "./errors"
 
 export class JsonRpcServer implements RpcServer {
     private serverProcess: ChildProcess | null = null
@@ -28,7 +28,7 @@ export class JsonRpcServer implements RpcServer {
             const nodePort = nodePortArg ? parseInt(nodePortArg.split("=")[1], 10) : NODE_START_PORT
 
             if (blockProcess) {
-                console.info(chalk.green(`Starting server at 127.0.0.1:${nodePortArg}`))
+                console.info(chalk.green(`Starting server at 127.0.0.1:${nodePort}`))
                 console.info(
                     chalk.green(`Running command: ${nodeCommand} ${nodeCommandArgs.join(" ")}`),
                 )
@@ -46,7 +46,7 @@ export class JsonRpcServer implements RpcServer {
             const adapterCommand = this.adapterBinaryPath
 
             if (!adapterCommand) {
-                throw new PolkaVMNodePluginError('A path for the Eth RPC Adapter must be provided.');
+                throw new PolkadotNodePluginError('A path for the Eth RPC Adapter must be provided.');
             }
 
             const adapterPortArg = adapterArgs.find((arg) => arg.startsWith('--port='));
diff --git a/packages/hardhat-polkadot-node/src/utils.ts b/packages/hardhat-polkadot-node/src/utils.ts
diff --git a/packages/hardhat-polkadot/src/cli/project-creation.ts b/packages/hardhat-polkadot/src/cli/project-creation.ts
