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 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
use alloc::vec::Vec;
use core::{fmt, ops::Index};
use miden_crypto::{hash::rpo::RpoDigest, Felt, WORD_SIZE};
use winter_utils::{ByteReader, ByteWriter, Deserializable, DeserializationError, Serializable};
use super::Kernel;
use crate::{
mast::{MastForest, MastNode, MastNodeId},
utils::ToElements,
};
// PROGRAM
// ===============================================================================================
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct Program {
mast_forest: MastForest,
/// The "entrypoint" is the node where execution of the program begins.
entrypoint: MastNodeId,
kernel: Kernel,
}
/// Constructors
impl Program {
/// Construct a new [`Program`] from the given MAST forest and entrypoint. The kernel is assumed
/// to be empty.
///
/// # Panics:
/// - if `mast_forest` doesn't have an entrypoint
pub fn new(mast_forest: MastForest, entrypoint: MastNodeId) -> Self {
assert!(mast_forest.get_node_by_id(entrypoint).is_some());
Self {
mast_forest,
entrypoint,
kernel: Kernel::default(),
}
}
/// Construct a new [`Program`] from the given MAST forest, entrypoint, and kernel.
///
/// # Panics:
/// - if `mast_forest` doesn't have an entrypoint
pub fn with_kernel(mast_forest: MastForest, entrypoint: MastNodeId, kernel: Kernel) -> Self {
assert!(mast_forest.get_node_by_id(entrypoint).is_some());
Self { mast_forest, entrypoint, kernel }
}
}
/// Public accessors
impl Program {
/// Returns the underlying [`MastForest`].
pub fn mast_forest(&self) -> &MastForest {
&self.mast_forest
}
/// Returns the kernel associated with this program.
pub fn kernel(&self) -> &Kernel {
&self.kernel
}
/// Returns the entrypoint associated with this program.
pub fn entrypoint(&self) -> MastNodeId {
self.entrypoint
}
/// Returns the hash of the program's entrypoint.
///
/// Equivalently, returns the hash of the root of the entrypoint procedure.
pub fn hash(&self) -> RpoDigest {
self.mast_forest[self.entrypoint].digest()
}
/// Returns the [`MastNode`] associated with the provided [`MastNodeId`] if valid, or else
/// `None`.
///
/// This is the faillible version of indexing (e.g. `program[node_id]`).
#[inline(always)]
pub fn get_node_by_id(&self, node_id: MastNodeId) -> Option<&MastNode> {
self.mast_forest.get_node_by_id(node_id)
}
/// Returns the [`MastNodeId`] of the procedure root associated with a given digest, if any.
#[inline(always)]
pub fn find_procedure_root(&self, digest: RpoDigest) -> Option<MastNodeId> {
self.mast_forest.find_procedure_root(digest)
}
/// Returns the number of procedures in this program.
pub fn num_procedures(&self) -> u32 {
self.mast_forest.num_procedures()
}
}
impl Index<MastNodeId> for Program {
type Output = MastNode;
fn index(&self, node_id: MastNodeId) -> &Self::Output {
&self.mast_forest[node_id]
}
}
impl crate::prettier::PrettyPrint for Program {
fn render(&self) -> crate::prettier::Document {
use crate::prettier::*;
let entrypoint = self[self.entrypoint()].to_pretty_print(&self.mast_forest);
indent(4, const_text("begin") + nl() + entrypoint.render()) + nl() + const_text("end")
}
}
impl fmt::Display for Program {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
use crate::prettier::PrettyPrint;
self.pretty_print(f)
}
}
impl From<Program> for MastForest {
fn from(program: Program) -> Self {
program.mast_forest
}
}
// PROGRAM INFO
// ===============================================================================================
/// A program information set consisting of its MAST root and set of kernel procedure roots used
/// for its compilation.
///
/// This will be used as public inputs of the proof so we bind its verification to the kernel and
/// root used to execute the program. This way, we extend the correctness of the proof to the
/// security guarantees provided by the kernel. We also allow the user to easily prove the
/// membership of a given kernel procedure for a given proof, without compromising its
/// zero-knowledge properties.
#[derive(Debug, Clone, Default, PartialEq, Eq)]
pub struct ProgramInfo {
program_hash: RpoDigest,
kernel: Kernel,
}
impl ProgramInfo {
// CONSTRUCTORS
// --------------------------------------------------------------------------------------------
/// Creates a new instance of a program info.
pub const fn new(program_hash: RpoDigest, kernel: Kernel) -> Self {
Self { program_hash, kernel }
}
// PUBLIC ACCESSORS
// --------------------------------------------------------------------------------------------
/// Returns the program hash computed from its code block root.
pub const fn program_hash(&self) -> &RpoDigest {
&self.program_hash
}
/// Returns the program kernel used during the compilation.
pub const fn kernel(&self) -> &Kernel {
&self.kernel
}
/// Returns the list of procedures of the kernel used during the compilation.
pub fn kernel_procedures(&self) -> &[RpoDigest] {
self.kernel.proc_hashes()
}
}
impl From<Program> for ProgramInfo {
fn from(program: Program) -> Self {
let program_hash = program.hash();
let kernel = program.kernel().clone();
Self { program_hash, kernel }
}
}
// SERIALIZATION
// ------------------------------------------------------------------------------------------------
impl Serializable for ProgramInfo {
fn write_into<W: ByteWriter>(&self, target: &mut W) {
self.program_hash.write_into(target);
self.kernel.write_into(target);
}
}
impl Deserializable for ProgramInfo {
fn read_from<R: ByteReader>(source: &mut R) -> Result<Self, DeserializationError> {
let program_hash = source.read()?;
let kernel = source.read()?;
Ok(Self { program_hash, kernel })
}
}
// TO ELEMENTS
// ------------------------------------------------------------------------------------------------
impl ToElements for ProgramInfo {
fn to_elements(&self) -> Vec<Felt> {
let num_kernel_proc_elements = self.kernel.proc_hashes().len() * WORD_SIZE;
let mut result = Vec::with_capacity(WORD_SIZE + num_kernel_proc_elements);
// append program hash elements
result.extend_from_slice(self.program_hash.as_elements());
// append kernel procedure hash elements
for proc_hash in self.kernel.proc_hashes() {
result.extend_from_slice(proc_hash.as_elements());
}
result
}
}