add BIP341 to the basic_bitcoin rust example (#1074)

Author: altkdf

rust/basic_bitcoin/Cargo.lock

@@ -4,27 +4,37 @@ all: deploy
 .PHONY: deploy
 .SILENT: deploy
 deploy:
+	dfx deploy chainkey_testing_canister
 	dfx deploy basic_bitcoin --argument '(variant { regtest })'
 
+.PHONY: mock
+.SILENT: mock
+mock: deploy
+	SCHNORR_MOCK_CANISTER_ID=$(shell dfx canister id chainkey_testing_canister); \
+	BASIC_BITCOIN_CANISTER_ID=$(shell dfx canister id basic_bitcoin); \
+	echo "Changing to using mock canister instead of management canister"; \
+	CMD="dfx canister call "$${BASIC_BITCOIN_CANISTER_ID}" for_test_only_change_management_canister_id '("\"$${SCHNORR_MOCK_CANISTER_ID}\"")'"; \
+	eval "$${CMD}"
+
 .PHONY: regtest_topup
 .SILENT: regtest_topup
 regtest_topup:
 	P2PKH_ADDR=$(shell dfx canister call basic_bitcoin get_p2pkh_address | tr -d '()') && \
-	P2TR_SCRIPT_SPEND_ADDR=$(shell dfx canister call basic_bitcoin get_p2tr_script_spend_address | tr -d '()') && \
-	P2TR_SCRIPT_KEY_SPEND_ADDR=$(shell dfx canister call basic_bitcoin get_p2tr_raw_key_spend_address | tr -d '()') && \
-	TOPUP_CMD_P2PKH="bitcoin-cli -rpcport=8333 sendtoaddress $${P2PKH_ADDR} 1" && \
-	TOPUP_CMD_P2TR_SCRIPT_SPEND="bitcoin-cli -rpcport=8333 sendtoaddress $${P2TR_SCRIPT_SPEND_ADDR} 1" && \
-	TOPUP_CMD_P2TR_RAW_KEY_SPEND="bitcoin-cli -rpcport=8333 sendtoaddress $${P2TR_SCRIPT_KEY_SPEND_ADDR} 1" && \
-	eval "$${TOPUP_CMD_P2PKH}" && \
-	eval "$${TOPUP_CMD_P2PKH}" && \
-	eval "$${TOPUP_CMD_P2PKH}" && \
-	eval "$${TOPUP_CMD_P2TR_SCRIPT_SPEND}" && \
-	eval "$${TOPUP_CMD_P2TR_SCRIPT_SPEND}" && \
-	eval "$${TOPUP_CMD_P2TR_SCRIPT_SPEND}" && \
-	eval "$${TOPUP_CMD_P2TR_RAW_KEY_SPEND}" && \
-	eval "$${TOPUP_CMD_P2TR_RAW_KEY_SPEND}" && \
-	eval "$${TOPUP_CMD_P2TR_RAW_KEY_SPEND}" && \
-	bitcoin-cli -rpcport=8333 -generate 6
+	P2TR_ADDR=$(shell dfx canister call basic_bitcoin get_p2tr_address | tr -d '()') && \
+	P2TR_KEY_ONLY_ADDR=$(shell dfx canister call basic_bitcoin get_p2tr_key_only_address | tr -d '()') && \
+	TOPUP_CMD_P2PKH_ADDR="bitcoin-cli -regtest -rpcport=8333 sendtoaddress $${P2PKH_ADDR} 1" && \
+	TOPUP_CMD_P2TR_ADDR="bitcoin-cli -regtest -rpcport=8333 sendtoaddress $${P2TR_ADDR} 1" && \
+	TOPUP_CMD_P2TR_KEY_ONLY_ADDR="bitcoin-cli -regtest -rpcport=8333 sendtoaddress $${P2TR_KEY_ONLY_ADDR} 1" && \
+	eval "$${TOPUP_CMD_P2PKH_ADDR}" && \
+	eval "$${TOPUP_CMD_P2PKH_ADDR}" && \
+	eval "$${TOPUP_CMD_P2PKH_ADDR}" && \
+	eval "$${TOPUP_CMD_P2TR_ADDR}" && \
+	eval "$${TOPUP_CMD_P2TR_ADDR}" && \
+	eval "$${TOPUP_CMD_P2TR_ADDR}" && \
+	eval "$${TOPUP_CMD_P2TR_KEY_ONLY_ADDR}" && \
+	eval "$${TOPUP_CMD_P2TR_KEY_ONLY_ADDR}" && \
+	eval "$${TOPUP_CMD_P2TR_KEY_ONLY_ADDR}" && \
+	bitcoin-cli -regtest -rpcport=8333 -generate 6
 
 .PHONY: clean
 .SILENT: clean

rust/basic_bitcoin/Makefile

@@ -18,7 +18,6 @@ For a deeper understanding of the ICP < > BTC integration, see the [Bitcoin inte
 
 * [x] Install the [IC
   SDK](https://internetcomputer.org/docs/current/developer-docs/getting-started/install).
-  For local testing, `dfx >= 0.22.0-beta.0` is required.
 * [x] On macOS, `llvm` with the `wasm32-unknown-unknown` target (which is not included in the XCode installation by default) is required.
 To install, run `brew install llvm`.
 
@@ -92,43 +91,30 @@ to check [this
 article](https://bitcoinmagazine.com/technical/bitcoin-address-types-compared-p2pkh-p2sh-p2wpkh-and-more)
 if you are interested in a high-level comparison of different address types.
 These addresses can be generated from an ECDSA public key or a Schnorr
-([BIP340](https://github.com/bitcoin/bips/blob/master/bip-0340.mediawiki))
-public key. The example code showcases how your canister can generate and spend
-from three types of addresses:
+([BIP340](https://github.com/bitcoin/bips/blob/master/bip-0340.mediawiki),
+[BIP341](https://github.com/bitcoin/bips/blob/master/bip-0341.mediawiki)) public
+key. The example code showcases how your canister can generate and spend from
+three types of addresses:
 1. A [P2PKH address](https://en.bitcoin.it/wiki/Transaction#Pay-to-PubkeyHash)
    using the
    [ecdsa_public_key](https://internetcomputer.org/docs/current/references/ic-interface-spec/#ic-method-ecdsa_public_key)
    API.
 2. A [P2TR
    address](https://github.com/bitcoin/bips/blob/master/bip-0341.mediawiki)
-   where the funds can be spent using the raw (untweaked) internal key
-   (so-called P2TR key path spend, but untweaked). The advantage of this
-   approach compared to the one below is its significantly smaller fee per
-   transaction because checking the transaction signature is analogous to P2PK
-   but uses Schnorr instead of ECDSA. IMPORTANT: Note that
-   [BIP341](https://github.com/bitcoin/bips/blob/master/bip-0341.mediawiki#cite_note-23)
-   advises against using taproot addresses that can be spent with an untweaked
-   key. This precaution is to prevent attacks that can occur when creating
-   taproot multisigner addresses using specific multisignature schemes. However,
-   the Schnorr API of the internet computer does not support Schnorr
-   multisignatures.
+   where the funds can be spent using the internal key only ([P2TR key path
+   spend with unspendable script
+   tree](https://github.com/bitcoin/bips/blob/master/bip-0341.mediawiki#cite_note-23)).
 3. A [P2TR
    address](https://github.com/bitcoin/bips/blob/master/bip-0341.mediawiki)
-   where the funds can be spent using the provided public key with the script
-   path, where the Merkelized Alternative Script Tree (MAST) consists of a
-   single script allowing to spend funds by exactly one key.
-
-Note that P2TR *key path* spending with a tweaked key is currently not available
-on the IC because the threshold Schnorr signing interface does not allow
-applying BIP341 tweaks to the private key. In contrast, the
-tweaked public key is used to spend in the script path, which is available on the
-IC. For a technical comparison of different ways of how single-signer P2TR
-addresses can be constructed and used, you may want to take a look at [this
-post](https://bitcoin.stackexchange.com/a/111100) by Pieter Wuille.
+   where the funds can be spent using either 1) the internal key or 2) the
+   provided public key with the script path, where the Merkelized Alternative
+   Script Tree (MAST) consists of a single script allowing to spend funds by
+   exactly one key.
 
 On the Candid UI of your canister, click the "Call" button under
 `get_${type}_address` to generate a `${type}` Bitcoin address, where `${type}`
-is one of `[p2pkh, p2tr_raw_key_spend, p2tr_script_spend]`.
+is one of `[p2pkh, p2tr_key_only, p2tr]` (corresponding to the three types of
+addresses described above, in the same order).
 
 Or, if you prefer the command line:
    `dfx canister --network=ic call basic_bitcoin get_${type}_address`
@@ -176,15 +162,16 @@ Checking the balance of a Bitcoin address relies on the [bitcoin_get_balance](ht
 ## Step 5: Sending bitcoin
 
 You can send bitcoin using the `send_from_${type}` endpoint on your canister, where
-`${type}` is on of `[p2pkh, p2tr_raw_key_spend, p2tr_script_spend]`.
+`${type}` is one of
+`[p2pkh_address, p2tr_key_only_address, p2tr_address_key_path, p2tr_address_script_path]`.
 
 In the Candid UI, add a destination address and an amount to send. In the example
 below, we're sending 4'321 Satoshi (0.00004321 BTC) back to the testnet faucet.
 
 Via command line, the same call would look like this:
 
 ```bash
-dfx canister --network=ic call basic_bitcoin send_from_p2pkh '(record { destination_address = "tb1ql7w62elx9ucw4pj5lgw4l028hmuw80sndtntxt"; amount_in_satoshi = 4321; })'
+dfx canister --network=ic call basic_bitcoin send_from_p2pkh_address '(record { destination_address = "tb1ql7w62elx9ucw4pj5lgw4l028hmuw80sndtntxt"; amount_in_satoshi = 4321; })'
 ```
 
 The `send_from_${type}` endpoint can send bitcoin by:

rust/basic_bitcoin/README.md

@@ -12,6 +12,11 @@
           "name": "candid:service"
         }
       ]
+    },
+    "chainkey_testing_canister": {
+      "type": "custom",
+      "candid": "https://github.com/dfinity/chainkey-testing-canister/releases/download/v0.1.0/chainkey_testing_canister.did",
+      "wasm": "https://github.com/dfinity/chainkey-testing-canister/releases/download/v0.1.0/chainkey_testing_canister.wasm.gz"
     }
   },
   "defaults": {

rust/basic_bitcoin/dfx.json

@@ -15,3 +15,4 @@ candid = "0.9.10"
 ic-cdk = "0.10.0"
 ic-cdk-macros = "0.7.1"
 serde = "1.0.132"
+serde_bytes = "0.11.15"

rust/basic_bitcoin/src/basic_bitcoin/Cargo.toml

@@ -41,11 +41,13 @@ type get_block_headers_response = record {
 };
 
 service : (network) -> {
+  "for_test_only_change_management_canister_id" : (text) -> (variant { Ok: null; Err: text });
+
   "get_p2pkh_address" : () -> (bitcoin_address);
 
-  "get_p2tr_script_spend_address" : () -> (bitcoin_address);
+  "get_p2tr_address" : () -> (bitcoin_address);
 
-  "get_p2tr_raw_key_spend_address" : () -> (bitcoin_address);
+  "get_p2tr_key_only_address" : () -> (bitcoin_address);
 
   "get_balance" : (address : bitcoin_address) -> (satoshi);
 
@@ -55,21 +57,28 @@ service : (network) -> {
 
   "get_current_fee_percentiles" : () -> (vec millisatoshi_per_vbyte);
 
-  "send_from_p2pkh" : (
+  "send_from_p2pkh_address" : (
+    record {
+      destination_address : bitcoin_address;
+      amount_in_satoshi : satoshi;
+    }
+  ) -> (transaction_id);
+
+  "send_from_p2tr_address_key_path" : (
     record {
       destination_address : bitcoin_address;
       amount_in_satoshi : satoshi;
     }
   ) -> (transaction_id);
 
-  "send_from_p2tr_script_spend" : (
+  "send_from_p2tr_address_script_path" : (
     record {
       destination_address : bitcoin_address;
       amount_in_satoshi : satoshi;
     }
   ) -> (transaction_id);
 
-  "send_from_p2tr_raw_key_spend" : (
+  "send_from_p2tr_key_only_address" : (
     record {
       destination_address : bitcoin_address;
       amount_in_satoshi : satoshi;

rust/basic_bitcoin/src/basic_bitcoin/basic_bitcoin.did

@@ -110,6 +110,7 @@ pub async fn get_fee_per_byte(network: BitcoinNetwork) -> u64 {
 pub async fn mock_signer(
     _key_name: String,
     _derivation_path: Vec<Vec<u8>>,
+    _merkle_root_hash: Option<Vec<u8>>,
     _message_hash: Vec<u8>,
 ) -> Vec<u8> {
     vec![255; 64]

rust/basic_bitcoin/src/basic_bitcoin/src/bitcoin_wallet/common.rs

@@ -11,5 +11,5 @@
 
 mod common;
 pub mod p2pkh;
-pub mod p2tr_raw_key_spend;
-pub mod p2tr_script_spend;
+pub mod p2tr;
+pub mod p2tr_key_only;

rust/basic_bitcoin/src/basic_bitcoin/src/bitcoin_wallet/mod.rs

@@ -140,7 +140,7 @@ async fn build_p2pkh_spend_tx(
             transaction.clone(),
             String::from(""), // mock key name
             vec![],           // mock derivation path
-            super::common::mock_signer,
+            mock_signer,
         )
         .await;
 
@@ -258,3 +258,11 @@ fn sec1_to_der(sec1_signature: Vec<u8>) -> Vec<u8> {
     .flatten()
     .collect()
 }
+
+async fn mock_signer(
+    _key_name: String,
+    _derivation_path: Vec<Vec<u8>>,
+    _signing_data: Vec<u8>,
+) -> Vec<u8> {
+    vec![0; 64]
+}