wallet

package
v1.2.0 Latest Latest
Warning

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

 Go to latest Published: Apr 23, 2018 License: ISC Imports: 33 Imported by: 0

README

wallet

Feature Overview

TODO: Flesh out this section

Documentation

GoDoc

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/decred/dcrwallet/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/decred/dcrwallet/wallet

Installation

$ go get github.com/decred/dcrwallet/wallet

Package wallet is licensed under the copyfree ISC License.

Documentation

Overview

Package wallet provides ... TODO: Flesh out this section

Overview

Index

Constants

View Source 
const (
	// OutputSelectionAlgorithmDefault describes the default output selection
	// algorithm.  It is not optimized for any particular use case.
	OutputSelectionAlgorithmDefault = iota

	// OutputSelectionAlgorithmAll describes the output selection algorithm of
	// picking every possible availble output.  This is useful for sweeping.
	OutputSelectionAlgorithmAll
)
View Source 
const DefaultGapLimit = 20

DefaultGapLimit is the default unused address gap limit defined by BIP0044.

View Source 
const (
	// InsecurePubPassphrase is the default outer encryption passphrase used
	// for public data (everything but private keys).  Using a non-default
	// public passphrase can prevent an attacker without the public
	// passphrase from discovering all past and future wallet addresses if
	// they gain access to the wallet database.
	//
	// NOTE: at time of writing, public encryption only applies to public
	// data in the waddrmgr namespace.  Transactions are not yet encrypted.
	InsecurePubPassphrase = "public"
)

Variables

View Source 
var ErrBlockchainReorganizing = errors.New("blockchain is currently " +
	"reorganizing")

ErrBlockchainReorganizing indicates that the blockchain is currently reorganizing.

View Source 
var ErrNegativeFee = errors.New("fee is negative")

ErrNegativeFee represents an error where a fee is erroneously negative.

View Source 
var ErrNoOutsToConsolidate = errors.New("no outputs to consolidate")

ErrNoOutsToConsolidate indicates that there were no outputs available to compress.

View Source 
var ErrNonPositiveAmount = errors.New("amount is not positive")

ErrNonPositiveAmount represents an error where an amount is not positive (either negative, or zero).

View Source 
var ErrSStxNotEnoughFunds = errors.New("not enough to purchase sstx")

ErrSStxNotEnoughFunds indicates that not enough funds were available in the wallet to purchase a ticket.

View Source 
var ErrSStxPriceExceedsSpendLimit = errors.New("ticket price exceeds spend limit")

ErrSStxPriceExceedsSpendLimit indicates that the current ticket price exceeds the specified spend maximum spend limit.

View Source 
var ErrTicketPriceNotSet = errors.New("ticket price not yet established")

ErrTicketPriceNotSet indicates that the wallet was recently connected and that the ticket price has not yet been set.

View Source 
var ErrUnsupportedTransactionType = errors.New("Only P2PKH transactions " +
	"are supported")

ErrUnsupportedTransactionType represents an error where a transaction cannot be signed as the API only supports spending P2PKH outputs.

View Source 
var (
	// SimulationPassphrase is the password for a wallet created for simnet
	// with --createtemp.
	SimulationPassphrase = []byte("password")
)

Functions

func Create 

func Create(db walletdb.DB, pubPass, privPass, seed []byte, params *chaincfg.Params) error

Create creates an new wallet, writing it to an empty database. If the passed seed is non-nil, it is used. Otherwise, a secure random seed of the recommended length is generated.

func CreateWatchOnly 

func CreateWatchOnly(db walletdb.DB, extendedPubKey string, pubPass []byte, params *chaincfg.Params) error

CreateWatchOnly creates a watchonly wallet on the provided db.

func CurrentAgendas added in v1.0.0 

func CurrentAgendas(params *chaincfg.Params) (version uint32, agendas []chaincfg.ConsensusDeployment)

CurrentAgendas returns the current stake version for the active network and this version of the software, and all agendas defined by it.

func DisableLog 

func DisableLog()

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

func UnstableAPI added in v0.5.0 

func UnstableAPI(w *Wallet) unstableAPI

UnstableAPI exposes additional unstable public APIs for a Wallet. These APIs may be changed or removed at any time. Currently this type exists to ease the transation (particularly for the legacy JSON-RPC server) from using exported manager packages to a unified wallet package that exposes all functionality by itself. New code should not be written using this API.

func UseLogger 

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

func VerifyMessage added in v1.0.7 

func VerifyMessage(msg string, addr dcrutil.Address, sig []byte) (bool, error)

VerifyMessage verifies that sig is a valid signature of msg and was created using the secp256k1 private key for addr.

Types

type AccountBalance 

type AccountBalance struct {
	Account      uint32
	TotalBalance dcrutil.Amount
}

AccountBalance associates a total (zero confirmation) balance with an account. Balances for other minimum confirmation counts require more expensive logic and it is not clear which minimums a client is interested in, so they are not included.

type AccountNotification 

type AccountNotification struct {
	AccountNumber    uint32
	AccountName      string
	ExternalKeyCount uint32
	InternalKeyCount uint32
	ImportedKeyCount uint32
}

AccountNotification contains properties regarding an account, such as its name and the number of derived and imported keys. When any of these properties change, the notification is fired.

type AccountNotificationsClient 

type AccountNotificationsClient struct {
	C chan *AccountNotification
	// contains filtered or unexported fields
}

AccountNotificationsClient receives AccountNotifications over the channel C.

func (*AccountNotificationsClient) Done 

func (c *AccountNotificationsClient) Done()

Done deregisters the client from the server and drains any remaining messages. It must be called exactly once when the client is finished receiving notifications.

type AccountResult 

type AccountResult struct {
	udb.AccountProperties
	TotalBalance dcrutil.Amount
}

AccountResult is a single account result for the AccountsResult type.

type AccountTotalReceivedResult added in v0.5.0 

type AccountTotalReceivedResult struct {
	AccountNumber    uint32
	AccountName      string
	TotalReceived    dcrutil.Amount
	LastConfirmation int32
}

AccountTotalReceivedResult is a single result for the Wallet.TotalReceivedForAccounts method.

type AccountsResult 

type AccountsResult struct {
	Accounts           []AccountResult
	CurrentBlockHash   *chainhash.Hash
	CurrentBlockHeight int32
}

AccountsResult is the resutl of the wallet's Accounts method. See that method for more details.

type AgendaChoice added in v1.0.0 

type AgendaChoice struct {
	AgendaID string
	ChoiceID string
}

AgendaChoice describes a user's choice for a consensus deployment agenda.

type Block 

type Block struct {
	Header       *wire.BlockHeader // Nil if referring to mempool
	Transactions []TransactionSummary
}

Block contains the properties and all relevant transactions of an attached block.

type BlockIdentifier 

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

BlockIdentifier identifies a block by either a height in the main chain or a hash.

func NewBlockIdentifierFromHash 

func NewBlockIdentifierFromHash(hash *chainhash.Hash) *BlockIdentifier

NewBlockIdentifierFromHash constructs a BlockIdentifier for a block hash.

func NewBlockIdentifierFromHeight 

func NewBlockIdentifierFromHeight(height int32) *BlockIdentifier

NewBlockIdentifierFromHeight constructs a BlockIdentifier for a block height.

type BlockIdentity added in v0.5.0 

type BlockIdentity struct {
	Hash   chainhash.Hash
	Height int32
}

BlockIdentity identifies a block, or the lack of one (used to describe an unmined transaction).

func (*BlockIdentity) None added in v0.5.0 

func (b *BlockIdentity) None() bool

None returns whether there is no block described by the instance. When associated with a transaction, this indicates the transaction is unmined.

type BlockInfo added in v1.0.3 

type BlockInfo struct {
	Hash             chainhash.Hash
	Height           int32
	Confirmations    int32
	Header           []byte
	Timestamp        int64
	StakeInvalidated bool
}

BlockInfo records info pertaining to a block. It does not include any information about wallet transactions contained in the block.

type Config added in v1.2.0 

type Config struct {
	DB walletdb.DB

	PubPassphrase []byte

	VotingEnabled bool
	AddressReuse  bool
	VotingAddress dcrutil.Address
	PoolAddress   dcrutil.Address
	PoolFees      float64
	TicketFee     float64

	GapLimit            int
	StakePoolColdExtKey string
	AllowHighFees       bool
	RelayFee            float64
	Params              *chaincfg.Params
}

Config represents the configuration options needed to initialize a wallet.

type ConfirmationNotification added in v1.0.3 

type ConfirmationNotification struct {
	TxHash        *chainhash.Hash
	Confirmations int32
	BlockHash     *chainhash.Hash // nil when unmined
	BlockHeight   int32           // -1 when unmined
}

ConfirmationNotification describes the number of confirmations of a single transaction, or -1 if the transaction is unknown or removed from the wallet. If the transaction is mined (Confirmations >= 1), the block hash and height is included. Otherwise the block hash is nil and the block hegiht is set to -1.

type ConfirmationNotificationsClient added in v1.0.3 

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

ConfirmationNotificationsClient provides confirmation notifications of watched transactions until the caller's context signals done. Callers register for notifications using Watch and receive notifications by calling Recv.

func (*ConfirmationNotificationsClient) Recv added in v1.0.3 

func (c *ConfirmationNotificationsClient) Recv() ([]ConfirmationNotification, error)

Recv waits for the next notification. Returns context.Canceled when the context is canceled.

func (*ConfirmationNotificationsClient) Watch added in v1.0.3 

func (c *ConfirmationNotificationsClient) Watch(txHashes []*chainhash.Hash, stopAfter int32)

Watch adds additional transactions to watch and create confirmation results for. Results are immediately created with the current number of confirmations and are watched until stopAfter confirmations is met or the transaction is unknown or removed from the wallet.

type CreatedTx 

type CreatedTx struct {
	MsgTx       *wire.MsgTx
	ChangeAddr  dcrutil.Address
	ChangeIndex int // negative if no change
	Fee         dcrutil.Amount
}

CreatedTx holds the state of a newly-created transaction and the change output (if one was added).

type CreditCategory 

type CreditCategory byte

CreditCategory describes the type of wallet transaction output. The category of "sent transactions" (debits) is always "send", and is not expressed by this type.

TODO: This is a requirement of the RPC server and should be moved. 

const (
	CreditReceive CreditCategory = iota
	CreditGenerate
	CreditImmature
)

These constants define the possible credit categories.

func RecvCategory 

func RecvCategory(details *udb.TxDetails, syncHeight int32,
	chainParams *chaincfg.Params) CreditCategory

RecvCategory returns the category of received credit outputs from a transaction record. The passed block chain height is used to distinguish immature from mature coinbase outputs.

TODO: This is intended for use by the RPC server and should be moved out of this package at a later time.

func (CreditCategory) String 

func (c CreditCategory) String() string

String returns the category as a string. This string may be used as the JSON string for categories as part of listtransactions and gettransaction RPC responses.

type GetTicketsResult added in v1.1.2 

type GetTicketsResult struct {
	Tickets []*TicketSummary
}

GetTicketsResult response struct for gettickets rpc request

type GetTransactionsResult 

type GetTransactionsResult struct {
	MinedTransactions   []Block
	UnminedTransactions []TransactionSummary
}

GetTransactionsResult is the result of the wallet's GetTransactions method. See GetTransactions for more details.

type MainTipChangedNotification added in v0.7.0 

type MainTipChangedNotification struct {
	AttachedBlocks []*chainhash.Hash
	DetachedBlocks []*chainhash.Hash
	NewHeight      int32
}

MainTipChangedNotification describes processed changes to the main chain tip block. Attached and detached blocks are sorted by increasing heights.

This is intended to be a lightweight alternative to TransactionNotifications when only info regarding the main chain tip block changing is needed.

type MainTipChangedNotificationsClient added in v0.7.0 

type MainTipChangedNotificationsClient struct {
	C chan *MainTipChangedNotification
	// contains filtered or unexported fields
}

MainTipChangedNotificationsClient receives MainTipChangedNotifications over the channel C.

func (*MainTipChangedNotificationsClient) Done added in v0.7.0 

func (c *MainTipChangedNotificationsClient) Done()

Done deregisters the client from the server and drains any remaining messages. It must be called exactly once when the client is finished receiving notifications.

type NetworkBackend added in v1.1.2 

type NetworkBackend interface {
	// Should be no issue for spv
	GetHeaders(ctx context.Context, blockLocators []chainhash.Hash, hashStop *chainhash.Hash) ([][]byte, error)
	LoadTxFilter(ctx context.Context, reload bool, addrs []dcrutil.Address, outpoints []wire.OutPoint) error
	PublishTransaction(ctx context.Context, tx *wire.MsgTx) error

	// Tricky but not impossible for spv
	AddressesUsed(ctx context.Context, addrs []dcrutil.Address) (bitset.Bytes, error)
	Rescan(ctx context.Context, blocks []chainhash.Hash) ([]*RescannedBlock, error)

	// TODO: these should be known directly by the wallet.
	StakeDifficulty(ctx context.Context) (dcrutil.Amount, error)

	// TODO: only used to work around a hack for broken getheaders json-rpc
	GetBlockHash(ctx context.Context, height int32) (*chainhash.Hash, error)
}

NetworkBackend provides wallets with Decred network functionality. Some wallet operations require the wallet to be associated with a network backend to complete.

type NextAddressCallOption added in v1.0.3 

type NextAddressCallOption func(*nextAddressCallOptions)

NextAddressCallOption defines a call option for the NextAddress family of wallet methods.

func WithGapPolicyError added in v1.0.3 

func WithGapPolicyError() NextAddressCallOption

WithGapPolicyError configures the NextAddress family of methods to error whenever the gap limit would be exceeded. When this default policy is used, callers should check errors against the apperrors.ErrExceedsGapLimit error code and let users specify whether to ignore the gap limit or wrap around to a previously returned address.

func WithGapPolicyIgnore added in v1.0.3 

func WithGapPolicyIgnore() NextAddressCallOption

WithGapPolicyIgnore configures the NextAddress family of methods to ignore the gap limit entirely when generating addresses. Exceeding the gap limit may result in unsynced address child indexes when seed restoring the wallet, unless the restoring gap limit is increased, as well as breaking automatic address synchronization of multiple running wallets.

This is a good policy to use when addresses must never be reused, but be aware of the issues noted above.

func WithGapPolicyWrap added in v1.0.3 

func WithGapPolicyWrap() NextAddressCallOption

WithGapPolicyWrap configures the NextAddress family of methods to wrap around to a previously returned address instead of erroring or ignoring the gap limit and returning a new unused address.

This is a good policy to use for most individual users' wallets where funds are segmented by accounts and not the addresses that control each output.

type NotificationServer 

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

NotificationServer is a server that interested clients may hook into to receive notifications of changes in a wallet. A client is created for each registered notification. Clients are guaranteed to receive messages in the order wallet created them, but there is no guaranteed synchronization between different clients.

func (*NotificationServer) AccountNotifications 

func (s *NotificationServer) AccountNotifications() AccountNotificationsClient

AccountNotifications returns a client for receiving AccountNotifications over a channel. The channel is unbuffered. When finished, the client's Done method should be called to disassociate the client from the server.

func (*NotificationServer) ConfirmationNotifications added in v1.0.3 

func (s *NotificationServer) ConfirmationNotifications(ctx context.Context) *ConfirmationNotificationsClient

ConfirmationNotifications registers a client for confirmation notifications from the notification server.

func (*NotificationServer) MainTipChangedNotifications added in v0.7.0 

func (s *NotificationServer) MainTipChangedNotifications() MainTipChangedNotificationsClient

MainTipChangedNotifications returns a client for receiving MainTipChangedNotification over a channel. The channel is unbuffered. When finished, the client's Done method should be called to disassociate the client from the server.

func (*NotificationServer) TransactionNotifications 

func (s *NotificationServer) TransactionNotifications() TransactionNotificationsClient

TransactionNotifications returns a client for receiving TransactionNotifiations notifications over a channel. The channel is unbuffered.

When finished, the Done method should be called on the client to disassociate it from the server.

type OutputInfo added in v0.8.0 

type OutputInfo struct {
	Received     time.Time
	Amount       dcrutil.Amount
	FromCoinbase bool
}

OutputInfo describes additional info about an output which can be queried using an outpoint.

type OutputKind added in v0.5.0 

type OutputKind byte

OutputKind describes a kind of transaction output. This is used to differentiate between coinbase, stakebase, and normal outputs. 

const (
	OutputKindNormal OutputKind = iota
	OutputKindCoinbase
	OutputKindStakebase // not returned by all APIs yet
)

Defined OutputKind constants

type OutputRedeemer added in v0.5.0 

type OutputRedeemer struct {
	TxHash     chainhash.Hash
	InputIndex uint32
}

OutputRedeemer identifies the transaction input which redeems an output.

type OutputSelectionAlgorithm added in v0.7.0 

type OutputSelectionAlgorithm uint

OutputSelectionAlgorithm specifies the algorithm to use when selecting outputs to construct a transaction.

type OutputSelectionPolicy added in v0.5.0 

type OutputSelectionPolicy struct {
	Account               uint32
	RequiredConfirmations int32
}

OutputSelectionPolicy describes the rules for selecting an output from the wallet.

type P2SHMultiSigOutput added in v0.5.0 

type P2SHMultiSigOutput struct {
	// TODO: Add a TransactionOutput member to this struct and remove these
	// fields which are duplicated by it.  This improves consistency.  Only
	// not done now because wtxmgr APIs don't support an efficient way of
	// fetching other Transactionoutput data together with the rest of the
	// multisig info.
	OutPoint        wire.OutPoint
	OutputAmount    dcrutil.Amount
	ContainingBlock BlockIdentity

	P2SHAddress  *dcrutil.AddressScriptHash
	RedeemScript []byte
	M, N         uint8           // M of N signatures required to redeem
	Redeemer     *OutputRedeemer // nil unless spent
}

P2SHMultiSigOutput describes a transaction output with a pay-to-script-hash output script and an imported redemption script. Along with common details of the output, this structure also includes the P2SH address the script was created from and the number of signatures required to redeem it.

TODO: Could be useful to return how many of the required signatures can be created by this wallet.

type RescanProgress added in v0.7.0 

type RescanProgress struct {
	Err            error
	ScannedThrough int32
}

RescanProgress records the height the rescan has completed through and any errors during processing of the rescan.

type RescannedBlock added in v1.1.2 

type RescannedBlock struct {
	BlockHash    chainhash.Hash
	Transactions [][]byte
}

RescannedBlock models the relevant data returned during a rescan from a single block.

type SignatureError 

type SignatureError struct {
	InputIndex uint32
	Error      error
}

SignatureError records the underlying error when validating a transaction input signature.

type StakeDifficultyInfo 

type StakeDifficultyInfo struct {
	BlockHash       *chainhash.Hash
	BlockHeight     int64
	StakeDifficulty int64
}

StakeDifficultyInfo is a container for stake difficulty information updates.

type StakeInfoData added in v0.2.0 

type StakeInfoData struct {
	BlockHeight   int64
	PoolSize      uint32
	AllMempoolTix uint32
	OwnMempoolTix uint32
	Immature      uint32
	Live          uint32
	Voted         uint32
	Missed        uint32
	Revoked       uint32
	Expired       uint32
	TotalSubsidy  dcrutil.Amount
}

StakeInfoData is a struct containing the data that would be returned from a StakeInfo request to the wallet.

type TicketStatus added in v1.1.2 

type TicketStatus int8

TicketStatus describes the current status a ticket can be observed to be. 

const (
	// TicketStatusUnknown any ticket that its status was unable to be determined.
	TicketStatusUnknown TicketStatus = iota
	// TicketStatusUnmined any not yet mined ticket.
	TicketStatusUnmined
	// TicketStatusImmature any so to be live ticket.
	TicketStatusImmature
	// TicketStatusLive any currently live ticket.
	TicketStatusLive
	// TicketStatusVoted any ticket that was seen to have voted.
	TicketStatusVoted
	// TicketStatusRevoked any ticket that has been previously revoked.
	TicketStatusRevoked
	// TicketStatusMissed any ticket that has yet to be revoked, and was missed.
	TicketStatusMissed
	// TicketStatusExpired any ticket that has yet to be revoked, and was expired.
	TicketStatusExpired
)

type TicketSummary added in v1.1.2 

type TicketSummary struct {
	Ticket  *TransactionSummary
	Spender *TransactionSummary
	Status  TicketStatus
}

TicketSummary contains the properties to describe a ticket's current status

type TransactionNotifications 

type TransactionNotifications struct {
	AttachedBlocks           []Block
	DetachedBlocks           []*chainhash.Hash
	UnminedTransactions      []TransactionSummary
	UnminedTransactionHashes []*chainhash.Hash
	NewBalances              []AccountBalance
}

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. All transactions added to the blockchain are organized by the block they were mined in.

During a chain switch, all removed block hashes are included. Detached blocks are sorted in the reverse order they were mined. Attached blocks are sorted in the order mined.

All newly added unmined transactions are included. Removed unmined transactions are not explicitly included. Instead, the hashes of all transactions still unmined are included.

If any transactions were involved, each affected account's new total balance is included.

TODO: Because this includes stuff about blocks and can be fired without any changes to transactions, it needs a better name.

type TransactionNotificationsClient 

type TransactionNotificationsClient struct {
	C <-chan *TransactionNotifications
	// contains filtered or unexported fields
}

TransactionNotificationsClient receives TransactionNotifications from the NotificationServer over the channel C.

func (*TransactionNotificationsClient) Done 

func (c *TransactionNotificationsClient) Done()

Done deregisters the client from the server and drains any remaining messages. It must be called exactly once when the client is finished receiving notifications.

type TransactionOutput added in v0.5.0 

type TransactionOutput struct {
	OutPoint   wire.OutPoint
	Output     wire.TxOut
	OutputKind OutputKind
	// These should be added later when the DB can return them more
	// efficiently:
	//TxLockTime      uint32
	//TxExpiry        uint32
	ContainingBlock BlockIdentity
	ReceiveTime     time.Time
}

TransactionOutput describes an output that was or is at least partially controlled by the wallet. Depending on context, this could refer to an unspent output, or a spent one.

type TransactionSummary 

type TransactionSummary struct {
	Hash        *chainhash.Hash
	Transaction []byte
	MyInputs    []TransactionSummaryInput
	MyOutputs   []TransactionSummaryOutput
	Fee         dcrutil.Amount
	Timestamp   int64
	Type        TransactionType
}

TransactionSummary contains a transaction relevant to the wallet and marks which inputs and outputs were relevant.

type TransactionSummaryInput 

type TransactionSummaryInput struct {
	Index           uint32
	PreviousAccount uint32
	PreviousAmount  dcrutil.Amount
}

TransactionSummaryInput describes a transaction input that is relevant to the wallet. The Index field marks the transaction input index of the transaction (not included here). The PreviousAccount and PreviousAmount fields describe how much this input debits from a wallet account.

type TransactionSummaryOutput 

type TransactionSummaryOutput struct {
	Index        uint32
	Account      uint32
	Internal     bool
	Amount       dcrutil.Amount
	Address      dcrutil.Address
	OutputScript []byte
}

TransactionSummaryOutput describes wallet properties of a transaction output controlled by the wallet. The Index field marks the transaction output index of the transaction (not included here).

type TransactionType added in v1.0.0 

type TransactionType int8

TransactionType describes the which type of transaction is has been observed to be. For instance, if it has a ticket as an input and a stake base reward as an ouput, it is known to be a vote. 

const (
	// TransactionTypeRegular transaction type for all regular transactions.
	TransactionTypeRegular TransactionType = iota

	// TransactionTypeCoinbase is the transaction type for all coinbase transactions.
	TransactionTypeCoinbase

	// TransactionTypeTicketPurchase transaction type for all transactions that
	// consume regular transactions as inputs and have commitments for future votes
	// as outputs.
	TransactionTypeTicketPurchase

	// TransactionTypeVote transaction type for all transactions that consume a ticket
	// and also offer a stake base reward output.
	TransactionTypeVote

	// TransactionTypeRevocation transaction type for all transactions that consume a
	// ticket, but offer no stake base reward.
	TransactionTypeRevocation
)

func TxTransactionType added in v1.1.2 

func TxTransactionType(tx *wire.MsgTx) TransactionType

TxTransactionType returns the correct TransactionType given a wire transaction

type Wallet 

type Wallet struct {
	Manager  *udb.Manager
	TxStore  *udb.Store
	StakeMgr *udb.StakeStore

	DisallowFree  bool
	AllowHighFees bool

	NtfnServer *NotificationServer
	// contains filtered or unexported fields
}

Wallet is a structure containing all the components for a complete wallet. It contains the Armory-style key store addresses and keys),

func Open 

func Open(cfg *Config) (*Wallet, error)

Open loads an already-created wallet from the passed database and namespaces configuration options and sets it up it according to the rest of options.

func (*Wallet) AcceptMempoolTx added in v1.1.2 

func (w *Wallet) AcceptMempoolTx(serializedTx []byte) error

AcceptMempoolTx adds a relevant unmined transaction to the wallet.

func (*Wallet) AccountBranchAddressRange added in v0.5.0 

func (w *Wallet) AccountBranchAddressRange(account, branch, start, end uint32) ([]dcrutil.Address, error)

AccountBranchAddressRange returns all addresses in the range [start, end) belonging to the BIP0044 account and address branch.

func (*Wallet) AccountName added in v0.5.0 

func (w *Wallet) AccountName(accountNumber uint32) (string, error)

AccountName returns the name of an account.

func (*Wallet) AccountNumber added in v0.5.0 

func (w *Wallet) AccountNumber(accountName string) (uint32, error)

AccountNumber returns the account number for an account name.

func (*Wallet) AccountOfAddress added in v0.5.0 

func (w *Wallet) AccountOfAddress(a dcrutil.Address) (uint32, error)

AccountOfAddress finds the account that an address is associated with.

func (*Wallet) AccountProperties added in v0.2.0 

func (w *Wallet) AccountProperties(acct uint32) (*udb.AccountProperties, error)

AccountProperties returns the properties of an account, including address indexes and name. It first fetches the desynced information from the address manager, then updates the indexes based on the address pools.

func (*Wallet) Accounts 

func (w *Wallet) Accounts() (*AccountsResult, error)

Accounts returns the current names, numbers, and total balances of all accounts in the wallet. The current chain tip is included in the result for atomicity reasons.

TODO(jrick): Is the chain tip really needed, since only the total balances are included?

func (*Wallet) AddTicket added in v0.5.0 

func (w *Wallet) AddTicket(ticket *wire.MsgTx) error

AddTicket adds a ticket transaction to the stake manager. It is not added to the transaction manager because it is unknown where the transaction belongs on the blockchain. It will be used to create votes.

func (*Wallet) AddressInfo added in v0.5.0 

func (w *Wallet) AddressInfo(a dcrutil.Address) (udb.ManagedAddress, error)

AddressInfo returns detailed information regarding a wallet address.

func (*Wallet) AgendaChoices added in v1.0.0 

func (w *Wallet) AgendaChoices() (choices []AgendaChoice, voteBits uint16, err error)

AgendaChoices returns the choice IDs for every agenda of the supported stake version. Abstains are included.

func (*Wallet) BIP0044BranchNextIndexes added in v1.0.0 

func (w *Wallet) BIP0044BranchNextIndexes(account uint32) (extChild, intChild uint32, err error)

BIP0044BranchNextIndexes returns the next external and internal branch child indexes of an account.

func (*Wallet) BalanceToMaintain 

func (w *Wallet) BalanceToMaintain() dcrutil.Amount

BalanceToMaintain is used to get the current balancetomaintain for the wallet.

func (*Wallet) BlockInfo added in v1.0.3 

func (w *Wallet) BlockInfo(blockID *BlockIdentifier) (*BlockInfo, error)

BlockInfo returns info regarding a block recorded by the wallet.

func (*Wallet) CalculateAccountBalance 

func (w *Wallet) CalculateAccountBalance(account uint32, confirms int32) (udb.Balances, error)

CalculateAccountBalance sums the amounts of all unspent transaction outputs to the given account of a wallet and returns the balance.

func (*Wallet) CalculateAccountBalances 

func (w *Wallet) CalculateAccountBalances(confirms int32) (map[uint32]*udb.Balances, error)

CalculateAccountBalances calculates the values for the wtxmgr struct Balance, which includes the total balance, the spendable balance, and the balance which has yet to mature.

func (*Wallet) ChainParams 

func (w *Wallet) ChainParams() *chaincfg.Params

ChainParams returns the network parameters for the blockchain the wallet belongs to.

func (*Wallet) ChangePrivatePassphrase added in v0.5.0 

func (w *Wallet) ChangePrivatePassphrase(old, new []byte) error

ChangePrivatePassphrase attempts to change the passphrase for a wallet from old to new. Changing the passphrase is synchronized with all other address manager locking and unlocking. The lock state will be the same as it was before the password change.

func (*Wallet) ChangePublicPassphrase added in v0.5.0 

func (w *Wallet) ChangePublicPassphrase(old, new []byte) error

ChangePublicPassphrase modifies the public passphrase of the wallet.

func (*Wallet) CommittedTickets added in v1.2.0 

func (w *Wallet) CommittedTickets(tickets []*chainhash.Hash) ([]*chainhash.Hash, []dcrutil.Address, error)

CommittedTickets takes a list of tickets and returns a filtered list of tickets that are controlled by this wallet.

func (*Wallet) ConnectBlock added in v1.1.2 

func (w *Wallet) ConnectBlock(serializedBlockHeader []byte, transactions [][]byte) (err error)

ConnectBlock attaches a block and relevant wallet transactions to the wallet's main chain or side chain depending on whether the wallet is reorganizing.

func (*Wallet) Consolidate 

func (w *Wallet) Consolidate(inputs int, account uint32,
	address dcrutil.Address) (*chainhash.Hash, error)

Consolidate consolidates as many UTXOs as are passed in the inputs argument. If that many UTXOs can not be found, it will use the maximum it finds. This will only compress UTXOs in the default account

func (*Wallet) CreateMultisigTx 

func (w *Wallet) CreateMultisigTx(account uint32, amount dcrutil.Amount,
	pubkeys []*dcrutil.AddressSecpPubKey, nrequired int8,
	minconf int32) (*CreatedTx, dcrutil.Address, []byte, error)

CreateMultisigTx receives a request from the RPC and ships it to txCreator to generate a new multisigtx.

func (*Wallet) CreateSignature added in v1.1.0 

func (w *Wallet) CreateSignature(tx *wire.MsgTx, idx uint32, addr dcrutil.Address,
	hashType txscript.SigHashType, prevPkScript []byte) (sig, pubkey []byte, err error)

CreateSignature returns the raw signature created by the private key of addr for tx's idx'th input script and the serialized compressed pubkey for the address.

func (*Wallet) CreateSimpleTx 

func (w *Wallet) CreateSimpleTx(account uint32, outputs []*wire.TxOut,
	minconf int32) (*txauthor.AuthoredTx, error)

CreateSimpleTx creates a new signed transaction spending unspent P2PKH outputs with at laest minconf confirmations spending to any number of address/amount pairs. Change and an appropriate transaction fee are automatically included, if necessary. All transaction creation through this function is serialized to prevent the creation of many transactions which spend the same outputs.

func (*Wallet) CurrentAddress 

func (w *Wallet) CurrentAddress(account uint32) (dcrutil.Address, error)

CurrentAddress gets the most recently requested payment address from a wallet. If the address has already been used (there is at least one transaction spending to it in the blockchain or dcrd mempool), the next chained address is returned.

func (*Wallet) DiscoverActiveAddresses added in v0.7.0 

func (w *Wallet) DiscoverActiveAddresses(n NetworkBackend, discoverAccts bool) error

DiscoverActiveAddresses accesses the consensus RPC server to discover all the addresses that have been used by an HD keychain stemming from this wallet. If discoverAccts is true, used accounts will be discovered as well. This feature requires the wallet to be unlocked in order to derive hardened account extended pubkeys.

If the wallet is currently on the legacy coin type and no address or account usage is observed, the wallet will be upgraded to the SLIP0044 coin type and the address discovery will occur again.

A transaction filter (re)load and rescan should be performed after discovery.

func (*Wallet) DumpWIFPrivateKey 

func (w *Wallet) DumpWIFPrivateKey(addr dcrutil.Address) (string, error)

DumpWIFPrivateKey returns the WIF encoded private key for a single wallet address.

func (*Wallet) ExtendWatchedAddresses added in v1.0.0 

func (w *Wallet) ExtendWatchedAddresses(account, branch, child uint32) error

ExtendWatchedAddresses derives and watches additional addresses for an account branch they have not yet been derived. This does not modify the next generated address for the branch.

func (*Wallet) FetchAllRedeemScripts added in v0.5.0 

func (w *Wallet) FetchAllRedeemScripts() ([][]byte, error)

FetchAllRedeemScripts returns all P2SH redeem scripts saved by the wallet.

func (*Wallet) FetchHeaders added in v0.7.0 

func (w *Wallet) FetchHeaders(n NetworkBackend) (count int, rescanFrom chainhash.Hash, rescanFromHeight int32,
	mainChainTipBlockHash chainhash.Hash, mainChainTipBlockHeight int32, err error)

FetchHeaders fetches headers from the consensus RPC server and updates the main chain tip with the latest block. The number of new headers fetched is returned, along with the hash of the first previously-unseen block hash now in the main chain. This is the block a rescan should begin at (inclusive), and is only relevant when the number of fetched headers is not zero.

func (*Wallet) FetchP2SHMultiSigOutput added in v0.5.0 

func (w *Wallet) FetchP2SHMultiSigOutput(outPoint *wire.OutPoint) (*P2SHMultiSigOutput, error)

FetchP2SHMultiSigOutput fetches information regarding a wallet's P2SH multi-signature output.

func (*Wallet) FindEligibleOutputs 

func (w *Wallet) FindEligibleOutputs(account uint32, minconf int32, currentHeight int32) ([]udb.Credit, error)

FindEligibleOutputs is the exported version of findEligibleOutputs (which tried to find unspent outputs that pass a maturity check).

func (*Wallet) GenerateVoteTx added in v1.0.0 

func (w *Wallet) GenerateVoteTx(blockHash *chainhash.Hash, height int32, ticketHash *chainhash.Hash, voteBits stake.VoteBits) (*wire.MsgTx, error)

GenerateVoteTx creates a vote transaction for a chosen ticket purchase hash using the provided votebits. The ticket purchase transaction must be stored by the wallet.

func (*Wallet) GetTickets added in v1.1.2 

func (w *Wallet) GetTickets(f func([]*TicketSummary, *wire.BlockHeader) (bool, error), chainClient *dcrrpcclient.Client, startBlock, endBlock *BlockIdentifier) error

GetTickets calls function f for all tickets located in between the given startBlock and endBlock. TicketSummary includes TransactionSummmary for the ticket and the spender (if already spent) and the ticket's current status. The function f also receives block header of the ticket. All tickets on a given call belong to the same block and at least one ticket is present when f is called. If the ticket is unmined, the block header will be nil.

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 when true.

The arguments to f may be reused and should not be kept by the caller.

func (*Wallet) GetTransactions 

func (w *Wallet) GetTransactions(f func(*Block) (bool, error), startBlock, endBlock *BlockIdentifier) error

GetTransactions runs the function f on all transactions between a starting and ending block. Blocks in the block range may be specified by either a height or a hash.

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 when true.

Transaction results are organized by blocks in ascending order and unmined transactions in an unspecified order. Mined transactions are saved in a Block structure which records properties about the block. Unmined transactions are returned on a Block structure with height == -1.

Internally this function uses the udb store RangeTransactions function, therefore the notes and restrictions of that function also apply here.

func (*Wallet) HaveAddress added in v0.5.0 

func (w *Wallet) HaveAddress(a dcrutil.Address) (bool, error)

HaveAddress returns whether the wallet is the owner of the address a.

func (*Wallet) ImportP2SHRedeemScript added in v0.5.0 

func (w *Wallet) ImportP2SHRedeemScript(script []byte) (*dcrutil.AddressScriptHash, error)

ImportP2SHRedeemScript adds a P2SH redeem script to the wallet.

func (*Wallet) ImportPrivateKey 

func (w *Wallet) ImportPrivateKey(wif *dcrutil.WIF) (string, error)

ImportPrivateKey imports a private key to the wallet and writes the new wallet to disk.

func (*Wallet) ImportScript added in v0.1.5 

func (w *Wallet) ImportScript(rs []byte) error

ImportScript imports a redeemscript to the wallet. If it also allows the user to specify whether or not they want the redeemscript to be rescanned, and how far back they wish to rescan.

func (*Wallet) ListAddressTransactions 

func (w *Wallet) ListAddressTransactions(pkHashes map[string]struct{}) ([]dcrjson.ListTransactionsResult, error)

ListAddressTransactions returns a slice of objects with details about recorded transactions to or from any address belonging to a set. This is intended to be used for listaddresstransactions RPC replies.

func (*Wallet) ListAllTransactions 

func (w *Wallet) ListAllTransactions() ([]dcrjson.ListTransactionsResult, error)

ListAllTransactions returns a slice of objects with details about a recorded transaction. This is intended to be used for listalltransactions RPC replies.

func (*Wallet) ListSinceBlock 

func (w *Wallet) ListSinceBlock(start, end, syncHeight int32) ([]dcrjson.ListTransactionsResult, error)

ListSinceBlock returns a slice of objects with details about transactions since the given block. If the block is -1 then all transactions are included. This is intended to be used for listsinceblock RPC replies.

func (*Wallet) ListTransactions 

func (w *Wallet) ListTransactions(from, count int) ([]dcrjson.ListTransactionsResult, error)

ListTransactions returns a slice of objects with details about a recorded transaction. This is intended to be used for listtransactions RPC replies.

func (*Wallet) ListUnspent 

func (w *Wallet) ListUnspent(minconf, maxconf int32, addresses map[string]struct{}) ([]*dcrjson.ListUnspentResult, error)

ListUnspent returns a slice of objects representing the unspent wallet transactions fitting the given criteria. The confirmations will be more than minconf, less than maxconf and if addresses is populated only the addresses contained within it will be considered. If we know nothing about a transaction an empty array will be returned.

func (*Wallet) LiveTicketHashes added in v0.5.0 

func (w *Wallet) LiveTicketHashes(chainClient *dcrrpcclient.Client, includeImmature bool) ([]chainhash.Hash, error)

LiveTicketHashes returns the hashes of live tickets that the wallet has purchased or has voting authority for.

func (*Wallet) LoadActiveDataFilters added in v0.7.0 

func (w *Wallet) LoadActiveDataFilters(n NetworkBackend) error

LoadActiveDataFilters loads filters for all active addresses and unspent outpoints for this wallet.

func (*Wallet) Lock 

func (w *Wallet) Lock()

Lock locks the wallet's address manager.

func (*Wallet) LockOutpoint 

func (w *Wallet) LockOutpoint(op wire.OutPoint)

LockOutpoint marks an outpoint as locked, that is, it should not be used as an input for newly created transactions.

func (*Wallet) Locked 

func (w *Wallet) Locked() bool

Locked returns whether the account manager for a wallet is locked.

func (*Wallet) LockedOutpoint 

func (w *Wallet) LockedOutpoint(op wire.OutPoint) bool

LockedOutpoint returns whether an outpoint has been marked as locked and should not be used as an input for created transactions.

func (*Wallet) LockedOutpoints 

func (w *Wallet) LockedOutpoints() []dcrjson.TransactionInput

LockedOutpoints returns a slice of currently locked outpoints. This is intended to be used by marshaling the result as a JSON array for listlockunspent RPC results.

func (*Wallet) MainChainTip added in v0.6.0 

func (w *Wallet) MainChainTip() (hash chainhash.Hash, height int32)

MainChainTip returns the hash and height of the tip-most block in the main chain that the wallet is synchronized to.

func (*Wallet) MakeSecp256k1MultiSigScript added in v0.5.0 

func (w *Wallet) MakeSecp256k1MultiSigScript(secp256k1Addrs []dcrutil.Address, nRequired int) ([]byte, error)

MakeSecp256k1MultiSigScript creates a multi-signature script that can be redeemed with nRequired signatures of the passed keys and addresses. If the address is a P2PKH address, the associated pubkey is looked up by the wallet if possible, otherwise an error is returned for a missing pubkey.

This function only works with secp256k1 pubkeys and P2PKH addresses derived from them.

func (*Wallet) MasterPubKey added in v0.5.0 

func (w *Wallet) MasterPubKey(account uint32) (*hdkeychain.ExtendedKey, error)

MasterPubKey returns the BIP0044 master public key for the passed account.

func (*Wallet) NeedsAccountsSync added in v0.6.0 

func (w *Wallet) NeedsAccountsSync() (bool, error)

NeedsAccountsSync returns whether or not the wallet is void of any generated keys and accounts (other than the default account), and records the genesis block as the main chain tip. When these are both true, an accounts sync should be performed to restore, per BIP0044, any generated accounts and addresses from a restored seed.

func (*Wallet) NetworkBackend added in v1.1.2 

func (w *Wallet) NetworkBackend() (NetworkBackend, error)

NetworkBackend returns the currently associated network backend of the wallet, or an error if the no backend is currently set.

func (*Wallet) NewChangeAddress 

func (w *Wallet) NewChangeAddress(account uint32) (dcrutil.Address, error)

NewChangeAddress returns an internal address. This is identical to NewInternalAddress but handles the imported account (which can't create addresses) by using account 0 instead, and always uses the wrapping gap limit policy.

func (*Wallet) NewExternalAddress added in v1.0.0 

func (w *Wallet) NewExternalAddress(account uint32, callOpts ...NextAddressCallOption) (dcrutil.Address, error)

NewExternalAddress returns an external address.

func (*Wallet) NewInternalAddress added in v1.0.0 

func (w *Wallet) NewInternalAddress(account uint32, callOpts ...NextAddressCallOption) (dcrutil.Address, error)

NewInternalAddress returns an internal address.

func (*Wallet) NewUnsignedTransaction added in v0.7.0 

func (w *Wallet) NewUnsignedTransaction(outputs []*wire.TxOut, relayFeePerKb dcrutil.Amount, account uint32, minConf int32,
	algo OutputSelectionAlgorithm, changeSource txauthor.ChangeSource) (*txauthor.AuthoredTx, error)

NewUnsignedTransaction constructs an unsigned transaction using unspent account outputs.

The changeSource parameter is optional and can be nil. When nil, and if a change output should be added, an internal change address is created for the account.

func (*Wallet) NextAccount 

func (w *Wallet) NextAccount(name string) (uint32, error)

NextAccount creates the next account and returns its account number. The name must be unique to the account. In order to support automatic seed restoring, new accounts may not be created when all of the previous 100 accounts have no transaction history (this is a deviation from the BIP0044 spec, which allows no unused account gaps).

func (*Wallet) OutputInfo added in v0.8.0 

func (w *Wallet) OutputInfo(op *wire.OutPoint) (OutputInfo, error)

OutputInfo queries the wallet for additional transaction output info regarding an outpoint.

func (*Wallet) PoolAddress added in v0.1.0 

func (w *Wallet) PoolAddress() dcrutil.Address

PoolAddress gets the pool address for the wallet to give ticket fees to.

func (*Wallet) PoolFees added in v0.1.0 

func (w *Wallet) PoolFees() float64

PoolFees gets the per-ticket pool fee for the wallet.

func (*Wallet) PrepareRedeemMultiSigOutTxOutput added in v1.2.0 

func (w *Wallet) PrepareRedeemMultiSigOutTxOutput(msgTx *wire.MsgTx, p2shOutput *P2SHMultiSigOutput, pkScript *[]byte) error

PrepareRedeemMultiSigOutTxOutput estimates the tx value for a MultiSigOutTx output and adds it

func (*Wallet) PubKeyForAddress added in v0.5.0 

func (w *Wallet) PubKeyForAddress(a dcrutil.Address) (chainec.PublicKey, error)

PubKeyForAddress looks up the associated public key for a P2PKH address.

func (*Wallet) PublishTransaction 

func (w *Wallet) PublishTransaction(tx *wire.MsgTx, serializedTx []byte, n NetworkBackend) (*chainhash.Hash, error)

PublishTransaction saves (if relevant) and sends the transaction to the consensus RPC server so it can be propagated to other nodes and eventually mined. If the send fails, the transaction is not added to the wallet.

func (*Wallet) PublishUnminedTransactions added in v1.2.0 

func (w *Wallet) PublishUnminedTransactions(ctx context.Context, backend NetworkBackend) error

PublishUnminedTransactions rebroadcasts all unmined transactions to the consensus RPC server so it can be propagated to other nodes and eventually mined.

func (*Wallet) PurchaseTickets added in v0.2.0 

func (w *Wallet) PurchaseTickets(minBalance, spendLimit dcrutil.Amount,
	minConf int32, ticketAddr dcrutil.Address, account uint32,
	numTickets int, poolAddress dcrutil.Address, poolFees float64,
	expiry int32, txFee dcrutil.Amount, ticketFee dcrutil.Amount) ([]*chainhash.Hash,
	error)

PurchaseTickets receives a request from the RPC and ships it to txCreator to purchase a new ticket. It returns a slice of the hashes of the purchased tickets.

func (*Wallet) RedeemScriptCopy added in v1.0.0 

func (w *Wallet) RedeemScriptCopy(addr dcrutil.Address) ([]byte, error)

RedeemScriptCopy returns a copy of a redeem script to redeem outputs payed to a P2SH address.

func (*Wallet) RelayFee 

func (w *Wallet) RelayFee() dcrutil.Amount

RelayFee returns the current minimum relay fee (per kB of serialized transaction) used when constructing transactions.

func (*Wallet) RenameAccount 

func (w *Wallet) RenameAccount(account uint32, newName string) error

RenameAccount sets the name for an account number to newName.

func (*Wallet) Rescan 

func (w *Wallet) Rescan(ctx context.Context, n NetworkBackend, startHash *chainhash.Hash) error

Rescan starts a rescan of the wallet for all blocks on the main chain beginning at startHash. This function blocks until the rescan completes.

func (*Wallet) RescanFromHeight added in v0.6.0 

func (w *Wallet) RescanFromHeight(ctx context.Context, n NetworkBackend, startHeight int32) error

RescanFromHeight is an alternative to Rescan that takes a block height instead of a hash. See Rescan for more details.

func (*Wallet) RescanProgressFromHeight added in v0.7.0 

func (w *Wallet) RescanProgressFromHeight(ctx context.Context, n NetworkBackend,
	startHeight int32, p chan<- RescanProgress)

RescanProgressFromHeight rescans for relevant transactions in all blocks in the main chain starting at startHeight. Progress notifications and any errors are sent to the channel p. This function blocks until the rescan completes or ends in an error. p is closed before returning.

func (*Wallet) ResetLockedOutpoints 

func (w *Wallet) ResetLockedOutpoints()

ResetLockedOutpoints resets the set of locked outpoints so all may be used as inputs for new transactions.

func (*Wallet) RevokeOwnedTickets added in v1.1.2 

func (w *Wallet) RevokeOwnedTickets(missedTicketHashes []*chainhash.Hash) error

RevokeOwnedTickets revokes any owned tickets specified in the missedTicketHashes slice.

func (*Wallet) RevokeTickets added in v1.0.3 

func (w *Wallet) RevokeTickets(chainClient *dcrrpcclient.Client) error

RevokeTickets creates and sends revocation transactions for any unrevoked missed and expired tickets. The wallet must be unlocked to generate any revocations.

func (*Wallet) SelectInputs added in v0.8.0 

func (w *Wallet) SelectInputs(targetAmount dcrutil.Amount, policy OutputSelectionPolicy) (total dcrutil.Amount,
	inputs []*wire.TxIn, prevScripts [][]byte, err error)

SelectInputs selects transaction inputs to redeem unspent outputs stored in the wallet. It returns the total input amount referenced by the previous transaction outputs, a slice of transaction inputs referencing these outputs, and a slice of previous output scripts from each previous output referenced by the corresponding input.

func (*Wallet) SendOutputs 

func (w *Wallet) SendOutputs(outputs []*wire.TxOut, account uint32,
	minconf int32) (*chainhash.Hash, error)

SendOutputs creates and sends payment transactions. It returns the transaction hash upon success

func (*Wallet) SetAgendaChoices added in v1.0.0 

func (w *Wallet) SetAgendaChoices(choices ...AgendaChoice) (voteBits uint16, err error)

SetAgendaChoices sets the choices for agendas defined by the supported stake version. If a choice is set multiple times, the last takes preference. The new votebits after each change is made are returned.

func (*Wallet) SetBalanceToMaintain 

func (w *Wallet) SetBalanceToMaintain(balance dcrutil.Amount)

SetBalanceToMaintain is used to set the current w.balancetomaintain for the wallet.

func (*Wallet) SetInitiallyUnlocked added in v0.1.5 

func (w *Wallet) SetInitiallyUnlocked(set bool)

SetInitiallyUnlocked sets whether or not the wallet is initially unlocked. This allows the user to resync accounts, dictating some of the start up syncing behaviour. It should only be called before the wallet RPC servers are accessible. It is not safe for concurrent access.

func (*Wallet) SetNetworkBackend added in v1.1.2 

func (w *Wallet) SetNetworkBackend(n NetworkBackend)

SetNetworkBackend sets the network backend used by various functions of the wallet.

func (*Wallet) SetRelayFee 

func (w *Wallet) SetRelayFee(relayFee dcrutil.Amount)

SetRelayFee sets a new minimum relay fee (per kB of serialized transaction) used when constructing transactions.

func (*Wallet) SetTicketFeeIncrement 

func (w *Wallet) SetTicketFeeIncrement(fee dcrutil.Amount)

SetTicketFeeIncrement is used to set the current w.ticketFeeIncrement for the wallet.

func (*Wallet) SignMessage added in v1.0.0 

func (w *Wallet) SignMessage(msg string, addr dcrutil.Address) (sig []byte, err error)

SignMessage returns the signature of a signed message using an address' associated private key.

func (*Wallet) SignTransaction 

func (w *Wallet) SignTransaction(tx *wire.MsgTx, hashType txscript.SigHashType,
	additionalPrevScripts map[wire.OutPoint][]byte,
	additionalKeysByAddress map[string]*dcrutil.WIF,
	p2shRedeemScriptsByAddress map[string][]byte) ([]SignatureError, error)

SignTransaction uses secrets of the wallet, as well as additional secrets passed in by the caller, to create and add input signatures to a transaction.

Transaction input script validation is used to confirm that all signatures are valid. For any invalid input, a SignatureError is added to the returns. The final error return is reserved for unexpected or fatal errors, such as being unable to determine a previous output script to redeem.

The transaction pointed to by tx is modified by this function.

func (*Wallet) SortedActivePaymentAddresses 

func (w *Wallet) SortedActivePaymentAddresses() ([]string, error)

SortedActivePaymentAddresses returns a slice of all active payment addresses in a wallet.

func (*Wallet) StakeDifficulty added in v0.2.0 

func (w *Wallet) StakeDifficulty() (dcrutil.Amount, error)

StakeDifficulty is used to get the next block's stake difficulty.

func (*Wallet) StakeInfo added in v0.2.0 

func (w *Wallet) StakeInfo(chainClient *dcrrpcclient.Client) (*StakeInfoData, error)

StakeInfo collects and returns staking statistics for this wallet to the end user. This includes: 

PoolSize         uint32   Number of live tickets in the ticket pool
AllMempoolTix    uint32   Number of tickets currently in the mempool
OwnMempoolTix    uint32   Number of tickets in mempool that are from
                            this wallet
Immature         uint32   Number of tickets from this wallet that are in
                            the blockchain but which are not yet mature
Live             uint32   Number of mature, active tickets owned by this
                            wallet
Voted            uint32   Number of votes cast by this wallet
Missed           uint32   Number of missed tickets (failing to vote)
Expired          uint32   Number of expired tickets
Revoked          uint32   Number of missed tickets that were missed and
                            then revoked
TotalSubsidy     int64    Total amount of coins earned by stake mining

Getting this information is extremely costly as in involves a massive number of chain server calls.

func (*Wallet) StakePoolUserInfo added in v0.5.0 

func (w *Wallet) StakePoolUserInfo(userAddress dcrutil.Address) (*udb.StakePoolUser, error)

StakePoolUserInfo returns the stake pool user information for a user identified by their P2SH voting address.

func (*Wallet) Start 

func (w *Wallet) Start()

Start starts the goroutines necessary to manage a wallet.

func (*Wallet) StartReorganize added in v1.1.2 

func (w *Wallet) StartReorganize(oldHash, newHash *chainhash.Hash, oldHeight, newHeight int64) error

StartReorganize sets the wallet to a reorganizing state where all attached blocks will attach to a sidechain until the final block is reached, at which point a chain switch occurs.

func (*Wallet) Stop 

func (w *Wallet) Stop()

Stop signals all wallet goroutines to shutdown.

func (*Wallet) TicketAddress added in v0.1.0 

func (w *Wallet) TicketAddress() dcrutil.Address

TicketAddress gets the ticket address for the wallet to give the ticket voting rights to.

func (*Wallet) TicketFeeIncrement 

func (w *Wallet) TicketFeeIncrement() dcrutil.Amount

TicketFeeIncrement is used to get the current feeIncrement for the wallet.

func (*Wallet) TicketHashesForVotingAddress added in v0.5.0 

func (w *Wallet) TicketHashesForVotingAddress(votingAddr dcrutil.Address) ([]chainhash.Hash, error)

TicketHashesForVotingAddress returns the hashes of all tickets with voting rights delegated to votingAddr. This function does not return the hashes of pruned tickets.

func (*Wallet) TotalReceivedForAccounts added in v0.5.0 

func (w *Wallet) TotalReceivedForAccounts(minConf int32) ([]AccountTotalReceivedResult, error)

TotalReceivedForAccounts iterates through a wallet's transaction history, returning the total amount of decred received for all accounts.

func (*Wallet) TotalReceivedForAddr 

func (w *Wallet) TotalReceivedForAddr(addr dcrutil.Address, minConf int32) (dcrutil.Amount, error)

TotalReceivedForAddr iterates through a wallet's transaction history, returning the total amount of decred received for a single wallet address.

func (*Wallet) TransactionSummary added in v1.0.5 

func (w *Wallet) TransactionSummary(txHash *chainhash.Hash) (txSummary *TransactionSummary,
	confs int32, blockHash *chainhash.Hash, err error)

TransactionSummary returns details about a recorded transaction that is relevant to the wallet in some way.

func (*Wallet) Unlock 

func (w *Wallet) Unlock(passphrase []byte, lock <-chan time.Time) error

Unlock unlocks the wallet's address manager and relocks it after timeout has expired. If the wallet is already unlocked and the new passphrase is correct, the current timeout is replaced with the new one. The wallet will be locked if the passphrase is incorrect or any other error occurs during the unlock.

func (*Wallet) UnlockOutpoint 

func (w *Wallet) UnlockOutpoint(op wire.OutPoint)

UnlockOutpoint marks an outpoint as unlocked, that is, it may be used as an input for newly created transactions.

func (*Wallet) UnminedTransactions added in v1.1.2 

func (w *Wallet) UnminedTransactions() ([]*wire.MsgTx, error)

UnminedTransactions returns all unmined transactions from the wallet. Transactions are sorted in dependency order making it suitable to range them in order to broadcast at wallet startup.

func (*Wallet) UnspentOutputs added in v0.5.0 

func (w *Wallet) UnspentOutputs(policy OutputSelectionPolicy) ([]*TransactionOutput, error)

UnspentOutputs fetches all unspent outputs from the wallet that match rules described in the passed policy.

func (*Wallet) UpgradeToSLIP0044CoinType added in v1.1.2 

func (w *Wallet) UpgradeToSLIP0044CoinType() error

UpgradeToSLIP0044CoinType upgrades the wallet from the legacy BIP0044 coin type to one of the coin types assigned to Decred in SLIP0044. This should be called after a new wallet is created with a random (not imported) seed.

This function does not register addresses from the new account 0 with the wallet's network backend. This is intentional as it allows offline activities, such as wallet creation, to perform this upgrade.

func (*Wallet) VoteBits 

func (w *Wallet) VoteBits() stake.VoteBits

VoteBits returns the vote bits that are described by the currently set agenda preferences. The previous block valid bit is always set, and must be unset elsewhere if the previous block's regular transactions should be voted against.

func (*Wallet) VoteOnOwnedTickets added in v1.1.2 

func (w *Wallet) VoteOnOwnedTickets(winningTicketHashes []*chainhash.Hash,
	blockHash *chainhash.Hash, blockHeight int32) error

VoteOnOwnedTickets creates and publishes vote transactions for all owned tickets in the winningTicketHashes slice if wallet voting is enabled. The vote is only valid when voting on the block described by the passed block hash and height.

func (*Wallet) VotingEnabled added in v1.0.0 

func (w *Wallet) VotingEnabled() bool

VotingEnabled returns whether the wallet is configured to vote tickets.

func (*Wallet) WaitForShutdown 

func (w *Wallet) WaitForShutdown()

WaitForShutdown blocks until all wallet goroutines have finished executing.

Source Files

View all Source files

Directories

Path Synopsis
internal
txsizes
Package txauthor provides transaction creation code for wallets.
 Package txauthor provides transaction creation code for wallets.
Package txrules provides functions that are help establish whether or not a transaction abides by non-consensus rules for things like the daemon and stake pool.
 Package txrules provides functions that are help establish whether or not a transaction abides by non-consensus rules for things like the daemon and stake pool.

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.