hardhat: fix docs according to expected kusama launch #563

BigTava · 2025-04-15T10:26:06Z

No description provided.

nhussein11

@BigTava Thanks! Left some comments

nhussein11 · 2025-04-16T11:24:36Z

develop/smart-contracts/dev-environments/hardhat.md

+    To interact with Polkadot Hub, Hardhat requires a plugin to compile contracts to PolkaVM bytecode and the and to spawn a local node compatible with PolkaVM.

    ```bash
-    npm install --save-dev hardhat-resolc hardhat-revive-node
+    npm install --save-dev @parity/hardhat-polkadot


What's the reason for this update? I checked https://www.npmjs.com/ and there is no package named @parity/hardhat-polkadot, so If we move on with this change the instruction would not work

We are releasing an umbrella package to 1) simplify onboarding 2) simplify adding more packages/features without the user having to install them

What do you think about this move?

Yes, having only one package will be much better for devs, I fully agree with that. However, I was suggesting that we need to implement this change only after the package has been deployed and we confirm that the command npm install @parity/hardhat-polkadot actually works

Absolutely. This PR should only be merged after the package is available

ah okay, I'd put this PR as a draft PR then, and it will get unblock once that package is available :)

nhussein11 · 2025-04-16T11:25:51Z

develop/smart-contracts/dev-environments/hardhat.md


- **Remix compiler** - uses the Remix online compiler backend for simplicity and ease of use
+- **Npm compiler** - uses library [@parity/revive](https://www.npmjs.com/package/@parity/revive){target=\_blank} for simplicity and ease of use


Can the @parity/revive be integrated into the hardhat workflow? Otherwise I think this would be misleading

Oh just saw that you can do:

resolc: { compilerSource: 'npm', settings: {}, },

Would it be possible to add a complete example of how to use npm, then, so users can compare the binary and the npm library

Can the @parity/revive be integrated into the hardhat workflow

@parity/revive is already integrated right? Users don't have to install it.

Would it be possible to add a complete example of how to use npm

Is npm.config.ts enough? I am proposing we add full project examples and not just the hardhat.config.ts? What do you think? In addition to this, do you think users will use binary configuration? What if they don't even add this "resolc" key to config? We just compile the thing if the package is imported and if someone wants to debug the compiler they can configure the "resolc" with the binary. Looking forward to your feedback

We do have some full project examples available here - https://github.com/polkadot-developers/polkavm-hardhat-examples

From my experience, the binary configuration was quite complex from a developer experience standpoint. I had to download the binary, switch the solc version on my machine to a compatible one, and then check out and compile a matching version of the Polkadot SDK to generate a compatible substrate-node and eth-rpc-adapter.

Now that there's an npm-based option, I think we should emphasize using that as much as possible.

That said, for this guide—which serves as a starting point for developers—I suggest we explain both approaches. We can highlight the npm.config.ts setup (https://github.com/paritytech/hardhat-polkadot/blob/main/examples/npm.config.ts) and pull that file directly from the Hardhat repo to avoid duplication. After covering the npm path, we can still include the binary configuration for projects that might require customizing the resolc binary, as you mentioned.

@BigTava, what do you think?

We do have some full project examples available here

Nice! Where will you feature these? I think it is key we have an examples folder too in our repo. They will also be part of our e2e test suite. Maybe you could just link to our folder so we reduce maintenance overhead.

what do you think

I think we shouldn't frame 2 options. We just mention there is a more advanced option to compile the contracts. The user shouldn't even need to configure the compiler. It just needs to import the package and it uses the npm as default. For now, let's keep as is and rename Remix -> Npm. But, if you agree, we would reduce the step "Compiling Your Contract" to just step 2 and 3 and briefly mention the binary configuration.

Nice! Where will you feature these? I think it is key we have an examples folder too in our repo. They will also be part of our e2e test suite. Maybe you could just link to our folder so we reduce maintenance overhead.

I believe that for tutorials, we should keep them in the repository I shared previously since it would be easier to update those projects as the tutorial requires if we need to adjust something in the documentation. However, if you all add some projects and examples in the Hardhat Revive repository, we can also add references so that people can check different use cases as soon as those projects are pinned to a specific tag or release, ensuring that the documentation does not break even if the project gets updated.

I think we shouldn't frame 2 options. We just mention there is a more advanced option to compile the contracts. The user shouldn't even need to configure the compiler. It just needs to import the package and it uses the npm as default. For now, let's keep as is and rename Remix -> Npm. But, if you agree, we would reduce the step "Compiling Your Contract" to just step 2 and 3 and briefly mention the binary configuration.

I like this, yeah I agree!

nhussein11 · 2025-04-16T11:28:19Z

develop/smart-contracts/dev-environments/hardhat.md

@@ -109,7 +109,7 @@ To compile your project, follow these instructions:
        --8<-- 'code/develop/smart-contracts/dev-environments/hardhat/hardhat.config.js:65:66'
        ```

-    For the binary configuration, replace `INSERT_PATH_TO_RESOLC_COMPILER` with the proper path to the binary. For more information about its installation, check the [installation](https://github.com/paritytech/revive?tab=readme-ov-file#installation){target=\_blank} section of the `pallet-revive`.
+    For the binary configuration, check the [installation](https://github.com/paritytech/revive?tab=readme-ov-file#installation){target=\_blank} section of the `pallet-revive`.


I wouldn't remove "replace INSERT_PATH_TO_RESOLC_COMPILER with the proper path to the binary. For more information about its installation,". This aims to add clarity for those who have no experience with the plugin, so if we take this out, it would be harder to grasp. Would you agree @BigTava ?

Agree, thanks

Could you please roll back this change?

nhussein11 · 2025-04-16T11:31:04Z

develop/smart-contracts/dev-environments/hardhat.md

@@ -303,7 +303,7 @@ For example, for the default `Lock.sol` contract, you can use the following file
 Run your interaction script:

 ```bash
-npx hardhat run scripts/interact.js --network westendAssetHub
+npx hardhat run scripts/interact.js --network polkadotHub


Perhaps this should be westendHub, in any case, this also requires updating the hardhat.config.js code snippet

We want to avoid using anything but polkadot, to reduce friction. polkadotHub is already a stretch for technical audiences. What is your opinion on this?

Mmm, I do understand your point, and I think @0xLucca worked in a PR to emphasize the usage of Polkadot Hub here - https://github.com/polkadot-developers/polkadot-docs/pull/572/files

But in this case, how would we differentiate if a user is trying to interact with Westend Asset Hub or polkadot asset hub? That's why I thought about using Westend Hub, as it'd be changed here

Exactly, the PR 572 is good. You're right, what about just calling it here in the docs polkadotTestnet? IMO, it would help developers associate westend as a testnet of Polkadot. In the end, I am just trying to minimize the different names we use, which cause real pain in developer onboarding. Polkadot is known for being quite confusing. The change starts here

Totally, I agree with that point. I'm just a bit concerned about Paseo, because if, at some point, Paseo is also upgraded to support polkavm, the word polkadotTestnet would not be enough to cover both, westend and paseo. What do you think?

Good point. I will confirm that point. IMO developers only care, if testnet 1 is better than testnet 2 for some reason. If not, they just care it is a testnet

nhussein11 · 2025-04-22T13:52:44Z

Marking this PR as blocked since it needs to wait until the hardhat-polkadot npm package is realesed (reference)

bee344 · 2025-05-06T14:54:39Z

develop/smart-contracts/dev-environments/hardhat.md

@@ -28,7 +28,7 @@ Before getting started, ensure you have:
 - [Node.js](https://nodejs.org/){target=\_blank} (v16.0.0 or later) and npm installed
 - Basic understanding of Solidity programming
 - Some WND test tokens to cover transaction fees (easily obtainable from the [Polkadot faucet](https://faucet.polkadot.io/westend?parachain=1000){target=\_blank}). To learn how to get test tokens, check out the [Test Tokens](/develop/smart-contracts/connect-to-asset-hub/#test-tokens){target=\_blank} section
- [MetaMask](https://metamask.io/){target=\_blank} installed and connected to [Westend Asset Hub](https://chainlist.org/chain/420420421){target=\_blank}. For more detailed instructions on connecting your wallet, see the [Connect Your Wallet](/develop/smart-contracts/connect-to-asset-hub/#connect-your-wallet){target=\_blank} section
+- [MetaMask](https://metamask.io/){target=\_blank} installed and connected to [Westend Hub](https://chainlist.org/chain/420420421){target=\_blank}. For more detailed instructions on connecting your wallet, see the [Connect Your Wallet](/develop/smart-contracts/connect-to-asset-hub/#connect-your-wallet){target=\_blank} section

 ## Setting Up Hardhat


This whole section needs to be updated, now that we have npx hardhat-polkadot init.

I also thought about that, but I think to also target users that already have a hardhat.config.ts and want to adapt, the existing flow is preferable. But we should use npx hardhat-polkadot init in the tutorial section Setting up the Development Environment. How does that sound to you? Ideally we should have 2 guides: One for Getting started from scratch and another to Migrate existing setup.

If that's the goal, it makes sense 👍

bee344 · 2025-05-06T14:55:50Z

develop/smart-contracts/dev-environments/hardhat.md


- **Remix compiler** - uses the Remix online compiler backend for simplicity and ease of use
+- **Npm compiler** - uses library [@parity/revive](https://www.npmjs.com/package/@parity/revive){target=\_blank} for simplicity and ease of use
 - **Binary compiler** - uses the resolc binary directly for more control and configuration options


Suggested change

- **Binary compiler** - uses the resolc binary directly for more control and configuration options

- **Binary compiler** - uses your local `resolc` binary directly for more control and configuration options

bee344 · 2025-05-06T15:00:30Z

develop/smart-contracts/dev-environments/hardhat.md

+6. Deploy your contract using Ignition:
+
+    ```bash
+    npx hardhat ignition deploy ./ignition/modules/Lock.js --network westendHub


If we are running a local node in the previous step, we should use --network localhost. Or if we want to make a live deployment the step 5 doesn't make sense.

Removed step 5. For some reason I couldn't deploy to westendHub without the node running

bee344 · 2025-05-06T15:00:54Z

develop/smart-contracts/dev-environments/hardhat.md

@@ -303,7 +313,7 @@ For example, for the default `Lock.sol` contract, you can use the following file
 Run your interaction script:

 ```bash
-npx hardhat run scripts/interact.js --network westendAssetHub
+npx hardhat run scripts/interact.js --network westendHub


Same comment as above

…to staging-ah-smart-contracts

…polkadot (#623) * hardhat: fix docs according to expected kusama launch (#563) * hardhat: fix docs according to expected kusama launch * fix: title * feat: proposes hardhat.config and hardhat.md * fix: rename polkadotTestnest to westendHub * fix: replaces `npx hardhat node` with `npx hardhat node-polkavm` * docs: small changes in "Use Hardhat with Polkadot" * docs: minor fixes * fix: tested and adjusting snippets * Apply suggestions from code review Co-authored-by: Alberto Nicolas Penayo <[email protected]> * fix: optimizer settings * Update develop/smart-contracts/dev-environments/hardhat.md Co-authored-by: Alberto Nicolas Penayo <[email protected]> * fix: missing polkavm true * fix: docs * fix: placeholder * Apply suggestions from code review Co-authored-by: Erin Shaben <[email protected]> * fix: feedback --------- Co-authored-by: Tiago Tavares ⭕️ <[email protected]> Co-authored-by: Alberto Nicolas Penayo <[email protected]> Co-authored-by: Erin Shaben <[email protected]>

hardhat: fix docs according to expected kusama launch

c80519f

BigTava requested a review from a team as a code owner April 15, 2025 10:26

fix: title

53de2db

eshaben requested review from nhussein11 and 0xLucca April 15, 2025 22:31

nhussein11 reviewed Apr 16, 2025

View reviewed changes

BigTava added 2 commits April 21, 2025 20:15

feat: proposes hardhat.config and hardhat.md

e63161a

fix: rename polkadotTestnest to westendHub

2c028f8

nhussein11 added the B2 - Blocked Pull request is blocked and should not be merged label Apr 22, 2025

BigTava added 2 commits April 23, 2025 18:50

fix: replaces npx hardhat node with npx hardhat node-polkavm

1d6e1f3

docs: small changes in "Use Hardhat with Polkadot"

f3be48a

bee344 reviewed May 6, 2025

View reviewed changes

BigTava added 2 commits May 8, 2025 10:26

docs: minor fixes

29d122d

Merge remote-tracking branch 'upstream/staging-ah-smart-contracts' in…

37ad3e8

…to staging-ah-smart-contracts

nhussein11 changed the base branch from staging-ah-smart-contracts to nhussein11/update-hardhat-polkadot-docs May 9, 2025 12:38

nhussein11 changed the base branch from nhussein11/update-hardhat-polkadot-docs to staging-ah-smart-contracts May 9, 2025 12:38

nhussein11 changed the base branch from staging-ah-smart-contracts to nhussein11/update-hardhat-polkadot-docs May 9, 2025 12:40

nhussein11 merged commit 50457ac into polkadot-developers:nhussein11/update-hardhat-polkadot-docs May 9, 2025

nhussein11 mentioned this pull request May 9, 2025

[FIX] - Update hardhat guide according to latest releases of hardhat-polkadot #623

Merged


		- Remix compiler - uses the Remix online compiler backend for simplicity and ease of use
		- Npm compiler - uses library [@parity/revive](https://www.npmjs.com/package/@parity/revive){target=\_blank} for simplicity and ease of use

	- Binary compiler - uses the resolc binary directly for more control and configuration options
	- Binary compiler - uses your local `resolc` binary directly for more control and configuration options

hardhat: fix docs according to expected kusama launch #563

hardhat: fix docs according to expected kusama launch #563

Uh oh!

Conversation

BigTava commented Apr 15, 2025

Uh oh!

nhussein11 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

BigTava Apr 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

BigTava Apr 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

BigTava Apr 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nhussein11 Apr 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nhussein11 commented Apr 22, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

BigTava May 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

BigTava Apr 21, 2025 •

edited

Loading

BigTava Apr 21, 2025 •

edited

Loading

BigTava Apr 21, 2025 •

edited

Loading

nhussein11 Apr 21, 2025 •

edited

Loading

BigTava May 6, 2025 •

edited

Loading

BigTava May 8, 2025 •

edited

Loading