decred.org/dcrdex@v1.0.5/client/asset/btc/wallettypes.go

// This code is available on the terms of the project LICENSE.md file,
// also available online at https://blueoakcouncil.org/license/1.0.0.

package btc

import (
	"decred.org/dcrdex/dex"
)

// GetBalancesResult models a successful response from the getbalances request.
type GetBalancesResult struct {
	Mine      Balances `json:"mine"`
	WatchOnly Balances `json:"watchonly"`
}

// Balances is a categorical balance breakdown.
type Balances struct {
	Trusted   float64  `json:"trusted"`
	Untrusted float64  `json:"untrusted_pending"`
	Immature  float64  `json:"immature"`
	Used      *float64 `json:"used,omitempty"`
}

// ListUnspentResult models a successful response from the listunspent request.
type ListUnspentResult struct {
	TxID          string    `json:"txid"`
	Vout          uint32    `json:"vout"`
	Address       string    `json:"address"`
	Label         string    `json:"label"`
	ScriptPubKey  dex.Bytes `json:"scriptPubKey"`
	Amount        float64   `json:"amount"`
	Confirmations uint32    `json:"confirmations"`
	RedeemScript  dex.Bytes `json:"redeemScript"`
	Spendable     bool      `json:"spendable"`
	Solvable      bool      `json:"solvable"`
	SafePtr       *bool     `json:"safe"`
}

func (l *ListUnspentResult) Safe() bool {
	return l.SafePtr == nil || *l.SafePtr
}

// ListTransactionsResult is similar to the btcjson.ListTransactionsResult, but
// most fields omitted.
type ListTransactionsResult struct {
	BlockHeight uint32   `json:"blockheight"`
	BlockTime   uint64   `json:"blocktime"`
	Fee         *float64 `json:"fee,omitempty"`
	// Send set to true means that the inputs of the transaction were
	// controlled by the wallet.
	Send bool   `json:"send"`
	TxID string `json:"txid"`
}

// SignTxResult models the data from the signrawtransaction command.
type SignTxResult struct {
	Hex      dex.Bytes      `json:"hex"`
	Complete bool           `json:"complete"`
	Errors   []*SignTxError `json:"errors"`
}

// SignTxError models the data that contains script verification errors from the
// signrawtransaction request
type SignTxError struct {
	TxID      string    `json:"txid"`
	Vout      uint32    `json:"vout"`
	ScriptSig dex.Bytes `json:"scriptSig"`
	Sequence  uint64    `json:"sequence"`
	Error     string    `json:"error"`
}

// GetTransactionResult models the required data from the gettransaction
// command. Several fields from the bitcoind/btcwallet response that are both
// unneeded and difficult to satisfy are omitted. e.g. the native btcwallet and
// the external Electrum backends must jump through hoops to reproduce certain
// fields that are not strictly necessary.
type GetTransactionResult struct {
	// The meaning of Amount and Fee for "wallet" transactions is iffy (and they
	// are unused), so we are going to ignore them.  We have the raw tx (Hex) if
	// it is necessary to compute amounts from the inputs and outputs.
	// Amount         float64   `json:"amount"`
	// Fee            float64   `json:"fee"`
	Confirmations uint64 `json:"confirmations"`
	BlockHash     string `json:"blockhash"`
	BlockIndex    int64  `json:"blockindex"` // unused, consider commenting
	BlockTime     uint64 `json:"blocktime"`
	// BlockHeight   uint64    `json:"blockheight"` // unused, potentially work to obtain
	TxID         string    `json:"txid"`
	Time         uint64    `json:"time"`
	TimeReceived uint64    `json:"timereceived"`
	Bytes        dex.Bytes `json:"hex"` // []byte, although it marshals/unmarshals a hex string
	// BipReplaceable string    `json:"bip125-replaceable"` // unused
	// Details        []*WalletTxDetails `json:"details"` // unused, and nearly impossible to satisfy in a generic interface
}

// RPCOutpoint is used to specify outputs to lock in calls to lockunspent.
type RPCOutpoint struct {
	TxID string `json:"txid"`
	Vout uint32 `json:"vout"`
}

// GetWalletInfoResult models the data from the getwalletinfo command.
type GetWalletInfoResult struct {
	WalletName            string  `json:"walletname"`
	WalletVersion         uint32  `json:"walletversion"`
	Format                string  `json:"format"`
	Balance               float64 `json:"balance"`
	UnconfirmedBalance    float64 `json:"unconfirmed_balance"`
	ImmatureBalance       float64 `json:"immature_balance"`
	TxCount               uint32  `json:"txcount"`
	KeyPoolOldest         uint64  `json:"keypoololdest"`
	KeyPoolSize           uint32  `json:"keypoolsize"`
	KeyPoolSizeHDInternal uint32  `json:"keypoolsize_hd_internal"`
	PayTxFee              float64 `json:"paytxfee"`
	HdSeedID              string  `json:"hdseedid"`
	// UnlockedUntil is a pointer because for encrypted locked wallets, it will
	// be zero, but for unencrypted wallets the field won't be present in the
	// response.
	UnlockedUntil *int64 `json:"unlocked_until"`
	// HDMasterKeyID is dropped in Bitcoin Core 0.18
	HdMasterKeyID     string `json:"hdmasterkeyid"`
	PriveyKeysEnabled bool   `json:"private_keys_enabled"`
	// AvoidReuse and Scanning were added in Bitcoin Core 0.19
	AvoidReuse bool `json:"avoid_reuse"`
	// Scanning is either a struct or boolean false, and since we're not using
	// it, commenting avoids having to deal with marshaling for now.
	// Scanning   struct {
	// 	Duration uint32  `json:"duration"`
	// 	Progress float32 `json:"progress"`
	// } `json:"scanning"`
	Descriptors bool `json:"descriptors"` // Descriptor wallets that do not support dumpprivkey
}

// GetAddressInfoResult models some of the data from the getaddressinfo command.
type GetAddressInfoResult struct {
	IsMine     bool   `json:"ismine"`
	Descriptor string `json:"desc"` // e.g. "wpkh([b940190e/84'/1'/0'/0/0]0300034...)#0pfw7rck"

	// The following fields are unused by DEX, but modeled here for completeness
	// and debugging:

	ParentDesc          string `json:"parent_desc"`         // e.g. "wpkh([b940190e/84'/1'/0']tpubDCo.../0/*)#xn4kr3dw" meaning range of external addresses
	HDKeyPath           string `json:"hdkeypath"`           // e.g. "m/84'/1'/0'/0/0"
	HDMasterFingerprint string `json:"hdmasterfingerprint"` // e.g. "b940190e"
}

type listDescriptorsResult struct {
	WalletName  string `json:"wallet_name"`
	Descriptors []*struct {
		Descriptor string `json:"desc"` // public or private depending on private RPC arg

		// The following fields are unused in this package, but they are modeled
		// here for completeness and debugging:

		TimeStamp int64 `json:"timestamp"` // creation time
		// Active makes it the descriptor for the corresponding output
		// type/externality e.g. wpkh. Must be true for "ranged" descriptors,
		// which are those for address derivation. Conversely, imported single
		// private keys are not active.
		Active   bool    `json:"active"`
		Internal bool    `json:"internal"` // i.e. change, only set when active
		Range    []int64 `json:"range"`    // set for ranged descriptors, pertains to gap limit and current index
		Next     int64   `json:"next"`     // next index to addresses generation; only set for ranged descriptors
	} `json:"descriptors"`
}