Skip to content

Commit

Permalink
Various Typo Fixes (#7413)
Browse files Browse the repository at this point in the history
Replaces #7408, #7409, #7410, and #7411
  • Loading branch information
danforbes authored Dec 3, 2024
1 parent acdb0c7 commit b3ee417
Show file tree
Hide file tree
Showing 9 changed files with 29 additions and 29 deletions.
38 changes: 19 additions & 19 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
https://www.contributor-covenant.org/faq
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/guides/09_web3_config/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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';
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/guides/10_web3_eth/eth.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/guides/12_web3_utils_module/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
```
Expand Down Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/guides/17_migration_from_other_libs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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();
Expand Down
2 changes: 1 addition & 1 deletion packages/web3-account-abstraction/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion packages/web3-validator/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
2 changes: 1 addition & 1 deletion packages/web3/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

1 comment on commit b3ee417

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Benchmark

Benchmark suite Current: b3ee417 Previous: 926044b Ratio
processingTx 21201 ops/sec (±6.42%) 22580 ops/sec (±6.70%) 1.07
processingContractDeploy 35446 ops/sec (±10.98%) 38234 ops/sec (±9.25%) 1.08
processingContractMethodSend 15255 ops/sec (±7.60%) 15487 ops/sec (±8.04%) 1.02
processingContractMethodCall 26930 ops/sec (±6.64%) 27549 ops/sec (±6.36%) 1.02
abiEncode 40055 ops/sec (±7.89%) 42126 ops/sec (±7.48%) 1.05
abiDecode 28372 ops/sec (±7.30%) 30213 ops/sec (±7.55%) 1.06
sign 1540 ops/sec (±0.53%) 1458 ops/sec (±3.47%) 0.95
verify 359 ops/sec (±0.56%) 361 ops/sec (±0.61%) 1.01

This comment was automatically generated by workflow using github-action-benchmark.

Please sign in to comment.