mirror of https://github.com/d0zingcat/gocryptotrader.git synced 2026-05-13 23:16:45 +00:00

Files

Ryan O'Hara-Reid e99adca86f encoding/json: Add custom JSON package with build tag support for Sonic (#1623 )

* tag optional sonic and allow full library conversion

* Add workflow and disallow arm and darwin usage

* Add basic hotswap benchmark

* linter: fix

* use bash

* linter: fix?

* Fix whoopsie, add to make file, also add mention in features list.

* test enforcement

* actually read documentation see if this works

* linter: fix

* linter: fix

* sonic: bump tagged version

* encoding/json: drop build tag arch and os filters

* encoding/json: consolidate tests

* encoding/json: log build tag usage

* rm superfluous builds

* glorious/nits: add template change and regen docs

* glorious/nits: update commentary on nolint directive

* glorious/nits: rm init func and log results in main.go

* Test to actually pull flag in

* linter: fix

* thrasher: nits

* gk: nits 4 goflags goooooooooo!

* gk: nits rn

* make sonic default json implementation

* screen 386

* linter: fix

* Add commentary

* glorious: nits Makefile not working

* gk: nits

* gk: nits whoops

* whoopsirino

* mention 32bit systems won't be sonic

* gk: super-duper nit of extremes

---------

Co-authored-by: Ryan O'Hara-Reid <ryan.oharareid@thrasher.io>

2025-02-20 16:05:55 +11:00

README.md

docs: Migrate development tracking from Trello to GitHub Projects (#1696 )

2024-11-08 10:10:49 +11:00

telegram_test.go

telegram: Fix pushing events to an authorised client list (#1208 )

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

telegram_types.go

New communications package

2018-06-08 14:09:36 +10:00

telegram.go

encoding/json: Add custom JSON package with build tag support for Sonic (#1623 )

2025-02-20 16:05:55 +11:00

README.md

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 our GoCryptoTrader Kanban board.

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