loader

package

v4.1.2 Latest Latest Go to latest Published: Jun 19, 2024 License: ISC Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/decred/dcrwallet

Links

Open Source Insights

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 Loader
- func NewLoader(chainParams *chaincfg.Params, dbDirPath string, stakeOptions *StakeOptions, ...) *Loader
type StakeOptions

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func AllVSPs ¶

func AllVSPs() map[string]*vsp.Client

AllVSPs returns the list of all currently registered VSPs.

func LookupVSP ¶

func LookupVSP(host string) (*vsp.Client, error)

LookupVSP returns a previously-configured VSP client, if one has been created and registered with the VSP function. Otherwise, a NotExist error is returned.

func UseLogger ¶

func UseLogger(logger slog.Logger)

UseLogger uses a specified Logger to output package logging info. This should be used in preference to SetLogWriter if the caller is also using slog.

func VSP ¶

func VSP(cfg vsp.Config) (*vsp.Client, error)

VSP loads or creates a package-global instance of the VSP client for a host. This allows clients to be created and reused across various subsystems.

Types ¶

type Loader ¶

type Loader struct {
	// 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, disableMixing 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) DbDirPath ¶

func (l *Loader) DbDirPath() string

DbDirPath returns the Loader's database directory path

func (*Loader) LoadedWallet ¶

func (l *Loader) LoadedWallet() (*wallet.Wallet, bool)

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 ¶

func (l *Loader) RunAfterLoad(fn func(*wallet.Wallet))

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 ¶

func (l *Loader) UnloadWallet() error

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 ¶

func (l *Loader) WalletExists() (bool, error)

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
	VotingAddress       stdaddr.StakeAddress
	PoolAddress         stdaddr.StakeAddress
	PoolFees            float64
	StakePoolColdExtKey string
}

StakeOptions contains the various options necessary for stake mining.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL