mirror of https://github.com/d0zingcat/gocryptotrader.git synced 2026-05-13 23:16:45 +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

slack_test.go

(Engine) Variety of engine updates (#390 )

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

slack_types.go

Engine QA (#381 )

2019-11-22 16:07:30 +11:00

slack.go

(Engine) Variety of engine updates (#390 )

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

README.md

GoCryptoTrader package Slack

This slack 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

Slack Communications package

What is Slack?

Slack is a code-centric collaboration hub that allows users to connect via an app and share different types of data
Please visit: Slack for more information and account setup

Current Features

Basic communication to your slack channel information includes:
- Working status of bot
- Recent ANX ticker
- Current ANX orderbook

How to enable

Enable via configuration
Individual package example below:

import (
"github.com/thrasher-corp/gocryptotrader/communications/slack"
"github.com/thrasher-corp/gocryptotrader/config"
)

s := new(slack.Slack)

// Define slack configuration
commsConfig := config.CommunicationsConfig{SlackConfig: config.SlackConfig{
  Name: "Slack",
	Enabled: true,
	Verbose: false,
	TargetChannel: "targetChan",
	VerificationToken: "slackGeneratedToken",
}}

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

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

!status 		- Displays current working status of bot
!help 			- Displays help text
!settings		- Displays current settings
!ticker			- Displays recent ANX ticker
!portfolio	- Displays portfolio data
!orderbook	- Displays current ANX orderbook

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