mirror of https://github.com/d0zingcat/gocryptotrader.git synced 2026-05-14 07:26:47 +00:00

Files

Ryan O'Hara-Reid 0c5d75b22c (Engine) Variety of engine updates (#390 )

* drop common uuid v4 func and imported package as needed

* removed common functions regarding json marshal and unmarshal and used the json package directly. WRT unmarshal it was calling reflect and converted to string which is also checked in the JSON package so it was doing a double up, this will be a tiny gain as it was directly used in the requester package for all our outbound requests.

* add in string

* explicitly throw away return error value

* atleast return the error that websocket initialise returns

* return error when not connected

* fix comment

* Adds comments

* move package declarations

* drop append whenever we call supported

* remove unused import

* Change incorrect spelling

* fix tests

* fix go import issue

2019-12-03 10:06:08 +11:00

README.md

Add directories to exclusion list && change default repo string (#387 )

2019-11-29 11:14:19 +11:00

telegram_test.go

Engine: Protocol Features, coverage, types, BTC markets websocket (#368 )

2019-10-22 10:56:20 +11:00

telegram_types.go

New communications package

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

telegram.go

(Engine) Variety of engine updates (#390 )

2019-12-03 10:06:08 +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 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
ANX orderbook
ANX ticker

How to enable

Enable via configuration
Individual package example below:

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
/ticker 		- Displays current ANX ticker data
/portfolio	- Displays your current portfolio
/orderbooks - Displays current orderbooks for ANX`

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:

1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB