From 0d5004d0f680a512cfb8c8676b59dd62d15dbef9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Danilo=20Arau=CC=81jo=20Silva?= Date: Fri, 22 Sep 2023 00:19:34 +0200 Subject: [PATCH] Inclusion of the Kujira connector MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit commit 8c9c6b359ffb7d7c5028ff5a63732c20c707aabd Author: Danilo Araújo Silva Date: Thu Sep 21 23:34:40 2023 +0200 Updating Kujira markdown files. commit 56e54ec61c68fc9d88ab6d6896445d01d281d262 Author: Álvaro E. F. Mota Date: Thu Sep 21 15:29:57 2023 -0300 fixing english mistakes commit 29e9bdb7ec2d1d1febbab6ae0518ceb8574a27a2 Author: Álvaro E. F. Mota Date: Thu Sep 21 15:27:51 2023 -0300 Organizing the discord channel hashtag commit 042628a26f6f3b49d7d147bb4fa4cb6c65a0cbf9 Author: Álvaro E. F. Mota Date: Thu Sep 21 14:45:00 2023 -0300 Modified files related to kujira commit bce4ae06b997d1fede4bc41a2fa19012c0df5642 Author: Álvaro E. F. Mota Date: Wed Sep 20 14:54:44 2023 -0300 Added kujira connector documentation --- docs/chains/index.md | 1 + docs/chains/kujira.md | 44 +++++++++++++++++++++++ docs/dex-connectors/index.md | 1 + docs/exchanges/kujira.md | 69 ++++++++++++++++++++++++++++++++++++ mkdocs.yml | 2 ++ 5 files changed, 117 insertions(+) create mode 100644 docs/chains/kujira.md create mode 100644 docs/exchanges/kujira.md diff --git a/docs/chains/index.md b/docs/chains/index.md index 17d60363..4ba64359 100644 --- 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 new file mode 100644 index 00000000..b4b7d0cc --- /dev/null +++ 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 <change to your kujira wallet address here> + +After that you should receive some Kujira tokens on your balance. \ No newline at end of file diff --git a/docs/dex-connectors/index.md b/docs/dex-connectors/index.md index 4bd9f19b..8eb14fcd 100644 --- 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 new file mode 100644 index 00000000..13d9abd2 --- /dev/null +++ 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**: +- **CoinMarketCap**: +- **CoinGecko**: +- **API Docs**: +- **Fees**: + +## 🔑 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**: + +### Order Types + +This connector supports the following `OrderType` constants: + +- `LIMIT` +- `MARKET` \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 67327eb3..bcd3f731 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -277,6 +277,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 @@ -302,6 +303,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