feat: amount and address parsing errors (MetaMask#73)

Author: darioAnongba

src/types/address.rs

@@ -4,9 +4,13 @@ use bdk_wallet::{
     bitcoin::{Address as BdkAddress, AddressType as BdkAddressType, Network as BdkNetwork, ScriptBuf as BdkScriptBuf},
     AddressInfo as BdkAddressInfo,
 };
+use bitcoin::address::ParseError;
 use wasm_bindgen::prelude::wasm_bindgen;
 
-use crate::result::JsResult;
+use crate::{
+    result::JsResult,
+    types::{BdkError, BdkErrorCode},
+};
 
 use super::{KeychainKind, Network};
 
@@ -75,7 +79,7 @@ impl Deref for Address {
 
 #[wasm_bindgen]
 impl Address {
-    pub fn from_string(address_str: &str, network: Network) -> JsResult<Self> {
+    pub fn from_string(address_str: &str, network: Network) -> Result<Self, BdkError> {
         let address = BdkAddress::from_str(address_str)?.require_network(network.into())?;
         Ok(Address(address))
     }
@@ -106,6 +110,24 @@ impl From<Address> for BdkAddress {
     }
 }
 
+impl From<ParseError> for BdkError {
+    fn from(e: ParseError) -> Self {
+        use ParseError::*;
+        match &e {
+            Base58(_) => BdkError::new(BdkErrorCode::Base58, e.to_string(), ()),
+            Bech32(_) => BdkError::new(BdkErrorCode::Bech32, e.to_string(), ()),
+            WitnessVersion(_) => BdkError::new(BdkErrorCode::WitnessVersion, e.to_string(), ()),
+            WitnessProgram(_) => BdkError::new(BdkErrorCode::WitnessProgram, e.to_string(), ()),
+            UnknownHrp(_) => BdkError::new(BdkErrorCode::UnknownHrp, e.to_string(), ()),
+            LegacyAddressTooLong(_) => BdkError::new(BdkErrorCode::LegacyAddressTooLong, e.to_string(), ()),
+            InvalidBase58PayloadLength(_) => BdkError::new(BdkErrorCode::InvalidBase58PayloadLength, e.to_string(), ()),
+            InvalidLegacyPrefix(_) => BdkError::new(BdkErrorCode::InvalidLegacyPrefix, e.to_string(), ()),
+            NetworkValidation(_) => BdkError::new(BdkErrorCode::NetworkValidation, e.to_string(), ()),
+            _ => BdkError::new(BdkErrorCode::Unexpected, e.to_string(), ()),
+        }
+    }
+}
+
 /// An owned, growable script.
 ///
 /// `ScriptBuf` is the most common script type that has the ownership over the contents of the

src/types/amount.rs

@@ -1,10 +1,11 @@
 use std::ops::Deref;
 
 use bdk_wallet::bitcoin::{Amount as BdkAmount, Denomination as BdkDenomination};
+use bitcoin::amount::ParseAmountError;
 use serde::Serialize;
 use wasm_bindgen::prelude::wasm_bindgen;
 
-use crate::result::JsResult;
+use crate::types::{BdkError, BdkErrorCode};
 
 /// Amount
 ///
@@ -16,7 +17,7 @@ pub struct Amount(BdkAmount);
 
 #[wasm_bindgen]
 impl Amount {
-    pub fn from_btc(btc: f64) -> JsResult<Self> {
+    pub fn from_btc(btc: f64) -> Result<Self, BdkError> {
         let amount = BdkAmount::from_btc(btc)?;
         Ok(Amount(amount))
     }
@@ -65,6 +66,20 @@ impl From<Amount> for BdkAmount {
     }
 }
 
+impl From<ParseAmountError> for BdkError {
+    fn from(e: ParseAmountError) -> Self {
+        use ParseAmountError::*;
+        match &e {
+            OutOfRange(_) => BdkError::new(BdkErrorCode::OutOfRange, e.to_string(), ()),
+            TooPrecise(_) => BdkError::new(BdkErrorCode::TooPrecise, e.to_string(), ()),
+            MissingDigits(_) => BdkError::new(BdkErrorCode::MissingDigits, e.to_string(), ()),
+            InputTooLarge(_) => BdkError::new(BdkErrorCode::InputTooLarge, e.to_string(), ()),
+            InvalidCharacter(_) => BdkError::new(BdkErrorCode::InvalidCharacter, e.to_string(), ()),
+            _ => BdkError::new(BdkErrorCode::Unexpected, e.to_string(), ()),
+        }
+    }
+}
+
 #[wasm_bindgen]
 pub struct SentAndReceived(pub Amount, pub Amount);
 

src/types/error.rs

@@ -43,6 +43,8 @@ impl BdkError {
 #[wasm_bindgen]
 #[derive(Clone, Copy)]
 pub enum BdkErrorCode {
+    /// ------- Transaction creation errors -------
+
     /// There was a problem with the descriptors passed in
     Descriptor,
     /// There was a problem while extracting and manipulating policies
@@ -83,4 +85,42 @@ pub enum BdkErrorCode {
     MissingNonWitnessUtxo,
     /// Miniscript PSBT error
     MiniscriptPsbt,
+
+    /// ------- Address errors -------
+
+    /// Base58 error.
+    Base58,
+    /// Bech32 segwit decoding error.
+    Bech32,
+    /// A witness version conversion/parsing error.
+    WitnessVersion,
+    /// A witness program error.
+    WitnessProgram,
+    /// Tried to parse an unknown HRP.
+    UnknownHrp,
+    /// Legacy address is too long.
+    LegacyAddressTooLong,
+    /// Invalid base58 payload data length for legacy address.
+    InvalidBase58PayloadLength,
+    /// Invalid legacy address prefix in base58 data payload.
+    InvalidLegacyPrefix,
+    /// Address's network differs from required one.
+    NetworkValidation,
+
+    /// ------- Amount errors -------
+
+    /// The amount is too big or too small.
+    OutOfRange,
+    /// Amount has higher precision than supported by the type.
+    TooPrecise,
+    /// A digit was expected but not found.
+    MissingDigits,
+    /// Input string was too large.
+    InputTooLarge,
+    /// Invalid character in input.
+    InvalidCharacter,
+
+    /// ------- Other errors -------
+    /// Unexpected error, should never happen
+    Unexpected,
 }

tests/node/integration/esplora.test.ts

@@ -8,8 +8,6 @@ import {
   UnconfirmedTx,
   Wallet,
   SignOptions,
-  BdkError,
-  BdkErrorCode,
 } from "../../../pkg/bitcoindevkit";
 
 // Tests are expected to run in order
@@ -61,7 +59,7 @@ describe("Esplora client", () => {
     feeRate = new FeeRate(BigInt(Math.floor(fee)));
   });
 
-  it.skip("sends a transaction", async () => {
+  it("sends a transaction", async () => {
     const sendAmount = Amount.from_sat(BigInt(1000));
     expect(wallet.balance.trusted_spendable.to_sat()).toBeGreaterThan(
       sendAmount.to_sat()
@@ -107,39 +105,4 @@ describe("Esplora client", () => {
         .finish();
     }).toThrow();
   });
-
-  it("catches fine-grained errors and deserializes its data", () => {
-    // Amount should be too big so we fail with InsufficientFunds
-    const sendAmount = Amount.from_sat(BigInt(2000000000));
-
-    try {
-      wallet
-        .build_tx()
-        .fee_rate(new FeeRate(BigInt(1)))
-        .add_recipient(new Recipient(recipientAddress, sendAmount))
-        .finish();
-    } catch (error) {
-      expect(error).toBeInstanceOf(BdkError);
-
-      const { code, message, data } = error;
-      expect(code).toBe(BdkErrorCode.InsufficientFunds);
-      expect(message.startsWith("Insufficient funds:")).toBe(true);
-      expect(data.needed).toBe(2000000000 + 110);
-      expect(data.available).toBeDefined();
-    }
-
-    try {
-      wallet
-        .build_tx()
-        .fee_rate(new FeeRate(BigInt(1)))
-        .finish();
-    } catch (error) {
-      expect(error).toBeInstanceOf(BdkError);
-
-      const { code, message, data } = error;
-      expect(code).toBe(BdkErrorCode.NoRecipients);
-      expect(message).toBe("Cannot build tx without recipients");
-      expect(data).toBeUndefined();
-    }
-  });
 });

tests/node/integration/wallet.test.ts

@@ -1,4 +1,12 @@
-import { Wallet } from "../../../pkg/bitcoindevkit";
+import {
+  Address,
+  Amount,
+  BdkError,
+  BdkErrorCode,
+  FeeRate,
+  Recipient,
+  Wallet,
+} from "../../../pkg/bitcoindevkit";
 import type { Network } from "../../../pkg/bitcoindevkit";
 
 describe("Wallet", () => {
@@ -8,6 +16,10 @@ describe("Wallet", () => {
   const internalDesc =
     "wpkh(tprv8ZgxMBicQKsPf6vydw7ixvsLKY79hmeXujBkGCNCApyft92yVYng2y28JpFZcneBYTTHycWSRpokhHE25GfHPBxnW5GpSm2dMWzEi9xxEyU/84'/1'/0'/1/*)#dd6w3a4e";
   let wallet: Wallet;
+  const recipientAddress = Address.from_string(
+    "tb1qd28npep0s8frcm3y7dxqajkcy2m40eysplyr9v",
+    network
+  );
 
   it("creates a new wallet from descriptors", () => {
     wallet = Wallet.create(network, externalDesc, internalDesc);
@@ -42,4 +54,65 @@ describe("Wallet", () => {
       loadedWallet.next_unused_address("external").address.toString()
     ).toBe("tb1qjtgffm20l9vu6a7gacxvpu2ej4kdcsgc26xfdz");
   });
+
+  it("catches fine-grained errors and deserializes its data", () => {
+    // Amount should be too big so we fail with InsufficientFunds
+    const sendAmount = Amount.from_sat(BigInt(2000000000));
+
+    try {
+      wallet
+        .build_tx()
+        .fee_rate(new FeeRate(BigInt(1)))
+        .add_recipient(new Recipient(recipientAddress, sendAmount))
+        .finish();
+    } catch (error) {
+      expect(error).toBeInstanceOf(BdkError);
+
+      const { code, message, data } = error;
+      expect(code).toBe(BdkErrorCode.InsufficientFunds);
+      expect(message.startsWith("Insufficient funds:")).toBe(true);
+      expect(data.needed).toBe(2000000000 + 42);
+      expect(data.available).toBeDefined();
+    }
+  });
+
+  it("catches fine-grained address errors", () => {
+    try {
+      Address.from_string(
+        "tb1qd28npep0s8frcm3y7dxqajkcy2m40eysplyr9v",
+        "bitcoin"
+      );
+    } catch (error) {
+      expect(error).toBeInstanceOf(BdkError);
+
+      const { code, message, data } = error;
+      expect(code).toBe(BdkErrorCode.NetworkValidation);
+      expect(message.startsWith("validation error")).toBe(true);
+      expect(data).toBeUndefined();
+    }
+
+    try {
+      Address.from_string("notAnAddress", network);
+    } catch (error) {
+      expect(error).toBeInstanceOf(BdkError);
+
+      const { code, message, data } = error;
+      expect(code).toBe(BdkErrorCode.Base58);
+      expect(message.startsWith("base58 error")).toBe(true);
+      expect(data).toBeUndefined();
+    }
+  });
+
+  it("catches fine-grained amount errors", () => {
+    try {
+      Amount.from_btc(-100000000);
+    } catch (error) {
+      expect(error).toBeInstanceOf(BdkError);
+
+      const { code, message, data } = error;
+      expect(code).toBe(BdkErrorCode.OutOfRange);
+      expect(message.startsWith("amount out of range")).toBe(true);
+      expect(data).toBeUndefined();
+    }
+  });
 });