Merge pull request #236 from hummingbot/guide-updates

(feat) liquidity mining guide and hbot blog post

docs/_redirects

@@ -6,11 +6,8 @@
 /exchanges/perp/*       /exchanges/:splat               301
 /gateway/exchanges/*    /exchanges/:splat               301
 /gateway/chains/*       /chains/:splat                  301
-/hbot                   https://hummingbot.org/hbot     301
-/news/hbot              https://blog.hummingbot.org/introducing-hbot/  301
-/news/foundation        https://blog.hummingbot.org/hummingbot-foundation  301
-/news/*                 https://blog.hummingbot.org/:splat   301
-/news                   https://blog.hummingbot.org     301
+/hbot                   /governance/hbot                301
+/news                   /blog                           301
 /installation/deploy    /installation/docker            301
 /installation/multiple-bots    /installation/orchestration     301
 /installation/linux    /installation/     301

docs/blog/posts/2021-12-introducing-hbot/index.md

@@ -3,6 +3,7 @@ date: 2021-12-16
 authors:
   - foundation
 categories:
+  - Announcements
   - Governance
 ---
 
@@ -12,8 +13,6 @@ categories:
 
 HBOT Tokens empower holders to decide how the Hummingbot codebase changes over time through voting on proposals.
 
-![](./HB_Token_Featured_Banner.webp)
-
 As announced in [this October post](../2021-10-hummingbot-foundation/index.md), CoinAlpha has established the Hummingbot Foundation (the "Foundation"), a new, independent open source foundation that will enable a decentralized, community-led software development model for Hummingbot, an open source toolbox for building crypto trading bots.
 
 <!-- more -->

docs/blog/posts/2023-09-governance-timeline/index.md

@@ -0,0 +1,92 @@
+---
+date: 2023-09-25
+authors:
+  - foundation
+categories:
+  - Governance
+---
+
+# FAQ on HBOT and Hummingbot Governance
+
+![](./token-governance.jpg)
+
+Ever since the birth of the Hummingbot ecosystem, we've strived to ensure a decentralized approach to governance and maintenance of the Hummingbot codebase. Let's take a brief journey through some key milestones:
+
+* **Oct 2021**: Launch of the Hummingbot Foundation
+* **Jan 2022**: Introduction of the HBOT Token
+* **Dec 2022**: Introduction of Polls for CEX and DEX Connector Voting
+* **Sep 2023**: Addition of Chain Connector Voting and Bounty Budgets
+
+HBOT holders are now empowered to dictate how the Foundation distributes its maintenance resources and bounty budgets across the 50+ CEX, DEX, and chain connectors in the codebase. This post updates HBOT holders on how the governance system works.
+
+<!-- more -->
+
+## What is the HBOT token?
+
+[HBOT](https://etherscan.io/address/0xe5097d9baeafb89f9bcb78c9290d545db5f9e9cb) is the native utility token of the Hummingbot ecosystem. It is a standard ERC-20 Ethereum token that lets holders to decide how the Hummingbot codebase changes through voting on [Snapshot](https://snapshot.org/#/hbot.eth).
+
+The sole use case of the HBOT token is **governance**. HBOT tokens empower holders to govern many aspects of the Hummingbot Foundation, including approving pull requests, allocating bounties toward various connectors, and electing Board of Directors.
+
+## How is the HBOT token distributed?
+
+The total supply of HBOT was fixed at genesis at 1,000,000,000 tokens, and the entire supply is designed to be distributed to stakeholders for contributing meaningful work to the Hummingbot ecosystem.
+
+At [inception](/blog/2021/12/16/introducing-the-hummingbot-governance-token-hbot/), 64.0% of the total HBOT supply was distributed to Github code contributors, Hummingbot users that provided liquidity to the Miner platform, and investors and team members from CoinAlpha, the company that originally open-sourced Hummingbot.
+
+From January 2022 through August 2023, 4.2% of the total HBOT supply was distributed across 468 transactions to 102 unique wallets for bug fixes, new connectors, content bounties and other uses approved via Polls and Proposals.
+
+Currently, 31.8% of the total HBOT supply remains available and earmarked for future distributions to the community. See [HBOT Tracker](https://docs.google.com/spreadsheets/d/1UNAumPMnXfsghAAXrfKkPGRH9QlC8k7Cu1FGQVL1t0M/edit#gid=285483484) for more information.
+
+## Who should acquire HBOT tokens?
+
+The HBOT token gives stakeholders a voice in the evolution of the Hummingbot codebase. Anyone with a keen interest in deciding which exchanges and blockchains Hummingbot supports should think about obtaining HBOT tokens. Here's a breakdown:
+
+**Exchanges (Centralized and Decentralized)**: Exchanges can benefit from ensuring that their platform is readily accessible and optimized within the Hummingbot ecosystem. By holding HBOT tokens, exchanges can cast votes to prioritize their development of spot/perpetual connector and historical candles feeds. Exchangs can also create bounties that incentivize community members to fix bugs and create guides that potentially drives more trading volume and user activity to their platforms.
+
+**L1/L2 Blockchain Networks**: As the crypto space evolves, different Layer 1 and Layer 2 solutions emerge and compete for dominance. These networks, aiming to ensure seamless interaction with Hummingbot, should consider acquiring HBOT tokens. This way, they can influence the addition or prioritization of their respective chain connectors, facilitating better integration with Hummingbot and consequently, promoting more efficient trading on DEXes operating on their network.
+
+**Traders and Trading Firms**: Individual traders and firms, especially those who rely on specific exchanges or blockchains, should acquire HBOT to have a say in which connectors are maintained and optimized. This allows them to ensure that their trading activities on their preferred platforms are uninterrupted and continually enhanced.
+
+In essence, acquiring HBOT tokens is an investment in the future trajectory of the Hummingbot platform, ensuring it aligns with your specific needs and preferences.
+
+## What can I do with HBOT tokens?
+
+**Voting on Polls and Proposals:**
+
+* **Connector Voting**: One of the primary utilities of the HBOT token is the ability to vote in quarterly [Polls](/governance/polls) on which Centralized Exchanges (CEX), Decentralized Exchanges (DEX), and Chain Connectors are integrated and supported within the Hummingbot codebase. As the crypto landscape evolves, it's essential to keep the Hummingbot platform updated with the most demanded and relevant connectors. HBOT token holders can weigh in on this.
+
+* **Governance System Parameters**: Apart from connectors, there are several other governance decisions to be made, such as bounty allocations for specific connectors and adjusting the connector inclusion thresholds. By holding HBOT, you can voice your opinions on these matters and help steer the ecosystem in a direction that best aligns with your preferences.
+
+* **Board Elections**: In addition, HBOT holders have the power to re-elect the Hummingbot Foundation Board of Directors each year.
+
+**Funding Bounties:**
+
+* **Bug Fixes and Improvements**: Encountered a bug or see room for improvement in a connector? With HBOT tokens, you can fund bounties to incentivize community developers to address these issues. By doing this, you're not only enhancing the user experience for yourself but also for the broader Hummingbot community.
+
+* **New Features**: Have an idea for a novel feature that could benefit the community? You can propose and fund a bounty to bring this feature to life. By compensating developers with HBOT tokens, you can encourage and foster innovation within the ecosystem.
+
+* **Bounties Board**: The Hummingbot platform has a dedicated [Bounties Board](https://github.com/orgs/hummingbot/projects/7/views/1), a place where token holders can list bounties for specific tasks, and community developers can pick them up. Whether it's a bug fix, a new connector, or an innovative strategy, the bounty board serves as a bridge between token holders and developers, aligning interests and fostering collaboration.
+
+In summary, HBOT tokens are not just a means of investment or holding; they're a tool that grants you an active role in the Hummingbot ecosystem's development and trajectory. Whether you're voting on key decisions or funding development work, the HBOT token ensures your voice is heard and your needs are addressed.
+
+## How can I earn HBOT tokens?
+
+Those involved with Hummingbot, whether as developers or users, primarily earn HBOT tokens through [Bounties](/governance/bounties). These rewards are a token of appreciation given to those who actively contribute to refining the Hummingbot platform. Whether it's bug fixes, connector enhancements, formulation of new trading strategies, or crafting educational content, each task can be a gateway to earning HBOT tokens.
+
+Furthermore, our Bounties Board is a testament to the community-driven ethos of our ecosystem. It's an arena where every connector, including those categorized as Bronze, can tap into the rich pool of expertise that our community offers. This interactive platform connects connectors in need of upgrades with seasoned Hummingbot developers. The result is a dynamic system where tasks find swift resolutions by experts, ensuring the consistent growth and improvement of the Hummingbot platform.
+
+## How does demand and supply for HBOT reach equilibrium?
+
+The trajectory of the Hummingbot ecosystem is largely shaped by our community maintainers. As the ecosystem thrives, we foresee a linear escalation in maintenance expenses, primarily due to development bounties. Conversely, as our user base grows, both the fees and the volume accumulated by the Foundation are poised to experience exponential growth. Our objective is to achieve an equilibrium where HBOT tokens disbursed to developers as bounties align closely with the HBOT garnered from connector affiliations. Should there arise a scenario where the fee share income overshadows operational expenses, the excess will be redirected to fuel more HBOT bounties, preserving a harmonious demand-supply dynamic.
+
+## What was changed in Epoch 6?
+
+Epoch 6, marked by [HGP-45](https://snapshot.org/#/hbot.eth/proposal/0x7807da661f09096db6aadb277051ed6defd580259fd8e503c2a77a83779a3fd5), ushered in the following transformations:
+
+* **Introduction of Chain Connector Voting:** This system was established to support and green-light Chain Connector endorsements.
+* **Delineation of Bounty Allocations:** Provisions were made for 400K Gold and 100K Silver bounty funds, reserved solely for connectors.
+* **Redefining the Connector Inclusion Threshold:** The bar for Connector Inclusion was elevated, now set at 200K HBOT, a significant jump from the earlier benchmark of 100K HBOT.
+
+## Conclusion
+
+HBOT is your passport to actively shaping the Hummingbot ecosystem. With HBOT in hand, you hold the reins – deciding which connectors thrive, endorsing critical bounties, and guiding our platform's trajectory. As the Hummingbot community grows, the scope and impact of HBOT will undoubtedly expand.

docs/bounties/index.md

@@ -32,9 +32,9 @@ Bounties can be classified into one of the following types:
 * 🐞 **Bug Fix**: Fix to a bug in the Hummingbot codebase
 * 🚀 **Enhancement**: Update or improvement to a component in the Hummingbot codebase
 * 📺 **Content**: Documentation, videos, guides, and other content that explains how to use an aspect of Hummingbot
-* 📜 **New Script**: A new [script](/scripts/) in the Hummingbot codebase
-* 🏦 **New Connector**: A new [exchange](/exchanges/) or [blockchain](/gateway/chains/) connector in Hummingbot or Hummingbot Gateway
-* 📈 **New Strategy**: A new [strategy](/strategies/) in the Hummingbot codebase.
+* 🔬 **Research**: Investigation into possible work and recommendation on how to proceed
+* 🏦 **New Connector**: A new [connector](/exchanges/) in the Hummingbot or the Hummingbot Gateway codebases
+* 📈 **New Strategy/Script**: A new [strategy](/strategies/) or [script](/scripts/) in the Hummingbot codebase.
 
 In addition, bounties may be:
 

docs/getting-started/index.md

@@ -9,17 +9,17 @@ Our codebase is free and publicly available on Github under the Apache 2.0 open
 New to Hummingbot? Start here!
 
 - [Installation](../installation/index.md): Install Hummingbot on various platforms
-- [Quickstart](../quickstart/index.md): Follow the new Quickstart guide to learn how to build a custom market making strategy with Hummingbot!
 - [Features](../client/index.md): The main commands and configs in Hummingbot
+- [Quickstart - Liquidity Mining](./custom-script/index.md): Follow this guide to learn how to earn liquidity mining rewards by running Hummingbot on the Miner platform
 
 ## 👩‍💻 For developers
 
 Hummingbot is a general source framework for crypto algorithmic trading. We welcome developers to fork the codebase for their own purposes and contribute to the community.
 
+- [Quickstart - Custom Script](./custom-script/index.md): Follow this guide to learn how to build a custom market making strategy with Hummingbot!
 - [Developers](../developers/index.md): Explanation of Hummingbot's architecture and detailed reference on how to build connectors and strategies
 - [Bounties](../bounties/index.md): Get paid for building and maintaining Hummingbot components
 connector middleware
-- [Support Hummingbot!](../support-hummingbot.md): How you can support our mission to democratize HFT!
 - [Contribution Guidelines](../developers/contributions.m): Read this before submitting a pull request
 
 ## 🙋‍♂️ Getting help
@@ -30,10 +30,4 @@ Hummingbot features an active, friendly community of users globally! Here are so
 - To report a bug or request a new feature, post a [Github issue](https://github.com/hummingbot/hummingbot/issues/new/choose).
 - Join the official [Discord](https://discord.gg/hummingbot) and post your question on **#support**
 
-For users using Hummingbot to earn rewards on [Miner](https://miner.hummingbot.io), the decentralized market making platform operated by CoinAlpha, you can also access Miner support via the following methods:
-
-- Discord: CoinAlpha maintains 24/7 dedicated technical support for users on the **#miner-support** channel within the Hummingbot Discord server. They help users install Hummingbot and configure API keys for use with the Miner platform, investigates reports related to missing or duplicate rewards, and other issues. 
-- Email: Send CoinAlpha support a message at [support@hummingbot.io](mailto:support@hummingbot.io)
-- Live chat: Click the chat widget in the lower right hand corner of the [Miner website](https://miner.hummingbot.io).
-
 We pledge that we will not use the information/data your provide us for trading purposes nor share them with third parties.

docs/getting-started/liquidity-mining/1-create-keys.md

@@ -0,0 +1,56 @@
+This is **part 1** of the Hummingbot Liquidity Mining Quickstart Guide:
+
+1. **Create API Keys**
+2. [Configure Miner]
+3. [Install Hummingbot]
+4. [Create Bot]
+5. [Earn Rewards]
+
+Let's get started!
+
+## Create API keys
+
+First, create an account at one of the following exchanges where Miner offers liquidity mining:
+
+* [Binance.com](https://binance.com) (not [Binance.US](https://binance.us))
+* [Kucoin](https://kucoin.com)
+* [Gate.io](https://gate.io)
+* [AscendEx](https://ascendex.com)
+
+Afterwards, go to the API management section of the exchange website. Here's where it resides in KuCoin:
+![][kucoin-home]
+
+Then, find the **Create API** command to create two API keys:
+
+* **Read-only key**: used by Miner to track and verify your order data in order to allocate rewards to you
+* **Trade key**: used by the Hummingbot software to run an automated bot that automatically creates and cancels orders
+
+### Read-only key
+
+The first API key should have `Enable Reading` checked in setup. This will be used to create the snapshots that Miner will read to calculate rewards. In the next section, you will add this key to the Miner app, which allows it to verify your bot’s activity and allocate your rewards.
+
+Additional verification steps may be needed, including two-factor authentication (2FA) or verification by SMS/email.
+
+In KuCoin, you can create a read-only API by only checking the **General** option and leaving **Trade** unchecked:
+![](./1-b-kucoin-create-api.png)
+
+### Trade key
+
+The second key should be trade enabled. Later, you will use this API key with the Hummingbot client to allow it to place and fill orders on a connected exchange.
+
+For each API key, make sure to save the API key, secret key, and passphrase (if required), since the exchange only shows them to you upon creation. You will need the public and secret keys for both APIs in the following steps!
+
+Afterwards, you should have two keys, a read-only key and a trade-enabled key:
+![](./1-c-kucoin-api-management.png)
+
+Next, [add a read-only API key to Miner][Configure Miner]
+
+[kucoin-home]: ./1-a-kucoin-home.png
+[kucoin-create-api]: ./1-b-kucoin-create-api.png
+[kucoin-api-management]: ./1-c-kucoin-api-management.png
+
+[Create API Keys]: ./1-create-keys
+[Configure Miner]: ./2-configure-miner
+[Install Hummingbot]: ./3-install-hummingbot
+[Create Bot]: ./4-create-bot
+[Earn Rewards]: ./5-earn-rewards

docs/getting-started/liquidity-mining/2-configure-miner.md

@@ -0,0 +1,49 @@
+This is **part 2** of the Hummingbot Liquidity Mining Quickstart Guide:
+
+1. [Create API Keys]
+2. **Configure Miner**
+3. [Install Hummingbot]
+4. [Create Bot]
+5. [Earn Rewards]
+
+## Create a Miner account
+
+Miner is a liquidity mining platform where you can run market making bots to earn liquidity rewards on various exchanges. In this step, you will add your read-only API key to Miner so that you can earn and monitor rewards for the orders placed by your bots.
+
+> Users are free to download and run Hummingbot without signing up on the mining platform. The liquidity mining strategy in particular, however, is optimized for participating in Miner campaigns.
+
+1. Navigate to [Miner](https://miner.hummingbot.io), and click on `Log in`
+![](./2-a-log-in.png)
+
+2. Select `Sign up`
+
+3. Enter your email address, read and agree to the [Terms of Service](https://hummingbot.io/terms/), then click on `Create account`
+![](./2-b-sign-up.png)
+
+4. Check your email to confirm your account
+
+5. On the Miner email, click on `Log in to Miner`
+
+> After clicking on the link sent by email, a new tab will open confirming that you are logged into Miner. You may close it and return to your original tab.
+
+![](./2-c-logged-in.png)
+
+6. You should now be logged into Miner with your new account.
+
+7. Go to the Settings page, and add the read-only API to your account.
+
+![](./2-d-settings.png)
+
+Add the read-only API key, Secret key, and Passphrase generated in [step one][Create API Keys]
+
+![](./2-e-add-keys.png)
+
+> Please do not attempt to use the same API key on more than one Miner account. Doing so will be seen as an attempt to cheat the system, since this could potentially cause users to be rewarded multiple times for the same orders, and will result in blacklisting.
+
+Next, you'll need to [install hummingbot][Install Hummingbot]
+
+[Create API Keys]: ./1-create-keys
+[Configure Miner]: ./2-configure-miner
+[Install Hummingbot]: ./3-install-hummingbot
+[Create Bot]: ./4-create-bot
+[Earn Rewards]: ./5-earn-rewards

docs/getting-started/liquidity-mining/3-install-hummingbot.md

@@ -0,0 +1,26 @@
+This is **part 3** of the Hummingbot Liquidity Mining Quickstart Guide:
+
+  1. [Create API Keys]
+  2. [Configure Miner]
+  3. **Install Hummingbot**
+  4. [Create Bot]
+  5. [Earn Rewards]
+
+You are about to download Hummingbot, which is open source and free to use!
+
+## Installation methods
+
+Coming soon.
+
+## Post installation
+
+After successful installing Hummingbot, you should see the Hummingbot interface:
+![Hummingbot CLI](./3-a-hummingbot-cli.png)
+
+Proceed to the next part of the Hummingbot quickstart guide: [Create Bot][Create Bot]
+
+[Create API Keys]: ./1-create-keys
+[Configure Miner]: ./2-configure-miner
+[Install Hummingbot]: ./3-install-hummingbot
+[Create Bot]: ./4-create-bot
+[Earn Rewards]: ./5-earn-rewards