Skip to content

Commit

Permalink
Merge pull request #235 from funttastic/feat/kujira
Browse files Browse the repository at this point in the history
Inclusion of the Kujira connector
  • Loading branch information
david-hummingbot committed Sep 27, 2023
2 parents cf0dc6f + a06e9a1 commit d41bcfa
Show file tree
Hide file tree
Showing 5 changed files with 117 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/chains/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
44 changes: 44 additions & 0 deletions docs/chains/kujira.md
Original file line number Diff line number Diff line change
@@ -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.
1 change: 1 addition & 0 deletions docs/dex-connectors/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
69 changes: 69 additions & 0 deletions docs/exchanges/kujira.md
Original file line number Diff line number Diff line change
@@ -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`
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -288,6 +288,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
Expand All @@ -313,6 +314,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
Expand Down

0 comments on commit d41bcfa

Please sign in to comment.