Add IdentityType to blocks, Remove empty validations, Add validation for (#718)

Identity Blocks, remove BackupService, remove File Based File Storage,
Move Bill Tests, Remove Cross-Crate-Re-Exports

Author: zupzup

CHANGELOG.md

@@ -7,6 +7,10 @@
 * Add strong types for `SchnorrSignature`, `Sha256Hash`, `BlockId`, `File` types, `Mint` types and use `PublicKey` and `SecretKey` in protocol types (breaking DB change)
 * Use bytes without encoding for bill data (breaking DB change)
 * Fix plaintext-chain rendering - the nesting of `data` now works properly and one `JSON.parse` call is enough (breaking API change)
+* Add `IdentityType` to `IdentityCreateBlockData` and `IdentityUpdateBlockData`
+* Remove `BackupService` and `BackupStore` since it's unused
+* Remove file-based `FileUpload` - we use surreal/nostr-based everywhere
+* Refactoring & Restructuring, removing cross-crate exports (breaking for Library dependents)
 
 # 0.4.12
 

Cargo.toml

@@ -62,7 +62,7 @@ bcr-ebill-core = { path = "./crates/bcr-ebill-core" }
 bcr-ebill-api = { path = "./crates/bcr-ebill-api" }
 bcr-ebill-persistence = { path = "./crates/bcr-ebill-persistence" }
 bcr-ebill-transport = { path = "./crates/bcr-ebill-transport" }
-bcr-common = { git = "https://github.com/BitcreditProtocol/bcr-common", tag = "v0.5.0" }
+bcr-common = { git = "https://github.com/BitcreditProtocol/bcr-common", tag = "v0.6.0" }
 surrealdb = { version = "2.3", default-features = false }
 strum = { version = "0.27", features = ["derive"] }
 url = { version = "2.5" }

crates/bcr-ebill-api/Cargo.toml

@@ -26,11 +26,11 @@ futures.workspace = true
 infer = { version = "0.19.0", default-features = false }
 bcr-ebill-core.workspace = true
 bcr-ebill-persistence.workspace = true
+bcr-common.workspace = true
 tokio.workspace = true
 tokio_with_wasm.workspace = true
 secp256k1.workspace = true
 bcr-wallet-lib = { git = "https://github.com/BitcreditProtocol/Wallet-Core", tag = "v0.6.0" }
-bcr-common.workspace = true
 cashu = { version = "0.13", default-features = false }
 rand = { version = "0.9" }
 strum.workspace = true

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

@@ -8,4 +8,3 @@ pub const VALID_FILE_MIME_TYPES: [&str; 3] = ["image/jpeg", "image/png", "applic
 // When subscribing events we subtract this from the last received event time
 pub const NOSTR_EVENT_TIME_SLACK: u64 = 3600 * 24 * 7; // 1 week
 pub const DEFAULT_INITIAL_SUBSCRIPTION_DELAY_SECONDS: u32 = 1;
-pub use bcr_ebill_core::constants::CURRENCY_SAT;

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

@@ -1,6 +1,7 @@
 use async_trait::async_trait;
+use bcr_common::core::{BillId, NodeId};
 use bcr_ebill_core::email::Email;
-use bcr_ebill_core::{NodeId, ServiceTraitBounds, bill::BillId, notification::BillEventType};
+use bcr_ebill_core::{ServiceTraitBounds, notification::BillEventType};
 use borsh_derive::BorshSerialize;
 use nostr::hashes::Hash;
 use nostr::util::SECP256K1;

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

@@ -1,7 +1,8 @@
 use async_trait::async_trait;
 use bcr_ebill_core::{
-    ServiceTraitBounds,
+    ServiceTraitBounds, ValidationError,
     identity_proof::{IdentityProofStamp, IdentityProofStatus},
+    util::crypto,
 };
 use borsh_derive::BorshSerialize;
 use log::error;
@@ -15,7 +16,7 @@ use url::Url;
 #[cfg(test)]
 use mockall::automock;
 
-use crate::{external::file_storage::to_url, util};
+use crate::external::file_storage::to_url;
 
 /// Generic result type
 pub type Result<T> = std::result::Result<T, super::Error>;
@@ -31,10 +32,10 @@ pub enum Error {
     Api(#[from] reqwest::Error),
     /// all errors originating from interacting with cryptography
     #[error("External Identity Proof Crypto error: {0}")]
-    Crypto(#[from] util::crypto::Error),
+    Crypto(#[from] crypto::Error),
     /// all errors originating from interacting with base58
     #[error("External Identity Proof Validation error: {0}")]
-    Validation(#[from] util::ValidationError),
+    Validation(#[from] ValidationError),
     /// all nostr key  errors
     #[error("External Identity Proof Nostr Key Error")]
     NostrKey,

crates/bcr-ebill-api/src/external/email.rs

@@ -1,34 +1,46 @@
 use anyhow::{Result, anyhow};
-use bcr_ebill_core::NodeId;
+use bcr_common::core::NodeId;
+use bcr_ebill_persistence::db::surreal::SurrealWrapper;
+#[cfg(not(target_arch = "wasm32"))]
+use bcr_ebill_persistence::get_surreal_db;
+use bcr_ebill_persistence::{
+    ContactStoreApi, NostrChainEventStoreApi, NostrEventOffsetStoreApi, NotificationStoreApi,
+    SurrealBillChainStore, SurrealBillStore, SurrealCompanyChainStore, SurrealCompanyStore,
+    SurrealContactStore, SurrealDbConfig, SurrealIdentityChainStore, SurrealIdentityStore,
+    SurrealNostrChainEventStore, SurrealNostrEventOffsetStore, SurrealNotificationStore,
+    bill::{BillChainStoreApi, BillStoreApi},
+    company::{CompanyChainStoreApi, CompanyStoreApi},
+    db::{
+        email_notification::SurrealEmailNotificationStore,
+        identity_proof::SurrealIdentityProofStore, mint::SurrealMintStore,
+        nostr_contact_store::SurrealNostrContactStore,
+        nostr_send_queue::SurrealNostrEventQueueStore,
+    },
+    file_upload::FileUploadStoreApi,
+    identity::{IdentityChainStoreApi, IdentityStoreApi},
+    identity_proof::IdentityProofStoreApi,
+    mint::MintStoreApi,
+    nostr::{NostrContactStoreApi, NostrQueuedMessageStoreApi},
+    notification::EmailNotificationStoreApi,
+};
 use bitcoin::Network;
-use std::sync::OnceLock;
+use log::error;
+use std::sync::{Arc, OnceLock};
 
-mod blockchain;
 pub mod constants;
-pub mod data;
 pub mod external;
-pub mod persistence;
 pub mod service;
 #[cfg(test)]
 mod tests;
 pub mod util;
 
-pub use blockchain::Block;
-pub use blockchain::Blockchain;
-pub use blockchain::bill::BillOpCode;
-pub use persistence::DbContext;
-pub use persistence::Error as PersistenceError;
-pub use persistence::db::SurrealDbConfig;
-pub use persistence::get_db_context;
-pub use persistence::notification::NotificationFilter;
-
 #[derive(Debug, Clone)]
 pub struct Config {
     pub app_url: url::Url,
     pub bitcoin_network: String,
     pub esplora_base_url: url::Url,
     pub db_config: SurrealDbConfig,
-    pub data_dir: String,
+    pub files_db_config: SurrealDbConfig,
     pub nostr_config: NostrConfig,
     pub mint_config: MintConfig,
     pub payment_config: PaymentConfig,
@@ -110,3 +122,101 @@ pub fn init(conf: Config) -> Result<()> {
 pub fn get_config() -> &'static Config {
     CONFIG.get().expect("E-Bill API is not initialized")
 }
+
+/// A container for all persistence related dependencies.
+#[derive(Clone)]
+pub struct DbContext {
+    pub contact_store: Arc<dyn ContactStoreApi>,
+    pub bill_store: Arc<dyn BillStoreApi>,
+    pub bill_blockchain_store: Arc<dyn BillChainStoreApi>,
+    pub identity_store: Arc<dyn IdentityStoreApi>,
+    pub identity_chain_store: Arc<dyn IdentityChainStoreApi>,
+    pub company_chain_store: Arc<dyn CompanyChainStoreApi>,
+    pub company_store: Arc<dyn CompanyStoreApi>,
+    pub file_upload_store: Arc<dyn FileUploadStoreApi>,
+    pub nostr_event_offset_store: Arc<dyn NostrEventOffsetStoreApi>,
+    pub notification_store: Arc<dyn NotificationStoreApi>,
+    pub email_notification_store: Arc<dyn EmailNotificationStoreApi>,
+    pub queued_message_store: Arc<dyn NostrQueuedMessageStoreApi>,
+    pub nostr_contact_store: Arc<dyn NostrContactStoreApi>,
+    pub mint_store: Arc<dyn MintStoreApi>,
+    pub nostr_chain_event_store: Arc<dyn NostrChainEventStoreApi>,
+    pub identity_proof_store: Arc<dyn IdentityProofStoreApi>,
+}
+
+/// Creates a new instance of the DbContext with the given SurrealDB configuration.
+pub async fn get_db_context(
+    #[allow(unused)] conf: &Config,
+) -> bcr_ebill_persistence::Result<DbContext> {
+    #[cfg(not(target_arch = "wasm32"))]
+    let db = get_surreal_db(&conf.db_config).await?;
+    #[cfg(not(target_arch = "wasm32"))]
+    let files_db = get_surreal_db(&conf.files_db_config).await?;
+    #[cfg(not(target_arch = "wasm32"))]
+    let surreal_wrapper = SurrealWrapper {
+        db: db.clone(),
+        files: false,
+    };
+
+    #[cfg(not(target_arch = "wasm32"))]
+    let files_surreal_wrapper = SurrealWrapper {
+        db: files_db.clone(),
+        files: true,
+    };
+
+    #[cfg(target_arch = "wasm32")]
+    let surreal_wrapper = SurrealWrapper { files: false };
+
+    #[cfg(target_arch = "wasm32")]
+    let files_surreal_wrapper = SurrealWrapper { files: true };
+
+    let company_store = Arc::new(SurrealCompanyStore::new(surreal_wrapper.clone()));
+    let file_upload_store = Arc::new(
+        bcr_ebill_persistence::db::file_upload::FileUploadStore::new(files_surreal_wrapper),
+    );
+
+    if let Err(e) = file_upload_store.cleanup_temp_uploads().await {
+        error!("Error cleaning up temp uploads: {e}");
+    }
+
+    let contact_store = Arc::new(SurrealContactStore::new(surreal_wrapper.clone()));
+
+    let bill_store = Arc::new(SurrealBillStore::new(surreal_wrapper.clone()));
+    let bill_blockchain_store = Arc::new(SurrealBillChainStore::new(surreal_wrapper.clone()));
+
+    let identity_store = Arc::new(SurrealIdentityStore::new(surreal_wrapper.clone()));
+    let identity_chain_store = Arc::new(SurrealIdentityChainStore::new(surreal_wrapper.clone()));
+    let identity_proof_store = Arc::new(SurrealIdentityProofStore::new(surreal_wrapper.clone()));
+    let company_chain_store = Arc::new(SurrealCompanyChainStore::new(surreal_wrapper.clone()));
+
+    let nostr_event_offset_store =
+        Arc::new(SurrealNostrEventOffsetStore::new(surreal_wrapper.clone()));
+    let notification_store = Arc::new(SurrealNotificationStore::new(surreal_wrapper.clone()));
+    let email_notification_store =
+        Arc::new(SurrealEmailNotificationStore::new(surreal_wrapper.clone()));
+
+    let queued_message_store = Arc::new(SurrealNostrEventQueueStore::new(surreal_wrapper.clone()));
+    let nostr_contact_store = Arc::new(SurrealNostrContactStore::new(surreal_wrapper.clone()));
+    let mint_store = Arc::new(SurrealMintStore::new(surreal_wrapper.clone()));
+    let nostr_chain_event_store =
+        Arc::new(SurrealNostrChainEventStore::new(surreal_wrapper.clone()));
+
+    Ok(DbContext {
+        contact_store,
+        bill_store,
+        bill_blockchain_store,
+        identity_store,
+        identity_chain_store,
+        company_chain_store,
+        company_store,
+        file_upload_store,
+        nostr_event_offset_store,
+        notification_store,
+        email_notification_store,
+        queued_message_store,
+        nostr_contact_store,
+        mint_store,
+        nostr_chain_event_store,
+        identity_proof_store,
+    })
+}