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

Files

Adrian Gallagher ba92ba3254 docs: Add CODING_GUIDELINES.md and other adjustments (#1988 )

* docs: Create new CODING_GUIDELINES doc

Rids excess contribution instructions from other packages
Adds AGENTS.md file for the AI overlords
Rids unused templates
Updates ADD_NEW_EXCHANGE.md with minor fixes

* docs: Fix linter issues and minor adjustments based on Copilot feedback

* docs: Update coding guidelines for API parameters and testing practices

* docs: Remove redundant GoDoc references

Adds copilot-instructions.md

* docs: Update CODING_GUIDELINES with export recommendations and test commentary

* docs: Fix formatting inconsistencies in ADD_NEW_EXCHANGE.md links

* docs: Update struct naming conventions for request and response types

* docs: Improve clarity and consistency in ADD_NEW_EXCHANGE.md and CODING_GUIDELINES.md

* refactor: Simplify error handling in QueryOrder method

2025-08-08 12:10:53 +10:00

README.md

docs: Add CODING_GUIDELINES.md and other adjustments (#1988 )

2025-08-08 12:10:53 +10:00

telegram_test.go

GHA: Add additional checks for common issues (#1922 )

2025-05-28 12:26:51 +10:00

telegram_types.go

modernise: Run new gopls modernise tool against the codebase and fix minor issues (#1826 )

2025-03-21 09:17:10 +11:00

telegram.go

GHA: Add additional checks for common issues (#1922 )

2025-05-28 12:26:51 +10: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

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