appconfig

Documentation

Index

• type AppConfig
  • func (c *AppConfig) AccountService() *application.AccountService
  • func (c *AppConfig) BlockchainScanner() ports.BlockchainScanner
  • func (c *AppConfig) NotificationService() *application.NotificationService
  • func (c *AppConfig) RepoManager() ports.RepoManager
  • func (c *AppConfig) TransactionService() *application.TransactionService
  • func (c *AppConfig) Validate() error
  • func (c *AppConfig) WalletService() *application.WalletService
  • func (c *AppConfig) WithAutoInit() bool
  • func (c *AppConfig) WithAutoUnlock() bool

Types

type AppConfig

type AppConfig struct {
	Version string
	Commit  string
	Date    string

	RootPath           string
	Network            *network.Network
	UtxoExpiryDuration time.Duration
	DustAmount         uint64
	Password           string
	Mnemonic           string

	RepoManagerType         string
	BlockchainScannerType   string
	RepoManagerConfig       interface{}
	BlockchainScannerConfig interface{}
	// contains filtered or unexported fields
}

AppConfig is the struct holding all configuration options for every application service (wallet, account, transaction and notification). This data structure acts also as a factory of the mentioned application services and the portable services used by them. Public config args:

• RootPath - (optional) Wallet root HD path (defaults to m/84'/0').
• Network - (required) The Liquid network (mainnet, testnet, regtest).
• UtxoExpiryDuration - (required) The duration in seconds for the app service to wait until unlocking one or more previously locked utxo.
• RepoManagerType - (required) One of the supported repository manager types.
• BlockchainScannerType - (required) One of the supported blockchain scanner types.
• RepoManagerConfig - (optional) Custom config args for the repository manager based on its type.
• BlockchainScannerConfig - (optional) Custom config args for the blockchain scanner based on its type.

func (*AppConfig) AccountService

func (c *AppConfig) AccountService() *application.AccountService

func (*AppConfig) BlockchainScanner

func (c *AppConfig) BlockchainScanner() ports.BlockchainScanner

func (*AppConfig) NotificationService

func (c *AppConfig) NotificationService() *application.NotificationService

func (*AppConfig) RepoManager

func (c *AppConfig) RepoManager() ports.RepoManager

func (*AppConfig) TransactionService

func (c *AppConfig) TransactionService() *application.TransactionService

func (*AppConfig) Validate

func (c *AppConfig) Validate() error

func (*AppConfig) WalletService

func (c *AppConfig) WalletService() *application.WalletService

func (*AppConfig) WithAutoInit

func (c *AppConfig) WithAutoInit() bool

func (*AppConfig) WithAutoUnlock

func (c *AppConfig) WithAutoUnlock() bool