https://github.com/aggstam/telegram-bot-hyperliquid

Very basic Telegram bot to retrieve information from Hyperliquid.
https://github.com/aggstam/telegram-bot-hyperliquid

hyperliquid telegram-bot

Last synced: about 2 months ago
JSON representation

Very basic Telegram bot to retrieve information from Hyperliquid.

• Host: GitHub
• URL: https://github.com/aggstam/telegram-bot-hyperliquid
• Owner: aggstam
• License: gpl-3.0
• Created: 2024-10-23T20:28:31.000Z (2 months ago)
• Default Branch: master
• Last Pushed: 2024-10-28T17:27:10.000Z (2 months ago)
• Last Synced: 2024-10-28T18:48:36.540Z (2 months ago)
• Topics: hyperliquid, telegram-bot
• Language: Python
• Homepage:
• Size: 14.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# telegram-bot-hyperliquid

Very basic `Telegram` bot to retrieve information from [Hyperliquid](https://hyperliquid.xyz/).

After you obtained your bot key, you can configure it by simply editting the Makefile with your

config options:

| Config            | Description                                                         |

|-------------------|---------------------------------------------------------------------|

| `BOT_TOKEN`       | Your bot API key, provided by `telegram`                            |

| `HL_DEFAULT_VAULT`| The default `Hyperliquid` vault address to retrieve information for |

## Usage

Script provides the following Make targets:

| Target      | Description                             |

|-------------|-----------------------------------------|

| `bootstrap` | Create the environment and get all deps |

| `clean`     | Remove build artifacts                  |

| `deploy`    | Start the bot using the configuration   |

### Environment setup

The following OS dependencies are required:

|   Dependency   |

|----------------|

| git            |

| make           |

| python         |

| python-venv    |

Before first usage, you have to grab all the required python libraries:

```

% make bootstrap

```

### Execution

Since we are using a `python` virtual environment, we have to source

it before starting the bot:

```

% . {FULL_PATH_REPO}/venv/bin/activate

```

After that, you can modify the configuration and start the bot:

```

% make deploy

```

After the bot is up and running, you can verify it's working by

sending it a prompt like `/hl vault`. The bot should respond with

information for your default vault.