Categorygithub.com/p9c/podpkgwallet
package
1.9.25
Repository: https://github.com/p9c/pod.git
Documentation: pkg.go.dev
Overview
Versions
2
Dependencies
33
Dependents
14
Files
5k SLOC

# README

wallet

[Build Status] (https://travis-ci.org/btcsuite/btcwallet)

Feature Overview

TODO: Flesh out this section

Documentation

[GoDoc] (http://godoc.org/github.com/p9c/pod/walletmain/wallet)

Full go doc style documentation for the project can be viewed online without installing this package by using the GoDoc site here: http://godoc.org/github.com/p9c/pod/walletmain/wallet

You can also view the documentation locally once the package is installed with the godoc tool by running godoc -http=":6060" and pointing your browser to http://localhost:6060/pkg/github.com/p9c/pod/walletmain/wallet

Installation

$ go get github.com/p9c/pod/walletmain/wallet

Package wallet is licensed under the copyfree ISC License.

# Functions

Create creates an new wallet, writing it to an empty database.
ExposeUnstableAPI exposes additional unstable public APIs for a Wallet.
NewBlockIdentifierFromHash constructs a BlockIdentifier for a block hash.
NewBlockIdentifierFromHeight constructs a BlockIdentifier for a block height.
NewBranchRecoveryState creates a new BranchRecoveryState that can be used to track either the external or internal branch of an account's derivation path.
NewLoader constructs a Loader with an optional recovery window.
NewRecoveryManager initializes a new RecoveryManager with a derivation look-ahead of `recoveryWindow` child indexes, and pre-allocates a backing array for `batchSize` blocks to scan at once.
NewRecoveryState creates a new RecoveryState using the provided recoveryWindow.
NewScopeRecoveryState initializes an ScopeRecoveryState with the chosen recovery window.
Open loads an already-created wallet from the passed database and namespaces.
RecvCategory returns the category of received credit outputs from a transaction record.

# Constants

These constants define the possible credit categories.
These constants define the possible credit categories.
These constants define the possible credit categories.
DbName is.
InsecurePubPassphrase is the default outer encryption passphrase used for public data (everything but private keys).
Defined OutputKind constants.
Defined OutputKind constants.

# Variables

No description provided by the author
No description provided by the author
ErrExists describes the error condition of attempting to create a new wallet when one exists already.
ErrLoaded describes the error condition of attempting to load or create a wallet when the loader has already done so.
ErrNotLoaded describes the error condition of attempting to close a loaded wallet when a wallet has not been loaded.
ErrNotSynced describes an error where an operation cannot complete due wallet being out of sync (and perhaps currently syncing with) the remote chain server.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

AccountBalance associates a total (zero confirmation) balance with an account.
AccountBalanceResult is a single result for the Wallet.AccountBalances method.
AccountNotification contains properties regarding an account, such as its name and the number of derived and imported keys.
AccountNotificationsClient receives AccountNotifications over the channel C.
AccountResult is a single account result for the AccountsResult type.
AccountsResult is the result of the wallet's Accounts method.
AccountTotalReceivedResult is a single result for the Wallet.TotalReceivedForAccounts method.
Balances records total, spendable (by policy), and immature coinbase reward balance amounts.
Block contains the properties and all relevant transactions of an attached block.
BlockIdentifier identifies a block by either a height or a hash.
BlockIdentity identifies a block, or the lack of one (used to describe an unmined transaction).
BranchRecoveryState maintains the required state in-order to properly recover addresses derived from a particular account's internal or external derivation branch.
GetTransactionsResult is the result of the wallet's GetTransactions method.
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.
NotificationServer is a server that interested clients may hook into to receive notifications of changes in a wallet.
OutputRedeemer identifies the transaction input which redeems an output.
OutputSelectionPolicy describes the rules for selecting an output from the wallet.
P2SHMultiSigOutput describes a transaction output with a pay-to-script-hash output script and an imported redemption script.
RecoveryManager maintains the state required to recover previously used addresses, and coordinates batched processing of the blocks to search.
RecoveryState manages the initialization and lookup of ScopeRecoveryStates for any actively used key scopes.
RescanFinishedMsg reports the addresses that were rescanned when a rescanfinished message was received rescanning a batch of addresses.
RescanJob is a job to be processed by the RescanManager.
RescanProgressMsg reports the current progress made by a rescan for a set of wallet addresses.
ScopeRecoveryState is used to manage the recovery of addresses generated under a particular BIP32 account.
SignatureError records the underlying error when validating a transaction input signature.
SpentnessNotifications is a notification that is fired for transaction outputs controlled by some account's keys.
SpentnessNotificationsClient receives SpentnessNotifications from the NotificationServer over the channel C.
TransactionNotifications is a notification of changes to the wallet's transaction set and the current chain tip that wallet is considered to be synced with.
TransactionNotificationsClient receives TransactionNotifications from the NotificationServer over the channel C.
TransactionOutput describes an output that was or is at least partially controlled by the wallet.
TransactionSummary contains a transaction relevant to the wallet and marks which inputs and outputs were relevant.
TransactionSummaryInput describes a transaction input that is relevant to the wallet.
TransactionSummaryOutput describes wallet properties of a transaction output controlled by the wallet.
UnstableAPI exposes unstable api in the wallet.
Wallet is a structure containing all the components for a complete wallet.

# Type aliases

CreditCategory describes the type of wallet transaction output.
OutputKind describes a kind of transaction output.