Add Basic Dev Mode for Bill Chains (#642)

Author: zupzup

CHANGELOG.md

@@ -1,3 +1,17 @@
+# 0.4.7
+
+* Added basic Dev Mode
+    * Can be activated using the config flag `dev_mode: true`
+    * If activated, it's possible to fetch a full JSON Bill Chain by ID with the bill data decrypted for debugging
+        * Endpoint: `dev_mode_get_full_bill_chain(bill_id: string): Promise<string[]>` on `Bill` api
+        * The resulting nested list of JSON strings can be consumed like this:
+        ```javascript
+        await billApi.dev_mode_get_full_bill_chain(bill_id).map((b) => {
+          const block = JSON.parse(b);
+          return { ...block, data: JSON.parse(block.data) };
+        })
+        ```
+
 # 0.4.6
 
 * Add basic logic for implementing (social) identity proofs

Cargo.toml

@@ -1,5 +1,5 @@
 [workspace.package]
-version = "0.4.6"
+version = "0.4.7"
 edition = "2024"
 license = "MIT"
 

crates/bcr-ebill-api/src/lib.rs

@@ -31,6 +31,7 @@ pub struct Config {
     pub nostr_config: NostrConfig,
     pub mint_config: MintConfig,
     pub payment_config: PaymentConfig,
+    pub dev_mode_config: DevModeConfig,
 }
 
 static CONFIG: OnceLock<Config> = OnceLock::new();
@@ -47,6 +48,13 @@ impl Config {
     }
 }
 
+/// Developer Mode specific configuration
+#[derive(Debug, Clone, Default)]
+pub struct DevModeConfig {
+    /// Whether dev mode is on
+    pub on: bool,
+}
+
 /// Payment specific configuration
 #[derive(Debug, Clone, Default)]
 pub struct PaymentConfig {

crates/bcr-ebill-api/src/service/bill_service/mod.rs

@@ -13,6 +13,7 @@ use crate::util::BcrKeys;
 use async_trait::async_trait;
 use bcr_ebill_core::ServiceTraitBounds;
 use bcr_ebill_core::bill::{BillAction, BillIssueData, PastPaymentResult};
+use bcr_ebill_core::blockchain::bill::chain::BillBlockPlaintextWrapper;
 
 pub use error::Error;
 #[cfg(test)]
@@ -218,6 +219,13 @@ pub trait BillServiceApi: ServiceTraitBounds {
 
     /// Check mint state for all bills
     async fn check_mint_state_for_all_bills(&self) -> Result<()>;
+
+    /// If dev mode is on, return the full bill chain with decrypted data
+    async fn dev_mode_get_full_bill_chain(
+        &self,
+        bill_id: &BillId,
+        current_identity_node_id: &NodeId,
+    ) -> Result<Vec<BillBlockPlaintextWrapper>>;
 }
 
 #[cfg(test)]

crates/bcr-ebill-api/src/service/bill_service/service.rs

@@ -38,6 +38,7 @@ use bcr_ebill_core::bill::{
 use bcr_ebill_core::blockchain::bill::block::{
     BillParticipantBlockData, BillRequestRecourseBlockData,
 };
+use bcr_ebill_core::blockchain::bill::chain::BillBlockPlaintextWrapper;
 use bcr_ebill_core::blockchain::bill::create_bill_to_share_with_external_party;
 use bcr_ebill_core::company::{Company, CompanyKeys};
 use bcr_ebill_core::constants::{
@@ -1799,4 +1800,43 @@ impl BillServiceApi for BillService {
             Err(Error::RejectMintRequestNotOffered)
         }
     }
+
+    async fn dev_mode_get_full_bill_chain(
+        &self,
+        bill_id: &BillId,
+        current_identity_node_id: &NodeId,
+    ) -> Result<Vec<BillBlockPlaintextWrapper>> {
+        // if dev mode is off - we return an error
+        if !get_config().dev_mode_config.on {
+            error!("Called dev mode operation with dev mode disabled - please enable!");
+            return Err(Error::InvalidOperation);
+        }
+
+        validate_bill_id_network(bill_id)?;
+        validate_node_id_network(current_identity_node_id)?;
+
+        // if there is no such bill, we return an error
+        match self.store.exists(bill_id).await {
+            Ok(true) => (),
+            _ => {
+                return Err(Error::NotFound);
+            }
+        };
+
+        let chain = self.blockchain_store.get_chain(bill_id).await?;
+        let bill_keys = self.store.get_keys(bill_id).await?;
+        let bill_participant_node_ids = chain.get_all_nodes_from_bill(&bill_keys)?;
+
+        // if currently active identity is not part of the bill, we can't access it
+        if !bill_participant_node_ids
+            .iter()
+            .any(|p| p == current_identity_node_id)
+        {
+            return Err(Error::NotFound);
+        }
+
+        let plaintext_chain = chain.get_chain_with_plaintext_block_data(&bill_keys)?;
+
+        Ok(plaintext_chain)
+    }
 }

crates/bcr-ebill-api/src/tests/mod.rs

@@ -2,7 +2,10 @@
 #[allow(clippy::module_inception)]
 pub mod tests {
     use crate::service::notification_service::{self, chain_keys::ChainKeyServiceApi};
-    use crate::{CONFIG, DbContext, MintConfig, NostrConfig, PaymentConfig, data::bill::BillKeys};
+    use crate::{
+        CONFIG, DbContext, DevModeConfig, MintConfig, NostrConfig, PaymentConfig,
+        data::bill::BillKeys,
+    };
     use async_trait::async_trait;
     use bcr_ebill_core::{
         NodeId, OptionalPostalAddress, PostalAddress, PublicKey, SecretKey, ServiceTraitBounds,
@@ -476,6 +479,9 @@ pub mod tests {
                     },
                     payment_config: PaymentConfig {
                         num_confirmations_for_payment: 6,
+                    },
+                    dev_mode_config: DevModeConfig {
+                        on: false
                     }
                 });
             }

crates/bcr-ebill-core/src/blockchain/bill/block.rs

@@ -59,7 +59,7 @@ pub struct BillBlockDataToHash {
 }
 
 /// Data for reject to accept/pay/recourse
-#[derive(BorshSerialize, BorshDeserialize, Debug, Clone, PartialEq)]
+#[derive(BorshSerialize, BorshDeserialize, Serialize, Debug, Clone, PartialEq)]
 pub struct BillRejectBlockData {
     pub rejecter: BillIdentParticipantBlockData, // reject to accept/pay/recourse has to be identified
     pub signatory: Option<BillSignatoryBlockData>,
@@ -82,7 +82,7 @@ impl Validate for BillRejectBlockData {
 }
 
 /// Data for reject to buy
-#[derive(BorshSerialize, BorshDeserialize, Debug, Clone, PartialEq)]
+#[derive(BorshSerialize, BorshDeserialize, Serialize, Debug, Clone, PartialEq)]
 pub struct BillRejectToBuyBlockData {
     pub rejecter: BillParticipantBlockData, // reject to buy can be done by anon
     pub signatory: Option<BillSignatoryBlockData>,
@@ -104,7 +104,7 @@ impl Validate for BillRejectToBuyBlockData {
     }
 }
 
-#[derive(BorshSerialize, BorshDeserialize, Debug, Clone, PartialEq)]
+#[derive(BorshSerialize, BorshDeserialize, Serialize, Debug, Clone, PartialEq)]
 pub struct BillIssueBlockData {
     pub id: BillId,
     pub country_of_issuing: String,
@@ -200,7 +200,7 @@ impl BillIssueBlockData {
     }
 }
 
-#[derive(BorshSerialize, BorshDeserialize, Debug, Clone, PartialEq)]
+#[derive(BorshSerialize, BorshDeserialize, Serialize, Debug, Clone, PartialEq)]
 pub struct BillAcceptBlockData {
     pub accepter: BillIdentParticipantBlockData, // accepter is drawer and has to be identified
     pub signatory: Option<BillSignatoryBlockData>,
@@ -222,7 +222,7 @@ impl Validate for BillAcceptBlockData {
     }
 }
 
-#[derive(BorshSerialize, BorshDeserialize, Debug, Clone, PartialEq)]
+#[derive(BorshSerialize, BorshDeserialize, Serialize, Debug, Clone, PartialEq)]
 pub struct BillRequestToPayBlockData {
     pub requester: BillParticipantBlockData, // requester is holder and can be anon
     pub currency: String,
@@ -247,7 +247,7 @@ impl Validate for BillRequestToPayBlockData {
     }
 }
 
-#[derive(BorshSerialize, BorshDeserialize, Debug, Clone, PartialEq)]
+#[derive(BorshSerialize, BorshDeserialize, Serialize, Debug, Clone, PartialEq)]
 pub struct BillRequestToAcceptBlockData {
     pub requester: BillParticipantBlockData, // requester is holder and can be anon
     pub signatory: Option<BillSignatoryBlockData>,
@@ -269,7 +269,7 @@ impl Validate for BillRequestToAcceptBlockData {
     }
 }
 
-#[derive(BorshSerialize, BorshDeserialize, Debug, Clone, PartialEq)]
+#[derive(BorshSerialize, BorshDeserialize, Serialize, Debug, Clone, PartialEq)]
 pub struct BillMintBlockData {
     pub endorser: BillParticipantBlockData, // bill can be minted by anon
     pub endorsee: BillParticipantBlockData, // mints can be anon
@@ -302,7 +302,7 @@ impl Validate for BillMintBlockData {
     }
 }
 
-#[derive(BorshSerialize, BorshDeserialize, Debug, Clone, PartialEq)]
+#[derive(BorshSerialize, BorshDeserialize, Serialize, Debug, Clone, PartialEq)]
 pub struct BillOfferToSellBlockData {
     pub seller: BillParticipantBlockData, // seller is holder and can be anon
     pub buyer: BillParticipantBlockData,  // buyer can be anon
@@ -340,7 +340,7 @@ impl Validate for BillOfferToSellBlockData {
     }
 }
 
-#[derive(BorshSerialize, BorshDeserialize, Debug, Clone, PartialEq)]
+#[derive(BorshSerialize, BorshDeserialize, Serialize, Debug, Clone, PartialEq)]
 pub struct BillSellBlockData {
     pub seller: BillParticipantBlockData, // seller is holder and can be anon
     pub buyer: BillParticipantBlockData,  // buyer can be anon
@@ -378,7 +378,7 @@ impl Validate for BillSellBlockData {
     }
 }
 
-#[derive(BorshSerialize, BorshDeserialize, Debug, Clone, PartialEq)]
+#[derive(BorshSerialize, BorshDeserialize, Serialize, Debug, Clone, PartialEq)]
 pub struct BillEndorseBlockData {
     pub endorser: BillParticipantBlockData, // endorser is holder and can be anon
     pub endorsee: BillParticipantBlockData, // endorsee can be anon
@@ -406,7 +406,7 @@ impl Validate for BillEndorseBlockData {
     }
 }
 
-#[derive(BorshSerialize, BorshDeserialize, Debug, Clone, PartialEq)]
+#[derive(BorshSerialize, BorshDeserialize, Serialize, Debug, Clone, PartialEq)]
 pub struct BillRequestRecourseBlockData {
     pub recourser: BillIdentParticipantBlockData, // anon can't do recourse
     pub recoursee: BillIdentParticipantBlockData, // anon can't be recoursed against
@@ -418,7 +418,7 @@ pub struct BillRequestRecourseBlockData {
     pub signing_address: PostalAddress, // address of the endorser
 }
 
-#[derive(BorshSerialize, BorshDeserialize, Debug, Clone, PartialEq, Eq)]
+#[derive(BorshSerialize, BorshDeserialize, Serialize, Debug, Clone, PartialEq, Eq)]
 pub enum BillRecourseReasonBlockData {
     Accept,
     Pay,
@@ -446,7 +446,7 @@ impl Validate for BillRequestRecourseBlockData {
     }
 }
 
-#[derive(BorshSerialize, BorshDeserialize, Debug, Clone, PartialEq)]
+#[derive(BorshSerialize, BorshDeserialize, Serialize, Debug, Clone, PartialEq)]
 pub struct BillRecourseBlockData {
     pub recourser: BillIdentParticipantBlockData, // anon can't do recourse
     pub recoursee: BillIdentParticipantBlockData, // anon can't be recoursed against
@@ -481,7 +481,7 @@ impl Validate for BillRecourseBlockData {
 }
 
 /// Participant in a bill transaction - either anonymous, or identified
-#[derive(BorshSerialize, BorshDeserialize, Debug, Clone, PartialEq, Eq)]
+#[derive(BorshSerialize, BorshDeserialize, Serialize, Debug, Clone, PartialEq, Eq)]
 pub enum BillParticipantBlockData {
     Anon(BillAnonParticipantBlockData),
     Ident(BillIdentParticipantBlockData),
@@ -547,7 +547,7 @@ impl Validate for BillParticipantBlockData {
 }
 
 /// Anon bill participany data
-#[derive(BorshSerialize, BorshDeserialize, Debug, Clone, PartialEq, Eq)]
+#[derive(BorshSerialize, BorshDeserialize, Serialize, Debug, Clone, PartialEq, Eq)]
 pub struct BillAnonParticipantBlockData {
     pub node_id: NodeId,
 }
@@ -559,7 +559,7 @@ impl Validate for BillAnonParticipantBlockData {
 }
 
 /// Legal data for parties of a bill within the liability chain
-#[derive(BorshSerialize, BorshDeserialize, Debug, Clone, PartialEq, Eq)]
+#[derive(BorshSerialize, BorshDeserialize, Serialize, Debug, Clone, PartialEq, Eq)]
 pub struct BillIdentParticipantBlockData {
     pub t: ContactType,
     pub node_id: NodeId,
@@ -654,7 +654,7 @@ impl From<BillIdentParticipantBlockData> for LightBillIdentParticipant {
 }
 
 /// The name and node_id of a company signatory
-#[derive(BorshSerialize, BorshDeserialize, Debug, Clone, PartialEq)]
+#[derive(BorshSerialize, BorshDeserialize, Serialize, Debug, Clone, PartialEq)]
 pub struct BillSignatoryBlockData {
     pub node_id: NodeId,
     pub name: String,

crates/bcr-ebill-core/src/blockchain/bill/chain.rs

@@ -10,6 +10,7 @@ use super::{BillOpCode, RecourseWaitingForPayment};
 use super::{OfferToSellWaitingForPayment, RecoursePaymentInfo};
 use crate::NodeId;
 use crate::bill::{BillKeys, Endorsement, LightSignedBy, PastEndorsee, PastPaymentStatus};
+use crate::blockchain::bill::block::BillRejectToBuyBlockData;
 use crate::blockchain::{Block, Blockchain, Error};
 use crate::constants::{PAYMENT_DEADLINE_SECONDS, RECOURSE_DEADLINE_SECONDS};
 use crate::contact::{
@@ -90,6 +91,64 @@ impl BillBlockPlaintextWrapper {
             _ => Ok(None),
         }
     }
+
+    /// This is only used for dev mode
+    pub fn to_json_text(&self) -> Result<String> {
+        let mut block = self.block.clone();
+        let block_data_string: String = match self.block.op_code() {
+            BillOpCode::Issue => {
+                Self::borsh_to_json_string::<BillIssueBlockData>(&self.plaintext_data_bytes)?
+            }
+            BillOpCode::Accept => {
+                Self::borsh_to_json_string::<BillAcceptBlockData>(&self.plaintext_data_bytes)?
+            }
+            BillOpCode::Endorse => {
+                Self::borsh_to_json_string::<BillEndorseBlockData>(&self.plaintext_data_bytes)?
+            }
+            BillOpCode::RequestToAccept => Self::borsh_to_json_string::<
+                BillRequestToAcceptBlockData,
+            >(&self.plaintext_data_bytes)?,
+            BillOpCode::RequestToPay => {
+                Self::borsh_to_json_string::<BillRequestToPayBlockData>(&self.plaintext_data_bytes)?
+            }
+            BillOpCode::OfferToSell => {
+                Self::borsh_to_json_string::<BillOfferToSellBlockData>(&self.plaintext_data_bytes)?
+            }
+            BillOpCode::Sell => {
+                Self::borsh_to_json_string::<BillSellBlockData>(&self.plaintext_data_bytes)?
+            }
+            BillOpCode::Mint => {
+                Self::borsh_to_json_string::<BillMintBlockData>(&self.plaintext_data_bytes)?
+            }
+            BillOpCode::RejectToAccept => {
+                Self::borsh_to_json_string::<BillRejectBlockData>(&self.plaintext_data_bytes)?
+            }
+            BillOpCode::RejectToPay => {
+                Self::borsh_to_json_string::<BillRejectBlockData>(&self.plaintext_data_bytes)?
+            }
+            BillOpCode::RejectToBuy => {
+                Self::borsh_to_json_string::<BillRejectToBuyBlockData>(&self.plaintext_data_bytes)?
+            }
+            BillOpCode::RejectToPayRecourse => {
+                Self::borsh_to_json_string::<BillRejectBlockData>(&self.plaintext_data_bytes)?
+            }
+            BillOpCode::RequestRecourse => Self::borsh_to_json_string::<
+                BillRequestRecourseBlockData,
+            >(&self.plaintext_data_bytes)?,
+            BillOpCode::Recourse => {
+                Self::borsh_to_json_string::<BillRecourseBlockData>(&self.plaintext_data_bytes)?
+            }
+        };
+        block.data = block_data_string;
+        serde_json::to_string(&block).map_err(|e| Error::JSON(e.to_string()))
+    }
+
+    fn borsh_to_json_string<T: borsh::BorshDeserialize + serde::Serialize>(
+        bytes: &[u8],
+    ) -> Result<String> {
+        let block_data: T = borsh::from_slice(bytes)?;
+        serde_json::to_string(&block_data).map_err(|e| Error::JSON(e.to_string()))
+    }
 }
 
 /// Gets bill parties from blocks with their plaintext data
@@ -937,9 +996,9 @@ impl BillBlockchain {
                 BillOpCode::RejectToPay => {
                     borsh::to_vec(&block.get_decrypted_block::<BillRejectBlockData>(bill_keys)?)?
                 }
-                BillOpCode::RejectToBuy => {
-                    borsh::to_vec(&block.get_decrypted_block::<BillRejectBlockData>(bill_keys)?)?
-                }
+                BillOpCode::RejectToBuy => borsh::to_vec(
+                    &block.get_decrypted_block::<BillRejectToBuyBlockData>(bill_keys)?,
+                )?,
                 BillOpCode::RejectToPayRecourse => {
                     borsh::to_vec(&block.get_decrypted_block::<BillRejectBlockData>(bill_keys)?)?
                 }

crates/bcr-ebill-core/src/blockchain/mod.rs

@@ -69,6 +69,10 @@ pub enum Error {
     /// The given blockchain type string could not be converted to a valid type
     #[error("Invalid blockchain type: {0}")]
     InvalidBlockchainType(String),
+
+    /// Errors from JSON serialization
+    #[error("JSON serialization error: {0}")]
+    JSON(String),
 }
 
 #[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)]