add mint state to bill (#523)

Author: zupzup

CHANGELOG.md

@@ -1,8 +1,11 @@
 # 0.3.13
 
-* Add default mint configuration options
-    * `default_mint_url`
-    * `default_mint_node_id`
+* Minting
+    * Add default mint configuration options
+        * `default_mint_url`
+        * `default_mint_node_id`
+    * Add minting status flag to bill
+    * Add endpoint to fetch minting status for a bill
 * Implement `request_to_mint`
 * Change bitcoin addresses and descriptor to p2wpkh
 * Suppress logging from crates we don't control

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

@@ -2,6 +2,7 @@ pub use bcr_ebill_core::bill;
 pub use bcr_ebill_core::company;
 pub use bcr_ebill_core::contact;
 pub use bcr_ebill_core::identity;
+pub use bcr_ebill_core::mint;
 pub use bcr_ebill_core::notification;
 
 pub use bcr_ebill_core::File;

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

@@ -3,6 +3,7 @@ use crate::util;
 use super::service::BillService;
 use super::{Error, Result};
 use bcr_ebill_core::ValidationError;
+use bcr_ebill_core::bill::BillMintStatus;
 use bcr_ebill_core::bill::validation::get_expiration_deadline_base_for_req_to_pay;
 use bcr_ebill_core::blockchain::bill::block::NodeId;
 use bcr_ebill_core::constants::RECOURSE_DEADLINE_SECONDS;
@@ -157,6 +158,10 @@ impl BillService {
             Some(ref endorsee) => endorsee,
         };
 
+        let has_mint_requests = self
+            .mint_store
+            .exists_for_bill(current_identity_node_id, &bill.id)
+            .await?;
         let mut paid = false;
         let mut requested_to_pay = false;
         let mut rejected_to_pay = false;
@@ -473,6 +478,7 @@ impl BillService {
                 request_to_recourse_timed_out,
                 rejected_request_to_recourse,
             },
+            mint: BillMintStatus { has_mint_requests },
             redeemed_funds_available,
             has_requested_funds,
         };

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

@@ -7,6 +7,7 @@ use crate::data::{
     },
     contact::BillParticipant,
     identity::{Identity, IdentityWithAll},
+    mint::MintRequestState,
 };
 use crate::util::BcrKeys;
 use async_trait::async_trait;
@@ -179,6 +180,14 @@ pub trait BillServiceApi: ServiceTraitBounds {
         current_identity_node_id: &str,
     ) -> Result<Vec<Endorsement>>;
 
+    /// Returns the mint state for a given bill
+    async fn get_mint_state(
+        &self,
+        bill_id: &str,
+        current_identity_node_id: &str,
+    ) -> Result<Vec<MintRequestState>>;
+
+    /// Clear the bill cache
     async fn clear_bill_cache(&self) -> Result<()>;
 }
 

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

@@ -36,7 +36,7 @@ use bcr_ebill_core::constants::{
 };
 use bcr_ebill_core::contact::{BillAnonParticipant, BillParticipant, Contact};
 use bcr_ebill_core::identity::{IdentityType, IdentityWithAll};
-use bcr_ebill_core::mint::MintRequestStatus;
+use bcr_ebill_core::mint::{MintRequestState, MintRequestStatus};
 use bcr_ebill_core::notification::ActionType;
 use bcr_ebill_core::util::currency;
 use bcr_ebill_core::{ServiceTraitBounds, Validate, ValidationError};
@@ -696,8 +696,8 @@ impl BillServiceApi for BillService {
             matches!(
                 rtm.status,
                 MintRequestStatus::Pending
-                    | MintRequestStatus::Offered { .. }
-                    | MintRequestStatus::Accepted { .. }
+                    | MintRequestStatus::Offered
+                    | MintRequestStatus::Accepted
             )
         }) {
             return Err(Error::Validation(
@@ -1100,6 +1100,24 @@ impl BillServiceApi for BillService {
         Ok(result)
     }
 
+    async fn get_mint_state(
+        &self,
+        bill_id: &str,
+        current_identity_node_id: &str,
+    ) -> Result<Vec<MintRequestState>> {
+        let requests = self
+            .mint_store
+            .get_requests_for_bill(current_identity_node_id, bill_id)
+            .await?;
+        Ok(requests
+            .into_iter()
+            .map(|req| MintRequestState {
+                request: req,
+                offer: None,
+            })
+            .collect())
+    }
+
     async fn clear_bill_cache(&self) -> Result<()> {
         self.store.clear_bill_cache().await?;
         Ok(())

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

@@ -19,8 +19,8 @@ use crate::{
 };
 use bcr_ebill_core::{
     bill::{
-        BillAcceptanceStatus, BillData, BillParticipants, BillPaymentStatus, BillRecourseStatus,
-        BillSellStatus, BillStatus,
+        BillAcceptanceStatus, BillData, BillMintStatus, BillParticipants, BillPaymentStatus,
+        BillRecourseStatus, BillSellStatus, BillStatus,
     },
     blockchain::{
         Blockchain,
@@ -131,6 +131,9 @@ pub fn get_baseline_cached_bill(id: String) -> BitcreditBillResult {
                 request_to_recourse_timed_out: false,
                 rejected_request_to_recourse: false,
             },
+            mint: BillMintStatus {
+                has_mint_requests: false,
+            },
             redeemed_funds_available: false,
             has_requested_funds: false,
         },
@@ -247,6 +250,9 @@ pub fn get_service(mut ctx: MockBillContext) -> BillService {
     ctx.identity_store
         .expect_get_full()
         .returning(|| Ok(get_baseline_identity()));
+    ctx.mint_store
+        .expect_exists_for_bill()
+        .returning(|_, _| Ok(false));
     BillService::new(
         Arc::new(ctx.bill_store),
         Arc::new(ctx.bill_blockchain_store),

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

@@ -58,12 +58,18 @@ pub mod tests {
 
         #[async_trait]
         impl MintStoreApi for MintStore {
+            async fn exists_for_bill(&self, requester_node_id: &str, bill_id: &str) -> Result<bool>;
             async fn get_requests(
                 &self,
                 requester_node_id: &str,
                 bill_id: &str,
                 mint_node_id: &str,
             ) -> Result<Vec<MintRequest>>;
+            async fn get_requests_for_bill(
+                &self,
+                requester_node_id: &str,
+                bill_id: &str,
+            ) -> Result<Vec<MintRequest>>;
             async fn add_request(
                 &self,
                 requester_node_id: &str,

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

@@ -175,6 +175,7 @@ pub struct BillStatus {
     pub payment: BillPaymentStatus,
     pub sell: BillSellStatus,
     pub recourse: BillRecourseStatus,
+    pub mint: BillMintStatus,
     pub redeemed_funds_available: bool,
     pub has_requested_funds: bool,
 }
@@ -215,6 +216,11 @@ pub struct BillRecourseStatus {
     pub rejected_request_to_recourse: bool,
 }
 
+#[derive(Debug, Clone)]
+pub struct BillMintStatus {
+    pub has_mint_requests: bool,
+}
+
 #[derive(Debug, Clone)]
 pub struct BillData {
     pub language: String,

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

@@ -1,26 +1,46 @@
+/// A request to mint
 #[derive(Debug, Clone)]
 pub struct MintRequest {
+    /// The requester
     pub requester_node_id: String,
+    /// The bill to request to mint
     pub bill_id: String,
+    /// The mint to be requested against
     pub mint_node_id: String,
+    /// The id returned from the mint
     pub mint_request_id: String,
+    /// The time of the request
     pub timestamp: u64,
+    /// The status of the request to mint
     pub status: MintRequestStatus,
 }
 
 #[derive(Debug, Clone)]
 pub enum MintRequestStatus {
+    /// Waiting for an answer from the mint
     Pending,
+    /// Denied by the mint
     Denied,
-    Offered {
-        keyset_id: String,
-        expiration_timestamp: u64,
-        discounted: u64,
-    },
-    Accepted {
-        keyset_id: String,
-    },
-    Rejected {
-        timestamp: u64,
-    },
+    /// Offer was made
+    Offered,
+    /// Offer was accepted
+    Accepted,
+    /// The offer was rejected by the requester
+    Rejected,
+    /// The request was cancelled by the requester
+    Cancelled,
+    /// The offer expired
+    Expired,
+}
+
+/// An offer from a mint as a response to a request to mint
+#[derive(Debug, Clone)]
+pub struct MintOffer {}
+
+#[derive(Debug, Clone)]
+pub struct MintRequestState {
+    /// There always is a request
+    pub request: MintRequest,
+    /// There might be an offer
+    pub offer: Option<MintOffer>,
 }

crates/bcr-ebill-persistence/src/db/bill.rs

@@ -1,14 +1,14 @@
 use std::collections::HashSet;
 
 use super::surreal::{Bindings, SurrealWrapper};
-use super::{FileDb, PostalAddressDb, Result};
+use super::{BillIdDb, FileDb, PostalAddressDb, Result};
 use crate::constants::{DB_BILL_ID, DB_IDS, DB_OP_CODE, DB_TABLE, DB_TIMESTAMP};
 use crate::{Error, bill::BillStoreApi};
 use async_trait::async_trait;
 use bcr_ebill_core::ServiceTraitBounds;
 use bcr_ebill_core::bill::{
-    BillAcceptanceStatus, BillCurrentWaitingState, BillData, BillParticipants, BillPaymentStatus,
-    BillRecourseStatus, BillSellStatus, BillStatus, BillWaitingForPaymentState,
+    BillAcceptanceStatus, BillCurrentWaitingState, BillData, BillMintStatus, BillParticipants,
+    BillPaymentStatus, BillRecourseStatus, BillSellStatus, BillStatus, BillWaitingForPaymentState,
     BillWaitingForRecourseState, BillWaitingForSellState, BitcreditBillResult,
 };
 use bcr_ebill_core::constants::{PAYMENT_DEADLINE_SECONDS, RECOURSE_DEADLINE_SECONDS};
@@ -445,6 +445,7 @@ pub struct BillStatusDb {
     pub payment: BillPaymentStatusDb,
     pub sell: BillSellStatusDb,
     pub recourse: BillRecourseStatusDb,
+    pub mint: BillMintStatusDb,
     pub redeemed_funds_available: bool,
     pub has_requested_funds: bool,
 }
@@ -456,6 +457,7 @@ impl From<BillStatusDb> for BillStatus {
             payment: value.payment.into(),
             sell: value.sell.into(),
             recourse: value.recourse.into(),
+            mint: value.mint.into(),
             redeemed_funds_available: value.redeemed_funds_available,
             has_requested_funds: value.has_requested_funds,
         }
@@ -469,6 +471,7 @@ impl From<&BillStatus> for BillStatusDb {
             payment: (&value.payment).into(),
             sell: (&value.sell).into(),
             recourse: (&value.recourse).into(),
+            mint: (&value.mint).into(),
             redeemed_funds_available: value.redeemed_funds_available,
             has_requested_funds: value.has_requested_funds,
         }
@@ -607,6 +610,27 @@ impl From<&BillRecourseStatus> for BillRecourseStatusDb {
     }
 }
 
+#[derive(Debug, Clone, Serialize, Deserialize)]
+pub struct BillMintStatusDb {
+    pub has_mint_requests: bool,
+}
+
+impl From<BillMintStatusDb> for BillMintStatus {
+    fn from(value: BillMintStatusDb) -> Self {
+        Self {
+            has_mint_requests: value.has_mint_requests,
+        }
+    }
+}
+
+impl From<&BillMintStatus> for BillMintStatusDb {
+    fn from(value: &BillMintStatus) -> Self {
+        Self {
+            has_mint_requests: value.has_mint_requests,
+        }
+    }
+}
+
 #[derive(Debug, Clone, Serialize, Deserialize)]
 pub struct BillDataDb {
     pub language: String,
@@ -783,11 +807,6 @@ pub struct BillPaidDb {
     pub payment_address: String,
 }
 
-#[derive(Debug, Clone, Serialize, Deserialize)]
-pub struct BillIdDb {
-    pub bill_id: String,
-}
-
 #[derive(Debug, Clone, Serialize, Deserialize)]
 pub struct BillKeysDb {
     #[serde(skip_serializing_if = "Option::is_none")]