mirror of https://github.com/d0zingcat/gocryptotrader.git synced 2026-05-13 15:09:42 +00:00

Files

Adrian Gallagher 400bcb6b56 telegram: Fix pushing events to an authorised client list (#1208 )

* fix_communications_authorised_clients

* Telegram: Link config to authorised clients list

* Telegram: Prevent multiple spam messages from unauthed user

* Telegram: Improve command handling for authenticated users

Telegram doesn't allow you to easily fetch the user ID of a user unless they have previously sent you a message and is currently waiting to be processed, or if they message you on the fly once the bot is connected. This ensures that the user ID is stored for future usage upon a single successful auth command.

It also fixes the offset as the previous code wouldn't be able to process incoming messages once connected and instead only relay them.

* Bump docs

* default to UTC time in case bot is run on a server with diff time zones

* Enhance config for already upgraded configs

---------

Co-authored-by: shanhuhai5739 <shanhu5739@gmail.com>

2023-06-05 10:37:13 +10:00

4.2 KiB

Raw Blame History

GoCryptoTrader package Telegram

This telegram package is part of the GoCryptoTrader codebase.

This is still in active development

You can track ideas, planned features and what's in progress on this Trello board: https://trello.com/b/ZAhMhpOy/gocryptotrader.

Join our slack to discuss all things related to GoCryptoTrader! GoCryptoTrader Slack

Telegram Communications package

What is telegram?

Telegram is a cloud-based instant messaging and voice over IP service developed by Telegram Messenger LLP
Please visit: Telegram for more information

Current Features

Creation of bot that can retrieve

Bot status

How to enable

Enable via configuration
See the individual package example below. NOTE: For privacy considerations, it's not possible to directly request a user's ID through the Telegram Bot API unless the user interacts first. The user must message the bot directly. This allows the bot to identify and save the user's ID. If this wasn't set initially, the user's ID will be stored by this package following a successful authentication when any supported command is issued.

import (
	"github.com/thrasher-corp/gocryptotrader/communications/base"
	"github.com/thrasher-corp/gocryptotrader/communications/telegram"
)

t := new(telegram.Telegram)

// Define Telegram configuration
commsConfig := &base.CommunicationsConfig{
	TelegramConfig: base.TelegramConfig{
		Name:              "Telegram",
		Enabled:           true,
		Verbose:           false,
		VerificationToken: "token",
		AuthorisedClients: map[string]int64{"pepe": 0}, // 0 represents a placeholder for the user's ID, see note above for more info.
	},
}

t.Setup(commsConfig)
err := t.Connect
// Handle error

Once the bot has started you can interact with the bot using these commands via Telegram:

/start			- Will authenticate your ID
/status			- Displays the status of the bot
/help			- Displays current command list

Please click GoDocs chevron above to view current GoDoc information for this package

Contribution

Please feel free to submit any pull requests or suggest any desired features to be added.

When submitting a PR, please abide by our coding guidelines:

Code must adhere to the official Go formatting guidelines (i.e. uses gofmt).
Code must be documented adhering to the official Go commentary guidelines.
Code must adhere to our coding style.
Pull requests need to be based on and opened against the master branch.

Donations

If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to:

bc1qk0jareu4jytc0cfrhr5wgshsq8282awpavfahc

4.2 KiB Raw Blame History