config

Documentation

Overview

Package config contains data structures related to Client configuration

Index

• Constants
• type Config
  • func NewCashLocal() *Config
  • func NewCashPublic() *Config
  • func NewCashPublicTestnet() *Config
  • func NewCustom(baseURL, coin, network string) (*Config, error)
  • func NewLocal() *Config
  • func NewLocalTestnet() *Config
  • func NewPublic() *Config
  • func NewPublicTestnet() *Config
  • func (cfg *Config) CoinType() uint32
  • func (cfg *Config) NetParams() *chaincfg.Params
  • func (cfg *Config) NetShort() string

Constants

const (
	CoinBTC = "btc"
	CoinBCH = "bch"
)

List of supported coins

const (
	CoinTypeBTC  uint32 = 0
	CoinTypeTEST uint32 = 1
	CoinTypeBCH  uint32 = 145
)

BIP-44 Coin types

const (
	NetworkLive = "livenet"
	NetworkTest = "testnet"
)

List of supported networks

Types

type Config

type Config struct {
	Debug    bool
	BaseURL  string
	Coin     string
	Network  string
	Timeout  int
	Deadline int
}

Config contains Client configuration

func NewCashLocal

func NewCashLocal() *Config

NewCashLocal creates new instance of Config for localhost API, BCH and livenet

func NewCashPublic

func NewCashPublic() *Config

NewCashPublic creates new instance of Config for public API, BCH and livenet

func NewCashPublicTestnet

func NewCashPublicTestnet() *Config

NewCashPublicTestnet creates new instance of Config for public API, BCH and livenet

func NewCustom

func NewCustom(baseURL, coin, network string) (*Config, error)

NewCustom creates new instance of Config with custom parameters

func NewLocal

func NewLocal() *Config

NewLocal creates new instance of Config for localhost API, BTC and livenet

func NewLocalTestnet

func NewLocalTestnet() *Config

NewLocalTestnet creates new instance of Config for localhost API, BTC and testnet

func NewPublic

func NewPublic() *Config

NewPublic creates new instance of Config for public API, BTC and livenet

func NewPublicTestnet

func NewPublicTestnet() *Config

NewPublicTestnet creates new instance of Config for public API, BTC and testnet

func (*Config) CoinType

func (cfg *Config) CoinType() uint32

CoinType returns BIP-44 coin type

func (*Config) NetParams

func (cfg *Config) NetParams() *chaincfg.Params

NetParams return network params for btcd

func (*Config) NetShort

func (cfg *Config) NetShort() string

NetShort returns network ID in one symbol