Release v0.1.0

vendor/github.com/btcsuite/btcwallet/chain/interface.go

@@ -0,0 +1,124 @@
+package chain
+
+import (
+	"time"
+
+	"github.com/btcsuite/btcd/chaincfg/chainhash"
+	"github.com/btcsuite/btcd/wire"
+	"github.com/btcsuite/btcutil"
+	"github.com/btcsuite/btcwallet/waddrmgr"
+	"github.com/btcsuite/btcwallet/wtxmgr"
+)
+
+// isCurrentDelta is the delta duration we'll use from the present time to
+// determine if a backend is considered "current", i.e. synced to the tip of
+// the chain.
+const isCurrentDelta = 2 * time.Hour
+
+// BackEnds returns a list of the available back ends.
+// TODO: Refactor each into a driver and use dynamic registration.
+func BackEnds() []string {
+	return []string{
+		"bitcoind",
+		"btcd",
+		"neutrino",
+	}
+}
+
+// Interface allows more than one backing blockchain source, such as a
+// btcd RPC chain server, or an SPV library, as long as we write a driver for
+// it.
+type Interface interface {
+	Start() error
+	Stop()
+	WaitForShutdown()
+	GetBestBlock() (*chainhash.Hash, int32, error)
+	GetBlock(*chainhash.Hash) (*wire.MsgBlock, error)
+	GetBlockHash(int64) (*chainhash.Hash, error)
+	GetBlockHeader(*chainhash.Hash) (*wire.BlockHeader, error)
+	IsCurrent() bool
+	FilterBlocks(*FilterBlocksRequest) (*FilterBlocksResponse, error)
+	BlockStamp() (*waddrmgr.BlockStamp, error)
+	SendRawTransaction(*wire.MsgTx, bool) (*chainhash.Hash, error)
+	Rescan(*chainhash.Hash, []btcutil.Address, map[wire.OutPoint]btcutil.Address) error
+	NotifyReceived([]btcutil.Address) error
+	NotifyBlocks() error
+	Notifications() <-chan interface{}
+	BackEnd() string
+}
+
+// Notification types.  These are defined here and processed from from reading
+// a notificationChan to avoid handling these notifications directly in
+// rpcclient callbacks, which isn't very Go-like and doesn't allow
+// blocking client calls.
+type (
+	// ClientConnected is a notification for when a client connection is
+	// opened or reestablished to the chain server.
+	ClientConnected struct{}
+
+	// BlockConnected is a notification for a newly-attached block to the
+	// best chain.
+	BlockConnected wtxmgr.BlockMeta
+
+	// FilteredBlockConnected is an alternate notification that contains
+	// both block and relevant transaction information in one struct, which
+	// allows atomic updates.
+	FilteredBlockConnected struct {
+		Block       *wtxmgr.BlockMeta
+		RelevantTxs []*wtxmgr.TxRecord
+	}
+
+	// FilterBlocksRequest specifies a range of blocks and the set of
+	// internal and external addresses of interest, indexed by corresponding
+	// scoped-index of the child address. A global set of watched outpoints
+	// is also included to monitor for spends.
+	FilterBlocksRequest struct {
+		Blocks           []wtxmgr.BlockMeta
+		ExternalAddrs    map[waddrmgr.ScopedIndex]btcutil.Address
+		InternalAddrs    map[waddrmgr.ScopedIndex]btcutil.Address
+		WatchedOutPoints map[wire.OutPoint]btcutil.Address
+	}
+
+	// FilterBlocksResponse reports the set of all internal and external
+	// addresses found in response to a FilterBlockRequest, any outpoints
+	// found that correspond to those addresses, as well as the relevant
+	// transactions that can modify the wallet's balance. The index of the
+	// block within the FilterBlocksRequest is returned, such that the
+	// caller can reinitiate a request for the subsequent block after
+	// updating the addresses of interest.
+	FilterBlocksResponse struct {
+		BatchIndex         uint32
+		BlockMeta          wtxmgr.BlockMeta
+		FoundExternalAddrs map[waddrmgr.KeyScope]map[uint32]struct{}
+		FoundInternalAddrs map[waddrmgr.KeyScope]map[uint32]struct{}
+		FoundOutPoints     map[wire.OutPoint]btcutil.Address
+		RelevantTxns       []*wire.MsgTx
+	}
+
+	// BlockDisconnected is a notifcation that the block described by the
+	// BlockStamp was reorganized out of the best chain.
+	BlockDisconnected wtxmgr.BlockMeta
+
+	// RelevantTx is a notification for a transaction which spends wallet
+	// inputs or pays to a watched address.
+	RelevantTx struct {
+		TxRecord *wtxmgr.TxRecord
+		Block    *wtxmgr.BlockMeta // nil if unmined
+	}
+
+	// RescanProgress is a notification describing the current status
+	// of an in-progress rescan.
+	RescanProgress struct {
+		Hash   *chainhash.Hash
+		Height int32
+		Time   time.Time
+	}
+
+	// RescanFinished is a notification that a previous rescan request
+	// has finished.
+	RescanFinished struct {
+		Hash   *chainhash.Hash
+		Height int32
+		Time   time.Time
+	}
+)