Files
gocryptotrader/communications/telegram/README.md
Adrian Gallagher b949388994 General engine improvements (#437)
* Add exchange manager to engine

* Several improvements for engine and friends

1) New file.Exists func
2) gRPC TLS cert expiration date check and regeneration
3) New donation var for use across the codebase
4) Use Go log package until the logger is initialised

* Add cert tests and create dir tree if it doesn't exist for file.Write

* Link up donation address to documentation tool plus minor adjustments

* Fix remaining donation addrs

* Move non-needed reload exchange funcs

* Revert accidental config_example.json changes 🕯️

* Use go logger for logging until the logger has initiliased, otherwise no output will be seen

* Link up portfolio delay val and other fixes

* Run go mod tidy after dependabot PR

* Address nitterinos
2020-02-06 12:32:01 +11:00

3.7 KiB

GoCryptoTrader package Telegram

Build Status Software License GoDoc Coverage Status Go Report Card

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 progresss 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

    import (
    "github.com/thrasher-corp/gocryptotrader/communications/telegram"
    "github.com/thrasher-corp/gocryptotrader/config"
    )
    
    t := new(telegram.Telegram)
    
    // Define Telegram configuration
    commsConfig := config.CommunicationsConfig{TelegramConfig: config.TelegramConfig{
      Name: "Telegram",
    	Enabled: true,
    	Verbose: false,
      VerificationToken: "token",
    }}
    
    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
/settings 	- Displays current bot settings

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