known_values/
known_values_registry.rs

1use std::sync::{Mutex, Once};
2
3use paste::paste;
4
5use super::KnownValuesStore;
6
7/// A macro that declares a known value at compile time.
8///
9/// This macro creates two constants:
10/// - A raw u64 value constant with the suffix `_RAW`
11/// - A KnownValue constant with the given name and value
12///
13/// This is used internally to define all the standard Known Values in the
14/// registry.
15///
16/// # Examples
17///
18/// ```
19/// use known_values::*;
20/// use paste::paste;
21///
22/// // Define a custom known value
23/// const_known_value!(1000, MY_CUSTOM_VALUE, "myCustomValue");
24///
25/// // Now MY_CUSTOM_VALUE is a constant KnownValue
26/// assert_eq!(MY_CUSTOM_VALUE.value(), 1000);
27/// assert_eq!(MY_CUSTOM_VALUE.name(), "myCustomValue");
28///
29/// paste! {
30///     // MY_CUSTOM_VALUE_RAW is the raw u64 value
31///     assert_eq!([<MY_CUSTOM_VALUE _RAW>], 1000);
32/// }
33/// ```
34#[macro_export]
35macro_rules! const_known_value {
36    ($value:expr, $const_name:ident, $name:expr) => {
37        paste! {
38            pub const [<$const_name _RAW>]: u64 = $value;
39        }
40        pub const $const_name: $crate::KnownValue =
41            $crate::KnownValue::new_with_static_name($value, $name);
42    };
43}
44
45// For definitions see: https://github.com/BlockchainCommons/Research/blob/master/papers/bcr-2023-002-known-value.md#appendix-a-registry
46
47//
48// General
49//
50
51const_known_value!(0, UNIT, "");
52const_known_value!(1, IS_A, "isA");
53const_known_value!(2, ID, "id");
54const_known_value!(3, SIGNED, "signed");
55const_known_value!(4, NOTE, "note");
56const_known_value!(5, HAS_RECIPIENT, "hasRecipient");
57const_known_value!(6, SSKR_SHARE, "sskrShare");
58const_known_value!(7, CONTROLLER, "controller");
59const_known_value!(8, KEY, "key");
60const_known_value!(9, DEREFERENCE_VIA, "dereferenceVia");
61const_known_value!(10, ENTITY, "entity");
62const_known_value!(11, NAME, "name");
63const_known_value!(12, LANGUAGE, "language");
64const_known_value!(13, ISSUER, "issuer");
65const_known_value!(14, HOLDER, "holder");
66const_known_value!(15, SALT, "salt");
67const_known_value!(16, DATE, "date");
68const_known_value!(17, UNKNOWN_VALUE, "Unknown");
69const_known_value!(18, VERSION_VALUE, "version");
70const_known_value!(19, HAS_SECRET, "hasSecret");
71const_known_value!(20, DIFF_EDITS, "edits");
72const_known_value!(21, VALID_FROM, "validFrom");
73const_known_value!(22, VALID_UNTIL, "validUntil");
74const_known_value!(23, POSITION, "position");
75const_known_value!(24, NICKNAME, "nickname");
76// 25-49 *unassigned*
77
78//
79// Attachments
80//
81
82const_known_value!(50, ATTACHMENT, "attachment");
83const_known_value!(51, VENDOR, "vendor");
84const_known_value!(52, CONFORMS_TO, "conformsTo");
85// 53-59 *unassigned*
86
87//
88// XID Documents
89//
90
91const_known_value!(60, ALLOW, "allow");
92const_known_value!(61, DENY, "deny");
93const_known_value!(62, ENDPOINT, "endpoint");
94const_known_value!(63, DELEGATE, "delegate");
95const_known_value!(64, PROVENANCE, "provenance");
96const_known_value!(65, PRIVATE_KEY, "privateKey");
97const_known_value!(66, SERVICE, "service");
98const_known_value!(67, CAPABILITY, "capability");
99const_known_value!(68, PROVENANCE_GENERATOR, "provenanceGenerator");
100// 68-69 *unassigned*
101
102//
103// XID Privileges
104//
105
106const_known_value!(70, PRIVILEGE_ALL, "All");
107const_known_value!(71, PRIVILEGE_AUTH, "Auth");
108const_known_value!(72, PRIVILEGE_SIGN, "Sign");
109const_known_value!(73, PRIVILEGE_ENCRYPT, "Encrypt");
110const_known_value!(74, PRIVILEGE_ELIDE, "Elide");
111const_known_value!(75, PRIVILEGE_ISSUE, "Issue");
112const_known_value!(76, PRIVILEGE_ACCESS, "Access");
113// 77-79 *unassigned*
114const_known_value!(80, PRIVILEGE_DELEGATE, "Delegate");
115const_known_value!(81, PRIVILEGE_VERIFY, "Verify");
116const_known_value!(82, PRIVILEGE_UPDATE, "Update");
117const_known_value!(83, PRIVILEGE_TRANSFER, "Transfer");
118const_known_value!(84, PRIVILEGE_ELECT, "Elect");
119const_known_value!(85, PRIVILEGE_BURN, "Burn");
120const_known_value!(86, PRIVILEGE_REVOKE, "Revoke");
121// 87-99 *unassigned*
122
123//
124// Expression and Function Calls
125//
126
127const_known_value!(100, BODY, "body");
128const_known_value!(101, RESULT, "result");
129const_known_value!(102, ERROR, "error");
130const_known_value!(103, OK_VALUE, "OK");
131const_known_value!(104, PROCESSING_VALUE, "Processing");
132const_known_value!(105, SENDER, "sender");
133const_known_value!(106, SENDER_CONTINUATION, "senderContinuation");
134const_known_value!(107, RECIPIENT_CONTINUATION, "recipientContinuation");
135const_known_value!(108, CONTENT, "content");
136// 109-199 *unassigned*
137
138//
139// Cryptography
140//
141
142const_known_value!(200, SEED_TYPE, "Seed");
143const_known_value!(201, PRIVATE_KEY_TYPE, "PrivateKey");
144const_known_value!(202, PUBLIC_KEY_TYPE, "PublicKey");
145const_known_value!(203, MASTER_KEY_TYPE, "MasterKey");
146// 204-299 *unassigned*
147
148//
149// Cryptocurrency Assets
150//
151
152const_known_value!(300, ASSET, "asset");
153const_known_value!(301, BITCOIN_VALUE, "BTC");
154const_known_value!(302, ETHEREUM_VALUE, "ETH");
155const_known_value!(303, TEZOS_VALUE, "XTZ");
156// 304-399 *unassigned*
157
158//
159// Cryptocurrency Networks
160//
161
162const_known_value!(400, NETWORK, "network");
163const_known_value!(401, MAIN_NET_VALUE, "MainNet");
164const_known_value!(402, TEST_NET_VALUE, "TestNet");
165// 403-499 *unassigned*
166
167//
168// Bitcoin
169//
170
171const_known_value!(500, BIP32_KEY_TYPE, "BIP32Key");
172const_known_value!(501, CHAIN_CODE, "chainCode");
173const_known_value!(502, DERIVATION_PATH_TYPE, "DerivationPath");
174const_known_value!(503, PARENT_PATH, "parent");
175const_known_value!(504, CHILDREN_PATH, "children");
176const_known_value!(505, PARENT_FINGERPRINT, "parentFingerprint");
177const_known_value!(506, PSBT_TYPE, "PSBT");
178const_known_value!(507, OUTPUT_DESCRIPTOR_TYPE, "OutputDescriptor");
179const_known_value!(508, OUTPUT_DESCRIPTOR, "outputDescriptor");
180// 509-599 *unassigned*
181
182//
183// Graphs
184//
185
186const_known_value!(600, GRAPH, "graph");
187const_known_value!(601, SOURCE_TARGET_GRAPH, "SourceTargetGraph");
188const_known_value!(602, PARENT_CHILD_GRAPH, "ParentChildGraph");
189const_known_value!(603, DIGRAPH, "Digraph");
190const_known_value!(604, ACYCLIC_GRAPH, "AcyclicGraph");
191const_known_value!(605, MULTIGRAPH, "Multigraph");
192const_known_value!(606, PSEUDOGRAPH, "Pseudograph");
193const_known_value!(607, GRAPH_FRAGMENT, "GraphFragment");
194const_known_value!(608, DAG, "DAG");
195const_known_value!(609, TREE, "Tree");
196const_known_value!(610, FOREST, "Forest");
197const_known_value!(611, COMPOUND_GRAPH, "CompoundGraph");
198const_known_value!(612, HYPERGRAPH, "Hypergraph");
199const_known_value!(613, DIHYPERGRAPH, "Dihypergraph");
200// 614-699 *unassigned*
201const_known_value!(700, NODE, "node");
202const_known_value!(701, EDGE, "edge");
203const_known_value!(702, SOURCE, "source");
204const_known_value!(703, TARGET, "target");
205const_known_value!(704, PARENT, "parent");
206const_known_value!(705, CHILD, "child");
207// 706-... *unassigned*
208
209/// A lazily initialized singleton that holds the global registry of known
210/// values.
211///
212/// This type provides thread-safe, lazy initialization of the global
213/// KnownValuesStore that contains all the predefined Known Values in the
214/// registry. The store is created only when first accessed, and subsequent
215/// accesses reuse the same instance.
216///
217/// This is used internally by the crate and should not typically be needed by
218/// users of the API, who should access Known Values through the constants
219/// exposed in the `known_values` module.
220///
221/// # Thread Safety
222///
223/// The implementation uses a mutex to protect the store, and initialization is
224/// performed only once across all threads using `std::sync::Once`.
225#[doc(hidden)]
226#[derive(Debug)]
227pub struct LazyKnownValues {
228    init: Once,
229    data: Mutex<Option<KnownValuesStore>>,
230}
231
232impl LazyKnownValues {
233    /// Gets the global KnownValuesStore, initializing it if necessary.
234    ///
235    /// This method guarantees that initialization occurs exactly once,
236    /// even when called from multiple threads simultaneously.
237    ///
238    /// When the `directory-loading` feature is enabled, this method will:
239    /// 1. Initialize the store with hardcoded known values
240    /// 2. Load additional values from configured directories (default:
241    ///    `~/.known-values/`)
242    /// 3. Override hardcoded values with directory-loaded values when
243    ///    codepoints match
244    pub fn get(&self) -> std::sync::MutexGuard<'_, Option<KnownValuesStore>> {
245        self.init.call_once(|| {
246            #[allow(unused_mut)]
247            let mut m = KnownValuesStore::new([
248                UNIT,
249                IS_A,
250                ID,
251                SIGNED,
252                NOTE,
253                HAS_RECIPIENT,
254                SSKR_SHARE,
255                CONTROLLER,
256                KEY,
257                DEREFERENCE_VIA,
258                ENTITY,
259                NAME,
260                LANGUAGE,
261                ISSUER,
262                HOLDER,
263                SALT,
264                DATE,
265                UNKNOWN_VALUE,
266                VERSION_VALUE,
267                HAS_SECRET,
268                DIFF_EDITS,
269                VALID_FROM,
270                VALID_UNTIL,
271                POSITION,
272                NICKNAME,
273                ATTACHMENT,
274                VENDOR,
275                CONFORMS_TO,
276                ALLOW,
277                DENY,
278                ENDPOINT,
279                DELEGATE,
280                PROVENANCE,
281                PRIVATE_KEY,
282                SERVICE,
283                CAPABILITY,
284                PROVENANCE_GENERATOR,
285                PRIVILEGE_ALL,
286                PRIVILEGE_AUTH,
287                PRIVILEGE_SIGN,
288                PRIVILEGE_ENCRYPT,
289                PRIVILEGE_ELIDE,
290                PRIVILEGE_ISSUE,
291                PRIVILEGE_ACCESS,
292                PRIVILEGE_DELEGATE,
293                PRIVILEGE_VERIFY,
294                PRIVILEGE_UPDATE,
295                PRIVILEGE_TRANSFER,
296                PRIVILEGE_ELECT,
297                PRIVILEGE_BURN,
298                PRIVILEGE_REVOKE,
299                BODY,
300                RESULT,
301                ERROR,
302                OK_VALUE,
303                PROCESSING_VALUE,
304                SENDER,
305                SENDER_CONTINUATION,
306                RECIPIENT_CONTINUATION,
307                CONTENT,
308                SEED_TYPE,
309                PRIVATE_KEY_TYPE,
310                PUBLIC_KEY_TYPE,
311                MASTER_KEY_TYPE,
312                ASSET,
313                BITCOIN_VALUE,
314                ETHEREUM_VALUE,
315                TEZOS_VALUE,
316                NETWORK,
317                MAIN_NET_VALUE,
318                TEST_NET_VALUE,
319                BIP32_KEY_TYPE,
320                CHAIN_CODE,
321                DERIVATION_PATH_TYPE,
322                PARENT_PATH,
323                CHILDREN_PATH,
324                PARENT_FINGERPRINT,
325                PSBT_TYPE,
326                OUTPUT_DESCRIPTOR_TYPE,
327                OUTPUT_DESCRIPTOR,
328                GRAPH,
329                SOURCE_TARGET_GRAPH,
330                PARENT_CHILD_GRAPH,
331                DIGRAPH,
332                ACYCLIC_GRAPH,
333                MULTIGRAPH,
334                PSEUDOGRAPH,
335                GRAPH_FRAGMENT,
336                DAG,
337                TREE,
338                FOREST,
339                COMPOUND_GRAPH,
340                HYPERGRAPH,
341                DIHYPERGRAPH,
342                NODE,
343                EDGE,
344                SOURCE,
345                TARGET,
346                PARENT,
347                CHILD,
348            ]);
349
350            // When directory-loading feature is enabled, load additional values
351            // from configured directories. Values from directories override
352            // hardcoded values when codepoints match.
353            #[cfg(feature = "directory-loading")]
354            {
355                let config = crate::directory_loader::get_and_lock_config();
356                let result = crate::directory_loader::load_from_config(&config);
357                for value in result.into_values() {
358                    m.insert(value);
359                }
360            }
361
362            *self.data.lock().unwrap() = Some(m);
363        });
364        self.data.lock().unwrap()
365    }
366}
367
368/// The global registry of Known Values.
369///
370/// This static instance provides access to all standard Known Values defined in
371/// the registry specification. It is lazily initialized on first access.
372///
373/// Most users should not need to interact with this directly, as the predefined
374/// Known Values are exposed as constants in the `known_values` module.
375///
376/// # Examples
377///
378/// ```
379/// use known_values::*;
380///
381/// // Access the global store
382/// let binding = KNOWN_VALUES.get();
383/// let known_values = binding.as_ref().unwrap();
384///
385/// // Look up a Known Value by name
386/// let is_a = known_values.known_value_named("isA").unwrap();
387/// assert_eq!(is_a.value(), 1);
388/// ```
389pub static KNOWN_VALUES: LazyKnownValues =
390    LazyKnownValues { init: Once::new(), data: Mutex::new(None) };
391
392#[cfg(test)]
393mod tests {
394    #[test]
395    fn test_1() {
396        assert_eq!(crate::IS_A.value(), 1);
397        assert_eq!(crate::IS_A.name(), "isA");
398        let binding = crate::KNOWN_VALUES.get();
399        let known_values = binding.as_ref().unwrap();
400        assert_eq!(known_values.known_value_named("isA").unwrap().value(), 1);
401    }
402}
known_values/known_values_registry.rs

known_values/
known_values_registry.rs
