read wallet config from KVStore instead of files

Author: dcorral

lightning/src/rgb_utils/mod.rs

@@ -33,24 +33,23 @@ use tokio::runtime::Handle;
 use crate::io;
 use core::ops::Deref;
 use std::collections::HashMap;
-use std::fs;
-use std::path::{Path, PathBuf};
+use std::path::Path;
 use std::str::FromStr;
 use std::sync::Arc;
 
 /// Static blinding constant (will be removed in the future)
 pub const STATIC_BLINDING: u64 = 777;
-/// Name of the file containing the bitcoin network
+/// KVStore key for the bitcoin network
 pub const BITCOIN_NETWORK_FNAME: &str = "bitcoin_network";
-/// Name of the file containing the electrum URL
+/// KVStore key for the electrum URL
 pub const INDEXER_URL_FNAME: &str = "indexer_url";
-/// Name of the file containing the wallet fingerprint
+/// KVStore key for the wallet fingerprint
 pub const WALLET_FINGERPRINT_FNAME: &str = "wallet_fingerprint";
-/// Name of the file containing the account-level xPub of the vanilla-side of the wallet
+/// KVStore key for the account-level xPub of the vanilla-side of the wallet
 pub const WALLET_ACCOUNT_XPUB_VANILLA_FNAME: &str = "wallet_account_xpub_vanilla";
-/// Name of the file containing the account-level xPub of the colored-side of the wallet
+/// KVStore key for the account-level xPub of the colored-side of the wallet
 pub const WALLET_ACCOUNT_XPUB_COLORED_FNAME: &str = "wallet_account_xpub_colored";
-/// Name of the file containing the master fingerprint of the wallet
+/// KVStore key for the master fingerprint of the wallet
 pub const WALLET_MASTER_FINGERPRINT_FNAME: &str = "wallet_master_fingerprint";
 const VANILLA_SYNC_LOOKBACK: u32 = 20;
 
@@ -69,6 +68,8 @@ pub const RGB_PAYMENT_INFO_OUTBOUND_NS: &str = "payment_info_outbound";
 pub const RGB_TRANSFER_INFO_NS: &str = "transfer_info";
 /// Secondary namespace for consignment data
 pub const RGB_CONSIGNMENT_NS: &str = "consignment";
+/// Secondary namespace for wallet config values
+pub const RGB_WALLET_CONFIG_NS: &str = "wallet_config";
 
 /// RGB channel info
 #[derive(Debug, Clone, Deserialize, Serialize)]
@@ -136,38 +137,32 @@ mod contract_id_serde {
 	}
 }
 
-fn _get_file_in_parent(ldk_data_dir: &Path, fname: &str) -> PathBuf {
-	ldk_data_dir.parent().unwrap().join(fname)
-}
-
-fn _read_file_in_parent(ldk_data_dir: &Path, fname: &str) -> String {
-	fs::read_to_string(_get_file_in_parent(ldk_data_dir, fname)).unwrap()
-}
-
-fn _get_rgb_wallet_dir(ldk_data_dir: &Path) -> PathBuf {
-	let fingerprint = _read_file_in_parent(ldk_data_dir, WALLET_FINGERPRINT_FNAME);
-	_get_file_in_parent(ldk_data_dir, &fingerprint)
-}
-
-fn _get_bitcoin_network(ldk_data_dir: &Path) -> BitcoinNetwork {
-	let bitcoin_network = _read_file_in_parent(ldk_data_dir, BITCOIN_NETWORK_FNAME);
+fn _get_bitcoin_network(kv_store: &dyn KVStoreSync) -> BitcoinNetwork {
+	let bitcoin_network =
+		kv_store.read_config(BITCOIN_NETWORK_FNAME).expect("bitcoin_network must be in KVStore");
 	BitcoinNetwork::from_str(&bitcoin_network).unwrap()
 }
 
-fn _get_account_xpub_colored(ldk_data_dir: &Path) -> String {
-	_read_file_in_parent(ldk_data_dir, WALLET_ACCOUNT_XPUB_COLORED_FNAME)
+fn _get_account_xpub_colored(kv_store: &dyn KVStoreSync) -> String {
+	kv_store
+		.read_config(WALLET_ACCOUNT_XPUB_COLORED_FNAME)
+		.expect("wallet_account_xpub_colored must be in KVStore")
 }
 
-fn _get_account_xpub_vanilla(ldk_data_dir: &Path) -> String {
-	_read_file_in_parent(ldk_data_dir, WALLET_ACCOUNT_XPUB_VANILLA_FNAME)
+fn _get_account_xpub_vanilla(kv_store: &dyn KVStoreSync) -> String {
+	kv_store
+		.read_config(WALLET_ACCOUNT_XPUB_VANILLA_FNAME)
+		.expect("wallet_account_xpub_vanilla must be in KVStore")
 }
 
-fn _get_master_fingerprint(ldk_data_dir: &Path) -> String {
-	_read_file_in_parent(ldk_data_dir, WALLET_MASTER_FINGERPRINT_FNAME)
+fn _get_master_fingerprint(kv_store: &dyn KVStoreSync) -> String {
+	kv_store
+		.read_config(WALLET_MASTER_FINGERPRINT_FNAME)
+		.expect("wallet_master_fingerprint must be in KVStore")
 }
 
-fn _get_indexer_url(ldk_data_dir: &Path) -> String {
-	_read_file_in_parent(ldk_data_dir, INDEXER_URL_FNAME)
+fn _get_indexer_url(kv_store: &dyn KVStoreSync) -> String {
+	kv_store.read_config(INDEXER_URL_FNAME).expect("indexer_url must be in KVStore")
 }
 
 fn _new_rgb_wallet(
@@ -200,18 +195,20 @@ fn _new_rgb_wallet(
 	.expect("valid rgb-lib wallet")
 }
 
-fn _get_wallet_data(ldk_data_dir: &Path) -> (String, BitcoinNetwork, String, String, String) {
+fn _get_wallet_data(
+	ldk_data_dir: &Path, kv_store: &dyn KVStoreSync,
+) -> (String, BitcoinNetwork, String, String, String) {
 	let data_dir = ldk_data_dir.parent().unwrap().to_string_lossy().to_string();
-	let bitcoin_network = _get_bitcoin_network(ldk_data_dir);
-	let account_xpub_vanilla = _get_account_xpub_vanilla(ldk_data_dir);
-	let account_xpub_colored = _get_account_xpub_colored(ldk_data_dir);
-	let master_fingerprint = _get_master_fingerprint(ldk_data_dir);
+	let bitcoin_network = _get_bitcoin_network(kv_store);
+	let account_xpub_vanilla = _get_account_xpub_vanilla(kv_store);
+	let account_xpub_colored = _get_account_xpub_colored(kv_store);
+	let master_fingerprint = _get_master_fingerprint(kv_store);
 	(data_dir, bitcoin_network, account_xpub_vanilla, account_xpub_colored, master_fingerprint)
 }
 
-async fn _get_rgb_wallet(ldk_data_dir: &Path) -> Wallet {
+async fn _get_rgb_wallet(ldk_data_dir: &Path, kv_store: &dyn KVStoreSync) -> Wallet {
 	let (data_dir, bitcoin_network, account_xpub_vanilla, account_xpub_colored, master_fingerprint) =
-		_get_wallet_data(ldk_data_dir);
+		_get_wallet_data(ldk_data_dir, kv_store);
 	tokio::task::spawn_blocking(move || {
 		_new_rgb_wallet(
 			data_dir,
@@ -227,11 +224,12 @@ async fn _get_rgb_wallet(ldk_data_dir: &Path) -> Wallet {
 
 async fn _accept_transfer(
 	ldk_data_dir: &Path, funding_txid: String, consignment_endpoint: RgbTransport,
+	kv_store: &dyn KVStoreSync,
 ) -> Result<(RgbTransfer, Vec<Assignment>), RgbLibError> {
 	let funding_vout = 1;
 	let (data_dir, bitcoin_network, account_xpub_vanilla, account_xpub_colored, master_fingerprint) =
-		_get_wallet_data(ldk_data_dir);
-	let indexer_url = _get_indexer_url(ldk_data_dir);
+		_get_wallet_data(ldk_data_dir, kv_store);
+	let indexer_url = _get_indexer_url(kv_store);
 	tokio::task::spawn_blocking(move || {
 		let mut wallet = _new_rgb_wallet(
 			data_dir,
@@ -405,7 +403,7 @@ where
 	let mut psbt = RgbLibPsbt::from_str(&psbt.to_string()).unwrap();
 	let handle = Handle::current();
 	let _ = handle.enter();
-	let wallet = futures::executor::block_on(_get_rgb_wallet(ldk_data_dir));
+	let wallet = futures::executor::block_on(_get_rgb_wallet(ldk_data_dir, kv_store));
 	let (fascia, _) = wallet.color_psbt(&mut psbt, coloring_info).unwrap();
 	let psbt = Psbt::from_str(&psbt.to_string()).unwrap();
 	let modified_tx = match psbt.extract_tx() {
@@ -459,7 +457,7 @@ pub(crate) fn color_htlc(
 	let mut psbt = RgbLibPsbt::from_str(&psbt.to_string()).unwrap();
 	let handle = Handle::current();
 	let _ = handle.enter();
-	let wallet = futures::executor::block_on(_get_rgb_wallet(ldk_data_dir));
+	let wallet = futures::executor::block_on(_get_rgb_wallet(ldk_data_dir, kv_store));
 	let (fascia, _) = wallet.color_psbt(&mut psbt, coloring_info).unwrap();
 	let psbt = Psbt::from_str(&psbt.to_string()).unwrap();
 	let modified_tx = match psbt.extract_tx() {
@@ -521,7 +519,7 @@ pub(crate) fn color_closing(
 	let mut psbt = RgbLibPsbt::from_str(&psbt.to_string()).unwrap();
 	let handle = Handle::current();
 	let _ = handle.enter();
-	let wallet = futures::executor::block_on(_get_rgb_wallet(ldk_data_dir));
+	let wallet = futures::executor::block_on(_get_rgb_wallet(ldk_data_dir, kv_store));
 	let (fascia, _) = wallet.color_psbt(&mut psbt, coloring_info).unwrap();
 	let psbt = Psbt::from_str(&psbt.to_string()).unwrap();
 	let modified_tx = match psbt.extract_tx() {
@@ -613,6 +611,7 @@ pub(crate) fn handle_funding(
 		ldk_data_dir,
 		funding_txid.clone(),
 		consignment_endpoint,
+		kv_store,
 	));
 	let (consignment, remote_rgb_assignments) = match accept_res {
 		Ok(res) => res,
@@ -737,6 +736,10 @@ pub trait RgbKvStoreExt {
 	fn filter_first_hops(
 		&self, payment_hash: &PaymentHash, first_hops: &mut Vec<ChannelDetails>,
 	) -> (ContractId, u64);
+	/// read a wallet config value from KVStore
+	fn read_config(&self, key: &str) -> Result<String, io::Error>;
+	/// write a wallet config value to KVStore
+	fn write_config(&self, key: &str, value: &str);
 }
 
 impl<K: KVStoreSync + ?Sized> RgbKvStoreExt for K {
@@ -834,4 +837,14 @@ impl<K: KVStoreSync + ?Sized> RgbKvStoreExt for K {
 		});
 		(contract_id, rgb_amount)
 	}
+
+	fn read_config(&self, key: &str) -> Result<String, io::Error> {
+		let data = self.read(RGB_PRIMARY_NS, RGB_WALLET_CONFIG_NS, key)?;
+		String::from_utf8(data).map_err(|e| io::Error::new(io::ErrorKind::InvalidData, e))
+	}
+
+	fn write_config(&self, key: &str, value: &str) {
+		self.write(RGB_PRIMARY_NS, RGB_WALLET_CONFIG_NS, key, value.as_bytes().to_vec())
+			.expect("KVStore write failed");
+	}
 }