config

Documentation

Index

• type API
• type Baker
• type Config
  • func New() (Config, error)
• type Key
• type Notifications
• type Operations
• type Twilio
• type Twitter

Types

type API

type API struct {
	TZKT  string `env:"TZPAY_API_TZKT" envDefault:"https://api.tzkt.io" validate:"required"`
	Tezos string `env:"TZPAY_API_TEZOS" envDefault:"https://mainnet-tezos.giganode.io" validate:"required"`
}

API contains configurations for the tzkt API and a tezos node

type Baker

type Baker struct {
	Address                      string   `env:"TZPAY_BAKER" validate:"required"`
	Fee                          float64  `env:"TZPAY_BAKER_FEE" validate:"required"`
	MinimumPayment               int      `env:"TZPAY_BAKER_MINIMUM_PAYMENT" envDefault:"1"`
	EarningsOnly                 bool     `env:"TZPAY_BAKER_EARNINGS_ONLY"`
	DexterLiquidityContractsOnly bool     `env:"TZPAY_BAKER_LIQUIDITY_CONTRACTS_ONLY"`
	Blacklist                    []string `env:"TZPAY_BAKER_BLACK_LIST" envSeparator:","`
	DexterLiquidityContracts     []string `env:"TZPAY_BAKER_LIQUIDITY_CONTRACTS" envSeparator:","`
	BakerPaysBurnFees            bool     `env:"TZPAY_BAKER_PAYS_BURN_FEES"`
	PayoutWhenRewardsUnfrozen    bool     `env:"TZPAY_REWARDS_UNFROZEN_WAIT"`
}

Baker contains configurations related to the how a baker might run their baking operation

type Config

type Config struct {
	API           API
	Baker         Baker
	Key           Key
	Operations    Operations
	Notifications Notifications
}

Config encapsulates all configuration possibilities into a single structure

func New

func New() (Config, error)

New loads enviroment variables into a Config struct

type Key

type Key struct {
	Esk      string `env:"TZPAY_WALLET_ESK" validate:"required"`
	Password string `env:"TZPAY_WALLET_PASSWORD" validate:"required"`
}

Key contains sensitive information regarding

type Notifications

type Notifications struct {
	Twitter Twitter
	Twilio  Twilio
}

Notifications contains the configurations for notification features

type Operations

type Operations struct {
	NetworkFee int `env:"TZPAY_OPERATIONS_NETWORK_FEE" envDefault:"2941"`
	GasLimit   int `env:"TZPAY_OPERATIONS_GAS_LIMIT" envDefault:"26283"`
	BatchSize  int `env:"TZPAY_OPERATIONS_BATCH_SIZE" envDefault:"125"`
}

Operations contains configurations for modifying the actual operation to be injected into a node

type Twilio

type Twilio struct {
	AccountSID string   `env:"TZPAY_TWILIO_ACCOUNT_SID"`
	AuthToken  string   `env:"TZPAY_TWILIO_AUTH_TOKEN"`
	From       string   `env:"TZPAY_TWILIO_FROM"`
	To         []string `env:"TZPAY_TWILIO_TO" envSeparator:","`
}

Twilio contains twilio API information for automatic notifications

type Twitter

type Twitter struct {
	ConsumerKey    string `env:"TZPAY_TWITTER_CONSUMER_KEY"`
	ConsumerSecret string `env:"TZPAY_TWITTER_CONSUMER_SECRET"`
	AccessToken    string `env:"TZPAY_TWITTER_ACCESS_TOKEN"`
	AccessSecret   string `env:"TZPAY_TWITTER_ACCESS_SECRET"`
}

Twitter contains twitter API information for automatic notifications