diff --git a/docs/devdocs/Examples and References/Examples-fheDapps.md b/docs/devdocs/Examples and References/Examples-fheDapps.md index 5d78334b..a058f3ea 100644 --- a/docs/devdocs/Examples and References/Examples-fheDapps.md +++ b/docs/devdocs/Examples and References/Examples-fheDapps.md @@ -25,7 +25,7 @@ Here you can find a list of some cool apps that you can use as a reference Blind Auction View on Github View on Github -An auction in which is bid is kept encrypted until the Auction ends and the winner is revealed. +An auction in which the bid is kept encrypted until the Auction ends and the winner is revealed. [//]: # () diff --git a/docs/devdocs/Fhenix Testnet/FHE-Overview.md b/docs/devdocs/Fhenix Testnet/FHE-Overview.md index f0217f4a..9f083eae 100644 --- a/docs/devdocs/Fhenix Testnet/FHE-Overview.md +++ b/docs/devdocs/Fhenix Testnet/FHE-Overview.md @@ -23,7 +23,7 @@ The GSW scheme introduces a unique approach for performing homomorphic operation ### FHEW Scheme -The FHEW scheme is an optimized version of the GSW scheme, focusing on bootstrapping efficiency. It treats decryption as an arithmetic function rather than a boolean circuit. This RLWE variant incorporates several optimizations, making GSW-based bootstrapping faster than the BGV scheme. Key improvements include: +The FHEW scheme is an optimized version of the GSW scheme, focusing on bootstrapping efficiency. It treats decryption as an arithmetic function rather than a Boolean circuit. This RLWE variant incorporates several optimizations, making GSW-based bootstrapping faster than the BGV scheme. Key improvements include: 1. Restricting computations to a binary message space and using a NAND gate for homomorphic operations. 2. Enabling the evaluation of arbitrary functions via lookup tables during bootstrapping, known as “programmable bootstrapping.” diff --git a/docs/devdocs/Fhenix Testnet/Fhenix-T-FHE.md b/docs/devdocs/Fhenix Testnet/Fhenix-T-FHE.md index 1de1a98d..1af5c662 100644 --- a/docs/devdocs/Fhenix Testnet/Fhenix-T-FHE.md +++ b/docs/devdocs/Fhenix Testnet/Fhenix-T-FHE.md @@ -18,7 +18,7 @@ To read more about different FHE schemes, see our [FHE Overview Section](./FHE-O ## Fhenix Nitrogen Testnet -The current Fhenix Nitrogen Testnet is the second public iteration of the Fhenix protocol. It is still an early build, and it can potentialy has bugs (unfortunately) and there are still features that are still under development. +The current Fhenix Nitrogen Testnet is the second public iteration of the Fhenix protocol. It is still an early build, and it can potentially has bugs (unfortunately) and there are still features that are still under development. There are still challenges ahead. However, we are excited to be working on this project, because it is potentially an innovative and disruptive technology in the blockchain space. diff --git a/docs/devdocs/Fhenix Testnet/Integration.md b/docs/devdocs/Fhenix Testnet/Integration.md index 0fc27c2d..caead779 100644 --- a/docs/devdocs/Fhenix Testnet/Integration.md +++ b/docs/devdocs/Fhenix Testnet/Integration.md @@ -48,7 +48,7 @@ We have public endpoints available for the Nitrogen Testnet, which can be used: If you require specialized endpoints, or higher rate limits than the default please reach out to us on [Discord](https://discord.gg/FuVgxrvJMY) or [email](mailto://info@fhenix.io). -## Cross Chain Messaging Contracts +## Cross-Chain Messaging Contracts The following contracts are deployed on Ethereum Sepolia and may be used by developers that wish to interact with Fhenix in a similar way to Arbitrum diff --git a/docs/devdocs/Setting Up Your Environment/Hardhat.md b/docs/devdocs/Setting Up Your Environment/Hardhat.md index b2988757..db388ee5 100644 --- a/docs/devdocs/Setting Up Your Environment/Hardhat.md +++ b/docs/devdocs/Setting Up Your Environment/Hardhat.md @@ -38,7 +38,7 @@ To start a LocalFhenix instance, run the following command: pnpm localfhenix:start ``` -This will start a LocalFhenix instance in a docker container, managed by the `fhenix-hardhat-docker` plugin for Hardhat. +This will start a LocalFhenix instance in a Docker container, managed by the `fhenix-hardhat-docker` plugin for Hardhat. If this worked you should see a `LocalFhenix started` message in your console. You've now officially created a LocalFhenix testnet. 🎉 diff --git a/docs/devdocs/Solidity API/FHE.md b/docs/devdocs/Solidity API/FHE.md index b4c1c45e..50b5967f 100644 --- a/docs/devdocs/Solidity API/FHE.md +++ b/docs/devdocs/Solidity API/FHE.md @@ -180,7 +180,7 @@ Pure in this function is marked as a hack/workaround - note that this function i function sealoutput(ebool value, bytes32 publicKey) internal pure returns (string) ``` -performs the sealoutput function on a ebool ciphertext. This operation returns the plaintext value, sealed for the public key provided +performs the sealoutput function on an ebool ciphertext. This operation returns the plaintext value, sealed for the public key provided _Pure in this function is marked as a hack/workaround - note that this function is NOT pure as fetches of ciphertexts require state access_ diff --git a/docs/devdocs/Tools and Utilities/Fhenix-Encryption-UI.md b/docs/devdocs/Tools and Utilities/Fhenix-Encryption-UI.md index 724118bd..891d351f 100644 --- a/docs/devdocs/Tools and Utilities/Fhenix-Encryption-UI.md +++ b/docs/devdocs/Tools and Utilities/Fhenix-Encryption-UI.md @@ -11,7 +11,7 @@ In order to encrypt a number you can simply write the number you want to encrypt You can choose what Euint\* type you want as an output and eventually you can choose one of the two options: 1. Encrypt (Plain) - Will output hex encoded bytes (`0x04000...`) that can be used as "bytes calldata" input or as the input for the remix plugin -2. Encrypt (InEuint) - Will output hex encoded bytes in square brackets (`[0x04000...]`) that can be used in remix (not with the plugin) for function that receive inEuint\* +2. Encrypt (InEuint) - Will output hex encoded bytes in square brackets (`[0x04000...]`) that can be used in remix (not with the plugin) for a function that receive inEuint\* All output will be copied to your clipboard and a notification will pop up telling you that the output was copied. diff --git a/docs/devdocs/Tools and Utilities/Fhenix-Hardhat-Plugin.md b/docs/devdocs/Tools and Utilities/Fhenix-Hardhat-Plugin.md index ab9c3f79..96592ee9 100644 --- a/docs/devdocs/Tools and Utilities/Fhenix-Hardhat-Plugin.md +++ b/docs/devdocs/Tools and Utilities/Fhenix-Hardhat-Plugin.md @@ -81,7 +81,7 @@ After importing `fhenix-hardhat-plugin` hardhat will automatically extend the Ha To set up a localfhenix instance, simply import `fhenix-hardhat-docker`. This will add two new hardhat tasks: -- **`localfhenix:start`** To start a local dev environment using docker. By default, the instance will listen for rpc connections on port `42069` +- **`localfhenix:start`** To start a local dev environment using Docker. By default, the instance will listen for RPC connections on port `42069` - **`localfhenix:stop`** Stops the docker container To start the container: diff --git a/docs/devdocs/Tutorials/Basic/Setting Up.mdx b/docs/devdocs/Tutorials/Basic/Setting Up.mdx index 918b6a39..9f8923be 100644 --- a/docs/devdocs/Tutorials/Basic/Setting Up.mdx +++ b/docs/devdocs/Tutorials/Basic/Setting Up.mdx @@ -16,7 +16,7 @@ Although you can use all the aforementioned package managers we primarily use, s

- Install docker from: https://docs.docker.com/engine/install/ubuntu/ + Install Docker from: https://docs.docker.com/engine/install/ubuntu/ Install nodejs from nodesource: (other options are also okay) ```sh diff --git a/docs/devdocs/Tutorials/Basic/Writing-The-Contract.md b/docs/devdocs/Tutorials/Basic/Writing-The-Contract.md index 89ce2f2c..6ff714b5 100644 --- a/docs/devdocs/Tutorials/Basic/Writing-The-Contract.md +++ b/docs/devdocs/Tutorials/Basic/Writing-The-Contract.md @@ -80,7 +80,7 @@ constructor(string memory name, string memory symbol) ERC20(name, symbol) { #### Wrap -First, let's define a function `wrap(uint32 amount)` that allows users to convert (wrap) their tokens into encrypted form. +First, let's define a function `wrap(uint32 amount)` that allows users to convert (wrap) their tokens into an encrypted form. The function will burn a specified amount from the user's balance and add the same amount to their encrypted balance. ```javascript diff --git a/docs/devdocs/Writing Smart Contracts/Randomness.md b/docs/devdocs/Writing Smart Contracts/Randomness.md index 775179e0..4371df63 100644 --- a/docs/devdocs/Writing Smart Contracts/Randomness.md +++ b/docs/devdocs/Writing Smart Contracts/Randomness.md @@ -59,7 +59,7 @@ contract RandomLucky { } ``` -An adversary could could call the randomness consumer function, check the result of the random, +An adversary could call the randomness consumer function, check the result of the random, and revert the transaction if that result were not favorable. In this case: