Struct safety_rules::PersistentSafetyStorage

pub struct PersistentSafetyStorage { /* private fields */ }

SafetyRules needs an abstract storage interface to act as a common utility for storing persistent data to local disk, cloud, secrets managers, or even memory (for tests) Any set function is expected to sync to the remote system before returning.

Note: cached_safety_data is a local in-memory copy of SafetyData. As SafetyData should only ever be used by safety rules, we maintain an in-memory copy to avoid issuing reads to the internal storage if the SafetyData hasn’t changed. On writes, we update the cache and internal storage.

Implementations

impl PersistentSafetyStorage

pub fn initialize( internal_store: Storage, author: Author, consensus_private_key: Ed25519PrivateKey, execution_private_key: Ed25519PrivateKey, waypoint: Waypoint, enable_cached_safety_data: bool ) -> Self

Use this to instantiate a PersistentStorage for a new data store, one that has no SafetyRules values set.

pub fn new(internal_store: Storage, enable_cached_safety_data: bool) -> Self

Use this to instantiate a PersistentStorage with an existing data store. This is intended for constructed environments.

pub fn author(&self) -> Result<Author, Error>

pub fn consensus_key_for_version( &self, version: Ed25519PublicKey ) -> Result<Ed25519PrivateKey, Error>

pub fn execution_public_key(&self) -> Result<Ed25519PublicKey, Error>

pub fn sign<T: Serialize + CryptoHash>( &self, key_name: String, key_version: Ed25519PublicKey, message: &T ) -> Result<Ed25519Signature, Error>

pub fn safety_data(&mut self) -> Result<SafetyData, Error>

pub fn set_safety_data(&mut self, data: SafetyData) -> Result<(), Error>

pub fn waypoint(&self) -> Result<Waypoint, Error>

pub fn set_waypoint(&mut self, waypoint: &Waypoint) -> Result<(), Error>

pub fn internal_store(&mut self) -> &mut Storage