Spelling and Grammar fixes (#1759)

Fixed the spelling and Grammar of readme, code of conduct, and contributing files

CODE_OF_CONDUCT.md

@@ -3,7 +3,7 @@
 ## Our Pledge
 
 In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
+contributors and maintainers pledge to make participation in our project and
 our community a harassment-free experience for everyone, regardless of age, body
 size, disability, ethnicity, sex characteristics, gender identity and expression,
 level of experience, education, socio-economic status, nationality, personal

CONTRIBUTING.md

@@ -25,7 +25,7 @@ Please read our [README.md](./README.md) first, to learn how to set up Iron Fish
 If you don't know what contribution you can work on, here are a few suggestions:
 * Take a look at our current [list of issues](https://github.com/iron-fish/ironfish/issues). Update the issue if you are interested in working on it.
 * Take a look at our current [pull requests](https://github.com/iron-fish/ironfish/pulls) and help review them.
-* Help us add new tests. More testing allow everyone to ship quality code faster.
+* Help us add new tests. More testing allows everyone to ship quality code faster.
 * Write documentation or fix the existing documentation
 * If you still don't know what could be a good task for you, do not hesitate to contact us.
 
@@ -42,13 +42,13 @@ If you are working on something in one of these categories, we will not accept y
  - #### Upgrading Package Versions
    - This is a common attack vector by malicious agents. We lock down our packages for this very reason, and only allow the core team to upgrade packages unless you submit a FIP first explaining why you want to upgrade the package.
  - #### Upgrading Node Versions
-   - There is a large impact in upgrading node versions. Iron Fish takes advantage of many experimental node features, some of which are not fully fleshed out. We use workers, and native code boundaries. Node is also known to introduce bugs in newer versions, even LTS. Because of this, there is production testing we do on our side when upgrading node to ensure it's compatible. Because of this, we don't allow users to upgrade our node versions unless a FIP is filed.
+   - There is a large impact in upgrading node versions. Iron Fish takes advantage of many experimental node features, some of which are not fully fleshed out. We use workers and native code boundaries. Node is also known to introduce bugs in newer versions, even LTS. Because of this, there is production testing we do on our side when upgrading node to ensure it's compatible. Because of this, we don't allow users to upgrade our node versions unless a FIP is filed.
  - #### Refactor a core system
-   - Often engineers have visions for core systems, and may be in the process of changing them. FIP's help avoid overlap and having your changes over-written. Some core systems include, MerkleTree, Blockchain, PeerNetwork, Verifier, Consensus.
- - #### Making new product design decisions that has no precedent
-   - This one is more complicated. If our products works one way, and you open a PR to change the core product principles to work in another way, then we are going to close your PR as it does not fit into our vision. Try to match existing precedent as much as possible in your code.
+   - Often engineers have visions for core systems, and may be in the process of changing them. FIP's help avoid overlap and having your changes overwritten. Some core systems include: MerkleTree, Blockchain, PeerNetwork, Verifier, and Consensus.
+ - #### Making new product design decisions that have no precedent
+   - This one is more complicated. If our product works one way, and you open a PR to change the core product principles to work in another way, then we are going to close your PR as it does not fit into our vision. Try to match existing precedent as much as possible in your code.
  - #### Tests for CLI commands
-   - They are not useful in their current form. Most of these tests are mocking out the entire node and sending back hand crafted values which are merely asserted and make changes these commands more annoying. We are accepting a FIP for refactoring command tests to be more valuable and not use mocking.
+   - They are not useful in their current form. Most of these tests are mocking out the entire node and sending back handcrafted values which are merely asserted and make changes to these commands more annoying. We are accepting a FIP for refactoring command tests to be more valuable and not use mocking.
 
 
 # Contact Us

README.md

@@ -40,12 +40,12 @@ The following steps should only be used to install if you are planning on contri
      1. On Ubuntu: `apt install build-essential`
      1. On Amazon Linux: `sudo yum groupinstall "Development Tools"`
 
-   - If `yarn install` fails with an error that includes "Error: Could not find any Python installation to use", you may need to install Python3 (required by node-gyp). on MacOS:
+   - If `yarn install` fails with an error that includes "Error: Could not find any Python installation to use", you may need to install Python3 (required by node-gyp). on macOS:
      1. Run `brew install python`
 
 ## Usage
 
-Once your environment is setup - you can run the CLI by following [these directions](https://github.com/iron-fish/ironfish/tree/master/ironfish-cli).
+Once your environment is set up - you can run the CLI by following [these directions](https://github.com/iron-fish/ironfish/tree/master/ironfish-cli).
 
 ## Running Tests
 
@@ -56,7 +56,7 @@ Once your environment is setup - you can run the CLI by following [these directi
 1. To test a specific project
    1. Run `yarn test` at the root of the project
    1. Run `yarn test:watch` in ./ironfish or ./ironfish-cli if you want the tests to run on change
-   1. Run `yarn test:coverage:html` if you want to export the coverage in an easy to use format (open the index.html file in the coverage folder of the project)
+   1. Run `yarn test:coverage:html` if you want to export the coverage in an easy-to-use format (open the index.html file in the coverage folder of the project)
 
 ## Structure of the repository
 

ironfish-cli/README.md

@@ -53,7 +53,7 @@ Run these commands in two different terminals:
 You should see messages in the second terminal indicating that the miner is running:
    - `Starting to mine with 8 threads`
    - `Mining block 6261 on request 1264... \ 1105974 H/s`
-      - The H/s number corresponds to the hash rate power of your machine with the given number of mining threads. 
+      - The H/s number corresponds to the hashrate power of your machine with the given number of mining threads. 
       - Performance reference: 8-core 3.8+ GHz AMD Ryzen 7 4700G with 8 threads gave the above 1.1 M H/s.
 
 When a block is mined, you will see a status line in the node's terminal (the first terminal):

ironfish-rust/README.md

@@ -4,10 +4,10 @@ This is the core API for interacting with transactions and the chain. It's essen
 
 This is the only Iron Fish project that knows about the
 [Sapling](https://github.com/zcash/librustzcash/tree/master/zcash_primitives/src/sapling)
-API and its zero knowledge [proving mechanism](https://github.com/zcash/librustzcash/tree/master/zcash_proofs/src/sapling).
+API and its zero-knowledge [proving mechanism](https://github.com/zcash/librustzcash/tree/master/zcash_proofs/src/sapling).
 
 There are theoretically different kinds of elliptical curves that can be used with Sapling, but we are currently
 depending on the BLS12 curve. Everything in ironfish-rust is parameterized on the curve type, but there
 are easy facades exported from sapling::bls12 for the different struct types.
 
-This layer is tangentially aware of the chain. It is not aware of the peer to peer network or client APIs.
+This layer is tangentially aware of the chain. It is not aware of the peer-to-peer network or client APIs.

ironfish/README.md

@@ -2,15 +2,15 @@
 
 [![codecov](https://codecov.io/gh/iron-fish/ironfish/branch/master/graph/badge.svg?token=PCSVEVEW5V&flag=ironfish)](https://codecov.io/gh/iron-fish/ironfish)
 
-Ironfish contains the implementation of the Ironfish node and all relavent components that run it including the Blockchain, MemPool, RPC layer, PeerNetwork, and more.
+Ironfish contains the implementation of the Ironfish node and all relevant components that run it including the Blockchain, MemPool, RPC layer, PeerNetwork, and more.
 
 ## Components
 
 ### Accounts
  An account store used to manage, create, and update Ironfish accounts.
 
 ### Config
-This represents the IronfishConfig and all of it's options. It's a hierarchical config system that has 3 levels of options. If you use `config.get()` or `config.config` then you'll always get the top level config options.
+This represents the IronfishConfig and all of its options. It's a hierarchical config system that has 3 levels of options. If you use `config.get()` or `config.config` then you'll always get the top-level config options.
 
 ```
 -> config
@@ -26,15 +26,15 @@ This represents the IronfishConfig and all of it's options. It's a hierarchical
 This is an abstraction on top of any file system related APIs like `path` and `fs` in node. It makes it so you can perform file and file system related methods in a way that works in the browser and node. `NodeFileSystem` is one implementation that works for node.
 
 ### RpcServer
-This is the server that handles clients connecting and making requests against the RPC routes. This server doesn't have much logic of it's own, but it contains a set of adapters that each implement a transport mechanism.
+This is the server that handles clients connecting and making requests against the RPC routes. This server doesn't have much logic of its own, but it contains a set of adapters that each implement a transport mechanism.
 
 When the RpcServer starts, so do the transports. They accept messages from clients, construct Requests, and route them into the routing layer which executes the proper route.
 
 #### RpcAdapter
 An adapter exists to represent a single transport layer. For example, in an HTTP adapter you might listen on port 80 for requests, construct RPC layer Request objects, and feed them into the routing layer, then render the RPC responses as HTTP responses. See IPCAdapter for an example of how to implement an adapter.
 
 ### Logger
-By default the log level is set to only display info.
+By default, the log level is set to only display info.
 
 Change the `logLevel` in the config file, from `*:info` to `*:debug` if you want verbose logs.
 

ironfish/src/serde/README.md

@@ -1,6 +1,6 @@
 [![codecov](https://codecov.io/gh/iron-fish/ironfish/branch/master/graph/badge.svg?token=PCSVEVEW5V&flag=serde)](https://codecov.io/gh/iron-fish/ironfish)
 
-Typescript interface for objects that can be serialized and deserialized to json
+Typescript interface for objects that can be serialized and deserialized to JSON
 as well as compared for equality.
 
 Also includes implementations of that interface for some standard structures: