diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md index 9ebc3e40d6c..cccc9fc9341 100644 --- a/.github/CODE_OF_CONDUCT.md +++ b/.github/CODE_OF_CONDUCT.md @@ -11,36 +11,36 @@ appearance, race, religion, or sexual identity and orientation. ## Our Standards -Examples of behaviour that contributes to creating a positive environment +Examples of behavior that contributes to creating a positive environment include: -* Using welcoming and inclusive language -* Being respectful of differing viewpoints and experiences -* Gracefully accepting constructive criticism -* Focusing on what is best for the community -* Showing empathy towards other community members +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members -Examples of unacceptable behaviour by participants include: +Examples of unacceptable behavior by participants include: -* The use of sexualized language or imagery and unwelcome sexual attention or - advances -* Trolling, insulting/derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or electronic - address, without explicit permission -* Other conduct which could reasonably be considered inappropriate in a - professional setting +- The use of sexualized language or imagery and unwelcome sexual attention or + advances +- Trolling, insulting/derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or electronic + address, without explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting ## Our Responsibilities Project maintainers are responsible for clarifying the standards of acceptable -behaviour and are expected to take appropriate and fair corrective action in -response to any instances of unacceptable behaviour. +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or -permanently any contributor for other behaviours that they deem inappropriate, +permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. ## Scope @@ -73,4 +73,4 @@ available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.ht [homepage]: https://www.contributor-covenant.org For answers to common questions about this code of conduct, see -https://www.contributor-covenant.org/faq \ No newline at end of file +https://www.contributor-covenant.org/faq diff --git a/CHANGELOG.md b/CHANGELOG.md index 7ea32551380..524e83eb8f6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2501,7 +2501,7 @@ If there are any bugs, improvements, optimizations or any new feature proposal f #### web3-validator - The JSON schema conversion process now correctly assigns an id when the `abi.name` is not available, for example, in the case of public mappings. (#6981) -- `browser` entry point that was pointing to an non-existing bundle file was removed from `package.json` (#7015) +- `browser` entry point that was pointing to a non-existing bundle file was removed from `package.json` (#7015) #### web3-core diff --git a/docs/docs/guides/09_web3_config/index.md b/docs/docs/guides/09_web3_config/index.md index 3642aad951d..ff1576edfc3 100644 --- a/docs/docs/guides/09_web3_config/index.md +++ b/docs/docs/guides/09_web3_config/index.md @@ -6,7 +6,7 @@ title: 'Web3.js Config Guide' ## Configuration parameters -There is list of configuration params that can be set for modifying behavior of different functions in web3.js packages. Following is list of configuration options with details: +There is list of configuration parameters that can be set to modify the behavior of different functions in web3.js packages. Following is list of configuration options with details: - [handleRevert](/guides/web3_config/#handlerevert) - [defaultAccount](/guides/web3_config/#defaultaccount) @@ -33,7 +33,7 @@ There is list of configuration params that can be set for modifying behavior of ## Global level Config -There is option of modifying any of above-mentioned configuration parameter at global level when instantiating Web3, and it will be available to all packages. +It is possible to modify any of the above-mentioned configuration parameter at the global level when instantiating a `Web3` object, and it will be available to all packages. ```ts import { Web3 } from 'web3'; diff --git a/docs/docs/guides/10_web3_eth/eth.md b/docs/docs/guides/10_web3_eth/eth.md index 5b97adea208..bc63995118f 100644 --- a/docs/docs/guides/10_web3_eth/eth.md +++ b/docs/docs/guides/10_web3_eth/eth.md @@ -674,7 +674,7 @@ async function test() { ## Conclusion -In this tutorial, we learned how to use different methods provied by the `web3-eth` package. +In this tutorial, we learned how to use different methods provided by the `web3-eth` package. With this knowledge, you can start experimenting with the Ethereum blockchain. Keep in mind that this is just the beginning, and there is a lot more to learn about Ethereum and web3.js. So keep exploring and building, and have fun! diff --git a/docs/docs/guides/12_web3_utils_module/index.md b/docs/docs/guides/12_web3_utils_module/index.md index 8a55f7bfe85..7833ffd8a1b 100644 --- a/docs/docs/guides/12_web3_utils_module/index.md +++ b/docs/docs/guides/12_web3_utils_module/index.md @@ -199,7 +199,7 @@ console.log(web3.utils.soliditySha3({ type: 'string', value: 'hello web3' })); console.log(web3.utils.toChecksumAddress('0xa3286628134bad128faeef82f44e99aa64085c94')); // 0xA3286628134baD128faeef82F44e99AA64085C94 -// passing an wrong address +// passing a wrong address console.log(web3.utils.toChecksumAddress('0xa3286628134bad128faeef82f44e99aa64085c9')); // InvalidAddressError: Invalid value given "0xa286628134bad128faeef82f44e99aa64085c94". Error: invalid ethereum address. ``` @@ -246,7 +246,7 @@ console.log(web3.utils.compareBlockNumbers(2, 2)); ### Formatting -The [`format` function](/api/web3-utils/function/format) in the `web3-utils` package is used to convert data between equivalent formats. For example, bytes that are represented as a [`Uint8Array` type](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) can be formatted as a hexademical string (e.g. `"0xdd"`) or primitive JavaScript [`Number` types](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) can be formatted as [`BigInt` types](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt). The `format` function expects two required parameters, `schema` and `data`, and accepts a third optional parameter, `returnFormat`. The `schema` parameter is used to describe how the data should be interpreted. The `data` parameter represents the data that is to be formatted. The [`returnFormat` parameter](#return-formats) specifies how the data should be formatted. +The [`format` function](/api/web3-utils/function/format) in the `web3-utils` package is used to convert data between equivalent formats. For example, bytes that are represented as a [`Uint8Array` type](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) can be formatted as a hexadecimal string (e.g. `"0xdd"`) or primitive JavaScript [`Number` types](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) can be formatted as [`BigInt` types](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt). The `format` function expects two required parameters, `schema` and `data`, and accepts a third optional parameter, `returnFormat`. The `schema` parameter is used to describe how the data should be interpreted. The `data` parameter represents the data that is to be formatted. The [`returnFormat` parameter](#return-formats) specifies how the data should be formatted. Here are some example that demonstrate the use of the `format` function: diff --git a/docs/docs/guides/17_migration_from_other_libs/index.md b/docs/docs/guides/17_migration_from_other_libs/index.md index 78e1f48d20c..e39477b49ea 100644 --- a/docs/docs/guides/17_migration_from_other_libs/index.md +++ b/docs/docs/guides/17_migration_from_other_libs/index.md @@ -326,7 +326,7 @@ In web3.js: const web3 = new Web3(provider); const contract = new web3.eth.Contract(ABI, CONTRACT_ADDRESS); -// If the method was only to read form the Blockchain: +// If the method was only to read from the blockchain: const result = await contract.methods.someFunction().call(); // Or, if the method would need a transaction to be sent: const result = await contract.methods.someFunction().send(); diff --git a/packages/web3-account-abstraction/README.md b/packages/web3-account-abstraction/README.md index 61d49413a5e..a70a9aa3fc6 100644 --- a/packages/web3-account-abstraction/README.md +++ b/packages/web3-account-abstraction/README.md @@ -53,7 +53,7 @@ yarn add web3-account-abstraction | test:unit | Uses `jest` to run tests under `/test/unit` | [docs]: https://docs.web3js.org/ -[repo]: https://github.com/web3/web3.js/tree/4.x/tools/web3-account-abstraction +[repo]: https://github.com/web3/web3.js/tree/4.x/packages/web3-account-abstraction [npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=tools%2Fweb3-account-abstraction%2Fpackage.json [npm-url]: https://npmjs.org/package/web3-account-abstraction [downloads-image]: https://img.shields.io/npm/dm/web3-account-abstraction?label=npm%20downloads diff --git a/packages/web3-validator/CHANGELOG.md b/packages/web3-validator/CHANGELOG.md index 8410b156c08..0ef2b96252e 100644 --- a/packages/web3-validator/CHANGELOG.md +++ b/packages/web3-validator/CHANGELOG.md @@ -173,6 +173,6 @@ Documentation: ### Fixed - The JSON schema conversion process now correctly assigns an id when the `abi.name` is not available, for example, in the case of public mappings. (#6981) -- `browser` entry point that was pointing to an non-existing bundle file was removed from `package.json` (#7015) +- `browser` entry point that was pointing to a non-existing bundle file was removed from `package.json` (#7015) ## [Unreleased] diff --git a/packages/web3/CHANGELOG.md b/packages/web3/CHANGELOG.md index b1f440e0074..ad452273c60 100644 --- a/packages/web3/CHANGELOG.md +++ b/packages/web3/CHANGELOG.md @@ -316,7 +316,7 @@ Documentation: #### web3-validator - The JSON schema conversion process now correctly assigns an id when the `abi.name` is not available, for example, in the case of public mappings. (#6981) -- `browser` entry point that was pointing to an non-existing bundle file was removed from `package.json` (#7015) +- `browser` entry point that was pointing to a non-existing bundle file was removed from `package.json` (#7015) #### web3-core