communications

README

GoCryptoTrader package Comms

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

Communications package

What is the Communications package?

• This package allows for the communication of events/data that occurs in the to be exported out to a defined communication medium

Current Features

• Slack bot support
• SMSGlobal instant bulk messaging
• SMTP messaging
• Telegram bot support

How to enable example

• In your config.json enable each individual communications package you desire
• Please view the individual readme documentation inside the specific package for more details

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

Documentation

Index

• Variables
• type Communications
  • func NewComm(cfg *base.CommunicationsConfig) (*Communications, error)

Variables

var ErrNoRelayersEnabled = errors.New("no communication relayers are enabled")

ErrNoRelayersEnabled returns when no communication relayers are enabled

Types

type Communications

type Communications struct {
	base.IComm
}

Communications is the overarching type across the communications packages

func NewComm

func NewComm(cfg *base.CommunicationsConfig) (*Communications, error)

NewComm sets up and returns a pointer to a Communications object