FIX - web3js refactor #1244
FIX - web3js refactor #1244
Conversation
nhussein11
had a problem deploying
to
n8n-sending
GitHub Actions
Failure
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the Web3.js documentation to migrate from PolkaVM-specific compilation (using @parity/resolc) to standard EVM compilation (using solc). The changes align Web3.js usage with standard Ethereum tooling while maintaining compatibility with Polkadot Hub's Ethereum RPC endpoint.
Key changes:
- Replaced PolkaVM compilation workflow with standard EVM/solc compilation
- Updated project structure to use
.binfiles instead of.polkavmfiles - Modified deployment and interaction scripts to work with EVM bytecode
- Enhanced documentation with step-by-step deployment instructions
Reviewed Changes
Copilot reviewed 9 out of 10 changed files in this pull request and generated 13 comments.
Show a summary per file
| File | Description |
|---|---|
| smart-contracts/libraries/web3-js.md | Main documentation updated to reflect EVM compilation approach and improved tutorial structure |
| llms.txt | Updated page title and description to match new content focus |
| llms-full.jsonl | Regenerated AI training data with updated Web3.js documentation content |
| .snippets/code/smart-contracts/libraries/web3-js/compile.js | Replaced resolc compiler with solc for standard EVM bytecode generation |
| .snippets/code/smart-contracts/libraries/web3-js/deploy.js | Updated to read .bin files and use CommonJS module syntax |
| .snippets/code/smart-contracts/libraries/web3-js/updateStorage.js | Refactored to use CommonJS and updated file path handling |
| .ai/site-index.json | Updated metadata including title, preview text, and outline structure |
| .ai/pages/smart-contracts-libraries-web3-js.md | Regenerated AI-friendly page with complete updated documentation |
| .ai/categories/tooling.md | Added full Web3.js content to tooling category index |
| .ai/categories/smart-contracts.md | Added full Web3.js content to smart contracts category index |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ``` | ||
|
|
||
| To execute the logic above, run: | ||
| Ensure you replace the `INSERT_MNEMONIC`, `INSERT_CONTRACT_ADDRESS`, and `INSERT_ADDRESS_TO_CHECK` placeholders with actual values. Also, ensure the contract ABI file (`Storage.json`) is correctly referenced. The script prints the balance for `ADDRESS_TO_CHECK` before it writes and doubles the stored value, so pick any account you want to monitor. |
There was a problem hiding this comment.
The documentation mentions placeholders INSERT_MNEMONIC and INSERT_ADDRESS_TO_CHECK, but the actual updateStorage.js code only contains INSERT_PRIVATE_KEY and INSERT_CONTRACT_ADDRESS. The documentation also incorrectly states "The script prints the balance for ADDRESS_TO_CHECK before it writes and doubles the stored value" - but the script actually sets the value to 1 (not doubling it) and doesn't print any balance. This description appears to be copied from a different example and doesn't match the actual code.
| Ensure you replace the `INSERT_MNEMONIC`, `INSERT_CONTRACT_ADDRESS`, and `INSERT_ADDRESS_TO_CHECK` placeholders with actual values. Also, ensure the contract ABI file (`Storage.json`) is correctly referenced. The script prints the balance for `ADDRESS_TO_CHECK` before it writes and doubles the stored value, so pick any account you want to monitor. | |
| Ensure you replace the `INSERT_PRIVATE_KEY` and `INSERT_CONTRACT_ADDRESS` placeholders with actual values. Also, ensure the contract ABI file (`Storage.json`) is correctly referenced. The script sets the stored value to 1; you can modify the script to change this value as needed. |
| ## Interact with the Contract | ||
|
|
||
| Once deployed, you can interact with your contract using Web3.js methods. Here's how to set a number and read it back, ensure replacing `INSERT_RPC_URL`, `INSERT_PRIVATE_KEY`, and `INSERT_CONTRACT_ADDRESS` with the appropriate values: | ||
| Once the contract is deployed, you can interact with it by calling its functions. For example, to set a number, read it and then modify that number by its double, you can create a file named `updateStorage.js` in the root of your project and add the following code: |
There was a problem hiding this comment.
The description says "to set a number, read it and then modify that number by its double" but the actual code sets the number to a fixed value of 1 (line 33), not doubling the current value. The documentation should accurately describe what the code does: "to set a number to 1 and read back the stored value".
| Once the contract is deployed, you can interact with it by calling its functions. For example, to set a number, read it and then modify that number by its double, you can create a file named `updateStorage.js` in the root of your project and add the following code: | |
| Once the contract is deployed, you can interact with it by calling its functions. For example, to set a number to 1 and read back the stored value, you can create a file named `updateStorage.js` in the root of your project and add the following code: |
| privateKey: 'INSERT_PRIVATE_KEY', | ||
| contractName: 'INSERT_CONTRACT_NAME', | ||
| const providerConfig = { | ||
| rpc: 'https://testnet-passet-hub-eth-rpc.polkadot.io', // TODO: replace to `https://services.polkadothub-rpc.com/testnet` when ready |
There was a problem hiding this comment.
The TODO comment suggests replacing the RPC URL with https://services.polkadothub-rpc.com/testnet when ready. If this is a permanent TODO that developers should be aware of, it should be documented. If the current URL is the correct one to use, the TODO should be removed.
| rpc: 'https://testnet-passet-hub-eth-rpc.polkadot.io', // TODO: replace to `https://services.polkadothub-rpc.com/testnet` when ready | |
| rpc: 'https://services.polkadothub-rpc.com/testnet', |
| ## Interact with the Contract | ||
|
|
||
| Once deployed, you can interact with your contract using Web3.js methods. Here's how to set a number and read it back, ensure replacing `INSERT_RPC_URL`, `INSERT_PRIVATE_KEY`, and `INSERT_CONTRACT_ADDRESS` with the appropriate values: | ||
| Once the contract is deployed, you can interact with it by calling its functions. For example, to set a number, read it and then modify that number by its double, you can create a file named `updateStorage.js` in the root of your project and add the following code: |
There was a problem hiding this comment.
The description says "to set a number, read it and then modify that number by its double" but the actual code sets the number to a fixed value of 1, not doubling the current value. The documentation should accurately describe what the code does: "to set a number to 1 and read back the stored value".
| Once the contract is deployed, you can interact with it by calling its functions. For example, to set a number, read it and then modify that number by its double, you can create a file named `updateStorage.js` in the root of your project and add the following code: | |
| Once the contract is deployed, you can interact with it by calling its functions. For example, to set the stored number to `1` and read back the stored value, you can create a file named `updateStorage.js` in the root of your project and add the following code: |
|
|
||
| ## Interact with the Contract | ||
|
|
||
| Once the contract is deployed, you can interact with it by calling its functions. For example, to set a number, read it and then modify that number by its double, you can create a file named `updateStorage.js` in the root of your project and add the following code: |
There was a problem hiding this comment.
The description says "to set a number, read it and then modify that number by its double" but the actual code sets the number to a fixed value of 1, not doubling the current value. The documentation should accurately describe what the code does: "to set a number to 1 and read back the stored value".
| Once the contract is deployed, you can interact with it by calling its functions. For example, to set a number, read it and then modify that number by its double, you can create a file named `updateStorage.js` in the root of your project and add the following code: | |
| Once the contract is deployed, you can interact with it by calling its functions. For example, to set a number to 1 and read back the stored value, you can create a file named `updateStorage.js` in the root of your project and add the following code: |
| .catch((error) => console.error('Update error')); | ||
| ``` | ||
|
|
||
| Ensure you replace the `INSERT_MNEMONIC`, `INSERT_CONTRACT_ADDRESS`, and `INSERT_ADDRESS_TO_CHECK` placeholders with actual values. Also, ensure the contract ABI file (`Storage.json`) is correctly referenced. The script prints the balance for `ADDRESS_TO_CHECK` before it writes and doubles the stored value, so pick any account you want to monitor. |
There was a problem hiding this comment.
The documentation mentions placeholders INSERT_MNEMONIC and INSERT_ADDRESS_TO_CHECK, but the actual updateStorage.js code only contains INSERT_PRIVATE_KEY and INSERT_CONTRACT_ADDRESS. The documentation also incorrectly states "The script prints the balance for ADDRESS_TO_CHECK before it writes and doubles the stored value" - but the script actually sets the value to 1 (not doubling it) and doesn't print any balance. This description appears to be copied from a different example and doesn't match the actual code.
| Ensure you replace the `INSERT_MNEMONIC`, `INSERT_CONTRACT_ADDRESS`, and `INSERT_ADDRESS_TO_CHECK` placeholders with actual values. Also, ensure the contract ABI file (`Storage.json`) is correctly referenced. The script prints the balance for `ADDRESS_TO_CHECK` before it writes and doubles the stored value, so pick any account you want to monitor. | |
| Ensure you replace the `INSERT_PRIVATE_KEY` and `INSERT_CONTRACT_ADDRESS` placeholders with actual values. Also, ensure the contract ABI file (`Storage.json`) is correctly referenced. The script prints the current stored value, sets it to 1, and then prints the new stored value. |
| !!! tip | ||
| The sample scripts use ECMAScript modules. Add `"type": "module"` to your `package.json` (or rename the files to `.mjs`) so that `node` can run the `import` statements. |
There was a problem hiding this comment.
The documentation states that "The sample scripts use ECMAScript modules" but the actual code snippets use CommonJS (require, module.exports). This is inconsistent. Either the tip should state the scripts use CommonJS, or the scripts should be updated to use ES modules with import statements.
| !!! tip | ||
| The sample scripts use ECMAScript modules. Add `"type": "module"` to your `package.json` (or rename the files to `.mjs`) so that `node` can run the `import` statements. |
There was a problem hiding this comment.
The documentation states that "The sample scripts use ECMAScript modules" but the actual code snippets use CommonJS (require, module.exports). This is inconsistent. Either the tip should state the scripts use CommonJS, or the scripts should be updated to use ES modules with import statements.
| | [ETH Native](/smart-contracts/precompiles/eth-native/){target=\_blank} | EVM precompiles and interfaces | | ||
| | [Staking](/smart-contracts/precompiles/staking/){target=\_blank} | Interact with staking functionality via precompiles | | ||
| | [XCM](/smart-contracts/precompiles/xcm/){target=\_blank} | Cross‑chain messaging helpers for contracts | | ||
| Ensure you replace the `INSERT_MNEMONIC`, `INSERT_CONTRACT_ADDRESS`, and `INSERT_ADDRESS_TO_CHECK` placeholders with actual values. Also, ensure the contract ABI file (`Storage.json`) is correctly referenced. The script prints the balance for `ADDRESS_TO_CHECK` before it writes and doubles the stored value, so pick any account you want to monitor. |
There was a problem hiding this comment.
The documentation mentions placeholders INSERT_MNEMONIC and INSERT_ADDRESS_TO_CHECK, but the actual updateStorage.js code only contains INSERT_PRIVATE_KEY and INSERT_CONTRACT_ADDRESS. The documentation also incorrectly states "The script prints the balance for ADDRESS_TO_CHECK before it writes and doubles the stored value" - but the script actually sets the value to 1 (not doubling it) and doesn't print any balance. This description appears to be copied from a different example and doesn't match the actual code.
| Ensure you replace the `INSERT_MNEMONIC`, `INSERT_CONTRACT_ADDRESS`, and `INSERT_ADDRESS_TO_CHECK` placeholders with actual values. Also, ensure the contract ABI file (`Storage.json`) is correctly referenced. The script prints the balance for `ADDRESS_TO_CHECK` before it writes and doubles the stored value, so pick any account you want to monitor. | |
| Ensure you replace the `INSERT_PRIVATE_KEY` and `INSERT_CONTRACT_ADDRESS` placeholders with actual values. Also, ensure the contract ABI file (`Storage.json`) is correctly referenced. The script prints the current stored value, sets it to 1, and then prints the new stored value. |
|
|
||
| ## Ethereum Developer Resources | ||
| Once the contract is deployed, you can interact with it by calling its functions. For example, to set a number, read it and then modify that number by its double, you can create a file named `updateStorage.js` in the root of your project and add the following code: |
There was a problem hiding this comment.
The description says "to set a number, read it and then modify that number by its double" but the actual code sets the number to a fixed value of 1, not doubling the current value. The documentation should accurately describe what the code does: "to set a number to 1 and read back the stored value".
| Once the contract is deployed, you can interact with it by calling its functions. For example, to set a number, read it and then modify that number by its double, you can create a file named `updateStorage.js` in the root of your project and add the following code: | |
| Once the contract is deployed, you can interact with it by calling its functions. For example, to set a number to 1 and read back the stored value, you can create a file named `updateStorage.js` in the root of your project and add the following code: |
📝 Description
Provide a clear and concise description of your changes.
🔍 Review Preference
Choose one:
🤖 AI-Ready Docs
If content changed, regenerate AI files:
python3 scripts/generate_llms.py✅ Checklist