add blossom client (#536)

Author: zupzup

CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.3.15
+
+* Upload and download files to and from Nostr using Blossom
+
 # 0.3.14
 
 * Minting

Cargo.toml

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

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

@@ -64,7 +64,9 @@ pub trait BitcoinClientApi: ServiceTraitBounds {
 }
 
 #[derive(Clone)]
-pub struct BitcoinClient;
+pub struct BitcoinClient {
+    cl: reqwest::Client,
+}
 
 impl ServiceTraitBounds for BitcoinClient {}
 
@@ -73,7 +75,9 @@ impl ServiceTraitBounds for MockBitcoinClientApi {}
 
 impl BitcoinClient {
     pub fn new() -> Self {
-        Self {}
+        Self {
+            cl: reqwest::Client::new(),
+        }
     }
 
     pub fn request_url(&self, path: &str) -> String {
@@ -117,7 +121,10 @@ impl Default for BitcoinClient {
 #[cfg_attr(not(target_arch = "wasm32"), async_trait)]
 impl BitcoinClientApi for BitcoinClient {
     async fn get_address_info(&self, address: &str) -> Result<AddressInfo> {
-        let address: AddressInfo = reqwest::get(&self.request_url(&format!("/address/{address}")))
+        let address: AddressInfo = self
+            .cl
+            .get(self.request_url(&format!("/address/{address}")))
+            .send()
             .await
             .map_err(Error::from)?
             .json()
@@ -128,19 +135,24 @@ impl BitcoinClientApi for BitcoinClient {
     }
 
     async fn get_transactions(&self, address: &str) -> Result<Transactions> {
-        let transactions: Transactions =
-            reqwest::get(&self.request_url(&format!("/address/{address}/txs")))
-                .await
-                .map_err(Error::from)?
-                .json()
-                .await
-                .map_err(Error::from)?;
+        let transactions: Transactions = self
+            .cl
+            .get(self.request_url(&format!("/address/{address}/txs")))
+            .send()
+            .await
+            .map_err(Error::from)?
+            .json()
+            .await
+            .map_err(Error::from)?;
 
         Ok(transactions)
     }
 
     async fn get_last_block_height(&self) -> Result<u64> {
-        let height: u64 = reqwest::get(&self.request_url("/blocks/tip/height"))
+        let height: u64 = self
+            .cl
+            .get(self.request_url("/blocks/tip/height"))
+            .send()
             .await?
             .json()
             .await?;

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

@@ -0,0 +1,117 @@
+use std::io::Write;
+
+use async_trait::async_trait;
+use bcr_ebill_core::ServiceTraitBounds;
+use nostr::hashes::{
+    Hash,
+    sha256::{self, Hash as Sha256Hash},
+};
+use serde::Deserialize;
+use thiserror::Error;
+
+/// Generic result type
+pub type Result<T> = std::result::Result<T, super::Error>;
+
+/// Generic error type
+#[derive(Debug, Error)]
+pub enum Error {
+    /// all errors originating from interacting with the web api
+    #[error("External File Storage Web API error: {0}")]
+    Api(#[from] reqwest::Error),
+    /// all errors originating from invalid urls
+    #[error("External File Storage Invalid Relay Url Error")]
+    InvalidRelayUrl,
+    /// all errors originating from invalid hashes
+    #[error("External File Storage Invalid Hash")]
+    InvalidHash,
+    /// all errors originating from hashing
+    #[error("External File Storage Hash Error")]
+    Hash,
+}
+
+#[cfg(test)]
+use mockall::automock;
+
+#[cfg_attr(test, automock)]
+#[cfg_attr(target_arch = "wasm32", async_trait(?Send))]
+#[cfg_attr(not(target_arch = "wasm32"), async_trait)]
+pub trait FileStorageClientApi: ServiceTraitBounds {
+    /// Upload the given bytes, checking and returning the nostr_hash
+    async fn upload(&self, relay_url: &str, bytes: Vec<u8>) -> Result<Sha256Hash>;
+    /// Download the bytes with the given nostr_hash and compare if the hash matches the file
+    async fn download(&self, relay_url: &str, nostr_hash: &str) -> Result<Vec<u8>>;
+}
+
+#[derive(Debug, Clone, Default)]
+pub struct FileStorageClient {
+    cl: reqwest::Client,
+}
+
+impl ServiceTraitBounds for FileStorageClient {}
+
+#[cfg(test)]
+impl ServiceTraitBounds for MockFileStorageClientApi {}
+
+impl FileStorageClient {
+    pub fn new() -> Self {
+        Self {
+            cl: reqwest::Client::new(),
+        }
+    }
+}
+
+#[cfg_attr(target_arch = "wasm32", async_trait(?Send))]
+#[cfg_attr(not(target_arch = "wasm32"), async_trait)]
+impl FileStorageClientApi for FileStorageClient {
+    async fn upload(&self, relay_url: &str, bytes: Vec<u8>) -> Result<Sha256Hash> {
+        // Calculate hash to compare with the hash we get back
+        let mut hash_engine = sha256::HashEngine::default();
+        if hash_engine.write_all(&bytes).is_err() {
+            return Err(Error::Hash.into());
+        }
+        let hash = sha256::Hash::from_engine(hash_engine);
+
+        // PUT {relay_url}/upload
+        let url = reqwest::Url::parse(relay_url)
+            .and_then(|url| url.join("upload"))
+            .map_err(|_| Error::InvalidRelayUrl)?;
+        // Make upload request
+        let resp: BlobDescriptorReply = self.cl.put(url).body(bytes).send().await?.json().await?;
+        let nostr_hash = resp.sha256;
+
+        // Check hash
+        if hash != nostr_hash {
+            return Err(Error::InvalidHash.into());
+        }
+
+        Ok(nostr_hash)
+    }
+
+    async fn download(&self, relay_url: &str, nostr_hash: &str) -> Result<Vec<u8>> {
+        // GET {relay_url}/{hash}
+        let url = reqwest::Url::parse(relay_url)
+            .and_then(|url| url.join(nostr_hash))
+            .map_err(|_| Error::InvalidRelayUrl)?;
+        // Make download request
+        let resp: Vec<u8> = self.cl.get(url).send().await?.bytes().await?.into();
+
+        // Calculate hash to compare with the hash we sent
+        let mut hash_engine = sha256::HashEngine::default();
+        if hash_engine.write_all(&resp).is_err() {
+            return Err(Error::Hash.into());
+        }
+
+        // Check hash
+        let hash = sha256::Hash::from_engine(hash_engine);
+        if hash.to_string() != nostr_hash {
+            return Err(Error::InvalidHash.into());
+        }
+
+        Ok(resp)
+    }
+}
+
+#[derive(Debug, Clone, Deserialize)]
+pub struct BlobDescriptorReply {
+    sha256: Sha256Hash,
+}

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

@@ -1,4 +1,5 @@
 pub mod bitcoin;
+pub mod file_storage;
 pub mod mint;
 pub mod time;
 
@@ -18,4 +19,8 @@ pub enum Error {
     /// all errors originating from the external mint API
     #[error("External Mint API error: {0}")]
     ExternalMintApi(#[from] mint::Error),
+
+    /// all errors originating from the external file storage API
+    #[error("External File Storage API error: {0}")]
+    ExternalFileStorageApi(#[from] file_storage::Error),
 }

crates/bcr-ebill-wasm/main.js

@@ -48,6 +48,7 @@ let config = {
   bitcoin_network: "testnet",
   esplora_base_url: "https://esplora.minibill.tech",
   nostr_relays: ["wss://bitcr-cloud-run-05-550030097098.europe-west1.run.app"],
+  // nostr_relays: ["ws://localhost:8080"],
   // if set to true we will drop DMs from nostr that we don't have in contacts
   nostr_only_known_contacts: false,
   job_runner_initial_delay_seconds: 1,