Fix: typos (#140)

tradingstrategy-ai · Aug 3, 2023 · cb10973 · cb10973
1 parent d6bb4b8
commit cb10973
Show file tree

Hide file tree

Showing 8 changed files with 16 additions and 16 deletions.
diff --git a/docs/source/related.rst b/docs/source/related.rst
@@ -4,7 +4,7 @@ Related projects
 * `Python Hentai <https://pypi.org/project/hentai/>`_ - This python package implements a wrapper class around nhentai's RESTful API.
   `web3-ethereum-defi` package was earlier known `eth-hentai`.
 
-* `Brownie <https://github.com/eth-brownie/brownie>`_ - smart contract development framwork with Bitcoin
+* `Brownie <https://github.com/eth-brownie/brownie>`_ - smart contract development framework with Bitcoin
 
 * `uniswap-python <https://github.com/uniswap-python/uniswap-python>`_
 

diff --git a/docs/source/tutorials/aave-v3-interest-analysis.ipynb b/docs/source/tutorials/aave-v3-interest-analysis.ipynb
@@ -41,7 +41,7 @@
    "source": [
     "### Download the raw data from a blockchain\n",
     "\n",
-    "For simplicity, you can sign up for free access to an Polygon node for example at [Infura](https://infura.io/), however we recommend you to [run your own node](https://tradingstrategy.ai/blog/preparing-a-server-for-hosting-goethereum-full-node).\n",
+    "For simplicity, you can sign up for free access to a Polygon node for example at [Infura](https://infura.io/), however we recommend you to [run your own node](https://tradingstrategy.ai/blog/preparing-a-server-for-hosting-goethereum-full-node).\n",
     "\n",
     "The code below will connect to your JSON-RPC URL and auto-detect the network by its chain id."
    ]

diff --git a/docs/source/tutorials/event-reader.rst b/docs/source/tutorials/event-reader.rst
@@ -1,10 +1,10 @@
 .. meta::
    :description: Reading historical Uniswap v2 compatible DEX data
 
-Uniswap v2 historial swaps and pairs event reading
---------------------------------------------------
+Uniswap v2 historical swaps and pairs event reading
+---------------------------------------------------
 
-This is an example how to efficiently read all Uniswap pairs and their swaps in a blockchain,
+This is an example of how to efficiently read all Uniswap pairs and their swaps in a blockchain,
 using :py:mod:`eth_defi.event_reader` module.
 
 Overview:
@@ -29,7 +29,7 @@ Overview:
 
 .. note ::
 
-    This reader uses a single thread. For speedupds, see the
+    This reader uses a single thread. For speedups, see the
     `concurrent reader version of the script on Github <https://github.com/tradingstrategy-ai/web3-ethereum-defi/blob/master/scripts/uniswap-v2-pairs-and-swaps-concurrent.py>`__.
 
 To run:

diff --git a/docs/source/tutorials/index.rst b/docs/source/tutorials/index.rst
@@ -5,7 +5,7 @@
 Tutorials
 =========
 
-Examples how to use web3.py and Web-Ethereum-Defi library.
+Examples of how to use web3.py and Web-Ethereum-Defi library.
 
 Examples include
 
@@ -52,4 +52,4 @@ Example tutorials
 
 `For more examples, browse tests folder on Github <https://github.com/tradingstrategy-ai/web3-ethereum-defi/tree/master/tests>`__.
 You can also search function names in `the repository <https://github.com/tradingstrategy-ai/web3-ethereum-defi/>`__
-using Github search.
+using Github search.
diff --git a/docs/source/tutorials/live-swap.rst b/docs/source/tutorials/live-swap.rst
@@ -4,7 +4,7 @@
 Uniswap v2 reading real-time swaps and new pairs
 ------------------------------------------------
 
-This the Python example code for `Uniswap <https://tradingstrategy.ai/glossary/uniswap>`__
+This is the Python example code for `Uniswap <https://tradingstrategy.ai/glossary/uniswap>`__
 v2 compatible `DEX <https://tradingstrategy.ai/glossary/decentralised-exchange>`__ swap live monitoring.
 
 This is an example code for showing live swaps happening
@@ -19,7 +19,7 @@ good free RPC nodes which makes running the example code easy.
   happen regularly, the latest block is rolled back and replaced
   by new block with reordered events.
 
-- This is an modified example of `read-uniswap-v2-pairs-and-swaps.py` to gracefully handle
+- This is a modified example of `read-uniswap-v2-pairs-and-swaps.py` to gracefully handle
   chain reorganisations, thus the code is suitable for live event reading.
   It should also support low quality JSON-RPC nodes that may give different replies between API requests.
 

diff --git a/docs/source/tutorials/multithread-reader.rst b/docs/source/tutorials/multithread-reader.rst
@@ -11,7 +11,7 @@ The example shows How to read Solidity events, or use eth_getLogs RPC, to maximi
 
 - We use Web3.py `Contract` class and its `Event` subclass
 
-- The example uses a thread pool reader with 16 parallel reqading threads (JSON-RPC API requets)
+- The example uses a thread pool reader with 16 parallel reading threads (JSON-RPC API requets)
 
 - The example uses optimised `ujson` library for decoding JSON
 

diff --git a/docs/source/tutorials/transfer.rst b/docs/source/tutorials/transfer.rst
@@ -4,7 +4,7 @@
 ERC-20 token transfer with web3.py
 ----------------------------------
 
-This is a tutorial how to transfer ERC-20 token in Python
+This is a tutorial on how to transfer ERC-20 token in Python
 with `web3-ethereum-defi <https://github.com/tradingstrategy-ai/web3-ethereum-defi>`_ package.
 
 You need
@@ -28,7 +28,7 @@ Import your private key to an environment variable in UNIX shell:
 
     export PRIVATE_KEY="0x1111111111111"
 
-Set up your JSON-RPC connecgtion:
+Set up your JSON-RPC connection:
 
 .. code-block:: shell
 
@@ -102,7 +102,7 @@ Then create the following script:
     assert web3.isChecksumAddress(to_address), f"Not a valid address: {to_address}"
 
     # Fat-fingering check
-    print(f"Confirm transfering {decimal_amount} {token_details.symbol} to {to_address}")
+    print(f"Confirm transferring {decimal_amount} {token_details.symbol} to {to_address}")
     confirm = input("Ok [y/n]?")
     if not confirm.lower().startswith("y"):
         print("Aborted")
@@ -137,7 +137,7 @@ Example output
     Your have : 0.2679961495972585 ETH for gas fees
     How many tokens to transfer? 1
     Give destination Ethereum address? 0x6449299d1d268c4008b4fB992afd04AB5fAec4E6
-    Confirm transfering 1 XXX to 0x6449299d1d268c4008b4fB992afd04AB5fAec4E6
+    Confirm transferring 1 XXX to 0x6449299d1d268c4008b4fB992afd04AB5fAec4E6
     Ok [y/n]?y
     Broadcasted transaction 0xfed8c07b1da1d4348d3ea0ec678f30082fc8e944ada4b0f6510b5a7c05ceb910, now waiting 5 minutes for mining
     All ok!

diff --git a/eth_defi/aave_v3/README.md b/eth_defi/aave_v3/README.md
@@ -37,7 +37,7 @@ Aave v3 has its own definition for APR and APY found in https://docs.aave.com/de
 To get APR and APY values, we apply the formulas to liquidityRate, stableBorrowRate and variableBorrowRate. This
 is implemented in rates.py.
 
-## Accured interest calculation
+## Accrued interest calculation
 
 To calculate accrued interest for a deposit made at T1 and withdrawn at T2, we need the current liquidity index at both times: