npm: add btcXpubs()

Author: benma

CHANGELOG-npm.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 0.11.0
+- Add `btcXpubs()`
+
 ## 0.10.1
 - package.json: use "main" instead of "module" to fix compatiblity with vitest
 

NPM_VERSION

@@ -1 +1 @@
-0.10.1
+0.11.0

sandbox/src/Bitcoin.tsx

@@ -76,6 +76,73 @@ function BtcXPub({ bb02 } : Props) {
   );
 }
 
+
+function BtcXPubs({ bb02 } : Props) {
+  const [coin, setCoin] = useState<bitbox.BtcCoin>('btc');
+  const [keypaths, setKeypaths] = useState(`["m/49'/0'/0'", "m/84'/0'/0'", "m/86'/0'/0'"]`);
+  const [xpubType, setXpubType] = useState<bitbox.BtcXPubsType>('xpub');
+  const [result, setResult] = useState<bitbox.BtcXpubs | undefined>();
+  const [running, setRunning] = useState(false);
+  const [err, setErr] = useState<bitbox.Error>();
+
+  const btcXPubsTypeOptions = ['tpub', 'xpub'];
+
+  const submitForm = async (e: FormEvent) => {
+    e.preventDefault();
+    setRunning(true);
+    setResult(undefined);
+    setErr(undefined);
+    try {
+      setResult(await bb02.btcXpubs(coin, JSON.parse(keypaths), xpubType));
+    } catch (err) {
+      throw err;
+      setErr(bitbox.ensureError(err));
+    } finally {
+      setRunning(false);
+    }
+  }
+
+
+  return (
+    <div>
+      <h4>Multiple XPubs</h4>
+      <form className="verticalForm"onSubmit={submitForm}>
+        <label>
+          Coin
+          <select value={coin} onChange={e => setCoin(e.target.value as bitbox.BtcCoin)}>
+            {btcCoinOptions.map(option => <option key={option} value={option}>{option}</option>)}
+          </select>
+        </label>
+        <label>
+          Keypaths
+        </label>
+        <textarea value={keypaths} onChange={e => setKeypaths(e.target.value)} rows={5} cols={80} />
+        <label>
+          XPub Type
+          <select value={xpubType} onChange={e => setXpubType(e.target.value as bitbox.BtcXPubsType)}>
+            {btcXPubsTypeOptions.map(option => <option key={option} value={option}>{option}</option>)}
+          </select>
+        </label>
+
+        <button type='submit' disabled={running}>Get XPubs</button>
+          {result ? <>
+            <div className="resultContainer">
+              <label>Result</label>
+              {
+                result.map((xpub, i) => (
+                  <code key={i}>
+                    {i}: <b>{xpub}</b><br />
+                  </code>
+                ))
+              }
+            </div>
+          </> : null}
+        <ShowError err={err} />
+      </form>
+    </div>
+  );
+}
+
 function BtcAddressSimple({ bb02 }: Props) {
   const [coin, setCoin] = useState<bitbox.BtcCoin>('btc');
   const [simpleType, setSimpleType] = useState<bitbox.BtcSimpleType>('p2wpkhP2sh');
@@ -451,6 +518,9 @@ export function Bitcoin({ bb02 } : Props) {
       <div className="action">
         <BtcXPub bb02={bb02} />
       </div>
+      <div className="action">
+        <BtcXPubs bb02={bb02} />
+      </div>
       <div className="action">
         <BtcAddressSimple bb02={bb02} />
       </div>

src/wasm/mod.rs

@@ -257,6 +257,29 @@ impl PairedBitBox {
             .await?)
     }
 
+    /// Query the device for xpubs. The result contains one xpub per requested keypath.
+    #[wasm_bindgen(js_name = btcXpubs)]
+    pub async fn btc_xpubs(
+        &self,
+        coin: types::TsBtcCoin,
+        keypaths: Vec<types::TsKeypath>,
+        xpub_type: types::TsBtcXPubsType,
+    ) -> Result<types::TsBtcXpubs, JavascriptError> {
+        let xpubs = self
+            .device
+            .btc_xpubs(
+                coin.try_into()?,
+                keypaths
+                    .into_iter()
+                    .map(|kp| kp.try_into())
+                    .collect::<Result<Vec<crate::Keypath>, _>>()?
+                    .as_slice(),
+                xpub_type.try_into()?,
+            )
+            .await?;
+        Ok(serde_wasm_bindgen::to_value(&xpubs).unwrap().into())
+    }
+
     /// Before a multisig or policy script config can be used to display receive addresses or sign
     /// transactions, it must be registered on the device. This function checks if the script config
     /// was already registered.

src/wasm/types.rs

@@ -15,6 +15,7 @@ type Product = 'unknown' | 'bitbox02-multi' | 'bitbox02-btconly' | 'bitbox02-nov
 type BtcCoin = 'btc' | 'tbtc' | 'ltc' | 'tltc' | 'rbtc';
 type BtcFormatUnit = 'default' | 'sat';
 type XPubType = 'tpub' | 'xpub' | 'ypub' | 'zpub' | 'vpub' | 'upub' | 'Vpub' | 'Zpub' | 'Upub' | 'Ypub';
+type BtcXPubsType = 'tpub' | 'xpub';
 type Keypath = string | number[];
 type XPub = string;
 type DeviceInfo = {
@@ -50,6 +51,7 @@ type BtcSignMessageSignature = {
   recid: bigint,
   electrumSig65: Uint8Array,
 };
+type BtcXpubs = string[];
 // nonce, gasPrice, gasLimit and value must be big-endian encoded, no trailing zeroes.
 type EthTransaction = {
   nonce: Uint8Array;
@@ -172,6 +174,8 @@ extern "C" {
     pub type TsBtcFormatUnit;
     #[wasm_bindgen(typescript_type = "XPubType")]
     pub type TsXPubType;
+    #[wasm_bindgen(typescript_type = "BtcXPubsType")]
+    pub type TsBtcXPubsType;
     #[wasm_bindgen(typescript_type = "Keypath")]
     pub type TsKeypath;
     #[wasm_bindgen(typescript_type = "DeviceInfo")]
@@ -190,6 +194,8 @@ extern "C" {
     pub type TsBtcScriptConfigWithKeypath;
     #[wasm_bindgen(typescript_type = "BtcSignMessageSignature")]
     pub type TsBtcSignMessageSignature;
+    #[wasm_bindgen(typescript_type = "BtcXpubs")]
+    pub type TsBtcXpubs;
     #[wasm_bindgen(typescript_type = "EthTransaction")]
     pub type TsEthTransaction;
     #[wasm_bindgen(typescript_type = "Eth1559Transaction")]
@@ -238,6 +244,14 @@ impl TryFrom<TsXPubType> for crate::pb::btc_pub_request::XPubType {
     }
 }
 
+impl TryFrom<TsBtcXPubsType> for crate::pb::btc_xpubs_request::XPubType {
+    type Error = JavascriptError;
+    fn try_from(value: TsBtcXPubsType) -> Result<Self, Self::Error> {
+        serde_wasm_bindgen::from_value(value.into())
+            .map_err(|_| JavascriptError::InvalidType("wrong type for BTCXPubsType"))
+    }
+}
+
 impl TryFrom<TsKeypath> for crate::Keypath {
     type Error = JavascriptError;
     fn try_from(value: TsKeypath) -> Result<Self, Self::Error> {