Skip to content

Commit

Permalink
dcr: Allow ticket purchasing for rpc spv wallets (#2756)
Browse files Browse the repository at this point in the history
* dcr: Allow ticket purchasing for rpc spv wallets

* deps: Update wallet to v4.1.1
  • Loading branch information
JoeGruffins committed Jun 19, 2024
1 parent 939685b commit 961548f
Show file tree
Hide file tree
Showing 21 changed files with 510 additions and 402 deletions.
2 changes: 1 addition & 1 deletion client/asset/dcr/coin_selection_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import (
"time"

dexdcr "decred.org/dcrdex/dex/networks/dcr"
walletjson "decred.org/dcrwallet/v3/rpc/jsonrpc/types"
walletjson "decred.org/dcrwallet/v4/rpc/jsonrpc/types"
)

func Test_leastOverFund(t *testing.T) {
Expand Down
38 changes: 33 additions & 5 deletions client/asset/dcr/dcr.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ import (
"decred.org/dcrdex/dex/config"
"decred.org/dcrdex/dex/dexnet"
dexdcr "decred.org/dcrdex/dex/networks/dcr"
walletjson "decred.org/dcrwallet/v3/rpc/jsonrpc/types"
"decred.org/dcrwallet/v3/wallet"
_ "decred.org/dcrwallet/v3/wallet/drivers/bdb"
walletjson "decred.org/dcrwallet/v4/rpc/jsonrpc/types"
"decred.org/dcrwallet/v4/wallet"
_ "decred.org/dcrwallet/v4/wallet/drivers/bdb"
"github.com/decred/dcrd/blockchain/stake/v5"
blockchain "github.com/decred/dcrd/blockchain/standalone/v2"
"github.com/decred/dcrd/chaincfg/chainhash"
Expand All @@ -50,7 +50,7 @@ import (
"github.com/decred/dcrd/txscript/v4/stdaddr"
"github.com/decred/dcrd/txscript/v4/stdscript"
"github.com/decred/dcrd/wire"
vspdjson "github.com/decred/vspd/types"
vspdjson "github.com/decred/vspd/types/v2"
)

const (
Expand Down Expand Up @@ -5366,9 +5366,13 @@ func (dcr *ExchangeWallet) StakeStatus() (*asset.TicketStakingStatus, error) {
if !dcr.connected.Load() {
return nil, errors.New("not connected, login first")
}
// Try to get tickets first, because this will error for RPC + SPV wallets.
// Try to get tickets first, because this will error for older RPC + SPV
// wallets.
tickets, err := dcr.tickets(dcr.ctx)
if err != nil {
if errors.Is(err, oldSPVWalletErr) {
return nil, nil
}
return nil, fmt.Errorf("error retrieving tickets: %w", err)
}
sinfo, err := dcr.wallet.StakeInfo(dcr.ctx)
Expand All @@ -5382,6 +5386,16 @@ func (dcr *ExchangeWallet) StakeStatus() (*asset.TicketStakingStatus, error) {
if v := dcr.vspV.Load(); v != nil {
vspURL = v.(*vsp).URL
}
} else {
rpcW, ok := dcr.wallet.(*rpcWallet)
if !ok {
return nil, errors.New("wallet not an *rpcWallet")
}
walletInfo, err := rpcW.walletInfo(dcr.ctx)
if err != nil {
return nil, fmt.Errorf("error retrieving wallet info: %w", err)
}
vspURL = walletInfo.VSP
}
voteChoices, tSpends, treasuryPolicy, err := dcr.wallet.VotingPreferences(dcr.ctx)
if err != nil {
Expand Down Expand Up @@ -5518,6 +5532,20 @@ func (dcr *ExchangeWallet) PurchaseTickets(n int, feeSuggestion uint64) error {
if err != nil {
return fmt.Errorf("error getting balance: %v", err)
}
isRPC := !dcr.isNative()
if isRPC {
rpcW, ok := dcr.wallet.(*rpcWallet)
if !ok {
return errors.New("wallet not an *rpcWallet")
}
walletInfo, err := rpcW.walletInfo(dcr.ctx)
if err != nil {
return fmt.Errorf("error retrieving wallet info: %w", err)
}
if walletInfo.SPV && walletInfo.VSP == "" {
return errors.New("a vsp must best set to purchase tickets with an spv wallet")
}
}
sinfo, err := dcr.wallet.StakeInfo(dcr.ctx)
if err != nil {
return fmt.Errorf("stakeinfo error: %v", err)
Expand Down
7 changes: 5 additions & 2 deletions client/asset/dcr/dcr_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ import (
"decred.org/dcrdex/dex/config"
"decred.org/dcrdex/dex/encode"
dexdcr "decred.org/dcrdex/dex/networks/dcr"
"decred.org/dcrwallet/v3/rpc/client/dcrwallet"
walletjson "decred.org/dcrwallet/v3/rpc/jsonrpc/types"
"decred.org/dcrwallet/v4/rpc/client/dcrwallet"
walletjson "decred.org/dcrwallet/v4/rpc/jsonrpc/types"
"github.com/decred/dcrd/chaincfg/chainhash"
"github.com/decred/dcrd/chaincfg/v3"
"github.com/decred/dcrd/dcrec"
Expand Down Expand Up @@ -715,6 +715,9 @@ func (c *tRPCClient) RawRequest(_ context.Context, method string, params []json.
Complete: complete,
}
return json.Marshal(&res)

case methodWalletInfo:
return json.Marshal(new(walletjson.WalletInfoResult))
}

return nil, fmt.Errorf("method %v not implemented by (*tRPCClient).RawRequest", method)
Expand Down
8 changes: 4 additions & 4 deletions client/asset/dcr/native_wallet.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ import (

"decred.org/dcrdex/client/asset"
"decred.org/dcrdex/dex"
walletjson "decred.org/dcrwallet/v3/rpc/jsonrpc/types"
"decred.org/dcrwallet/v3/wallet"
"decred.org/dcrwallet/v4/p2p"
walletjson "decred.org/dcrwallet/v4/rpc/jsonrpc/types"
"github.com/decred/dcrd/chaincfg/chainhash"
"github.com/decred/dcrd/dcrutil/v4"
)
Expand All @@ -40,7 +40,7 @@ type mixingConfigFile struct {
type mixingConfig struct {
server string
cert []byte
dialer wallet.DialFunc
dialer p2p.DialFunc
enabled bool
}

Expand Down Expand Up @@ -155,7 +155,7 @@ func initNativeWallet(ew *ExchangeWallet) (*NativeWallet, error) {
return w, nil
}

func makeCSPPDialer(serverAddress string, certB []byte) (wallet.DialFunc, error) {
func makeCSPPDialer(serverAddress string, certB []byte) (p2p.DialFunc, error) {
serverName, _, err := net.SplitHostPort(serverAddress)
if err != nil {
return nil, fmt.Errorf("cannot parse CoinShuffle++ server name %q: %v", serverAddress, err)
Expand Down
65 changes: 48 additions & 17 deletions client/asset/dcr/rpcwallet.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ import (

"decred.org/dcrdex/client/asset"
"decred.org/dcrdex/dex"
"decred.org/dcrwallet/v3/rpc/client/dcrwallet"
walletjson "decred.org/dcrwallet/v3/rpc/jsonrpc/types"
"decred.org/dcrwallet/v3/wallet"
"decred.org/dcrwallet/v4/rpc/client/dcrwallet"
walletjson "decred.org/dcrwallet/v4/rpc/jsonrpc/types"
"decred.org/dcrwallet/v4/wallet"
"github.com/decred/dcrd/chaincfg/chainhash"
"github.com/decred/dcrd/chaincfg/v3"
"github.com/decred/dcrd/dcrec/secp256k1/v4"
Expand All @@ -43,6 +43,10 @@ var (
{Major: 8, Minor: 0, Patch: 0}, // 1.8-pre, just dropped unused ticket RPCs
{Major: 7, Minor: 0, Patch: 0}, // 1.7 release, new gettxout args
}
// From vspWithSPVWalletRPCVersion and later the wallet's current "vsp"
// is included in the walletinfo response and the wallet will no longer
// error on GetTickets with an spv wallet.
vspWithSPVWalletRPCVersion = dex.Semver{Major: 9, Minor: 2, Patch: 0}
)

// RawRequest RPC methods
Expand All @@ -53,6 +57,7 @@ const (
methodSignRawTransaction = "signrawtransaction"
methodSyncStatus = "syncstatus"
methodGetPeerInfo = "getpeerinfo"
methodWalletInfo = "walletinfo"
)

// rpcWallet implements Wallet functionality using an rpc client to communicate
Expand All @@ -63,6 +68,8 @@ type rpcWallet struct {
rpcCfg *rpcclient.ConnConfig
accountsV atomic.Value // XCWalletAccounts

hasSPVTicketFunctions bool

rpcMtx sync.RWMutex
spvMode bool
// rpcConnector is a rpcclient.Client, does not need to be
Expand Down Expand Up @@ -338,56 +345,60 @@ func (w *rpcWallet) handleRPCClientReconnection(ctx context.Context) {
w.log.Debugf("dcrwallet reconnected (%d)", connectCount-1)
w.rpcMtx.RLock()
defer w.rpcMtx.RUnlock()
spv, err := checkRPCConnection(ctx, w.rpcConnector, w.rpcClient, w.log)
spv, hasSPVTicketFunctions, err := checkRPCConnection(ctx, w.rpcConnector, w.rpcClient, w.log)
if err != nil {
w.log.Errorf("dcrwallet reconnect handler error: %v", err)
}
w.spvMode = spv
w.hasSPVTicketFunctions = hasSPVTicketFunctions
}

// checkRPCConnection verifies the dcrwallet connection with the walletinfo RPC
// and sets the spvMode flag accordingly. The spvMode flag is only set after a
// successful check. This method is not safe for concurrent access, and the
// rpcMtx must be at least read locked.
func checkRPCConnection(ctx context.Context, connector rpcConnector, client rpcClient, log dex.Logger) (bool, error) {
func checkRPCConnection(ctx context.Context, connector rpcConnector, client rpcClient, log dex.Logger) (bool, bool, error) {
// Check the required API versions.
versions, err := connector.Version(ctx)
if err != nil {
return false, fmt.Errorf("dcrwallet version fetch error: %w", err)
return false, false, fmt.Errorf("dcrwallet version fetch error: %w", err)
}

ver, exists := versions["dcrwalletjsonrpcapi"]
if !exists {
return false, fmt.Errorf("dcrwallet.Version response missing 'dcrwalletjsonrpcapi'")
return false, false, fmt.Errorf("dcrwallet.Version response missing 'dcrwalletjsonrpcapi'")
}
walletSemver := dex.NewSemver(ver.Major, ver.Minor, ver.Patch)
if !dex.SemverCompatibleAny(compatibleWalletRPCVersions, walletSemver) {
return false, fmt.Errorf("advertised dcrwallet JSON-RPC version %v incompatible with %v",
return false, false, fmt.Errorf("advertised dcrwallet JSON-RPC version %v incompatible with %v",
walletSemver, compatibleWalletRPCVersions)
}

hasSPVTicketFunctions := walletSemver.Major >= vspWithSPVWalletRPCVersion.Major &&
walletSemver.Minor >= vspWithSPVWalletRPCVersion.Minor

ver, exists = versions["dcrdjsonrpcapi"]
if exists {
nodeSemver := dex.NewSemver(ver.Major, ver.Minor, ver.Patch)
if !dex.SemverCompatibleAny(compatibleNodeRPCVersions, nodeSemver) {
return false, fmt.Errorf("advertised dcrd JSON-RPC version %v incompatible with %v",
return false, false, fmt.Errorf("advertised dcrd JSON-RPC version %v incompatible with %v",
nodeSemver, compatibleNodeRPCVersions)
}
log.Infof("Connected to dcrwallet (JSON-RPC API v%s) proxying dcrd (JSON-RPC API v%s)",
walletSemver, nodeSemver)
return false, nil
return false, false, nil
}

// SPV maybe?
walletInfo, err := client.WalletInfo(ctx)
if err != nil {
return false, fmt.Errorf("walletinfo rpc error: %w", translateRPCCancelErr(err))
return false, false, fmt.Errorf("walletinfo rpc error: %w", translateRPCCancelErr(err))
}
if !walletInfo.SPV {
return false, fmt.Errorf("dcrwallet.Version response missing 'dcrdjsonrpcapi' for non-spv wallet")
return false, false, fmt.Errorf("dcrwallet.Version response missing 'dcrdjsonrpcapi' for non-spv wallet")
}
log.Infof("Connected to dcrwallet (JSON-RPC API v%s) in SPV mode", walletSemver)
return true, nil
return true, hasSPVTicketFunctions, nil
}

// Connect establishes a connection to the previously created rpc client. The
Expand Down Expand Up @@ -433,7 +444,7 @@ func (w *rpcWallet) Connect(ctx context.Context) error {
// fails and we return with a non-nil error, we must shutdown the
// rpc client otherwise subsequent reconnect attempts will be met
// with "websocket client has already connected".
spv, err := checkRPCConnection(ctx, w.rpcConnector, w.rpcClient, w.log)
spv, hasSPVTicketFunctions, err := checkRPCConnection(ctx, w.rpcConnector, w.rpcClient, w.log)
if err != nil {
// The client should still be connected, but if not, do not try to
// shutdown and wait as it could hang.
Expand All @@ -446,6 +457,7 @@ func (w *rpcWallet) Connect(ctx context.Context) error {
}

w.spvMode = spv
w.hasSPVTicketFunctions = hasSPVTicketFunctions

return nil
}
Expand Down Expand Up @@ -1050,10 +1062,18 @@ func (w *rpcWallet) PurchaseTickets(ctx context.Context, n int, _, _ string, _ *
return tickets, nil
}

var oldSPVWalletErr = errors.New("wallet is an older spv wallet")

// Tickets returns active tickets.
func (w *rpcWallet) Tickets(ctx context.Context) ([]*asset.Ticket, error) {
const includeImmature = true
// GetTickets only works for clients with a dcrd backend.
return w.tickets(ctx, true)
}

func (w *rpcWallet) tickets(ctx context.Context, includeImmature bool) ([]*asset.Ticket, error) {
// GetTickets only works for spv clients after version 9.2.0
if w.spvMode && !w.hasSPVTicketFunctions {
return nil, oldSPVWalletErr
}
hashes, err := w.rpcClient.GetTickets(ctx, includeImmature)
if err != nil {
return nil, err
Expand Down Expand Up @@ -1110,7 +1130,6 @@ func (w *rpcWallet) Tickets(ctx context.Context) ([]*asset.Ticket, error) {
// Spender: ?,
})
}

return tickets, nil
}

Expand Down Expand Up @@ -1236,3 +1255,15 @@ func isAccountLockedErr(err error) bool {
return errors.As(err, &rpcErr) && rpcErr.Code == dcrjson.ErrRPCWalletUnlockNeeded &&
strings.Contains(rpcErr.Message, "account is already locked")
}

func (w *rpcWallet) walletInfo(ctx context.Context) (*walletjson.WalletInfoResult, error) {
var walletInfo walletjson.WalletInfoResult
err := w.rpcClientRawRequest(ctx, methodWalletInfo, nil, &walletInfo)
return &walletInfo, translateRPCCancelErr(err)
}

var _ ticketPager = (*rpcWallet)(nil)

func (w *rpcWallet) TicketPage(ctx context.Context, scanStart int32, n, skipN int) ([]*asset.Ticket, error) {
return make([]*asset.Ticket, 0), nil
}
Loading

0 comments on commit 961548f

Please sign in to comment.