wtxmgr

package module
v0.0.0-...-8d45b69 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 21, 2021 License: ISC Imports: 14 Imported by: 1

README

wtxmgr

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

Package wtxmgr provides storage and spend tracking of wallet transactions and their relevant input and outputs.

Feature overview

  • Storage for relevant wallet transactions
  • Ability to mark outputs as controlled by wallet
  • Unspent transaction output index
  • Balance tracking
  • Automatic spend tracking for transaction inserts and removals
  • Double spend detection and correction after blockchain reorgs
  • Scalable design:
    • Utilizes similar prefixes to allow cursor iteration over relevant transaction inputs and outputs
    • Programmatically detectable errors, including encapsulation of errors from packages it relies on
    • Operates under its own walletdb namespace

Documentation

[GoDoc] (http://godoc.org/github.com/btcsuite/btcwallet/wtxmgr)

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/btcsuite/btcwallet/wtxmgr

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/btcsuite/btcwallet/wtxmgr

Installation

$ go get github.com/btcsuite/btcwallet/wtxmgr

Package wtxmgr is licensed under the copyfree ISC License.

Documentation

Overview

Package wtxmgr provides an implementation of a transaction database handling spend tracking for a bitcoin wallet. Its primary purpose is to save transactions with outputs spendable with wallet keys and transactions that are signed by wallet keys in memory, handle spend tracking for unspent outputs and newly-inserted transactions, and report the spendable balance from each unspent transaction output. It uses walletdb as the backend for storing the serialized transaction objects in buckets.

Transaction outputs which are spendable by wallet keys are called credits (because they credit to a wallet's total spendable balance). Transaction inputs which spend previously-inserted credits are called debits (because they debit from the wallet's spendable balance).

Spend tracking is mostly automatic. When a new transaction is inserted, if it spends from any unspent credits, they are automatically marked spent by the new transaction, and each input which spent a credit is marked as a debit. However, transaction outputs of inserted transactions must manually marked as credits, as this package has no knowledge of wallet keys or addresses, and therefore cannot determine which outputs may be spent.

Details regarding individual transactions and their credits and debits may be queried either by just a transaction hash, or by hash and block. When querying for just a transaction hash, the most recent transaction with a matching hash will be queried. However, because transaction hashes may collide with other transaction hashes, methods to query for specific transactions in the chain (or unmined) are provided as well.

Example (BasicUsage) 
// Open the database.
db, dbTeardown, err := testDB()
defer dbTeardown()
if err != nil {
	fmt.Println(err)
	return
}

// Open a read-write transaction to operate on the database.
dbtx, err := db.BeginReadWriteTx()
if err != nil {
	fmt.Println(err)
	return
}
defer dbtx.Commit()

// Create a bucket for the transaction store.
b, err := dbtx.CreateTopLevelBucket([]byte("txstore"))
if err != nil {
	fmt.Println(err)
	return
}

// Create and open the transaction store in the provided namespace.
err = Create(b)
if err != nil {
	fmt.Println(err)
	return
}
s, err := Open(b, &chaincfg.TestNet3Params)
if err != nil {
	fmt.Println(err)
	return
}

// Insert an unmined transaction that outputs 10 BTC to a wallet address
// at output 0.
err = s.InsertTx(b, exampleTxRecordA, nil)
if err != nil {
	fmt.Println(err)
	return
}
err = s.AddCredit(b, exampleTxRecordA, nil, 0, false)
if err != nil {
	fmt.Println(err)
	return
}

// Insert a second transaction which spends the output, and creates two
// outputs.  Mark the second one (5 BTC) as wallet change.
err = s.InsertTx(b, exampleTxRecordB, nil)
if err != nil {
	fmt.Println(err)
	return
}
err = s.AddCredit(b, exampleTxRecordB, nil, 1, true)
if err != nil {
	fmt.Println(err)
	return
}

// Mine each transaction in a block at height 100.
err = s.InsertTx(b, exampleTxRecordA, &exampleBlock100)
if err != nil {
	fmt.Println(err)
	return
}
err = s.InsertTx(b, exampleTxRecordB, &exampleBlock100)
if err != nil {
	fmt.Println(err)
	return
}

// Print the one confirmation balance.
bal, err := s.Balance(b, 1, 100)
if err != nil {
	fmt.Println(err)
	return
}
fmt.Println(bal)

// Fetch unspent outputs.
utxos, err := s.UnspentOutputs(b)
if err != nil {
	fmt.Println(err)
}
expectedOutPoint := wire.OutPoint{Hash: exampleTxRecordB.Hash, Index: 1}
for _, utxo := range utxos {
	fmt.Println(utxo.OutPoint == expectedOutPoint)
}

Output:

5 BTC
true

Index

Examples

Constants

View Source 
const (
	// TxLabelLimit is the length limit we impose on transaction labels.
	TxLabelLimit = 500
)

Variables

View Source 
var (
	// ErrEmptyLabel is returned when an attempt to write a label that is
	// empty is made.
	ErrEmptyLabel = errors.New("empty transaction label not allowed")

	// ErrLabelTooLong is returned when an attempt to write a label that is
	// to long is made.
	ErrLabelTooLong = errors.New("transaction label exceeds limit")

	// ErrNoLabelBucket is returned when the bucket holding optional
	// transaction labels is not found. This occurs when no transactions
	// have been labelled yet.
	ErrNoLabelBucket = errors.New("labels bucket does not exist")

	// ErrTxLabelNotFound is returned when no label is found for a
	// transaction hash.
	ErrTxLabelNotFound = errors.New("label for transaction not found")

	// ErrUnknownOutput is an error returned when an output not known to the
	// wallet is attempted to be locked.
	ErrUnknownOutput = errors.New("unknown output")

	// ErrOutputAlreadyLocked is an error returned when an output has
	// already been locked to a different ID.
	ErrOutputAlreadyLocked = errors.New("output already locked")

	// ErrOutputUnlockNotAllowed is an error returned when an output unlock
	// is attempted with a different ID than the one which locked it.
	ErrOutputUnlockNotAllowed = errors.New("output unlock not alowed")

	// ErrDuplicateTx is returned when attempting to record a mined or
	// unmined transaction that is already recorded.
	ErrDuplicateTx = errors.New("transaction already exists")
)

Functions

func Create 

func Create(ns walletdb.ReadWriteBucket) error

Create creates a new persistent transaction store in the walletdb namespace. Creating the store when one already exists in this namespace will error with ErrAlreadyExists.

func DependencySort 

func DependencySort(txs map[chainhash.Hash]*wire.MsgTx) []*wire.MsgTx

DependencySort topologically sorts a set of transactions by their dependency order. It is implemented using Kahn's algorithm.

func DeserializeLabel 

func DeserializeLabel(v []byte) (string, error)

DeserializeLabel reads a deserializes a length-value encoded label from the byte array provided.

func DisableLog 

func DisableLog()

DisableLog disables all library log output. Logging output is disabled by default until either UseLogger or SetLogWriter are called.

func FetchTxLabel 

func FetchTxLabel(ns walletdb.ReadBucket, txid chainhash.Hash) (string, error)

FetchTxLabel reads a transaction label from the tx labels bucket. If a label with 0 length was written, we return an error, since this is unexpected.

func IsNoExists 

func IsNoExists(err error) bool

IsNoExists returns whether an error is a Error with the ErrNoExists error code.

func PutTxLabel 

func PutTxLabel(labelBucket walletdb.ReadWriteBucket, txid chainhash.Hash,
	label string) error

PutTxLabel writes a label for a tx to the bucket provided. Note that it does not perform any validation on the label provided, or check whether there is an existing label for the txid.

func UseLogger 

func UseLogger(logger palclog.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 palclog.

Types

type Block 

type Block struct {
	Hash   chainhash.Hash
	Height int32
}

Block contains the minimum amount of data to uniquely identify any block on either the best or side chain.

type BlockMeta 

type BlockMeta struct {
	Block
	Time time.Time
}

BlockMeta contains the unique identification for a block and any metadata pertaining to the block. At the moment, this additional metadata only includes the block time from the block header.

type Credit 

type Credit struct {
	wire.OutPoint
	BlockMeta
	Amount       palcutil.Amount
	PkScript     []byte
	Received     time.Time
	FromCoinBase bool
}

Credit is the type representing a transaction output which was spent or is still spendable by wallet. A UTXO is an unspent Credit, but not all Credits are UTXOs.

type CreditRecord 

type CreditRecord struct {
	Amount palcutil.Amount
	Index  uint32
	Spent  bool
	Change bool
}

CreditRecord contains metadata regarding a transaction credit for a known transaction. Further details may be looked up by indexing a wire.MsgTx.TxOut with the Index field.

type DebitRecord 

type DebitRecord struct {
	Amount palcutil.Amount
	Index  uint32
}

DebitRecord contains metadata regarding a transaction debit for a known transaction. Further details may be looked up by indexing a wire.MsgTx.TxIn with the Index field.

type Error 

type Error struct {
	Code ErrorCode // Describes the kind of error
	Desc string    // Human readable description of the issue
	Err  error     // Underlying error, optional
}

Error provides a single type for errors that can happen during Store operation.

func (Error) Error 

func (e Error) Error() string

Error satisfies the error interface and prints human-readable errors.

type ErrorCode 

type ErrorCode uint8

ErrorCode identifies a category of error. 

const (
	// ErrDatabase indicates an error with the underlying database.  When
	// this error code is set, the Err field of the Error will be
	// set to the underlying error returned from the database.
	ErrDatabase ErrorCode = iota

	// ErrData describes an error where data stored in the transaction
	// database is incorrect.  This may be due to missing values, values of
	// wrong sizes, or data from different buckets that is inconsistent with
	// itself.  Recovering from an ErrData requires rebuilding all
	// transaction history or manual database surgery.  If the failure was
	// not due to data corruption, this error category indicates a
	// programming error in this package.
	ErrData

	// ErrInput describes an error where the variables passed into this
	// function by the caller are obviously incorrect.  Examples include
	// passing transactions which do not serialize, or attempting to insert
	// a credit at an index for which no transaction output exists.
	ErrInput

	// ErrAlreadyExists describes an error where creating the store cannot
	// continue because a store already exists in the namespace.
	ErrAlreadyExists

	// ErrNoExists describes an error where the store cannot be opened due to
	// it not already existing in the namespace.  This error should be
	// handled by creating a new store.
	ErrNoExists

	// ErrNeedsUpgrade describes an error during store opening where the
	// database contains an older version of the store.
	ErrNeedsUpgrade

	// ErrUnknownVersion describes an error where the store already exists
	// but the database version is newer than latest version known to this
	// software.  This likely indicates an outdated binary.
	ErrUnknownVersion
)

These constants are used to identify a specific Error.

func (ErrorCode) String 

func (e ErrorCode) String() string

String returns the ErrorCode as a human-readable name.

type LockID 

type LockID [32]byte

LockID represents a unique context-specific ID assigned to an output lock.

type LockedOutput 

type LockedOutput struct {
	Outpoint   wire.OutPoint
	LockID     LockID
	Expiration time.Time
}

LockedOutput is a type that contains an outpoint of an UTXO and its lock lease information.

type MigrationManager 

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

MigrationManager is an implementation of the migration.Manager interface that will be used to handle migrations for the address manager. It exposes the necessary parameters required to successfully perform migrations.

func NewMigrationManager 

func NewMigrationManager(ns walletdb.ReadWriteBucket) *MigrationManager

NewMigrationManager creates a new migration manager for the transaction manager. The given bucket should reflect the top-level bucket in which all of the transaction manager's data is contained within.

func (*MigrationManager) CurrentVersion 

func (m *MigrationManager) CurrentVersion(ns walletdb.ReadBucket) (uint32, error)

CurrentVersion returns the current version of the service's database.

NOTE: This method is part of the migration.Manager interface.

func (*MigrationManager) Name 

func (m *MigrationManager) Name() string

Name returns the name of the service we'll be attempting to upgrade.

NOTE: This method is part of the migration.Manager interface.

func (*MigrationManager) Namespace 

func (m *MigrationManager) Namespace() walletdb.ReadWriteBucket

Namespace returns the top-level bucket of the service.

NOTE: This method is part of the migration.Manager interface.

func (*MigrationManager) SetVersion 

func (m *MigrationManager) SetVersion(ns walletdb.ReadWriteBucket,
	version uint32) error

SetVersion sets the version of the service's database.

NOTE: This method is part of the migration.Manager interface.

func (*MigrationManager) Versions 

func (m *MigrationManager) Versions() []migration.Version

Versions returns all of the available database versions of the service.

NOTE: This method is part of the migration.Manager interface.

type Store 

type Store struct {

	// Event callbacks.  These execute in the same goroutine as the wtxmgr
	// caller.
	NotifyUnspent func(hash *chainhash.Hash, index uint32)
	// contains filtered or unexported fields
}

Store implements a transaction store for storing and managing wallet transactions.

func Open 

func Open(ns walletdb.ReadBucket, chainParams *chaincfg.Params) (*Store, error)

Open opens the wallet transaction store from a walletdb namespace. If the store does not exist, ErrNoExist is returned. `lockDuration` represents how long outputs are locked for.

func (*Store) AddCredit 

func (s *Store) AddCredit(ns walletdb.ReadWriteBucket, rec *TxRecord, block *BlockMeta, index uint32, change bool) error

AddCredit marks a transaction record as containing a transaction output spendable by wallet. The output is added unspent, and is marked spent when a new transaction spending the output is inserted into the store.

TODO(jrick): This should not be necessary. Instead, pass the indexes that are known to contain credits when a transaction or merkleblock is inserted into the store.

func (*Store) Balance 

func (s *Store) Balance(ns walletdb.ReadBucket, minConf int32, syncHeight int32) (palcutil.Amount, error)

Balance returns the spendable wallet balance (total value of all unspent transaction outputs) given a minimum of minConf confirmations, calculated at a current chain height of curHeight. Coinbase outputs are only included in the balance if maturity has been reached.

Balance may return unexpected results if syncHeight is lower than the block height of the most recent mined transaction in the store.

Example

This example demonstrates reporting the Store balance given an unmined and mined transaction given 0, 1, and 6 block confirmations. 

s, db, teardown, err := testStore()
defer teardown()
if err != nil {
	fmt.Println(err)
	return
}

// Prints balances for 0 block confirmations, 1 confirmation, and 6
// confirmations.
printBalances := func(syncHeight int32) {
	dbtx, err := db.BeginReadTx()
	if err != nil {
		fmt.Println(err)
		return
	}
	defer dbtx.Rollback()
	ns := dbtx.ReadBucket(namespaceKey)
	zeroConfBal, err := s.Balance(ns, 0, syncHeight)
	if err != nil {
		fmt.Println(err)
		return
	}
	oneConfBal, err := s.Balance(ns, 1, syncHeight)
	if err != nil {
		fmt.Println(err)
		return
	}
	sixConfBal, err := s.Balance(ns, 6, syncHeight)
	if err != nil {
		fmt.Println(err)
		return
	}
	fmt.Printf("%v, %v, %v\n", zeroConfBal, oneConfBal, sixConfBal)
}

// Insert a transaction which outputs 10 BTC unmined and mark the output
// as a credit.
err = walletdb.Update(db, func(tx walletdb.ReadWriteTx) error {
	ns := tx.ReadWriteBucket(namespaceKey)
	err := s.InsertTx(ns, exampleTxRecordA, nil)
	if err != nil {
		return err
	}
	return s.AddCredit(ns, exampleTxRecordA, nil, 0, false)
})
if err != nil {
	fmt.Println(err)
	return
}
printBalances(100)

// Mine the transaction in block 100 and print balances again with a
// sync height of 100 and 105 blocks.
err = walletdb.Update(db, func(tx walletdb.ReadWriteTx) error {
	ns := tx.ReadWriteBucket(namespaceKey)
	return s.InsertTx(ns, exampleTxRecordA, &exampleBlock100)
})
if err != nil {
	fmt.Println(err)
	return
}
printBalances(100)
printBalances(105)

Output:

10 BTC, 0 BTC, 0 BTC
10 BTC, 10 BTC, 0 BTC
10 BTC, 10 BTC, 10 BTC

func (*Store) DeleteExpiredLockedOutputs 

func (s *Store) DeleteExpiredLockedOutputs(ns walletdb.ReadWriteBucket) error

DeleteExpiredLockedOutputs iterates through all existing locked outputs and deletes those which have already expired.

func (*Store) InsertTx 

func (s *Store) InsertTx(ns walletdb.ReadWriteBucket, rec *TxRecord,
	block *BlockMeta) error

InsertTx records a transaction as belonging to a wallet's transaction history. If block is nil, the transaction is considered unspent, and the transaction's index must be unset.

func (*Store) InsertTxCheckIfExists 

func (s *Store) InsertTxCheckIfExists(ns walletdb.ReadWriteBucket,
	rec *TxRecord, block *BlockMeta) (bool, error)

InsertTxCheckIfExists records a transaction as belonging to a wallet's transaction history. If block is nil, the transaction is considered unspent, and the transaction's index must be unset. It will return true if the transaction was already recorded prior to the call.

func (*Store) ListLockedOutputs 

func (s *Store) ListLockedOutputs(ns walletdb.ReadBucket) ([]*LockedOutput,
	error)

ListLockedOutputs returns a list of objects representing the currently locked utxos.

func (*Store) LockOutput 

func (s *Store) LockOutput(ns walletdb.ReadWriteBucket, id LockID,
	op wire.OutPoint, duration time.Duration) (time.Time, error)

LockOutput locks an output to the given ID, preventing it from being available for coin selection. The absolute time of the lock's expiration is returned. The expiration of the lock can be extended by successive invocations of this call.

Outputs can be unlocked before their expiration through `UnlockOutput`. Otherwise, they are unlocked lazily through calls which iterate through all known outputs, e.g., `Balance`, `UnspentOutputs`.

If the output is not known, ErrUnknownOutput is returned. If the output has already been locked to a different ID, then ErrOutputAlreadyLocked is returned.

func (*Store) PreviousPkScripts 

func (s *Store) PreviousPkScripts(ns walletdb.ReadBucket, rec *TxRecord, block *Block) ([][]byte, error)

PreviousPkScripts returns a slice of previous output scripts for each credit output this transaction record debits from.

func (*Store) PutTxLabel 

func (s *Store) PutTxLabel(ns walletdb.ReadWriteBucket, txid chainhash.Hash,
	label string) error

PutTxLabel validates transaction labels and writes them to disk if they are non-zero and within the label length limit. The entry is keyed by the transaction hash: [0:32] Transaction hash (32 bytes)

The label itself is written to disk in length value format: [0:2] Label length [2: +len] Label

func (*Store) RangeTransactions 

func (s *Store) RangeTransactions(ns walletdb.ReadBucket, begin, end int32,
	f func([]TxDetails) (bool, error)) error

RangeTransactions runs the function f on all transaction details between blocks on the best chain over the height range [begin,end]. The special height -1 may be used to also include unmined transactions. If the end height comes before the begin height, blocks are iterated in reverse order and unmined transactions (if any) are processed first.

The function f may return an error which, if non-nil, is propagated to the caller. Additionally, a boolean return value allows exiting the function early without reading any additional transactions early when true.

All calls to f are guaranteed to be passed a slice with more than zero elements. The slice may be reused for multiple blocks, so it is not safe to use it after the loop iteration it was acquired.

func (*Store) RemoveUnminedTx 

func (s *Store) RemoveUnminedTx(ns walletdb.ReadWriteBucket, rec *TxRecord) error

RemoveUnminedTx attempts to remove an unmined transaction from the transaction store. This is to be used in the scenario that a transaction that we attempt to rebroadcast, turns out to double spend one of our existing inputs. This function we remove the conflicting transaction identified by the tx record, and also recursively remove all transactions that depend on it.

func (*Store) Rollback 

func (s *Store) Rollback(ns walletdb.ReadWriteBucket, height int32) error

Rollback removes all blocks at height onwards, moving any transactions within each block to the unconfirmed pool.

Example 
s, db, teardown, err := testStore()
defer teardown()
if err != nil {
	fmt.Println(err)
	return
}

err = walletdb.Update(db, func(tx walletdb.ReadWriteTx) error {
	ns := tx.ReadWriteBucket(namespaceKey)

	// Insert a transaction which outputs 10 BTC in a block at height 100.
	err := s.InsertTx(ns, exampleTxRecordA, &exampleBlock100)
	if err != nil {
		return err
	}

	// Rollback everything from block 100 onwards.
	err = s.Rollback(ns, 100)
	if err != nil {
		return err
	}

	// Assert that the transaction is now unmined.
	details, err := s.TxDetails(ns, &exampleTxRecordA.Hash)
	if err != nil {
		return err
	}
	if details == nil {
		return fmt.Errorf("no details found")
	}
	fmt.Println(details.Block.Height)
	return nil
})
if err != nil {
	fmt.Println(err)
	return
}

Output:

-1

func (*Store) TxDetails 

func (s *Store) TxDetails(ns walletdb.ReadBucket, txHash *chainhash.Hash) (*TxDetails, error)

TxDetails looks up all recorded details regarding a transaction with some hash. In case of a hash collision, the most recent transaction with a matching hash is returned.

Not finding a transaction with this hash is not an error. In this case, a nil TxDetails is returned.

func (*Store) TxLabel 

func (s *Store) TxLabel(ns walletdb.ReadBucket, txHash chainhash.Hash) (string,
	error)

TxLabel looks up a transaction label for the txHash provided. If the store has no labels in it, or the specific txHash does not have a label, an empty string and no error are returned.

func (*Store) UniqueTxDetails 

func (s *Store) UniqueTxDetails(ns walletdb.ReadBucket, txHash *chainhash.Hash,
	block *Block) (*TxDetails, error)

UniqueTxDetails looks up all recorded details for a transaction recorded mined in some particular block, or an unmined transaction if block is nil.

Not finding a transaction with this hash from this block is not an error. In this case, a nil TxDetails is returned.

func (*Store) UnlockOutput 

func (s *Store) UnlockOutput(ns walletdb.ReadWriteBucket, id LockID,
	op wire.OutPoint) error

UnlockOutput unlocks an output, allowing it to be available for coin selection if it remains unspent. The ID should match the one used to originally lock the output.

func (*Store) UnminedTxHashes 

func (s *Store) UnminedTxHashes(ns walletdb.ReadBucket) ([]*chainhash.Hash, error)

UnminedTxHashes returns the hashes of all transactions not known to have been mined in a block.

func (*Store) UnminedTxs 

func (s *Store) UnminedTxs(ns walletdb.ReadBucket) ([]*wire.MsgTx, error)

UnminedTxs returns the underlying transactions for all unmined transactions which are not known to have been mined in a block. Transactions are guaranteed to be sorted by their dependency order.

func (*Store) UnspentOutputs 

func (s *Store) UnspentOutputs(ns walletdb.ReadBucket) ([]Credit, error)

UnspentOutputs returns all unspent received transaction outputs. The order is undefined.

type TxDetails 

type TxDetails struct {
	TxRecord
	Block   BlockMeta
	Credits []CreditRecord
	Debits  []DebitRecord
	Label   string
}

TxDetails is intended to provide callers with access to rich details regarding a relevant transaction and which inputs and outputs are credit or debits.

type TxRecord 

type TxRecord struct {
	MsgTx        wire.MsgTx
	Hash         chainhash.Hash
	Received     time.Time
	SerializedTx []byte // Optional: may be nil
}

TxRecord represents a transaction managed by the Store.

func NewTxRecord 

func NewTxRecord(serializedTx []byte, received time.Time) (*TxRecord, error)

NewTxRecord creates a new transaction record that may be inserted into the store. It uses memoization to save the transaction hash and the serialized transaction.

func NewTxRecordFromMsgTx 

func NewTxRecordFromMsgTx(msgTx *wire.MsgTx, received time.Time) (*TxRecord, error)

NewTxRecordFromMsgTx creates a new transaction record that may be inserted into the store.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.