Inclusion of the Kujira connector

commit 8c9c6b3 Author: Danilo Araújo Silva <danilo.silva@funttastic.com> Date: Thu Sep 21 23:34:40 2023 +0200 Updating Kujira markdown files. commit 56e54ec Author: Álvaro E. F. Mota <alvaro.mota@gmail.com> Date: Thu Sep 21 15:29:57 2023 -0300 fixing english mistakes commit 29e9bdb Author: Álvaro E. F. Mota <alvaro.mota@gmail.com> Date: Thu Sep 21 15:27:51 2023 -0300 Organizing the discord channel hashtag commit 042628a Author: Álvaro E. F. Mota <alvaro.mota@gmail.com> Date: Thu Sep 21 14:45:00 2023 -0300 Modified files related to kujira commit bce4ae0 Author: Álvaro E. F. Mota <alvaro.mota@gmail.com> Date: Wed Sep 20 14:54:44 2023 -0300 Added kujira connector documentation
hummingbot · Sep 21, 2023 · f13f0da · f13f0da
1 parent 2298624
commit f13f0da
Show file tree

Hide file tree

Showing 5 changed files with 117 additions and 0 deletions.
diff --git a/docs/chains/index.md b/docs/chains/index.md
@@ -14,6 +14,7 @@ Here are the current chain connectors in the codebase, as of Q3 2023:
 | [Cronos](/chains/cronos) | Non-EVM |
 | [Harmony](/chains/harmony) | EVM |
 | [Injective](/chains/injective) | Non-EVM |
+| [Kujira](/chains/kujira) | Non-EVM |
 | [Polygon](/chains/polygon) | EVM |
 | [NEAR](/chains/near) | Non-EVM |
 | [XDC Chain](/chains/xdc-chain) | Non-EVM |

diff --git a/docs/chains/kujira.md b/docs/chains/kujira.md
@@ -0,0 +1,44 @@
+# `Kujira`
+
+`Kujira` is a [Chain](/chains) connector in Hummingbot Gateway that helps users connect to FIN DEX on the Kujira blockchain.
+
+## 📁 Connector Info
+
+* Folder: [/gateway/src/chains/kujira](https://github.com/hummingbot/gateway/tree/development/src/chains/kujira)
+* Configs: [/gateway/src/templates/kujira.yml](https://github.com/hummingbot/gateway/blob/development/src/templates/kujira.yml)
+
+## ℹ️ Chain Info
+
+* Website: https://kujira.app
+* Block Explorer:  https://finder.kujira.network
+* CoinMarketCap: https://coinmarketcap.com/currencies/kujira
+* CoinGecko: https://www.coingecko.com/en/coins/kujira
+
+## 🕸️ Supported Networks
+
+| Network | ChainId | Type |  
+|---------|---------|------|  
+| `mainnet` | kaiyo-1 | mainnet |  
+| `testnet` | harpoon-4 | testnet |
+
+## 🚰 Faucets
+
+To add funds to your testnet wallet, you can use a faucet inside the Kujira Discord.
+
+To join their discord you can use this link:
+
+> [https://discord.gg/teamkujira](https://discord.gg/teamkujira)
+
+After joining and doing their verification process, you can look for this channel:
+
+> `#public-testnet-faucet`
+
+Or try this link:
+
+> [https://discord.com/channels/970650215801569330/1009931570263629854](https://discord.com/channels/970650215801569330/1009931570263629854)
+
+Then you can use the following command there:
+
+> !faucet &lt;change to your kujira wallet address here&gt;
+
+After that you should receive some Kujira tokens on your balance.
diff --git a/docs/dex-connectors/index.md b/docs/dex-connectors/index.md
@@ -14,6 +14,7 @@ Here are the current DEX connectors in the codebase, as of Q3 2023:
 | [Dexalot](../exchanges/dexalot.md) | CLOB | 🥈 Silver | Hummingbot Foundation |
 | [Defira](../exchanges/defira.md) | AMM | 🥉 Bronze
 | [Injective](../exchanges/injective.md) | CLOB | 🥉 Bronze
+| [Kujira](../exchanges/kujira.md) | CLOB | 🥉 Bronze
 | [Loopring](../exchanges/loopring/index.md) | CLOB | 🥉 Bronze
 | [Mad Meerkat](../exchanges/mad-meerkat.md) | AMM | 🥉 Bronze | [CoinAlpha](https://coinalpha.com) | 
 | [OpenOcean](../exchanges/openocean.md) | AMM | 🥉 Bronze

diff --git a/docs/exchanges/kujira.md b/docs/exchanges/kujira.md
@@ -0,0 +1,69 @@
+
+## 🛠 Connector Info
+
+- **Exchange Type**: Decentralized Exchange (**DEX**)
+- **Market Type**: Central Limit Order Book (**CLOB**)
+- **Maintenance Tier**: ![](https://img.shields.io/static/v1?label=Hummingbot&message=BRONZE&color=green	)
+- **Maintainer:**   
+
+Currently, Kujira is a **Bronze** exchange, as voted by HBOT holders in each quarterly [Epoch](/governance/epochs). This means Hummingbot Foundation does not maintain the components below, but community members may submit [Proposals](/governance/proposals) to fund development bounties and approve pull requests to fix bugs and add enhancements to them.
+
+| Component                                  | Status        | Notes            |
+|--------------------------------------------|---------------|------------------|
+| [🔀 Spot Connector](#spot-connector)       | ✅             | Supports testnet |
+| [🔀 Perp Connector](#perp-connector)       | Not available |                  |
+| [🕯 Spot Candles Feed](#spot-candles-feed) | Not available |                  |
+| [🕯 Perp Candles Feed](#perp-candles-feed) | Not available |                  |
+
+## ℹ️ Exchange Info
+
+- **Website**: <https://fin.kujira.network/>
+- **CoinMarketCap**: <https://coinmarketcap.com/currencies/kujira/>
+- **CoinGecko**: <https://www.coingecko.com/en/coins/kujira>
+- **API Docs**: <https://docs.kujira.app/dapps-and-infrastructure/fin>
+- **Fees**: <https://docs.kujira.app/dapps-and-infrastructure/fin/how-to-use-fin/spot-and-margin-trade-ui#spot-trading>
+
+## 🔑 How to Connect
+
+Create a Keplr wallet to use the supported networks below:
+
+| Chain    | Networks             |
+|----------|----------------------|
+| `kujira` | `mainnet`, `testnet` |
+
+From inside the Hummingbot client, run `gateway connect kujira` in order to connect your wallet:
+
+In the private key field you have to put your mnemonic.
+
+```  
+Which chain do you want kujira to connect to? (kujira) >>> kujira
+
+Which network do you want kujira to connect to? (mainnet, testnet) >>> mainnet
+
+Do you want to continue to use node url 'None' for kujira-mainnet? (Yes/No) >>> Yes
+
+Enter your kujira-mainnet wallet private key >>>  *****************************
+***********************************
+
+Enter your kujira account number (input 0 if unsure) >>> 0
+```
+
+If connection is successful:
+
+```  
+The kujira connector now uses wallet [pubKey] on kujira-mainnet  
+```  
+
+## 🔀 Spot Connector
+*Integration to spot markets API endpoints*
+
+- **ID**: `kujira`
+- **Connection Type**: REST API
+- **Folder**: <https://github.com/hummingbot/gateway/tree/development/src/connectors/kujira>
+
+### Order Types
+
+This connector supports the following `OrderType` constants:
+
+- `LIMIT`
+- `MARKET`
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -278,6 +278,7 @@ nav:
         - Dexalot 🥈: exchanges/dexalot.md
         - Defira: exchanges/defira.md
         - Injective: exchanges/injective.md
+        - Kujira: exchanges/kujira.md
         - Loopring: exchanges/loopring/index.md
         - Mad Meerkat: exchanges/mad-meerkat.md
         - OpenOcean: exchanges/openocean.md
@@ -303,6 +304,7 @@ nav:
         - Cosmos: chains/cosmos.md
         - Harmony: chains/harmony.md
         - Injective: chains/injective.md
+        - Kujira: chains/kujira.md
         - NEAR: chains/near.md
         - Polygon: chains/polygon.md
         - XDC Chain: chains/xdc-chain.md