123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754 |
- //! Cashu Wallet
- use std::collections::{HashMap, HashSet};
- use std::str::FromStr;
- use bip39::Mnemonic;
- use cashu::dhke::{construct_proofs, unblind_message};
- #[cfg(feature = "nut07")]
- use cashu::nuts::nut07::ProofState;
- use cashu::nuts::{
- BlindedSignature, CurrencyUnit, Id, KeySetInfo, Keys, MintInfo, PreMintSecrets, PreSwap, Proof,
- Proofs, SwapRequest, Token,
- };
- #[cfg(feature = "nut07")]
- use cashu::secret::Secret;
- use cashu::types::{MeltQuote, Melted, MintQuote};
- use cashu::url::UncheckedUrl;
- use cashu::{Amount, Bolt11Invoice};
- use localstore::LocalStore;
- use thiserror::Error;
- use tracing::warn;
- use crate::client::Client;
- use crate::utils::unix_time;
- pub mod localstore;
- #[derive(Debug, Error)]
- pub enum Error {
- /// Insufficient Funds
- #[error("Insufficient Funds")]
- InsufficientFunds,
- #[error("`{0}`")]
- Cashu(#[from] cashu::error::wallet::Error),
- #[error("`{0}`")]
- Client(#[from] crate::client::Error),
- /// Cashu Url Error
- #[error("`{0}`")]
- CashuUrl(#[from] cashu::url::Error),
- #[error("Quote Expired")]
- QuoteExpired,
- #[error("Quote Unknown")]
- QuoteUnknown,
- #[error("`{0}`")]
- LocalStore(#[from] localstore::Error),
- #[error("`{0}`")]
- Custom(String),
- }
- #[derive(Clone, Debug)]
- pub struct BackupInfo {
- mnemonic: Mnemonic,
- counter: HashMap<Id, u64>,
- }
- #[derive(Clone, Debug)]
- pub struct Wallet<C: Client, L: LocalStore> {
- pub client: C,
- localstore: L,
- backup_info: Option<BackupInfo>,
- }
- impl<C: Client, L: LocalStore> Wallet<C, L> {
- pub async fn new(client: C, localstore: L, backup_info: Option<BackupInfo>) -> Self {
- Self {
- backup_info,
- client,
- localstore,
- }
- }
- /// Back up seed
- pub fn mnemonic(&self) -> Option<Mnemonic> {
- self.backup_info.clone().map(|b| b.mnemonic)
- }
- /// Back up keyset counters
- pub fn keyset_counters(&self) -> Option<HashMap<Id, u64>> {
- self.backup_info.clone().map(|b| b.counter)
- }
- pub async fn mint_balances(&self) -> Result<HashMap<UncheckedUrl, Amount>, Error> {
- let mints = self.localstore.get_mints().await?;
- let mut balances = HashMap::new();
- for (mint, _) in mints {
- if let Some(proofs) = self.localstore.get_proofs(mint.clone()).await? {
- let amount = proofs.iter().map(|p| p.amount).sum();
- balances.insert(mint, amount);
- } else {
- balances.insert(mint, Amount::ZERO);
- }
- }
- Ok(balances)
- }
- pub async fn get_proofs(&self, mint_url: UncheckedUrl) -> Result<Option<Proofs>, Error> {
- Ok(self.localstore.get_proofs(mint_url).await?)
- }
- pub async fn add_mint(&self, mint_url: UncheckedUrl) -> Result<Option<MintInfo>, Error> {
- let mint_info = match self
- .client
- .get_mint_info(mint_url.clone().try_into()?)
- .await
- {
- Ok(mint_info) => Some(mint_info),
- Err(err) => {
- warn!("Could not get mint info {}", err);
- None
- }
- };
- self.localstore
- .add_mint(mint_url, mint_info.clone())
- .await?;
- Ok(mint_info)
- }
- pub async fn get_mint_keys(
- &self,
- mint_url: &UncheckedUrl,
- keyset_id: Id,
- ) -> Result<Keys, Error> {
- let keys = if let Some(keys) = self.localstore.get_keys(&keyset_id).await? {
- keys
- } else {
- let keys = self
- .client
- .get_mint_keyset(mint_url.try_into()?, keyset_id)
- .await?;
- self.localstore.add_keys(keys.keys.clone()).await?;
- keys.keys
- };
- Ok(keys)
- }
- /// Check if a proof is spent
- #[cfg(feature = "nut07")]
- pub async fn check_proofs_spent(
- &self,
- mint_url: UncheckedUrl,
- proofs: Proofs,
- ) -> Result<Vec<ProofState>, Error> {
- let spendable = self
- .client
- .post_check_state(
- mint_url.try_into()?,
- proofs
- .clone()
- .into_iter()
- .map(|p| p.secret)
- .collect::<Vec<Secret>>()
- .clone(),
- )
- .await?;
- // Separate proofs in spent and unspent based on mint response
- Ok(spendable.states)
- }
- /*
- // TODO: This should be create token
- // the requited proofs for the token amount may already be in the wallet and mint is not needed
- // Mint a token
- pub async fn mint_token(
- &mut self,
- mint_url: UncheckedUrl,
- amount: Amount,
- memo: Option<String>,
- unit: Option<CurrencyUnit>,
- ) -> Result<Token, Error> {
- let quote = self
- .mint_quote(
- mint_url.clone(),
- amount,
- unit.clone()
- .ok_or(Error::Custom("Unit required".to_string()))?,
- )
- .await?;
- let proofs = self.mint(mint_url.clone(), "e.id).await?;
- let token = Token::new(mint_url.clone(), proofs, memo, unit);
- Ok(token?)
- }
- */
- /// Mint Quote
- pub async fn mint_quote(
- &mut self,
- mint_url: UncheckedUrl,
- amount: Amount,
- unit: CurrencyUnit,
- ) -> Result<MintQuote, Error> {
- let quote_res = self
- .client
- .post_mint_quote(mint_url.try_into()?, amount, unit.clone())
- .await?;
- let quote = MintQuote {
- id: quote_res.quote.clone(),
- amount,
- unit: unit.clone(),
- request: quote_res.request,
- paid: quote_res.paid,
- expiry: quote_res.expiry,
- };
- self.localstore.add_mint_quote(quote.clone()).await?;
- Ok(quote)
- }
- async fn active_mint_keyset(
- &mut self,
- mint_url: &UncheckedUrl,
- unit: &CurrencyUnit,
- ) -> Result<Option<Id>, Error> {
- if let Some(keysets) = self.localstore.get_mint_keysets(mint_url.clone()).await? {
- for keyset in keysets {
- if keyset.unit.eq(unit) && keyset.active {
- return Ok(Some(keyset.id));
- }
- }
- }
- let keysets = self.client.get_mint_keysets(mint_url.try_into()?).await?;
- self.localstore
- .add_mint_keysets(
- mint_url.clone(),
- keysets.keysets.clone().into_iter().collect(),
- )
- .await?;
- for keyset in &keysets.keysets {
- if keyset.unit.eq(unit) && keyset.active {
- return Ok(Some(keyset.id));
- }
- }
- Ok(None)
- }
- async fn active_keys(
- &mut self,
- mint_url: &UncheckedUrl,
- unit: &CurrencyUnit,
- ) -> Result<Option<Keys>, Error> {
- let active_keyset_id = self.active_mint_keyset(mint_url, unit).await?.unwrap();
- let keys;
- if let Some(k) = self.localstore.get_keys(&active_keyset_id).await? {
- keys = Some(k.clone())
- } else {
- let keyset = self
- .client
- .get_mint_keyset(mint_url.try_into()?, active_keyset_id)
- .await?;
- self.localstore.add_keys(keyset.keys.clone()).await?;
- keys = Some(keyset.keys);
- }
- Ok(keys)
- }
- /// Mint
- pub async fn mint(&mut self, mint_url: UncheckedUrl, quote_id: &str) -> Result<Amount, Error> {
- // Check that mint is in store of mints
- if self.localstore.get_mint(mint_url.clone()).await?.is_none() {
- self.add_mint(mint_url.clone()).await?;
- }
- let quote_info = self.localstore.get_mint_quote(quote_id).await?;
- let quote_info = if let Some(quote) = quote_info {
- if quote.expiry.le(&unix_time()) && quote.expiry.ne(&0) {
- return Err(Error::QuoteExpired);
- }
- quote.clone()
- } else {
- return Err(Error::QuoteUnknown);
- };
- let active_keyset_id = self
- .active_mint_keyset(&mint_url, "e_info.unit)
- .await?
- .unwrap();
- let premint_secrets = match &self.backup_info {
- Some(backup_info) => PreMintSecrets::from_seed(
- active_keyset_id,
- *backup_info.counter.get(&active_keyset_id).unwrap_or(&0),
- &backup_info.mnemonic,
- quote_info.amount,
- )?,
- None => PreMintSecrets::random(active_keyset_id, quote_info.amount)?,
- };
- let mint_res = self
- .client
- .post_mint(
- mint_url.clone().try_into()?,
- quote_id,
- premint_secrets.clone(),
- )
- .await?;
- let keys = self.get_mint_keys(&mint_url, active_keyset_id).await?;
- let proofs = construct_proofs(
- mint_res.signatures,
- premint_secrets.rs(),
- premint_secrets.secrets(),
- &keys,
- )?;
- let minted_amount = proofs.iter().map(|p| p.amount).sum();
- // Remove filled quote from store
- self.localstore.remove_mint_quote("e_info.id).await?;
- // Add new proofs to store
- self.localstore.add_proofs(mint_url, proofs).await?;
- Ok(minted_amount)
- }
- /// Receive
- pub async fn receive(&mut self, encoded_token: &str) -> Result<(), Error> {
- let token_data = Token::from_str(encoded_token)?;
- let unit = token_data.unit.unwrap_or_default();
- let mut proofs: HashMap<UncheckedUrl, Proofs> = HashMap::new();
- for token in token_data.token {
- if token.proofs.is_empty() {
- continue;
- }
- let active_keyset_id = self.active_mint_keyset(&token.mint, &unit).await?;
- // TODO: if none fetch keyset for mint
- let keys = self.localstore.get_keys(&active_keyset_id.unwrap()).await?;
- // Sum amount of all proofs
- let amount: Amount = token.proofs.iter().map(|p| p.amount).sum();
- let pre_swap = self
- .create_swap(&token.mint, &unit, Some(amount), token.proofs)
- .await?;
- let swap_response = self
- .client
- .post_swap(token.mint.clone().try_into()?, pre_swap.split_request)
- .await?;
- // Proof to keep
- let p = construct_proofs(
- swap_response.signatures,
- pre_swap.pre_mint_secrets.rs(),
- pre_swap.pre_mint_secrets.secrets(),
- &keys.unwrap(),
- )?;
- let mint_proofs = proofs.entry(token.mint).or_default();
- mint_proofs.extend(p);
- }
- for (mint, proofs) in proofs {
- self.localstore.add_proofs(mint, proofs).await?;
- }
- Ok(())
- }
- /// Create Split Payload
- async fn create_swap(
- &mut self,
- mint_url: &UncheckedUrl,
- unit: &CurrencyUnit,
- amount: Option<Amount>,
- proofs: Proofs,
- ) -> Result<PreSwap, Error> {
- // Since split is used to get the needed combination of tokens for a specific
- // amount first blinded messages are created for the amount
- let active_keyset_id = self.active_mint_keyset(mint_url, unit).await?.unwrap();
- let pre_mint_secrets = if let Some(amount) = amount {
- let mut desired_messages = PreMintSecrets::random(active_keyset_id, amount)?;
- let change_amount = proofs.iter().map(|p| p.amount).sum::<Amount>() - amount;
- let change_messages = PreMintSecrets::random(active_keyset_id, change_amount)?;
- // Combine the BlindedMessages totoalling the desired amount with change
- desired_messages.combine(change_messages);
- // Sort the premint secrets to avoid finger printing
- desired_messages.sort_secrets();
- desired_messages
- } else {
- let value = proofs.iter().map(|p| p.amount).sum();
- PreMintSecrets::random(active_keyset_id, value)?
- };
- let split_request = SwapRequest::new(proofs, pre_mint_secrets.blinded_messages());
- Ok(PreSwap {
- pre_mint_secrets,
- split_request,
- })
- }
- pub async fn process_swap_response(
- &self,
- blinded_messages: PreMintSecrets,
- promises: Vec<BlindedSignature>,
- ) -> Result<Proofs, Error> {
- let mut proofs = vec![];
- for (promise, premint) in promises.iter().zip(blinded_messages) {
- let a = self
- .localstore
- .get_keys(&promise.keyset_id)
- .await?
- .unwrap()
- .amount_key(promise.amount)
- .unwrap()
- .to_owned();
- let blinded_c = promise.c.clone();
- let unblinded_sig = unblind_message(blinded_c, premint.r.into(), a).unwrap();
- let proof = Proof {
- keyset_id: promise.keyset_id,
- amount: promise.amount,
- secret: premint.secret,
- c: unblinded_sig,
- };
- proofs.push(proof);
- }
- Ok(proofs)
- }
- /// Send
- pub async fn send(
- &mut self,
- mint_url: &UncheckedUrl,
- unit: &CurrencyUnit,
- amount: Amount,
- ) -> Result<Proofs, Error> {
- let proofs = self.select_proofs(mint_url.clone(), unit, amount).await?;
- let pre_swap = self
- .create_swap(mint_url, unit, Some(amount), proofs.clone())
- .await?;
- let swap_response = self
- .client
- .post_swap(mint_url.clone().try_into()?, pre_swap.split_request)
- .await?;
- let mut keep_proofs = Proofs::new();
- let mut send_proofs = Proofs::new();
- let mut post_swap_proofs = construct_proofs(
- swap_response.signatures,
- pre_swap.pre_mint_secrets.rs(),
- pre_swap.pre_mint_secrets.secrets(),
- &self.active_keys(mint_url, unit).await?.unwrap(),
- )?;
- post_swap_proofs.reverse();
- for proof in post_swap_proofs {
- if (proof.amount + send_proofs.iter().map(|p| p.amount).sum()).gt(&amount) {
- keep_proofs.push(proof);
- } else {
- send_proofs.push(proof);
- }
- }
- let send_amount: Amount = send_proofs.iter().map(|p| p.amount).sum();
- if send_amount.ne(&amount) {
- warn!(
- "Send amount proofs is {:?} expected {:?}",
- send_amount, amount
- );
- }
- self.localstore
- .remove_proofs(mint_url.clone(), &proofs)
- .await?;
- self.localstore
- .add_pending_proofs(mint_url.clone(), proofs)
- .await?;
- self.localstore
- .add_proofs(mint_url.clone(), keep_proofs)
- .await?;
- Ok(send_proofs)
- }
- /// Melt Quote
- pub async fn melt_quote(
- &mut self,
- mint_url: UncheckedUrl,
- unit: CurrencyUnit,
- request: String,
- ) -> Result<MeltQuote, Error> {
- let quote_res = self
- .client
- .post_melt_quote(
- mint_url.clone().try_into()?,
- unit.clone(),
- Bolt11Invoice::from_str(&request.clone()).unwrap(),
- )
- .await?;
- let quote = MeltQuote {
- id: quote_res.quote,
- amount: quote_res.amount.into(),
- request,
- unit,
- fee_reserve: quote_res.fee_reserve.into(),
- paid: quote_res.paid,
- expiry: quote_res.expiry,
- };
- self.localstore.add_melt_quote(quote.clone()).await?;
- Ok(quote)
- }
- // Select proofs
- async fn select_proofs(
- &self,
- mint_url: UncheckedUrl,
- unit: &CurrencyUnit,
- amount: Amount,
- ) -> Result<Proofs, Error> {
- let mint_proofs = self
- .localstore
- .get_proofs(mint_url.clone())
- .await?
- .ok_or(Error::InsufficientFunds)?;
- let mint_keysets = self.localstore.get_mint_keysets(mint_url).await?.unwrap();
- let (active, inactive): (HashSet<KeySetInfo>, HashSet<KeySetInfo>) = mint_keysets
- .into_iter()
- .filter(|p| p.unit.eq(unit))
- .partition(|x| x.active);
- let active: HashSet<Id> = active.iter().map(|k| k.id).collect();
- let inactive: HashSet<Id> = inactive.iter().map(|k| k.id).collect();
- let mut active_proofs: Proofs = Vec::new();
- let mut inactive_proofs: Proofs = Vec::new();
- for proof in mint_proofs {
- if active.contains(&proof.keyset_id) {
- active_proofs.push(proof);
- } else if inactive.contains(&proof.keyset_id) {
- inactive_proofs.push(proof);
- }
- }
- active_proofs.reverse();
- inactive_proofs.reverse();
- inactive_proofs.append(&mut active_proofs);
- let proofs = inactive_proofs;
- let mut selected_proofs: Proofs = Vec::new();
- for proof in proofs {
- if selected_proofs.iter().map(|p| p.amount).sum::<Amount>() < amount {
- selected_proofs.push(proof);
- }
- }
- if selected_proofs.iter().map(|p| p.amount).sum::<Amount>() < amount {
- return Err(Error::InsufficientFunds);
- }
- Ok(selected_proofs)
- }
- /// Melt
- pub async fn melt(&mut self, mint_url: &UncheckedUrl, quote_id: &str) -> Result<Melted, Error> {
- let quote_info = self.localstore.get_melt_quote(quote_id).await?;
- let quote_info = if let Some(quote) = quote_info {
- if quote.expiry.le(&unix_time()) {
- return Err(Error::QuoteExpired);
- }
- quote.clone()
- } else {
- return Err(Error::QuoteUnknown);
- };
- let proofs = self
- .select_proofs(mint_url.clone(), "e_info.unit, quote_info.amount)
- .await?;
- let proofs_amount = proofs.iter().map(|p| p.amount).sum();
- let blinded = PreMintSecrets::blank(
- self.active_mint_keyset(mint_url, "e_info.unit)
- .await?
- .unwrap(),
- proofs_amount,
- )?;
- let melt_response = self
- .client
- .post_melt(
- mint_url.clone().try_into()?,
- quote_id.to_string(),
- proofs.clone(),
- Some(blinded.blinded_messages()),
- )
- .await?;
- let change_proofs = match melt_response.change {
- Some(change) => Some(construct_proofs(
- change,
- blinded.rs(),
- blinded.secrets(),
- &self.active_keys(mint_url, "e_info.unit).await?.unwrap(),
- )?),
- None => None,
- };
- let melted = Melted {
- paid: true,
- preimage: melt_response.payment_preimage,
- change: change_proofs.clone(),
- };
- if let Some(change_proofs) = change_proofs {
- self.localstore
- .add_proofs(mint_url.clone(), change_proofs)
- .await?;
- }
- self.localstore.remove_melt_quote("e_info.id).await?;
- self.localstore
- .remove_proofs(mint_url.clone(), &proofs)
- .await?;
- Ok(melted)
- }
- pub fn proofs_to_token(
- &self,
- mint_url: UncheckedUrl,
- proofs: Proofs,
- memo: Option<String>,
- unit: Option<CurrencyUnit>,
- ) -> Result<String, Error> {
- Ok(Token::new(mint_url, proofs, memo, unit)?.to_string())
- }
- }
- /*
- #[cfg(test)]
- mod tests {
- use std::collections::{HashMap, HashSet};
- use super::*;
- use crate::client::Client;
- use crate::mint::Mint;
- use cashu::nuts::nut04;
- #[test]
- fn test_wallet() {
- let mut mint = Mint::new(
- "supersecretsecret",
- "0/0/0/0",
- HashMap::new(),
- HashSet::new(),
- 32,
- );
- let keys = mint.active_keyset_pubkeys();
- let client = Client::new("https://cashu-rs.thesimplekid.space/").unwrap();
- let wallet = Wallet::new(client, keys.keys);
- let blinded_messages = BlindedMessages::random(Amount::from_sat(64)).unwrap();
- let mint_request = nut04::MintRequest {
- outputs: blinded_messages.blinded_messages.clone(),
- };
- let res = mint.process_mint_request(mint_request).unwrap();
- let proofs = wallet
- .process_split_response(blinded_messages, res.promises)
- .unwrap();
- for proof in &proofs {
- mint.verify_proof(proof).unwrap();
- }
- let split = wallet.create_split(proofs.clone()).unwrap();
- let split_request = split.split_payload;
- let split_response = mint.process_split_request(split_request).unwrap();
- let p = split_response.promises;
- let snd_proofs = wallet
- .process_split_response(split.blinded_messages, p.unwrap())
- .unwrap();
- let mut error = false;
- for proof in &snd_proofs {
- if let Err(err) = mint.verify_proof(proof) {
- println!("{err}{:?}", serde_json::to_string(proof));
- error = true;
- }
- }
- if error {
- panic!()
- }
- }
- }
- */
|