feat: shielded TX support

.github/workflows/ci.yml

@@ -28,19 +28,13 @@ jobs:
         with:
           cache-provider: warpbuild
 
-      - name: Check formatting
-        run: cargo fmt --all -- --check
-
-      - name: Run Clippy
-        run: cargo clippy --lib --bins --examples -- -D warnings -D clippy::pedantic -D clippy::as_conversions -A clippy::must_use_candidate -A clippy::needless_pass_by_value -A clippy::missing_panics_doc -A clippy::missing_errors_doc -A clippy::match_same_arms -A clippy::unused_self -A clippy::too_many_lines
+      - name: Run lint
+        run: make lint
 
       - name: Install cargo-near
         run: |
           curl --proto '=https' --tlsv1.2 -LsSf https://github.com/near/cargo-near/releases/latest/download/cargo-near-installer.sh | sh
 
-      - name: Build contracts
-        run: make build
-        timeout-minutes: 60
-
       - name: Run tests
-        run: cargo test --all -- --nocapture
+        run: make test
+

Makefile

@@ -1,21 +1,48 @@
-.PHONY: zcash-bridge
+MAKEFILE_DIR :=  $(shell dirname $(realpath $(lastword $(MAKEFILE_LIST))))
+#INT_OPTIONS = -D warnings -D clippy::pedantic -A clippy::must_use_candidate -A clippy::used_underscore_binding -A clippy::needless_range_loop //TODO: enable it later
+BRIDGE_MANIFEST := $(MAKEFILE_DIR)/contracts/satoshi-bridge/Cargo.toml
 
 RFLAGS="-C link-arg=-s"
 
-build: lint satoshi-bridge zcash-bridge nbtc mock-chain-signatures mock-btc-light-client mock-dapp
+FEATURES = bitcoin zcash
 
-lint:
+release: $(addprefix build-,$(FEATURES))
+	$(call build_release_wasm,nbtc,nbtc)
+
+build-local: $(addprefix build-local-,$(FEATURES)) nbtc mock-chain-signatures mock-btc-light-client mock-dapp
+
+lint: $(addprefix clippy-,$(FEATURES)) $(addprefix fmt-,$(FEATURES))
 	@cargo fmt --all
-	@cargo clippy --fix --allow-dirty --allow-staged
+	@cargo clippy -- $(LINT_OPTIONS)
 
-satoshi-bridge: contracts/satoshi-bridge
-	$(call local_build_wasm,satoshi-bridge,satoshi_bridge)
+test: build-local $(addprefix test-,$(FEATURES))
 
-zcash-bridge: contracts/satoshi-bridge
-	$(call local_build_zcash_wasm)
+$(foreach feature,$(FEATURES), \
+	$(eval build-$(feature): ; \
+		cargo near build reproducible-wasm --variant "$(feature)" --manifest-path $(BRIDGE_MANIFEST) && \
+		mkdir -p res && mv ./target/near/satoshi_bridge/satoshi_bridge.wasm ./res/$(feature)_bridge_release.wasm \
+	) \
+)
+
+$(foreach feature,$(FEATURES), \
+	$(eval build-local-$(feature): ; \
+		cargo near build non-reproducible-wasm --features "$(feature)" --manifest-path $(BRIDGE_MANIFEST) --no-abi && \
+		mkdir -p res && mv ./target/near/satoshi_bridge/satoshi_bridge.wasm ./res/$(feature)_bridge.wasm \
+	) \
+)
+
+$(foreach feature,$(FEATURES), \
+	$(eval clippy-$(feature): ; cargo clippy --no-default-features --features "$(feature)" --manifest-path $(BRIDGE_MANIFEST) -- $(LINT_OPTIONS)) \
+)
+
+$(foreach feature,$(FEATURES), \
+	$(eval fmt-$(feature): ; cargo fmt --all --check --manifest-path $(BRIDGE_MANIFEST)) \
+)
+
+$(foreach feature,$(FEATURES), \
+	$(eval test-$(feature): ; cargo test --no-default-features --features "$(feature)" --manifest-path $(BRIDGE_MANIFEST)) \
+)
 
-nbtc: contracts/nbtc
-	$(call local_build_wasm,nbtc,nbtc)
 
 mock-dapp: contracts/mock-dapp
 	$(call local_build_wasm,mock-dapp,mock_dapp)
@@ -26,19 +53,9 @@ mock-chain-signatures: contracts/mock-chain-signatures
 mock-btc-light-client: contracts/mock-btc-light-client
 	$(call local_build_wasm,mock-btc-light-client,mock_btc_light_client)
 
-count:
-	@tokei ./contracts/satoshi-bridge/src/ --files --exclude unit
-	@tokei ./contracts/nbtc/src/ --files
-
-release:
-	$(call build_release_wasm,satoshi-bridge,satoshi_bridge)
-	$(call build_release_wasm,nbtc,nbtc)
-	$(call build_release_zcash_wasm)
-
-clean:
-	cargo clean
-	rm -rf res/
-
+nbtc: contracts/nbtc
+	$(call local_build_wasm,nbtc,nbtc)
+
 define local_build_wasm
 	$(eval PACKAGE_NAME := $(1))
 	$(eval WASM_NAME := $(2))

contracts/mock-btc-light-client/src/lib.rs

@@ -81,4 +81,9 @@ impl Contract {
     pub fn verify_transaction_inclusion(&self, #[serializer(borsh)] args: ProofArgs) -> bool {
         true
     }
+
+    pub fn get_last_block_height(&self) -> u32 {
+        // Return a reasonable mock block height for Zcash testnet
+        1000
+    }
 }

contracts/satoshi-bridge/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "satoshi-bridge"
-version = "0.7.3"
+version = "0.7.4"
 edition.workspace = true
 publish.workspace = true
 repository.workspace = true
@@ -21,18 +21,11 @@ container_build_command = [
     "--no-abi",
 ]
 
+[package.metadata.near.reproducible_build.variant.bitcoin]
+container_build_command = ["cargo", "near", "build", "non-reproducible-wasm", "--locked", "--no-abi", "--no-default-features", "--features", "bitcoin"]
+
 [package.metadata.near.reproducible_build.variant.zcash]
-container_build_command = [
-    "cargo",
-    "near",
-    "build",
-    "non-reproducible-wasm",
-    "--locked",
-    "--no-abi",
-    "--no-default-features",
-    "--features",
-    "zcash"
-]
+container_build_command = ["cargo", "near", "build", "non-reproducible-wasm", "--locked", "--no-abi", "--no-default-features", "--features", "zcash"]
 
 [dependencies]
 near-sdk.workspace = true
@@ -45,6 +38,8 @@ ed25519-dalek = "2.1.0"
 crypto-shared = { git = "https://github.com/near/mpc_old", rev = "0afee9004a1b1c3386940e60c28cff7cf1b5978c" }
 zcash_primitives = { version = "0.24.0", default-features = false, features = ["circuits", "transparent-inputs"], optional = true }
 zcash_transparent = { version = "0.4.0", features = ["transparent-inputs"], optional = true }
+orchard = { version = "0.11.0", default-features = false, optional = true }
+sapling-crypto = { version = "0.5.0", default-features = false, optional = true }
 zcash_protocol = { version = "0.6.1" }
 core2 = { version = "0.3", optional = true }
 zcash_address = { version = "0.9.0" }
@@ -55,7 +50,11 @@ getrandom = { version = "0.2.12", features = ["custom"] }
 [dev-dependencies]
 near-workspaces = { version = "0.20", features = ["unstable"] }
 tokio = { version = "1.12.0", features = ["full"] }
+rand = "0.8"
+hex = "0.4"
+bs58 = "0.5"
 
 [features]
 default = []
-zcash = ["zcash_primitives", "zcash_transparent", "core2"]
+zcash = ["zcash_primitives", "zcash_transparent", "orchard", "core2", "sapling-crypto"]
+bitcoin = []

contracts/satoshi-bridge/src/account.rs

@@ -1,4 +1,5 @@
 use crate::{near, u128_dec_format, AccountId, Contract};
+use near_sdk::env;
 use std::collections::HashSet;
 
 #[near(serializers = [borsh, json])]
@@ -85,16 +86,20 @@ impl Contract {
         self.data()
             .accounts
             .get(account_id)
-            .map(Into::into)
-            .expect("ACCOUNT NOT REGISTERED")
+            .map(|o| o.into())
+            .unwrap_or_else(|| {
+                env::panic_str(&format!("ERR_ACCOUNT_NOT_REGISTERED: {}", account_id))
+            })
     }
 
     pub fn internal_unwrap_mut_account(&mut self, account_id: &AccountId) -> &mut Account {
         self.data_mut()
             .accounts
             .get_mut(account_id)
-            .map(Into::into)
-            .expect("ACCOUNT NOT REGISTERED")
+            .map(|o| o.into())
+            .unwrap_or_else(|| {
+                env::panic_str(&format!("ERR_ACCOUNT_NOT_REGISTERED: {}", account_id))
+            })
     }
 
     pub fn internal_unwrap_or_create_mut_account(

contracts/satoshi-bridge/src/api/bridge.rs

@@ -1,9 +1,5 @@
-use crate::{
-    assert_one_yocto, env, generate_utxo_storage_key, get_deposit_path, nano_to_sec, near,
-    psbt_wrapper::PsbtWrapper, require, AccessControllable, AccountId, BTCPendingInfo, Contract,
-    ContractExt, DepositMsg, Event, LockTime, OriginalState, OutPoint, Pausable, PendingInfoStage,
-    PendingInfoState, PendingUTXOInfo, Promise, Role, TxOut, WrappedTransaction, UTXO,
-};
+use crate::psbt_wrapper::PsbtWrapper;
+use crate::*;
 use near_plugins::{access_control_any, pause};
 
 #[near]
@@ -204,7 +200,12 @@ impl Contract {
     /// * `original_btc_pending_verify_id` - Pending verify ID of the original transaction.
     /// * `output` - Modified output.
     #[pause(except(roles(Role::DAO)))]
-    pub fn withdraw_rbf(&mut self, original_btc_pending_verify_id: String, output: Vec<TxOut>) {
+    pub fn withdraw_rbf(
+        &mut self,
+        original_btc_pending_verify_id: String,
+        output: Vec<TxOut>,
+        chain_specific_data: Option<ChainSpecificData>,
+    ) {
         let account_id = env::predecessor_account_id();
         require!(
             self.internal_unwrap_account(&account_id)
@@ -213,7 +214,12 @@ impl Contract {
             "Previous btc tx has not been signed"
         );
 
-        self.withdraw_rbf_chain_specific(account_id, original_btc_pending_verify_id, output);
+        self.withdraw_rbf_chain_specific(
+            account_id,
+            original_btc_pending_verify_id,
+            output,
+            chain_specific_data,
+        );
     }
 
     /// If the user's Withdraw is not verified within a certain time, the protocol can actively cancel the Withdraw through RBF, with the gas fee borne by the user.
@@ -242,6 +248,7 @@ impl Contract {
             user_account_id,
             original_btc_pending_verify_id,
             output,
+            None,
         );
     }
 
@@ -327,6 +334,7 @@ impl Contract {
             account_id,
             original_btc_pending_verify_id,
             output,
+            None,
         );
     }
 
@@ -359,6 +367,7 @@ impl Contract {
             user_account_id,
             original_btc_pending_verify_id,
             output,
+            None,
         );
     }
 
@@ -416,17 +425,17 @@ impl Contract {
     pub fn create_active_utxo_management_pending_info(
         &mut self,
         account_id: AccountId,
-        psbt: &mut PsbtWrapper,
+        mut psbt: PsbtWrapper,
     ) {
         let account = self.internal_unwrap_account(&account_id);
         require!(
             account.btc_pending_sign_id.is_none(),
             "Previous btc tx has not been signed"
         );
 
-        let (utxo_storage_keys, vutxos) = self.generate_vutxos(psbt);
+        let (utxo_storage_keys, vutxos) = self.generate_vutxos(&mut psbt);
         let (actual_received_amount, gas_fee) =
-            self.check_active_management_psbt_valid(psbt, &vutxos);
+            self.check_active_management_psbt_valid(&psbt, &vutxos);
         require!(
             gas_fee <= self.data().cur_available_protocol_fee,
             "Insufficient protocol_fee"

contracts/satoshi-bridge/src/api/token_receiver.rs

@@ -1,9 +1,4 @@
-use crate::{
-    env, nano_to_sec, near, psbt_wrapper::PsbtWrapper, require, serde_json, AccessControllable,
-    AccountId, BTCPendingInfo, Contract, ContractExt, Event, Gas, OriginalState, OutPoint,
-    Pausable, PendingInfoStage, PendingInfoState, PromiseOrValue, Role, TxOut, U128,
-};
-
+use crate::{psbt_wrapper::PsbtWrapper, *};
 use near_contract_standards::fungible_token::receiver::FungibleTokenReceiver;
 use near_plugins::pause;
 
@@ -12,11 +7,13 @@ pub const GAS_FOR_FT_ON_TRANSFER_CALL_BACK: Gas = Gas::from_tgas(100);
 #[near(serializers = [json])]
 pub enum TokenReceiverMessage {
     DepositProtocolFee,
+    // Here is the withdraw message structure that will be sent from user or dApp to the btc/zcash connector
     Withdraw {
         target_btc_address: String,
         input: Vec<OutPoint>,
         output: Vec<TxOut>,
         max_gas_fee: Option<U128>,
+        chain_specific_data: Option<ChainSpecificData>,
     },
 }
 
@@ -56,13 +53,15 @@ impl FungibleTokenReceiver for Contract {
                 input,
                 output,
                 max_gas_fee,
+                chain_specific_data,
             } => self.ft_on_transfer_withdraw_chain_specific(
                 sender_id,
                 amount,
                 target_btc_address,
                 input,
                 output,
                 max_gas_fee,
+                chain_specific_data,
             ),
         }
     }
@@ -74,27 +73,24 @@ impl Contract {
         sender_id: AccountId,
         amount: u128,
         target_btc_address: String,
-        psbt: &mut PsbtWrapper,
+        mut psbt: PsbtWrapper,
         max_gas_fee: Option<U128>,
     ) {
-        let (utxo_storage_keys, vutxos) = self.generate_vutxos(psbt);
+        let (utxo_storage_keys, vutxos) = self.generate_vutxos(&mut psbt);
         require!(
             self.internal_unwrap_or_create_mut_account(&sender_id)
                 .btc_pending_sign_id
                 .is_none(),
             "Previous btc tx has not been signed"
         );
-        let target_address_script_pubkey = self
-            .internal_config()
-            .string_to_script_pubkey(&target_btc_address);
 
         let withdraw_change_address_script_pubkey =
             self.internal_config().get_change_script_pubkey();
         let withdraw_fee = self.internal_config().withdraw_bridge_fee.get_fee(amount);
         let (actual_received_amount, gas_fee) = self.check_withdraw_psbt_valid(
-            &target_address_script_pubkey,
+            target_btc_address.clone(),
             &withdraw_change_address_script_pubkey,
-            psbt,
+            &psbt,
             &vutxos,
             amount,
             withdraw_fee,