arguments

Documentation

Index

• type Arguments
  • func NewArguments(mainDirectoryPath string, testing bool, regtest bool, multisig bool, ...) *Arguments
  • func (arguments *Arguments) AccountsConfigFilename() string
  • func (arguments *Arguments) AppConfigFilename() string
  • func (arguments *Arguments) CacheDirectoryPath() string
  • func (arguments *Arguments) DevMode() bool
  • func (arguments *Arguments) MainDirectoryPath() string
  • func (arguments *Arguments) Multisig() bool
  • func (arguments *Arguments) Regtest() bool
  • func (arguments *Arguments) Testing() bool

Types

type Arguments

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

Arguments models a configuration of the backend.

func NewArguments

func NewArguments(
	mainDirectoryPath string,
	testing bool,
	regtest bool,
	multisig bool,
	devmode bool,
) *Arguments

NewArguments returns the given parameters as backend arguments.

func (*Arguments) AccountsConfigFilename

func (arguments *Arguments) AccountsConfigFilename() string

AccountsConfigFilename returns the path to the accounts config file of the backend.

func (*Arguments) AppConfigFilename

func (arguments *Arguments) AppConfigFilename() string

AppConfigFilename returns the path to the app config file of the backend.

func (*Arguments) CacheDirectoryPath

func (arguments *Arguments) CacheDirectoryPath() string

CacheDirectoryPath returns the path to the cache directory of the backend to store caches. The above constructor ensures that the directory with the returned path exists.

func (*Arguments) DevMode

func (arguments *Arguments) DevMode() bool

DevMode returns whether the backend is in developer mode.

func (*Arguments) MainDirectoryPath

func (arguments *Arguments) MainDirectoryPath() string

MainDirectoryPath returns the path to the main directory of the backend to store data. The above constructor ensures that the directory with the returned path exists.

func (*Arguments) Multisig

func (arguments *Arguments) Multisig() bool

Multisig returns whether the backend is in multisig mode.

func (*Arguments) Regtest

func (arguments *Arguments) Regtest() bool

Regtest returns whether the backend is for regtest only.

func (*Arguments) Testing

func (arguments *Arguments) Testing() bool

Testing returns whether the backend is for testing only.