Rename namespace validity constants to be more concise

The constants in `lightning::util::persist` are sufficiently long
that its often difficult eyeball their correctness which nearly led
to several bugs when adding async support.

Here we take the first step towards condensing them by making them
somewhat more concise, dropping words which are obvious from
context.

Author: TheBlueMatt

lightning-persister/src/test_utils.rs

@@ -5,7 +5,7 @@ use lightning::ln::functional_test_utils::{
 };
 use lightning::util::persist::{
 	migrate_kv_store_data, read_channel_monitors, KVStoreSync, MigratableKVStore,
-	KVSTORE_NAMESPACE_KEY_ALPHABET, KVSTORE_NAMESPACE_KEY_MAX_LEN,
+	NAMESPACE_ALPHABET, NAMESPACE_MAX_LEN,
 };
 use lightning::util::test_utils;
 use lightning::{check_added_monitors, check_closed_broadcast, check_closed_event};
@@ -46,8 +46,8 @@ pub(crate) fn do_read_write_remove_list_persist<K: KVStoreSync + RefUnwindSafe>(
 	assert_eq!(listed_keys.len(), 0);
 
 	// Ensure we have no issue operating with primary_namespace/secondary_namespace/key being
-	// KVSTORE_NAMESPACE_KEY_MAX_LEN
-	let max_chars = "A".repeat(KVSTORE_NAMESPACE_KEY_MAX_LEN);
+	// NAMESPACE_MAX_LEN
+	let max_chars = "A".repeat(NAMESPACE_MAX_LEN);
 	kv_store.write(&max_chars, &max_chars, &max_chars, data.clone()).unwrap();
 
 	let listed_keys = kv_store.list(&max_chars, &max_chars).unwrap();
@@ -76,17 +76,16 @@ pub(crate) fn do_test_data_migration<S: MigratableKVStore, T: MigratableKVStore>
 		let primary_namespace = if i == 0 {
 			String::new()
 		} else {
-			format!("testspace{}", KVSTORE_NAMESPACE_KEY_ALPHABET.chars().nth(i).unwrap())
+			format!("testspace{}", NAMESPACE_ALPHABET.chars().nth(i).unwrap())
 		};
 		for j in 0..num_secondary_namespaces {
 			let secondary_namespace = if i == 0 || j == 0 {
 				String::new()
 			} else {
-				format!("testsubspace{}", KVSTORE_NAMESPACE_KEY_ALPHABET.chars().nth(j).unwrap())
+				format!("testsubspace{}", NAMESPACE_ALPHABET.chars().nth(j).unwrap())
 			};
 			for k in 0..num_keys {
-				let key =
-					format!("testkey{}", KVSTORE_NAMESPACE_KEY_ALPHABET.chars().nth(k).unwrap());
+				let key = format!("testkey{}", NAMESPACE_ALPHABET.chars().nth(k).unwrap());
 				source_store
 					.write(&primary_namespace, &secondary_namespace, &key, dummy_data.clone())
 					.unwrap();

lightning-persister/src/utils.rs

@@ -1,9 +1,8 @@
 use lightning::types::string::PrintableString;
-use lightning::util::persist::{KVSTORE_NAMESPACE_KEY_ALPHABET, KVSTORE_NAMESPACE_KEY_MAX_LEN};
+use lightning::util::persist::{NAMESPACE_ALPHABET, NAMESPACE_MAX_LEN};
 
 pub(crate) fn is_valid_kvstore_str(key: &str) -> bool {
-	key.len() <= KVSTORE_NAMESPACE_KEY_MAX_LEN
-		&& key.chars().all(|c| KVSTORE_NAMESPACE_KEY_ALPHABET.contains(c))
+	key.len() <= NAMESPACE_MAX_LEN && key.chars().all(|c| NAMESPACE_ALPHABET.contains(c))
 }
 
 pub(crate) fn check_namespace_key_validity(

lightning/src/util/persist.rs

@@ -41,11 +41,11 @@ use crate::util::ser::{Readable, ReadableArgs, Writeable};
 use crate::util::wakers::Notifier;
 
 /// The alphabet of characters allowed for namespaces and keys.
-pub const KVSTORE_NAMESPACE_KEY_ALPHABET: &str =
+pub const NAMESPACE_ALPHABET: &str =
 	"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_-";
 
 /// The maximum number of characters namespaces and keys may have.
-pub const KVSTORE_NAMESPACE_KEY_MAX_LEN: usize = 120;
+pub const NAMESPACE_MAX_LEN: usize = 120;
 
 /// The primary namespace under which the [`ChannelManager`] will be persisted.
 ///
@@ -126,15 +126,14 @@ pub const MONITOR_UPDATING_PERSISTER_PREPEND_SENTINEL: &[u8] = &[0xFF; 2];
 /// ways, as long as per-namespace key uniqueness is asserted.
 ///
 /// Keys and namespaces are required to be valid ASCII strings in the range of
-/// [`KVSTORE_NAMESPACE_KEY_ALPHABET`] and no longer than [`KVSTORE_NAMESPACE_KEY_MAX_LEN`]. Empty
-/// primary namespaces and secondary namespaces (`""`) are assumed to be a valid, however, if
-/// `primary_namespace` is empty, `secondary_namespace` is required to be empty, too. This means
-/// that concerns should always be separated by primary namespace first, before secondary
-/// namespaces are used. While the number of primary namespaces will be relatively small and is
-/// determined at compile time, there may be many secondary namespaces per primary namespace. Note
-/// that per-namespace uniqueness needs to also hold for keys *and* namespaces in any given
-/// namespace, i.e., conflicts between keys and equally named
-/// primary namespaces/secondary namespaces must be avoided.
+/// [`NAMESPACE_ALPHABET`] and no longer than [`NAMESPACE_MAX_LEN`]. Empty primary namespaces and
+/// secondary namespaces (`""`) are assumed to be a valid, however, if `primary_namespace` is empty,
+/// `secondary_namespace` is required to be empty, too. This means that concerns should always be
+/// separated by primary namespace first, before secondary namespaces are used. While the number of
+/// primary namespaces will be relatively small and is determined at compile time, there may be many
+/// secondary namespaces per primary namespace. Note that per-namespace uniqueness needs to also
+/// hold for keys *and* namespaces in any given namespace, i.e., conflicts between keys and equally
+/// named primary namespaces/secondary namespaces must be avoided.
 ///
 /// **Note:** Users migrating custom persistence backends from the pre-v0.0.117 `KVStorePersister`
 /// interface can use a concatenation of `[{primary_namespace}/[{secondary_namespace}/]]{key}` to
@@ -255,15 +254,14 @@ where
 /// ways, as long as per-namespace key uniqueness is asserted.
 ///
 /// Keys and namespaces are required to be valid ASCII strings in the range of
-/// [`KVSTORE_NAMESPACE_KEY_ALPHABET`] and no longer than [`KVSTORE_NAMESPACE_KEY_MAX_LEN`]. Empty
-/// primary namespaces and secondary namespaces (`""`) are assumed to be a valid, however, if
-/// `primary_namespace` is empty, `secondary_namespace` is required to be empty, too. This means
-/// that concerns should always be separated by primary namespace first, before secondary
-/// namespaces are used. While the number of primary namespaces will be relatively small and is
-/// determined at compile time, there may be many secondary namespaces per primary namespace. Note
-/// that per-namespace uniqueness needs to also hold for keys *and* namespaces in any given
-/// namespace, i.e., conflicts between keys and equally named
-/// primary namespaces/secondary namespaces must be avoided.
+/// [`NAMESPACE_ALPHABET`] and no longer than [`NAMESPACE_MAX_LEN`]. Empty primary namespaces and
+/// secondary namespaces (`""`) are assumed to be a valid, however, if `primary_namespace` is
+/// empty, `secondary_namespace` is required to be empty, too. This means that concerns should
+/// always be separated by primary namespace first, before secondary namespaces are used. While the
+/// number of primary namespaces will be relatively small and is determined at compile time, there
+/// may be many secondary namespaces per primary namespace. Note that per-namespace uniqueness
+/// needs to also hold for keys *and* namespaces in any given namespace, i.e., conflicts between
+/// keys and equally named primary namespaces/secondary namespaces must be avoided.
 ///
 /// **Note:** Users migrating custom persistence backends from the pre-v0.0.117 `KVStorePersister`
 /// interface can use a concatenation of `[{primary_namespace}/[{secondary_namespace}/]]{key}` to