Skip to content

Commit

Permalink
fix typos in web3-eth-accounts.rst & TESTING.md #5047
Browse files Browse the repository at this point in the history
Signed-off-by: Andrei Stefan <[email protected]>
  • Loading branch information
andreistefanwork committed May 22, 2022
1 parent 2c0324a commit 2841520
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 8 deletions.
9 changes: 7 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -538,8 +538,6 @@ Released with 1.0.0-beta.37 code base.

- Fixed build issues of 1.7.2

## [Unreleased]

## [1.7.4]

### Fixed
Expand All @@ -560,3 +558,10 @@ Released with 1.0.0-beta.37 code base.

### Security
- `npm audit fix` to address vulnerabilities and update libraries (#5014)

## [Unreleased]

## [1.7.5]

### Fixed
- Fix typos in web3-eth-accounts.rst & TESTING.md (#5047)
6 changes: 3 additions & 3 deletions TESTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Web3 is used in Node.js and browser contexts to interact with a wide variety of clients. Its tests
try to cover as much of this domain as possible.

If you're looking for a fixture, test pattern or common execution context to validate a change, you should be able find it in the existing test suite. (Caveats include Parity / Quorum clients and MetaMask specific tests.)
If you're looking for a fixture, test pattern or common execution context to validate a change, you should be able to find it in the existing test suite. (Caveats include Parity / Quorum clients and MetaMask specific tests.)

## Required Tests

Expand All @@ -23,7 +23,7 @@ These should pass for PRs to merge:

## Optional Tests

CI also has tests that install Web3's state at an arbitrary commit in an external real-world project and run *their* unit tests with it. This strategy is borrowed from ethereum/solidity which checks latest Solidity against OpenZeppelin and others to keep abreast of how local changes might affect critical projects downstream from them.
CI also has tests that install Web3's state at an arbitrary commit in an external real-world project and run *their* unit tests with it. This strategy is borrowed from ethereum/solidity which checks the latest Solidity against OpenZeppelin and others to keep abreast of how local changes might affect critical projects downstream from them.

Examples include:
+ [e2e.mosaic.sh][8]: ~300 unit tests for [a Solidity project built with Buidler & @truffle/contract][9]
Expand Down Expand Up @@ -63,7 +63,7 @@ npm registry which is spun up in CI using [verdaccio][14]. (Implementation detai
be seen in [scripts/e2e.npm.publish.sh][15])

The real world target is then cloned and npm or yarn are used to replace its existing
Web3 version with the version published to the the private registry. A simple example can be seen at
Web3 version with the version published to the private registry. A simple example can be seen at
[scripts/e2e.ganache.core.sh][10].

In practice, complex projects can have many versions of Web3 nested in their dependency tree.
Expand Down
6 changes: 3 additions & 3 deletions docs/web3-eth-accounts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ privateKeyToAccount
Creates an account object from a private key.

For more advanced hierarchial address derivation, see
For more advanced hierarchial address derivation, see
[truffle-hd-wallet-provider](https://github.com/trufflesuite/truffle/tree/develop/packages/hdwallet-provider)
package.

Expand All @@ -107,7 +107,7 @@ Parameters
----------

1. ``privateKey`` - ``String``: The private key to import. This is 32 bytes of random data.
If you are supplying a hexadecimal number, it must have `0x` prefix in order to be in line
If you are supplying a hexadecimal number, it must have `0x` prefix in order to be in line
with other Ethereum libraries.
2. ``ignoreLength`` - ``Boolean``: If set to true does the ``privateKey`` length not get validated.

Expand Down Expand Up @@ -344,7 +344,7 @@ Returns
-------

``Object``: The signature object
- ``message`` - ``String``: The the given message.
- ``message`` - ``String``: The given message.
- ``messageHash`` - ``String``: The hash of the given message.
- ``r`` - ``String``: First 32 bytes of the signature
- ``s`` - ``String``: Next 32 bytes of the signature
Expand Down

0 comments on commit 2841520

Please sign in to comment.