Skip to content

More strict version checks #504

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jholdstock wants to merge 5 commits into
base: master
Choose a base branch
from
Open

More strict version checks #504

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3547855
rpc: Extract wallet RPC calls to funcs.
jholdstock Dec 18, 2025
ddfe0ea
rpc: Extract dcrd RPC calls to funcs.
jholdstock Dec 17, 2025
f8d2c1b
rpc: Rename semver.go to version.go.
jholdstock Dec 18, 2025
44d4f60
rpc: Check dcrd and dcrwallet binary version.
jholdstock Dec 18, 2025
5b21dd4
docs: Explicitly prohibit running SPV wallets.
jholdstock Dec 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 33 additions & 20 deletions rpc/dcrwallet.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,57 +56,46 @@ func (w *WalletConnect) Close() {
// increments a count of failed connections if a connection cannot be
// established, or if the wallet is misconfigured.
func (w *WalletConnect) Clients() ([]*WalletRPC, []string) {
ctx := context.TODO()
walletClients := make([]*WalletRPC, 0)
failedConnections := make([]string, 0)

for _, connect := range w.clients {

c, newConnection, err := connect.dial(ctx)
c, newConnection, err := connect.dial(context.TODO())
if err != nil {
w.log.Errorf("dcrwallet dial error: %v", err)
failedConnections = append(failedConnections, connect.addr)
continue
}

walletRPC := &WalletRPC{c}

// If this is a reused connection, we don't need to validate the
// dcrwallet config again.
if !newConnection {
walletClients = append(walletClients, &WalletRPC{c})
walletClients = append(walletClients, walletRPC)
continue
}

// Verify dcrwallet is at the required api version.
var verMap map[string]dcrdtypes.VersionResult
err = c.Call(ctx, "version", &verMap)
ver, err := walletRPC.version()
if err != nil {
w.log.Errorf("dcrwallet.Version error (wallet=%s): %v", c.String(), err)
failedConnections = append(failedConnections, connect.addr)
connect.Close()
continue
}

ver, exists := verMap["dcrwalletjsonrpcapi"]
if !exists {
w.log.Errorf("dcrwallet.Version response missing 'dcrwalletjsonrpcapi' (wallet=%s)",
c.String())
failedConnections = append(failedConnections, connect.addr)
connect.Close()
continue
}

sVer := semver{ver.Major, ver.Minor, ver.Patch}
if !semverCompatible(requiredWalletVersion, sVer) {
if !semverCompatible(requiredWalletVersion, *ver) {
w.log.Errorf("dcrwallet has incompatible JSON-RPC version (wallet=%s): got %s, expected %s",
c.String(), sVer, requiredWalletVersion)
c.String(), ver, requiredWalletVersion)
failedConnections = append(failedConnections, connect.addr)
connect.Close()
continue
}

// Verify dcrwallet is on the correct network.
var netID wire.CurrencyNet
err = c.Call(ctx, "getcurrentnet", &netID)
netID, err := walletRPC.getCurrentNet()
if err != nil {
w.log.Errorf("dcrwallet.GetCurrentNet error (wallet=%s): %v", c.String(), err)
failedConnections = append(failedConnections, connect.addr)
Expand All @@ -122,7 +111,6 @@ func (w *WalletConnect) Clients() ([]*WalletRPC, []string) {
}

// Verify dcrwallet is voting and unlocked.
walletRPC := &WalletRPC{c}
walletInfo, err := walletRPC.WalletInfo()
if err != nil {
w.log.Errorf("dcrwallet.WalletInfo error (wallet=%s): %v", c.String(), err)
Expand Down Expand Up @@ -155,6 +143,31 @@ func (w *WalletConnect) Clients() ([]*WalletRPC, []string) {
return walletClients, failedConnections
}

// version uses version RPC to retrieve the API version of dcrwallet.
func (c *WalletRPC) version() (*semver, error) {
var verMap map[string]dcrdtypes.VersionResult
err := c.Call(context.TODO(), "version", &verMap)
Copy link
Copy Markdown
Member

@jrick jrick Dec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

instead of introducing even more TODO, why not write this with context support and pass in TODO from the caller, if that is still needed?

Copy link
Copy Markdown
Member Author

@jholdstock jholdstock Dec 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I might just be naive here, but I believe the reality of the situation is that context just isn't needed in these RPC clients.

None of the calls are particularly long running, and in every case I think adding early interruption adds more complexity than its worth. The code is kept cleaner and data integrity is protected if we allow vspd to finish what it is doing before shutting down.

The one thing I might consider is adding a timeout to the context, but the underlying context would still be TODO or Background anyway.

if err != nil {
return nil, err
}

if ver, ok := verMap["dcrwalletjsonrpcapi"]; ok {
return &semver{ver.Major, ver.Minor, ver.Patch}, nil
}

return nil, fmt.Errorf("response missing %q", "dcrwalletjsonrpcapi")
}

// getCurrentNet returns the Decred network the wallet is connected to.
func (c *WalletRPC) getCurrentNet() (wire.CurrencyNet, error) {
var netID wire.CurrencyNet
err := c.Call(context.TODO(), "getcurrentnet", &netID)
if err != nil {
return 0, err
}
return netID, nil
}

// WalletInfo uses walletinfo RPC to retrieve information about how the
// dcrwallet instance is configured.
func (c *WalletRPC) WalletInfo() (*wallettypes.WalletInfoResult, error) {
Expand Down