claimer

Documentation

Index

• Constants
• func Claim(config *Config, logger *log.Entry) http.HandlerFunc
• func NewClaimService(config *Config, logger *log.Entry) *claimService
• type Config
  • func LoadConfig(path string) (*Config, error)
  • func LoadConfigData(data io.Reader) (*Config, error)
  • func (c Config) GetKeys(addr address.Address) (keys []signature.PrivateKey, exists bool, err error)

Constants

const DefaultConfigPath = "claimer_conf.toml"

DefaultConfigPath is the default expected path for the claimer's configuration

This is a relative path, and can be prepended as necessary

Functions

func Claim

func Claim(config *Config, logger *log.Entry) http.HandlerFunc

Claim returns a HandlerFunc which claims a node reward

func NewClaimService

func NewClaimService(config *Config, logger *log.Entry) *claimService

NewClaimService constructs a new claim service

Types

type Config

type Config struct {
	// URL to the API address of a node
	NodeAPI string `toml:"node_api"`
	// The Nodes map actually maps an address to a list of private keys
	Nodes map[string][]string `toml:"nodes"`
	// If set and true, operate in synchronous mode: wait for the blockchain
	// to return before returning from a request.
	SyncMode *bool `toml:"sync_mode"`
}

Config configures the claimer

func LoadConfig

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

LoadConfig loads the configuration data

func LoadConfigData

func LoadConfigData(data io.Reader) (*Config, error)

LoadConfigData loads the configuration data from a streaming reader

This is useful if for example the data is not stored in the local filesystem

func (Config) GetKeys

func (c Config) GetKeys(addr address.Address) (keys []signature.PrivateKey, exists bool, err error)

GetKeys gets the configured keys for a given address, and whether they are configured at all