use crate::{
atomic_write_batch,
block::Transaction,
cow_to_cloned,
cow_to_copied,
process::{Deployment, Fee},
program::Program,
snark::{Certificate, Proof, VerifyingKey},
store::{
helpers::{memory_map::MemoryMap, Map, MapRead},
TransitionMemory,
TransitionStorage,
TransitionStore,
},
};
use console::{
network::prelude::*,
program::{Identifier, ProgramID},
};
use anyhow::Result;
use core::marker::PhantomData;
use indexmap::IndexMap;
use std::borrow::Cow;
pub trait DeploymentStorage<N: Network>: Clone + Send + Sync {
type IDMap: for<'a> Map<'a, N::TransactionID, ProgramID<N>>;
type EditionMap: for<'a> Map<'a, ProgramID<N>, u16>;
type ReverseIDMap: for<'a> Map<'a, (ProgramID<N>, u16), N::TransactionID>;
type ProgramMap: for<'a> Map<'a, (ProgramID<N>, u16), Program<N>>;
type VerifyingKeyMap: for<'a> Map<'a, (ProgramID<N>, Identifier<N>, u16), VerifyingKey<N>>;
type CertificateMap: for<'a> Map<'a, (ProgramID<N>, Identifier<N>, u16), Certificate<N>>;
type FeeMap: for<'a> Map<'a, N::TransactionID, (N::TransitionID, N::StateRoot, Option<Proof<N>>)>;
type TransitionStorage: TransitionStorage<N>;
fn open(transition_store: TransitionStore<N, Self::TransitionStorage>) -> Result<Self>;
fn id_map(&self) -> &Self::IDMap;
fn edition_map(&self) -> &Self::EditionMap;
fn reverse_id_map(&self) -> &Self::ReverseIDMap;
fn program_map(&self) -> &Self::ProgramMap;
fn verifying_key_map(&self) -> &Self::VerifyingKeyMap;
fn certificate_map(&self) -> &Self::CertificateMap;
fn fee_map(&self) -> &Self::FeeMap;
fn transition_store(&self) -> &TransitionStore<N, Self::TransitionStorage>;
fn dev(&self) -> Option<u16> {
self.transition_store().dev()
}
fn start_atomic(&self) {
self.id_map().start_atomic();
self.edition_map().start_atomic();
self.reverse_id_map().start_atomic();
self.program_map().start_atomic();
self.verifying_key_map().start_atomic();
self.certificate_map().start_atomic();
self.fee_map().start_atomic();
self.transition_store().start_atomic();
}
fn is_atomic_in_progress(&self) -> bool {
self.id_map().is_atomic_in_progress()
|| self.edition_map().is_atomic_in_progress()
|| self.reverse_id_map().is_atomic_in_progress()
|| self.program_map().is_atomic_in_progress()
|| self.verifying_key_map().is_atomic_in_progress()
|| self.certificate_map().is_atomic_in_progress()
|| self.fee_map().is_atomic_in_progress()
|| self.transition_store().is_atomic_in_progress()
}
fn abort_atomic(&self) {
self.id_map().abort_atomic();
self.edition_map().abort_atomic();
self.reverse_id_map().abort_atomic();
self.program_map().abort_atomic();
self.verifying_key_map().abort_atomic();
self.certificate_map().abort_atomic();
self.fee_map().abort_atomic();
self.transition_store().abort_atomic();
}
fn finish_atomic(&self) -> Result<()> {
self.id_map().finish_atomic()?;
self.edition_map().finish_atomic()?;
self.reverse_id_map().finish_atomic()?;
self.program_map().finish_atomic()?;
self.verifying_key_map().finish_atomic()?;
self.certificate_map().finish_atomic()?;
self.fee_map().finish_atomic()?;
self.transition_store().finish_atomic()
}
fn insert(&self, transaction: &Transaction<N>) -> Result<()> {
let (transaction_id, deployment, fee) = match transaction {
Transaction::Deploy(transaction_id, deployment, fee) => (transaction_id, deployment, fee),
Transaction::Execute(..) => {
bail!("Attempted to insert non-deployment transaction into deployment storage.")
}
};
let program = deployment.program();
let program_id = *program.id();
let edition = deployment.edition();
if program.functions().len() != deployment.verifying_keys().len() {
bail!("Deployment has an incorrect number of verifying keys, according to the program.");
}
for function_name in program.functions().keys() {
if !deployment.verifying_keys().keys().contains(function_name) {
bail!("Deployment is missing a verifying key for function '{function_name}'.");
}
}
atomic_write_batch!(self, {
self.id_map().insert(*transaction_id, program_id)?;
self.edition_map().insert(program_id, edition)?;
self.reverse_id_map().insert((program_id, edition), *transaction_id)?;
self.program_map().insert((program_id, edition), program.clone())?;
for (function_name, (verifying_key, certificate)) in deployment.verifying_keys() {
self.verifying_key_map().insert((program_id, *function_name, edition), verifying_key.clone())?;
self.certificate_map().insert((program_id, *function_name, edition), certificate.clone())?;
}
self.fee_map().insert(
*transaction_id,
(*fee.transition_id(), fee.global_state_root(), fee.inclusion_proof().cloned()),
)?;
self.transition_store().insert(fee)?;
Ok(())
});
Ok(())
}
fn remove(&self, transaction_id: &N::TransactionID) -> Result<()> {
let program_id = match self.get_program_id(transaction_id)? {
Some(edition) => edition,
None => bail!("Failed to get the program ID for transaction '{transaction_id}'"),
};
let edition = match self.get_edition(&program_id)? {
Some(edition) => edition,
None => bail!("Failed to locate the edition for program '{program_id}'"),
};
let program = match self.program_map().get(&(program_id, edition))? {
Some(program) => cow_to_cloned!(program),
None => bail!("Failed to locate program '{program_id}' for transaction '{transaction_id}'"),
};
let (transition_id, _, _) = match self.fee_map().get(transaction_id)? {
Some(fee_id) => cow_to_cloned!(fee_id),
None => bail!("Failed to locate the fee transition ID for transaction '{transaction_id}'"),
};
atomic_write_batch!(self, {
self.id_map().remove(transaction_id)?;
self.edition_map().remove(&program_id)?;
self.reverse_id_map().remove(&(program_id, edition))?;
self.program_map().remove(&(program_id, edition))?;
for function_name in program.functions().keys() {
self.verifying_key_map().remove(&(program_id, *function_name, edition))?;
self.certificate_map().remove(&(program_id, *function_name, edition))?;
}
self.fee_map().remove(transaction_id)?;
self.transition_store().remove(&transition_id)?;
Ok(())
});
Ok(())
}
fn find_transaction_id(&self, program_id: &ProgramID<N>) -> Result<Option<N::TransactionID>> {
let edition = match self.get_edition(program_id)? {
Some(edition) => edition,
None => return Ok(None),
};
match self.reverse_id_map().get(&(*program_id, edition))? {
Some(transaction_id) => Ok(Some(cow_to_copied!(transaction_id))),
None => bail!("Failed to find the transaction ID for program '{program_id}' (edition {edition})"),
}
}
fn get_program_id(&self, transaction_id: &N::TransactionID) -> Result<Option<ProgramID<N>>> {
match self.id_map().get(transaction_id)? {
Some(program_id) => Ok(Some(cow_to_copied!(program_id))),
None => Ok(None),
}
}
fn get_edition(&self, program_id: &ProgramID<N>) -> Result<Option<u16>> {
match self.edition_map().get(program_id)? {
Some(edition) => Ok(Some(cow_to_copied!(edition))),
None => Ok(None),
}
}
fn get_program(&self, program_id: &ProgramID<N>) -> Result<Option<Program<N>>> {
let edition = match self.get_edition(program_id)? {
Some(edition) => edition,
None => return Ok(None),
};
match self.program_map().get(&(*program_id, edition))? {
Some(program) => Ok(Some(cow_to_cloned!(program))),
None => bail!("Failed to get program '{program_id}' (edition {edition})"),
}
}
fn get_verifying_key(
&self,
program_id: &ProgramID<N>,
function_name: &Identifier<N>,
) -> Result<Option<VerifyingKey<N>>> {
let edition = match self.get_edition(program_id)? {
Some(edition) => edition,
None => return Ok(None),
};
match self.verifying_key_map().get(&(*program_id, *function_name, edition))? {
Some(verifying_key) => Ok(Some(cow_to_cloned!(verifying_key))),
None => bail!("Failed to get the verifying key for '{program_id}/{function_name}' (edition {edition})"),
}
}
fn get_certificate(
&self,
program_id: &ProgramID<N>,
function_name: &Identifier<N>,
) -> Result<Option<Certificate<N>>> {
let edition = match self.get_edition(program_id)? {
Some(edition) => edition,
None => return Ok(None),
};
match self.certificate_map().get(&(*program_id, *function_name, edition))? {
Some(certificate) => Ok(Some(cow_to_cloned!(certificate))),
None => bail!("Failed to get the certificate for '{program_id}/{function_name}' (edition {edition})"),
}
}
fn get_deployment(&self, transaction_id: &N::TransactionID) -> Result<Option<Deployment<N>>> {
let program_id = match self.get_program_id(transaction_id)? {
Some(edition) => edition,
None => return Ok(None),
};
let edition = match self.get_edition(&program_id)? {
Some(edition) => edition,
None => bail!("Failed to get the edition for program '{program_id}'"),
};
let program = match self.program_map().get(&(program_id, edition))? {
Some(program) => cow_to_cloned!(program),
None => bail!("Failed to get the deployed program '{program_id}' (edition {edition})"),
};
let mut verifying_keys = IndexMap::new();
for function_name in program.functions().keys() {
let verifying_key = match self.verifying_key_map().get(&(program_id, *function_name, edition))? {
Some(verifying_key) => cow_to_cloned!(verifying_key),
None => bail!("Failed to get the verifying key for '{program_id}/{function_name}' (edition {edition})"),
};
let certificate = match self.certificate_map().get(&(program_id, *function_name, edition))? {
Some(certificate) => cow_to_cloned!(certificate),
None => bail!("Failed to get the certificate for '{program_id}/{function_name}' (edition {edition})"),
};
verifying_keys.insert(*function_name, (verifying_key, certificate));
}
Ok(Some(Deployment::new(edition, program, verifying_keys)?))
}
fn get_fee(&self, transaction_id: &N::TransactionID) -> Result<Option<Fee<N>>> {
let (fee_transition_id, global_state_root, inclusion_proof) = match self.fee_map().get(transaction_id)? {
Some(fee) => cow_to_cloned!(fee),
None => return Ok(None),
};
match self.transition_store().get_transition(&fee_transition_id)? {
Some(transition) => Ok(Some(Fee::from(transition, global_state_root, inclusion_proof))),
None => bail!("Failed to locate the fee transition for transaction '{transaction_id}'"),
}
}
fn get_transaction(&self, transaction_id: &N::TransactionID) -> Result<Option<Transaction<N>>> {
let deployment = match self.get_deployment(transaction_id)? {
Some(deployment) => deployment,
None => return Ok(None),
};
let fee = match self.get_fee(transaction_id)? {
Some(fee) => fee,
None => bail!("Failed to get the fee for transaction '{transaction_id}'"),
};
let deployment_transaction = Transaction::from_deployment(deployment, fee)?;
match *transaction_id == deployment_transaction.id() {
true => Ok(Some(deployment_transaction)),
false => bail!("The deployment transaction ID does not match '{transaction_id}'"),
}
}
}
#[derive(Clone)]
#[allow(clippy::type_complexity)]
pub struct DeploymentMemory<N: Network> {
id_map: MemoryMap<N::TransactionID, ProgramID<N>>,
edition_map: MemoryMap<ProgramID<N>, u16>,
reverse_id_map: MemoryMap<(ProgramID<N>, u16), N::TransactionID>,
program_map: MemoryMap<(ProgramID<N>, u16), Program<N>>,
verifying_key_map: MemoryMap<(ProgramID<N>, Identifier<N>, u16), VerifyingKey<N>>,
certificate_map: MemoryMap<(ProgramID<N>, Identifier<N>, u16), Certificate<N>>,
fee_map: MemoryMap<N::TransactionID, (N::TransitionID, N::StateRoot, Option<Proof<N>>)>,
transition_store: TransitionStore<N, TransitionMemory<N>>,
}
#[rustfmt::skip]
impl<N: Network> DeploymentStorage<N> for DeploymentMemory<N> {
type IDMap = MemoryMap<N::TransactionID, ProgramID<N>>;
type EditionMap = MemoryMap<ProgramID<N>, u16>;
type ReverseIDMap = MemoryMap<(ProgramID<N>, u16), N::TransactionID>;
type ProgramMap = MemoryMap<(ProgramID<N>, u16), Program<N>>;
type VerifyingKeyMap = MemoryMap<(ProgramID<N>, Identifier<N>, u16), VerifyingKey<N>>;
type CertificateMap = MemoryMap<(ProgramID<N>, Identifier<N>, u16), Certificate<N>>;
type FeeMap = MemoryMap<N::TransactionID, (N::TransitionID, N::StateRoot, Option<Proof<N>>)>;
type TransitionStorage = TransitionMemory<N>;
fn open(transition_store: TransitionStore<N, Self::TransitionStorage>) -> Result<Self> {
Ok(Self {
id_map: MemoryMap::default(),
edition_map: MemoryMap::default(),
reverse_id_map: MemoryMap::default(),
program_map: MemoryMap::default(),
verifying_key_map: MemoryMap::default(),
certificate_map: MemoryMap::default(),
fee_map: MemoryMap::default(),
transition_store,
})
}
fn id_map(&self) -> &Self::IDMap {
&self.id_map
}
fn edition_map(&self) -> &Self::EditionMap {
&self.edition_map
}
fn reverse_id_map(&self) -> &Self::ReverseIDMap {
&self.reverse_id_map
}
fn program_map(&self) -> &Self::ProgramMap {
&self.program_map
}
fn verifying_key_map(&self) -> &Self::VerifyingKeyMap {
&self.verifying_key_map
}
fn certificate_map(&self) -> &Self::CertificateMap {
&self.certificate_map
}
fn fee_map(&self) -> &Self::FeeMap {
&self.fee_map
}
fn transition_store(&self) -> &TransitionStore<N, Self::TransitionStorage> {
&self.transition_store
}
}
#[derive(Clone)]
pub struct DeploymentStore<N: Network, D: DeploymentStorage<N>> {
storage: D,
_phantom: PhantomData<N>,
}
impl<N: Network, D: DeploymentStorage<N>> DeploymentStore<N, D> {
pub fn open(transition_store: TransitionStore<N, D::TransitionStorage>) -> Result<Self> {
let storage = D::open(transition_store)?;
Ok(Self { storage, _phantom: PhantomData })
}
pub fn from(storage: D) -> Self {
Self { storage, _phantom: PhantomData }
}
pub fn insert(&self, transaction: &Transaction<N>) -> Result<()> {
self.storage.insert(transaction)
}
pub fn remove(&self, transaction_id: &N::TransactionID) -> Result<()> {
self.storage.remove(transaction_id)
}
pub fn start_atomic(&self) {
self.storage.start_atomic();
}
pub fn is_atomic_in_progress(&self) -> bool {
self.storage.is_atomic_in_progress()
}
pub fn abort_atomic(&self) {
self.storage.abort_atomic();
}
pub fn finish_atomic(&self) -> Result<()> {
self.storage.finish_atomic()
}
pub fn dev(&self) -> Option<u16> {
self.storage.dev()
}
}
impl<N: Network, D: DeploymentStorage<N>> DeploymentStore<N, D> {
pub fn get_transaction(&self, transaction_id: &N::TransactionID) -> Result<Option<Transaction<N>>> {
self.storage.get_transaction(transaction_id)
}
pub fn get_deployment(&self, transaction_id: &N::TransactionID) -> Result<Option<Deployment<N>>> {
self.storage.get_deployment(transaction_id)
}
pub fn get_edition(&self, program_id: &ProgramID<N>) -> Result<Option<u16>> {
self.storage.get_edition(program_id)
}
pub fn get_program_id(&self, transaction_id: &N::TransactionID) -> Result<Option<ProgramID<N>>> {
self.storage.get_program_id(transaction_id)
}
pub fn get_program(&self, program_id: &ProgramID<N>) -> Result<Option<Program<N>>> {
self.storage.get_program(program_id)
}
pub fn get_verifying_key(
&self,
program_id: &ProgramID<N>,
function_name: &Identifier<N>,
) -> Result<Option<VerifyingKey<N>>> {
self.storage.get_verifying_key(program_id, function_name)
}
pub fn get_certificate(
&self,
program_id: &ProgramID<N>,
function_name: &Identifier<N>,
) -> Result<Option<Certificate<N>>> {
self.storage.get_certificate(program_id, function_name)
}
pub fn get_fee(&self, transaction_id: &N::TransactionID) -> Result<Option<Fee<N>>> {
self.storage.get_fee(transaction_id)
}
}
impl<N: Network, D: DeploymentStorage<N>> DeploymentStore<N, D> {
pub fn find_transaction_id(&self, program_id: &ProgramID<N>) -> Result<Option<N::TransactionID>> {
self.storage.find_transaction_id(program_id)
}
}
impl<N: Network, D: DeploymentStorage<N>> DeploymentStore<N, D> {
pub fn contains_program_id(&self, program_id: &ProgramID<N>) -> Result<bool> {
self.storage.edition_map().contains_key(program_id)
}
}
impl<N: Network, D: DeploymentStorage<N>> DeploymentStore<N, D> {
pub fn deployment_ids(&self) -> impl '_ + Iterator<Item = Cow<'_, N::TransactionID>> {
self.storage.id_map().keys()
}
pub fn program_ids(&self) -> impl '_ + Iterator<Item = Cow<'_, ProgramID<N>>> {
self.storage.id_map().values().map(|id| match id {
Cow::Borrowed(id) => Cow::Borrowed(id),
Cow::Owned(id) => Cow::Owned(id),
})
}
pub fn programs(&self) -> impl '_ + Iterator<Item = Cow<'_, Program<N>>> {
self.storage.program_map().values().map(|program| match program {
Cow::Borrowed(program) => Cow::Borrowed(program),
Cow::Owned(program) => Cow::Owned(program),
})
}
pub fn verifying_keys(
&self,
) -> impl '_ + Iterator<Item = (Cow<'_, (ProgramID<N>, Identifier<N>, u16)>, Cow<'_, VerifyingKey<N>>)> {
self.storage.verifying_key_map().iter()
}
pub fn certificates(
&self,
) -> impl '_ + Iterator<Item = (Cow<'_, (ProgramID<N>, Identifier<N>, u16)>, Cow<'_, Certificate<N>>)> {
self.storage.certificate_map().iter()
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_insert_get_remove() {
let rng = &mut TestRng::default();
let transaction = crate::vm::test_helpers::sample_deployment_transaction(rng);
let transaction_id = transaction.id();
let transition_store = TransitionStore::open(None).unwrap();
let deployment_store = DeploymentMemory::open(transition_store).unwrap();
let candidate = deployment_store.get_transaction(&transaction_id).unwrap();
assert_eq!(None, candidate);
deployment_store.insert(&transaction).unwrap();
let candidate = deployment_store.get_transaction(&transaction_id).unwrap();
assert_eq!(Some(transaction), candidate);
deployment_store.remove(&transaction_id).unwrap();
let candidate = deployment_store.get_transaction(&transaction_id).unwrap();
assert_eq!(None, candidate);
}
#[test]
fn test_find_transaction_id() {
let rng = &mut TestRng::default();
let transaction = crate::vm::test_helpers::sample_deployment_transaction(rng);
let transaction_id = transaction.id();
let program_id = match transaction {
Transaction::Deploy(_, ref deployment, _) => *deployment.program_id(),
_ => panic!("Incorrect transaction type"),
};
let transition_store = TransitionStore::open(None).unwrap();
let deployment_store = DeploymentMemory::open(transition_store).unwrap();
let candidate = deployment_store.get_transaction(&transaction_id).unwrap();
assert_eq!(None, candidate);
let candidate = deployment_store.find_transaction_id(&program_id).unwrap();
assert_eq!(None, candidate);
deployment_store.insert(&transaction).unwrap();
let candidate = deployment_store.find_transaction_id(&program_id).unwrap();
assert_eq!(Some(transaction_id), candidate);
deployment_store.remove(&transaction_id).unwrap();
let candidate = deployment_store.find_transaction_id(&program_id).unwrap();
assert_eq!(None, candidate);
}
}