discord

Documentation

Overview

Package discord provides a discord bot to poll NDX contracts

Index

• Variables
• func BaseEmbed() *discordgo.MessageEmbed
• func NewConfig(path string) error
• type Client
  • func NewClient(ctx context.Context, cfg *Config, bc *bclient.Client, db *db.Database) (*Client, error)
  • func (c *Client) Close() error
• type Config
  • func LoadConfig(path string) (*Config, error)
• type Database
• type Watcher

Variables

var (
	// ExampleConfig is primarily used to provide a template for generating the config file
	ExampleConfig = &Config{
		MainDiscordToken: "CHANGEME-MAIN",
		InfuraAPIKey:     "INFURA-KEY",
		InfuraWSEnabled:  false,
		ETHRPCEndpoint:   "http://localhost:8545",
		Watchers: []Watcher{
			{DiscordToken: "CHANGEME-TOKEN", Currency: "CHANGEME-CURRENCY"},
		},
		Database: Database{
			Type:           "sqlite",
			Host:           "localhost",
			Port:           "5432",
			User:           "user",
			Pass:           "pass",
			DBName:         "indexed",
			DBPath:         "/changeme",
			SSLModeDisable: false,
		},
	}
)

Functions

func BaseEmbed

func BaseEmbed() *discordgo.MessageEmbed

BaseEmbed returns a base message embed type to be customized

func NewConfig

func NewConfig(path string) error

NewConfig generates a new config and stores at path

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client wraps bclient and discordgo to provide a discord bot for indexed finance

func NewClient

func NewClient(ctx context.Context, cfg *Config, bc *bclient.Client, db *db.Database) (*Client, error)

NewClient provides a wrapper around discordgo

func (*Client) Close

func (c *Client) Close() error

Close terminates the discordgo session

type Config

type Config struct {
	// the token used by the main bot (NDXBot)
	MainDiscordToken string `yaml:"main_discord_token"`
	// if nil we dont use infura and connect directly to the rpc node below
	InfuraAPIKey    string    `yaml:"infura_api_key"`
	InfuraWSEnabled bool      `yaml:"infura_ws_enabled"`
	ETHRPCEndpoint  string    `yaml:"eth_rpc_endpoint"`
	Watchers        []Watcher `yaml:"watchers"`
	Database        Database  `yaml:"database"`
}

Config bundles together discord configuration information

func LoadConfig

func LoadConfig(path string) (*Config, error)

LoadConfig loads the configuration

type Database

type Database struct {
	Type           string `yaml:"type"` // sqlite or postgres, if sqlite all other options except DBName are ignored
	Host           string `yaml:"host"`
	Port           string `yaml:"port"`
	User           string `yaml:"user"`
	Pass           string `yaml:"pass"`
	DBName         string `yaml:"db_name"`
	DBPath         string `yaml:"db_path"`
	SSLModeDisable bool   `yaml:"ssl_mode_disable"`
}

Database provides configuration over our database connection

type Watcher

type Watcher struct {
	DiscordToken string `yaml:"discord_token"`
	Currency     string `yaml:"currency"`
}

Watcher is used to start a process that watches the price of a token and posts its value as a name