From c3a38af4624b0ebf7a2c968ddf3ec4c394db07ca Mon Sep 17 00:00:00 2001 From: omahs <73983677+omahs@users.noreply.github.com> Date: Thu, 28 Nov 2024 08:49:15 +0100 Subject: [PATCH 1/8] fix typo --- docs/chains/osmosis-chain.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/chains/osmosis-chain.md b/docs/chains/osmosis-chain.md index 2c86e371..23c704b1 100644 --- a/docs/chains/osmosis-chain.md +++ b/docs/chains/osmosis-chain.md @@ -1,6 +1,6 @@ # `osmosis` -`osmosis` is a [Chain](/chains) connector in Hummingbot Gateway that helps users connect to Osmoisis DEX on the Osmosis Blockchain. +`osmosis` is a [Chain](/chains) connector in Hummingbot Gateway that helps users connect to Osmosis DEX on the Osmosis Blockchain. ## 📁 Connector Info From 56e9968b4c3ba69670f1dcce727130bd33d85997 Mon Sep 17 00:00:00 2001 From: omahs <73983677+omahs@users.noreply.github.com> Date: Thu, 28 Nov 2024 08:51:20 +0100 Subject: [PATCH 2/8] fix typos --- docs/blog/posts/quickstart-dashboard/index.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/blog/posts/quickstart-dashboard/index.md b/docs/blog/posts/quickstart-dashboard/index.md index c1201899..4ca23a12 100644 --- a/docs/blog/posts/quickstart-dashboard/index.md +++ b/docs/blog/posts/quickstart-dashboard/index.md @@ -9,7 +9,7 @@ categories: # Hummingbot Dashboard Quickstart Guide -In this tutorial, we'll guide you through installing Hummingbot 2.0, which provide an easy-to-use Dashboard app that helps you connect exchange credentials, create/backtest a strategy configuration, and deploy a fleet of bots! +In this tutorial, we'll guide you through installing Hummingbot 2.0, which provides an easy-to-use Dashboard app that helps you connect exchange credentials, create/backtest a strategy configuration, and deploy a fleet of bots! Watch this video for an overview and walkthrough of the features in Hummingbot 2.0: @@ -89,7 +89,7 @@ Once API keys are added, you can view the tokens available and their allocation [![](./portfolio-1.png)](./portfolio-1.png) -The table above shows the list of available tokens for the `Kucoin` exchange. The graphs below will show your `Portfoliio Evolution over Time` as well as `Token Value Evolution over time` +The table above shows the list of available tokens for the `Kucoin` exchange. The graphs below will show your `Portfolio Evolution over Time` as well as `Token Value Evolution over time` [![](./portfolio-2.png)](./portfolio-2.png) @@ -121,7 +121,7 @@ We can also set the `Total amount of quote` which is how much we want to trade w [![](./config-3.png)](./config-3.png) -Under `Executors Configuration`, we can set the the spread and amount for both buy and sell orders manually or we can choose from the following distributions: +Under `Executors Configuration`, we can set the spread and amount for both buy and sell orders manually or we can choose from the following distributions: - GeoCustom - Geometric @@ -258,4 +258,4 @@ The dashboard uses `admin` and `abc` as the default username and password respec ### Known Issues -- Refreshing the browser window may log you out and display the login screen again. This is a known issue that might be addressed in future updates. \ No newline at end of file +- Refreshing the browser window may log you out and display the login screen again. This is a known issue that might be addressed in future updates. From 45373df54ef7a0845e0492eabeec368911823f94 Mon Sep 17 00:00:00 2001 From: omahs <73983677+omahs@users.noreply.github.com> Date: Thu, 28 Nov 2024 08:52:44 +0100 Subject: [PATCH 3/8] fix typos --- docs/gateway/testing.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/gateway/testing.md b/docs/gateway/testing.md index a0f9431d..ee991746 100644 --- a/docs/gateway/testing.md +++ b/docs/gateway/testing.md @@ -2,7 +2,7 @@ After the Gateway server is running, we recommend testing out the endpoints usin In addition, you can also run unit tests and manual test scripts if you have installed Gateway from source. -These methods allows you to test out the endpoints and understand how Gateway works, before interacting with it through the Hummingbot client. This is an important step because you will likely need to configure your node provider, gas settings, wallet, and other dependencies in order to run DEX trading bots successfully, and understanding Gateway's behavior on a standalone basis helps tremendously. +These methods allow you to test out the endpoints and understand how Gateway works, before interacting with it through the Hummingbot client. This is an important step because you will likely need to configure your node provider, gas settings, wallet, and other dependencies in order to run DEX trading bots successfully, and understanding Gateway's behavior on a standalone basis helps tremendously. ## Testing with Postman @@ -20,7 +20,7 @@ First, go to **Settings** >> **Certificates** in Postman: [![](./postman-certs-1.png)](./postman-certs-1.png) -In this view, eable the **CA Certificates** toggle, Then go to the **certs_path** folder location from [Installation - Generating Certs](/gateway/installation/#generate-certs). Add the `ca_cert.pem` from this folder to **PEM file** in Postman. +In this view, enable the **CA Certificates** toggle, Then go to the **certs_path** folder location from [Installation - Generating Certs](/gateway/installation/#generate-certs). Add the `ca_cert.pem` from this folder to **PEM file** in Postman. [![](./postman-certs-2.png)](./postman-certs-2.png) @@ -35,11 +35,11 @@ In the **Client Certificates** section, set the following: You can also find Postman collections and environments from the [/postman](https://github.com/hummingbot/gateway/tree/main/postman) folder in the Gateway repo. -Import the GatewayAPI collection and the acccompanying Gateway environment into your Postman app in order to test the Gateway endpoints. +Import the GatewayAPI collection and the accompanying Gateway environment into your Postman app in order to test the Gateway endpoints. ### Running tests -After you have imported the collection and environment, test the various endpoints and change the request parameters to understand the their behavior. This will help you understand the speed/latency of each endpoint and configure important setting, especially your node provider, to match your trading style. +After you have imported the collection and environment, test the various endpoints and change the request parameters to understand their behavior. This will help you understand the speed/latency of each endpoint and configure important settings, especially your node provider, to match your trading style. By convention, the POST requests have sample request payloads in the Body field, which allows you to run the same From aee112f7e65967347ccbf4242f943ebb58846879 Mon Sep 17 00:00:00 2001 From: omahs <73983677+omahs@users.noreply.github.com> Date: Thu, 28 Nov 2024 08:54:27 +0100 Subject: [PATCH 4/8] fix typos --- docs/gateway/tokens.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/gateway/tokens.md b/docs/gateway/tokens.md index 05d183a0..b01d8a76 100644 --- a/docs/gateway/tokens.md +++ b/docs/gateway/tokens.md @@ -42,7 +42,7 @@ hummingbot_gateway_compose ┣ logs ``` -The folder location and list file is defined in each blockchain's config file (i.e. `/conf/ethereum.yml`). It also defines a `tokenListType` (`FILE` or `URL`) and `tokenListSource` (path to the designated file or URL) for each network. Note that `URL`-based token lists may impact client latency, compared to accessing the Token List via `FILE`. +The folder location and list file are defined in each blockchain's config file (i.e. `/conf/ethereum.yml`). It also defines a `tokenListType` (`FILE` or `URL`) and `tokenListSource` (path to the designated file or URL) for each network. Note that `URL`-based token lists may impact client latency, compared to accessing the Token List via `FILE`. Users are free to change this setting by configuring the `tokenListType` and `tokenListSource` parameters for each network - see [Updating config parameters](/gateway/setup/#updating-config-parameters) for more information. @@ -55,9 +55,9 @@ Alternatively, you may add entries to the existing lists by following the conven ## Approving tokens -On Ethereum and EVM-compatible chains, wallets need to **approve** other addresses (such as DEXs) before transferring tokens to them. You can inspect the **allowance** for a spender address to see how much of a specific token you can tranfer to it. +On Ethereum and EVM-compatible chains, wallets need to **approve** other addresses (such as DEXs) before transferring tokens to them. You can inspect the **allowance** for a spender address to see how much of a specific token you can transfer to it. -When you `start` a strategy or script, Gateway automatically checks whether both base and quote tokens are approved for the DEX that you are using. If they are not approved or if allowance is insufficient, you will see an log message like "Waiting for allowances.." and the strategy will not start. +When you `start` a strategy or script, Gateway automatically checks whether both base and quote tokens are approved for the DEX that you are using. If they are not approved or if allowance is insufficient, you will see a log message like "Waiting for allowances.." and the strategy will not start. Here is how you can approve tokens: @@ -101,13 +101,13 @@ Here is an example: ## Testnet faucets -An testnet faucet is a tool that allows developers and users to obtain testnet ETH or other test assets for free. Testnet ETH is a cryptocurrency that is used exclusively for testing purposes on the Ethereum network and has no real-world value. +A testnet faucet is a tool that allows developers and users to obtain testnet ETH or other test assets for free. Testnet ETH is a cryptocurrency that is used exclusively for testing purposes on the Ethereum network and has no real-world value. Using an Ethereum testnet faucet is a simple process that involves the following steps: 1. Visit a faucet website for your [chain](/chains). For example, see [Ethereum](/chains/ethereum) for a list of testnet faucets. -2. Enter your testnet wallet address where indicaated. +2. Enter your testnet wallet address where indicated. 3. Complete any additional verification steps: Depending on the testnet faucet you are using, you may be required to complete additional verification steps, such as solving a captcha or proving that you are not a robot. From ad6edc709514b7a65c77a4dad400faee2aea6683 Mon Sep 17 00:00:00 2001 From: omahs <73983677+omahs@users.noreply.github.com> Date: Thu, 28 Nov 2024 08:55:50 +0100 Subject: [PATCH 5/8] fix typo --- docs/gateway/running-dex-bots.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/gateway/running-dex-bots.md b/docs/gateway/running-dex-bots.md index a502d556..c96156f9 100644 --- a/docs/gateway/running-dex-bots.md +++ b/docs/gateway/running-dex-bots.md @@ -25,7 +25,7 @@ The guide below shows you how to run this strategy using the `uniswap-ethereum-g ### Create strategy -Use `create` command to set up an [`amm_arb` strategy](../strategies/amm-arbitrage.md). Answer the question prompts presented so that you to generate the following configuration: +Use `create` command to set up an [`amm_arb` strategy](../strategies/amm-arbitrage.md). Answer the question prompts presented to generate the following configuration: ```yaml template_version: 5 From 8a483ac0641986252f135f895c04c1245f4bc7cc Mon Sep 17 00:00:00 2001 From: omahs <73983677+omahs@users.noreply.github.com> Date: Thu, 28 Nov 2024 08:57:03 +0100 Subject: [PATCH 6/8] fix typos --- docs/gateway/installation.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/gateway/installation.md b/docs/gateway/installation.md index 1c79a4a4..877d7daa 100644 --- a/docs/gateway/installation.md +++ b/docs/gateway/installation.md @@ -1,4 +1,4 @@ -The official Github repository for Gateway is . Gateway is released monthly with the same cadence as the [Hummingbot client](https://github.com/hummingbot/hummingbot), and it follows the same conventions for releases, contributions, etc. +The official Github repository for Gateway is . Gateway is released monthly with the same cadence as the [Hummingbot client](https://github.com/hummingbot/hummingbot), and it follows the same conventions for releases, contributions, etc. ## Install with Docker @@ -7,7 +7,7 @@ For most users, this is the recommended install method for Hummingbot and Gatewa [![](./gateway.gif)](./gateway.gif) -Navigate to the Hummingbot root folder in your terminal of if you haven't cloned the Hummingbot repo yet run the command below +Navigate to the Hummingbot root folder in your terminal or if you haven't cloned the Hummingbot repo yet run the command below ```bash git clone https://github.com/hummingbot/hummingbot @@ -98,7 +98,7 @@ docker logs gateway ## Install from Source -You can also install Gateway on a standalone basis and then link it to Hummingbot manually. These instructions assumes that you have already installed Hummingbot on the machine where you are installing Gateway, either from source or via Docker. +You can also install Gateway on a standalone basis and then link it to Hummingbot manually. These instructions assume that you have already installed Hummingbot on the machine where you are installing Gateway, either from source or via Docker. ### Prerequisites From 414682a929f4c9c045bb22a2e533d0c1b9b10d6f Mon Sep 17 00:00:00 2001 From: omahs <73983677+omahs@users.noreply.github.com> Date: Thu, 28 Nov 2024 08:58:43 +0100 Subject: [PATCH 7/8] fix typo --- docs/gateway/adding-dex-connectors.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/gateway/adding-dex-connectors.md b/docs/gateway/adding-dex-connectors.md index 26ad8e2c..eee39227 100644 --- a/docs/gateway/adding-dex-connectors.md +++ b/docs/gateway/adding-dex-connectors.md @@ -4,7 +4,7 @@ We'll use the Uniswap and Pangolin connectors as examples to help guide you thro ## Requirements -Introducing a connector into the Hummingbot codebase requires a mutual commitment from both the contributing developer as wel the Hummingbot Foundation team to maintain a high standard of code quality and software reliability. +Introducing a connector into the Hummingbot codebase requires a mutual commitment from both the contributing developer as well as the Hummingbot Foundation team to maintain a high standard of code quality and software reliability. We encourage and welcome contributions from the community, subject to the guidelines and expectations outlined below: From 067ddb8af4f8b17ae307bc5f5c7b50ea2a0d1600 Mon Sep 17 00:00:00 2001 From: omahs <73983677+omahs@users.noreply.github.com> Date: Thu, 28 Nov 2024 09:00:49 +0100 Subject: [PATCH 8/8] fix typos --- docs/faq.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/faq.md b/docs/faq.md index 78ebc97e..6313bdd0 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -20,7 +20,7 @@ With many connectors and strategies being added all the time, Hummingbot is a co ### How do people use Hummingbot? -You can use Hummingbot to build any types of automated crypto trading bot, with the most common bot types being market making and arbitrage bots. Market making bots provide liquidity to a trading pair on an exchange, while arbitrage bots exploit price differences betweeen trading pairs on different exchanges. +You can use Hummingbot to build any type of automated crypto trading bot, with the most common bot types being market making and arbitrage bots. Market making bots provide liquidity to a trading pair on an exchange, while arbitrage bots exploit price differences between trading pairs on different exchanges. Typically, users install the Docker image version on AWS or another cloud provider. Afterwards, they can add their API key or private keys to it, which allows them to configure and run one of Hummingbot's pre-built strategies on many different exchanges. @@ -87,7 +87,7 @@ If you just want to get Gateway up and running alongside Hummingbot, following t Afterwards, follow the instructions at [Using Gateway with Hummingbot](gateway/setup.md). -### What kinds of DEX bots can you building with Gateway? +### What kinds of DEX bots can you build with Gateway? Currently, Hummingbot Gateway is ideal for bots that: @@ -118,7 +118,7 @@ Speed and latency in DEX trading is heavily dependent on your connection to the **1 - Use a node provider** -This is the most common route. Gateway ships with [Ankr] as the default node provider, since theydon’t require API keys. See [default settings](https://github.com/hummingbot/gateway/tree/main/src/templates) for each chain. +This is the most common route. Gateway ships with [Ankr] as the default node provider, since they don’t require API keys. See [default settings](https://github.com/hummingbot/gateway/tree/main/src/templates) for each chain. Providers include: