Add NetworkMismatch error type
#485
Conversation
src/builder.rs
Outdated
| @@ -189,6 +191,7 @@ impl fmt::Display for BuildError { | |||
| Self::WalletSetupFailed => write!(f, "Failed to setup onchain wallet."), | |||
| Self::LoggerSetupFailed => write!(f, "Failed to setup the logger."), | |||
| Self::InvalidNodeAlias => write!(f, "Given node alias is invalid."), | |||
| Self::NetworkMismatch => write!(f, "Given network does match."), | |||
There was a problem hiding this comment.
nit: Could you specify what it doesn't match?
src/builder.rs
Outdated
| BuildError::WalletSetupFailed | ||
| .map_err(|e| match e { | ||
| bdk_wallet::LoadWithPersistError::InvalidChangeSet( | ||
| bdk_wallet::LoadError::Mismatch(bdk_wallet::LoadMismatch::Network { .. }), |
There was a problem hiding this comment.
Seems we might also want to match on the Genesis variant?
There was a problem hiding this comment.
hmmm, since the genesis hash is not a configuration that can be directly set by the user I think the check on the network mismatch will already catch it? Because to do the check on the genesis hash we would first need to get it with something like: bitcoin::blockdata::constants::genesis_block(config.network).block_hash(); which depends on the network provided by the user. So it doesn't seem possible to pass the network check but fail the Genesis one. That's how I saw it but lmk if this is wrong and I'll change it.
There was a problem hiding this comment.
I mean, technically yes, but are we sure BDK won't ever emit a Genesis variant if we set the wrong Network?
There was a problem hiding this comment.
if we set the wrong network, yes I guess any of these two errors (Network or Genesis mismatch) could be thrown.
There was a problem hiding this comment.
Right, that's why I'd prefer to match on both and return the mismatch error if either variant is returned.
elnosh
force-pushed
the
check-network-switch
branch
from
8991768 to
206a092
Compare
src/builder.rs
Outdated
| @@ -189,6 +191,7 @@ impl fmt::Display for BuildError { | |||
| Self::WalletSetupFailed => write!(f, "Failed to setup onchain wallet."), | |||
| Self::LoggerSetupFailed => write!(f, "Failed to setup the logger."), | |||
| Self::InvalidNodeAlias => write!(f, "Given node alias is invalid."), | |||
| Self::NetworkMismatch => write!(f, "Given network does not match the node's network."), | |||
There was a problem hiding this comment.
nit : Given network does not match the node's previously configured network.
elnosh
force-pushed
the
check-network-switch
branch
from
206a092 to
b1b2caf
Compare
src/builder.rs
Outdated
| @@ -903,10 +908,19 @@ fn build_with_store_internal( | |||
| .descriptor(KeychainKind::Internal, Some(change_descriptor.clone())) | |||
| .extract_keys() | |||
| .check_network(config.network) | |||
| .check_genesis_hash(constants::genesis_block(config.network).block_hash()) | |||
There was a problem hiding this comment.
Hmm, I'd rather not include this line. My main point below was that BDK's docs aren't super clear on when which variant would be emitted, so we might as well match on the Genesis variant just to be sure. But we probably don't want do both check_network and check_genesis.
There was a problem hiding this comment.
oh ok. Yeah I'm not sure either, maybe I should ask them, but from looking at their docs I thought the Genesis error would only be thrown if you pre-call that check_genesis_hash method. I thought that because for each of the 3 LoadMismatch variants there is a respective check_[variant] method.
There was a problem hiding this comment.
Right. I don’t think it matters too much, so we shouldn’t block this PR on it. Should be fine whether we match on Genesis or not.
There was a problem hiding this comment.
I checked with them. The errors will not be returned unless the check_* methods are called so I removed the Genesis one.
src/builder.rs
Outdated
| .map_err(|e| match e { | ||
| bdk_wallet::LoadWithPersistError::InvalidChangeSet( | ||
| bdk_wallet::LoadError::Mismatch(bdk_wallet::LoadMismatch::Network { .. }), | ||
| ) => BuildError::NetworkMismatch, |
There was a problem hiding this comment.
Can we still log that we failed to setup the wallet due to mismatching network here?
elnosh
force-pushed
the
check-network-switch
branch
from
b1b2caf to
ebc5548
Compare
Return specific error if the node is restarted with a different network from the one it was first created with. This will be caught when trying to load the `BDK` wallet.
elnosh
force-pushed
the
check-network-switch
branch
from
ebc5548 to
ca49cb7
Compare
for #117
Added a
NetworkMismatcherror type if the node is restarted with a different network. This is caught when trying to load bdk wallet.