-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
63 additions
and
48 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,23 @@ | ||
# Whale Notification Bot | ||
A telegram bot which watches and sends message to the group when a swap above threshold amount takes place for the solana SPL-TOKEN. | ||
A telegram bot which watches and sends message to the group when a swap above threshold amount takes place for the solana SPL-TOKEN on meteora pools. Currently, the bot is limited to 4 tokens per group (this can be modified in the by changing _maxTokensPerGroup_). | ||
|
||
## Environment variables | ||
## Executing on local | ||
|
||
### Environment variables | ||
Create an .env file and add the following variables. | ||
```.env | ||
BOT_TOKEN= | ||
DB_URI= | ||
HELIUS_API_KEY= | ||
BACKEND_RPC= | ||
BIRDSEYE_API_KEY= | ||
``` | ||
### Running the bot | ||
```bash | ||
yarn install | ||
yarn start | ||
``` | ||
|
||
## Commands | ||
- list - Get the list of tokens and the min. amount registered. Usage : /list | ||
- register - Register the token with min. amount. Usage : /register <token_mint> <min_value> | ||
- unregister - Unregister a token. Usage : /unregister <token_mint> | ||
## Telegram Bot Commands | ||
- config - Configure the bot; add/remove tokens to watch and modify their settings. | ||
- setup - Setup the portal, add the bot to the group. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters