Documentation ¶
Overview ¶
Package loader provides a concurrent safe implementation of a wallet loader.
It is intended to allow creating and opening wallets as well as managing services like ticket buyer by RPC servers as well other subsystems.
Index ¶
- func AllVSPs() map[string]*vsp.Client
- func LookupVSP(host string) (*vsp.Client, error)
- func UseLogger(logger slog.Logger)
- func VSP(cfg vsp.Config) (*vsp.Client, error)
- type DialFunc
- type Loader
- func (l *Loader) CreateNewWallet(ctx context.Context, pubPassphrase, privPassphrase, seed []byte) (w *wallet.Wallet, err error)
- func (l *Loader) CreateWatchingOnlyWallet(ctx context.Context, extendedPubKey string, pubPass []byte) (w *wallet.Wallet, err error)
- func (l *Loader) DbDirPath() string
- func (l *Loader) LoadedWallet() (*wallet.Wallet, bool)
- func (l *Loader) NetworkBackend() (n wallet.NetworkBackend, ok bool)
- func (l *Loader) OpenExistingWallet(ctx context.Context, pubPassphrase []byte) (w *wallet.Wallet, rerr error)
- func (l *Loader) RunAfterLoad(fn func(*wallet.Wallet))
- func (l *Loader) UnloadWallet() error
- func (l *Loader) WalletExists() (bool, error)
- type StakeOptions
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func LookupVSP ¶
LookupVSP returns a previously-configured VSP client, if one has been created and registered with the VSP function. Otherwise, a NotExist error is returned.
Types ¶
type DialFunc ¶
DialFunc provides a method to dial a network connection. If the dialed network connection is secured by TLS, TLS configuration is provided by the method, not the caller.
type Loader ¶
type Loader struct { DialCSPPServer DialFunc // contains filtered or unexported fields }
Loader implements the creating of new and opening of existing wallets, while providing a callback system for other subsystems to handle the loading of a wallet. This is primarely intended for use by the RPC servers, to enable methods and services which require the wallet when the wallet is loaded by another subsystem.
Loader is safe for concurrent access.
func NewLoader ¶
func NewLoader(chainParams *chaincfg.Params, dbDirPath string, stakeOptions *StakeOptions, gapLimit uint32, watchLast uint32, allowHighFees bool, relayFee dcrutil.Amount, accountGapLimit int, disableCoinTypeUpgrades bool, manualTickets bool, mixSplitLimit int) *Loader
NewLoader constructs a Loader.
func (*Loader) CreateNewWallet ¶
func (l *Loader) CreateNewWallet(ctx context.Context, pubPassphrase, privPassphrase, seed []byte) (w *wallet.Wallet, err error)
CreateNewWallet creates a new wallet using the provided public and private passphrases. The seed is optional. If non-nil, addresses are derived from this seed. If nil, a secure random seed is generated.
func (*Loader) CreateWatchingOnlyWallet ¶
func (l *Loader) CreateWatchingOnlyWallet(ctx context.Context, extendedPubKey string, pubPass []byte) (w *wallet.Wallet, err error)
CreateWatchingOnlyWallet creates a new watch-only wallet using the provided extended public key and public passphrase.
func (*Loader) LoadedWallet ¶
LoadedWallet returns the loaded wallet, if any, and a bool for whether the wallet has been loaded or not. If true, the wallet pointer should be safe to dereference.
func (*Loader) NetworkBackend ¶
func (l *Loader) NetworkBackend() (n wallet.NetworkBackend, ok bool)
NetworkBackend returns the associated wallet network backend, if any, and a bool describing whether a non-nil network backend was set.
func (*Loader) OpenExistingWallet ¶
func (l *Loader) OpenExistingWallet(ctx context.Context, pubPassphrase []byte) (w *wallet.Wallet, rerr error)
OpenExistingWallet opens the wallet from the loader's wallet database path and the public passphrase. If the loader is being called by a context where standard input prompts may be used during wallet upgrades, setting canConsolePrompt will enable these prompts.
func (*Loader) RunAfterLoad ¶
RunAfterLoad adds a function to be executed when the loader creates or opens a wallet. Functions are executed in a single goroutine in the order they are added.
func (*Loader) UnloadWallet ¶
UnloadWallet stops the loaded wallet, if any, and closes the wallet database. Returns with errors.Invalid if the wallet has not been loaded with CreateNewWallet or LoadExistingWallet. The Loader may be reused if this function returns without error.
func (*Loader) WalletExists ¶
WalletExists returns whether a file exists at the loader's database path. This may return an error for unexpected I/O failures.
type StakeOptions ¶
type StakeOptions struct { VotingEnabled bool AddressReuse bool VotingAddress stdaddr.StakeAddress PoolAddress stdaddr.StakeAddress PoolFees float64 StakePoolColdExtKey string }
StakeOptions contains the various options necessary for stake mining.