tmkms 0.15.0

Tendermint Key Management System: provides isolated, optionally HSM-backed signing key management for Tendermint applications including validators, oracles, IBC relayers, and other transaction signing applications
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99

//! Registry of information about known Tendermint blockchain networks

use super::{Chain, Guard, Id};
use crate::{
    Map,
    error::{Error, ErrorKind::*},
    keyring,
    prelude::*,
};
use once_cell::sync::Lazy;
use std::sync::RwLock;

/// State of Tendermint blockchain networks
pub static REGISTRY: Lazy<GlobalRegistry> = Lazy::new(GlobalRegistry::default);

/// Registry of blockchain networks known to the KMS
#[derive(Default)]
pub struct Registry(Map<Id, Chain>);

impl Registry {
    /// Add an account key to a keyring for a chain stored in the registry
    pub fn add_account_key(
        &mut self,
        chain_id: &Id,
        signer: keyring::ecdsa::Signer,
    ) -> Result<(), Error> {
        let chain = self.0.get_mut(chain_id).ok_or_else(|| {
            format_err!(
                InvalidKey,
                "can't add ECDSA signer {} to unregistered chain: {}",
                signer.provider(),
                chain_id
            )
        })?;

        chain.keyring.add_ecdsa(signer)
    }

    /// Add a consensus key to a keyring for a chain stored in the registry
    pub fn add_consensus_key(
        &mut self,
        chain_id: &Id,
        signer: keyring::ed25519::Signer,
    ) -> Result<(), Error> {
        let chain = self.0.get_mut(chain_id).ok_or_else(|| {
            format_err!(
                InvalidKey,
                "can't add Ed25519 signer {} to unregistered chain: {}",
                signer.provider(),
                chain_id
            )
        })?;

        chain.keyring.add_ed25519(signer)
    }

    /// Register a `Chain` with the registry
    pub fn register_chain(&mut self, chain: Chain) -> Result<(), Error> {
        let chain_id = chain.id.clone();

        if self.0.insert(chain_id.clone(), chain).is_none() {
            Ok(())
        } else {
            // TODO(tarcieri): handle updating the set of registered chains
            fail!(ConfigError, "chain ID already registered: {}", chain_id);
        }
    }

    /// Get information about a particular chain ID (if registered)
    pub fn get_chain(&self, chain_id: &Id) -> Option<&Chain> {
        self.0.get(chain_id)
    }
}

/// Global registry of blockchain networks known to the KMS
// NOTE: The `RwLock` is a bit of futureproofing as this data structure is for the
// most part "immutable". New chains should be registered at boot time.
// The only case in which this structure may change is in the event of
// runtime configuration reloading, so the `RwLock` is included as
// futureproofing for such a feature.
//
// See: <https://github.com/tendermint/kms/issues/183>
#[derive(Default)]
pub struct GlobalRegistry(pub(super) RwLock<Registry>);

impl GlobalRegistry {
    /// Acquire a read-only (concurrent) lock to the internal chain registry
    pub fn get(&self) -> Guard<'_> {
        // TODO(tarcieri): better handle `PoisonError` here?
        self.0.read().unwrap().into()
    }

    /// Register a chain with the registry
    pub fn register(&self, chain: Chain) -> Result<(), Error> {
        // TODO(tarcieri): better handle `PoisonError` here?
        let mut registry = self.0.write().unwrap();
        registry.register_chain(chain)
    }
}