pub mod config; pub mod error; pub mod format; pub mod module; pub mod options; pub mod pretty; pub mod script; pub mod telemetry; use aiken_lang::{ ast::{ Annotation, DataType, Definition, Function, ModuleKind, RecordConstructor, RecordConstructorArg, Span, TypedDataType, TypedDefinition, TypedFunction, }, builder::{DataTypeKey, FunctionAccessKey}, builtins::{self, generic_var}, tipo::TypeInfo, uplc::CodeGenerator, IdGenerator, }; use miette::NamedSource; use options::{CodeGenMode, Options}; use pallas::{ codec::minicbor, ledger::{addresses::Address, primitives::babbage}, }; use pallas_traverse::ComputeHash; use script::{EvalHint, EvalInfo, Script}; use serde_json::json; use std::{ collections::HashMap, fs, path::{Path, PathBuf}, }; use telemetry::EventListener; use uplc::{ ast::{Constant, DeBruijn, Program, Term}, machine::cost_model::ExBudget, }; use crate::{ config::Config, error::{Error, Warning}, module::{CheckedModule, CheckedModules, ParsedModule, ParsedModules}, telemetry::Event, }; #[derive(Debug)] pub struct Source { pub path: PathBuf, pub name: String, pub code: String, pub kind: ModuleKind, } pub const SPEND: &str = "spend"; pub const CERT: &str = "cert"; pub const MINT: &str = "mint"; pub const WITHDRAWL: &str = "withdrawl"; pub const VALIDATOR_NAMES: [&str; 4] = [SPEND, CERT, MINT, WITHDRAWL]; pub struct Project where T: EventListener, { config: Config, defined_modules: HashMap, id_gen: IdGenerator, module_types: HashMap, root: PathBuf, sources: Vec, pub warnings: Vec, event_listener: T, } impl Project where T: EventListener, { pub fn new(config: Config, root: PathBuf, event_listener: T) -> Project { let id_gen = IdGenerator::new(); let mut module_types = HashMap::new(); module_types.insert("aiken".to_string(), builtins::prelude(&id_gen)); module_types.insert("aiken/builtin".to_string(), builtins::plutus(&id_gen)); Project { config, defined_modules: HashMap::new(), id_gen, module_types, root, sources: vec![], warnings: vec![], event_listener, } } pub fn build(&mut self, uplc: bool) -> Result<(), Error> { let options = Options { code_gen_mode: CodeGenMode::Build(uplc), }; self.compile(options) } pub fn check(&mut self, skip_tests: bool, match_tests: Option) -> Result<(), Error> { let options = Options { code_gen_mode: if skip_tests { CodeGenMode::NoOp } else { CodeGenMode::Test(match_tests) }, }; self.compile(options) } pub fn compile(&mut self, options: Options) -> Result<(), Error> { self.event_listener .handle_event(Event::StartingCompilation { root: self.root.clone(), name: self.config.name.clone(), version: self.config.version.clone(), }); self.event_listener.handle_event(Event::ParsingProjectFiles); self.read_source_files()?; let parsed_modules = self.parse_sources()?; let processing_sequence = parsed_modules.sequence()?; self.event_listener.handle_event(Event::TypeChecking); let mut checked_modules = self.type_check(parsed_modules, processing_sequence)?; let validators = self.validate_validators(&mut checked_modules)?; match options.code_gen_mode { CodeGenMode::Build(uplc_dump) => { self.event_listener.handle_event(Event::GeneratingUPLC { output_path: self.output_path(), }); let programs = self.code_gen(validators, &checked_modules)?; self.write_build_outputs(programs, uplc_dump)?; Ok(()) } CodeGenMode::Test(match_tests) => { let tests = self .collect_scripts(&checked_modules, |def| matches!(def, Definition::Test(..)))?; if !tests.is_empty() { self.event_listener.handle_event(Event::RunningTests); } let results = self.eval_scripts(tests, match_tests); let errors: Vec = results .iter() .filter_map(|e| { if e.success { None } else { Some(Error::TestFailure { name: e.script.name.clone(), path: e.script.input_path.clone(), evaluation_hint: e.script.evaluation_hint.clone(), }) } }) .collect(); self.event_listener .handle_event(Event::FinishedTests { tests: results }); if !errors.is_empty() { Err(Error::List(errors)) } else { Ok(()) } } CodeGenMode::NoOp => Ok(()), } } fn read_source_files(&mut self) -> Result<(), Error> { let lib = self.root.join("lib"); let validators = self.root.join("validators"); self.aiken_files(&validators, ModuleKind::Validator)?; self.aiken_files(&lib, ModuleKind::Lib)?; Ok(()) } fn parse_sources(&mut self) -> Result { let mut errors = Vec::new(); let mut parsed_modules = HashMap::with_capacity(self.sources.len()); for Source { path, name, code, kind, } in self.sources.drain(0..) { match aiken_lang::parser::module(&code, kind) { Ok((mut ast, _)) => { // Store the name ast.name = name.clone(); let module = ParsedModule { kind, ast, code, name, path, package: self.config.name.clone(), }; if let Some(first) = self .defined_modules .insert(module.name.clone(), module.path.clone()) { return Err(Error::DuplicateModule { module: module.name.clone(), first, second: module.path, }); } parsed_modules.insert(module.name.clone(), module); } Err(errs) => { for error in errs { errors.push(Error::Parse { path: path.clone(), src: code.clone(), named: NamedSource::new(path.display().to_string(), code.clone()), error: Box::new(error), }) } } } } if errors.is_empty() { Ok(parsed_modules.into()) } else { Err(Error::List(errors)) } } fn type_check( &mut self, mut parsed_modules: ParsedModules, processing_sequence: Vec, ) -> Result { let mut modules = HashMap::with_capacity(parsed_modules.len() + 1); for name in processing_sequence { if let Some(ParsedModule { name, path, code, kind, // TODO: come back and figure out where to use this package: _package, ast, }) = parsed_modules.remove(&name) { let mut type_warnings = Vec::new(); let ast = ast .infer( &self.id_gen, kind, &self.config.name, &self.module_types, &mut type_warnings, ) .map_err(|error| Error::Type { path: path.clone(), src: code.clone(), named: NamedSource::new(path.display().to_string(), code.clone()), error, })?; // Register any warnings emitted as type warnings let type_warnings = type_warnings .into_iter() .map(|w| Warning::from_type_warning(w, path.clone(), code.clone())); self.warnings.extend(type_warnings); // Register the types from this module so they can be imported into // other modules. self.module_types .insert(name.clone(), ast.type_info.clone()); modules.insert( name.clone(), CheckedModule { kind, // extra, name, code, ast, input_path: path, }, ); } } Ok(modules.into()) } fn validate_validators( &self, checked_modules: &mut CheckedModules, ) -> Result, Error> { let mut errors = Vec::new(); let mut validators = Vec::new(); let mut indices_to_remove = Vec::new(); for module in checked_modules.validators() { for (index, def) in module.ast.definitions().enumerate() { if let Definition::Fn(func_def) = def { if VALIDATOR_NAMES.contains(&func_def.name.as_str()) { // validators must return a Bool if !func_def.return_type.is_bool() { errors.push(Error::ValidatorMustReturnBool { location: func_def.location, src: module.code.clone(), path: module.input_path.clone(), named: NamedSource::new( module.input_path.display().to_string(), module.code.clone(), ), }) } // depending on name, validate the minimum number of arguments // if too low, push a new error on to errors if [MINT, CERT, WITHDRAWL].contains(&func_def.name.as_str()) && func_def.arguments.len() < 2 { errors.push(Error::WrongValidatorArity { location: func_def.location, src: module.code.clone(), path: module.input_path.clone(), named: NamedSource::new( module.input_path.display().to_string(), module.code.clone(), ), name: func_def.name.clone(), at_least: 2, }) } if SPEND == func_def.name && func_def.arguments.len() < 3 { errors.push(Error::WrongValidatorArity { location: func_def.location, src: module.code.clone(), path: module.input_path.clone(), named: NamedSource::new( module.input_path.display().to_string(), module.code.clone(), ), name: func_def.name.clone(), at_least: 3, }) } validators.push(( module.input_path.clone(), module.name.clone(), func_def.clone(), )); indices_to_remove.push(index); } } } for index in indices_to_remove.drain(0..) { module.ast.definitions.remove(index); } } if errors.is_empty() { Ok(validators) } else { Err(Error::List(errors)) } } fn code_gen( &mut self, validators: Vec<(PathBuf, String, TypedFunction)>, checked_modules: &CheckedModules, ) -> Result, Error> { let mut programs = Vec::new(); let mut functions = HashMap::new(); let mut type_aliases = HashMap::new(); let mut data_types = HashMap::new(); let mut imports = HashMap::new(); let mut constants = HashMap::new(); let option_data_type = make_option(); data_types.insert( DataTypeKey { module_name: "".to_string(), defined_type: "Option".to_string(), }, &option_data_type, ); for module in checked_modules.values() { for def in module.ast.definitions() { match def { Definition::Fn(func) => { functions.insert( FunctionAccessKey { module_name: module.name.clone(), function_name: func.name.clone(), variant_name: String::new(), }, func, ); } Definition::Test(_) => {} Definition::TypeAlias(ta) => { type_aliases.insert((module.name.clone(), ta.alias.clone()), ta); } Definition::DataType(dt) => { data_types.insert( DataTypeKey { module_name: module.name.clone(), defined_type: dt.name.clone(), }, dt, ); } Definition::Use(import) => { imports.insert((module.name.clone(), import.module.join("/")), import); } Definition::ModuleConstant(mc) => { constants.insert((module.name.clone(), mc.name.clone()), mc); } } } } for (input_path, module_name, func_def) in validators { let Function { arguments, name, body, .. } = func_def; let mut generator = CodeGenerator::new( &functions, // &type_aliases, &data_types, // &imports, // &constants, &self.module_types, ); let program = generator.generate(body, arguments, true); let script = Script::new( input_path, module_name, name, program.try_into().unwrap(), None, ); programs.push(script); } Ok(programs) } // TODO: revisit ownership and lifetimes of data in this function fn collect_scripts( &mut self, checked_modules: &CheckedModules, should_collect: fn(&TypedDefinition) -> bool, ) -> Result, Error> { let mut programs = Vec::new(); let mut functions = HashMap::new(); let mut type_aliases = HashMap::new(); let mut data_types = HashMap::new(); let mut imports = HashMap::new(); let mut constants = HashMap::new(); let option_data_type = make_option(); data_types.insert( DataTypeKey { module_name: "".to_string(), defined_type: "Option".to_string(), }, &option_data_type, ); // let mut indices_to_remove = Vec::new(); let mut scripts = Vec::new(); for module in checked_modules.values() { for (_index, def) in module.ast.definitions().enumerate() { match def { Definition::Fn(func) => { functions.insert( FunctionAccessKey { module_name: module.name.clone(), function_name: func.name.clone(), variant_name: String::new(), }, func, ); if should_collect(def) { scripts.push((module.input_path.clone(), module.name.clone(), func)); } } Definition::Test(func) => { if should_collect(def) { scripts.push((module.input_path.clone(), module.name.clone(), func)); } // indices_to_remove.push(index); } Definition::TypeAlias(ta) => { type_aliases.insert((module.name.clone(), ta.alias.clone()), ta); } Definition::DataType(dt) => { data_types.insert( DataTypeKey { module_name: module.name.clone(), defined_type: dt.name.clone(), }, dt, ); } Definition::Use(import) => { imports.insert((module.name.clone(), import.module.join("/")), import); } Definition::ModuleConstant(mc) => { constants.insert((module.name.clone(), mc.name.clone()), mc); } } } // for index in indices_to_remove.drain(0..) { // module.ast.definitions.remove(index); // } } for (input_path, module_name, func_def) in scripts { let Function { arguments, name, body, .. } = func_def; let mut generator = CodeGenerator::new( &functions, // &type_aliases, &data_types, // &imports, // &constants, &self.module_types, ); let evaluation_hint = if let Some((bin_op, left_src, right_src)) = func_def.test_hint() { let left = CodeGenerator::new(&functions, &data_types, &self.module_types) .generate(*left_src, vec![], false) .try_into() .unwrap(); let right = CodeGenerator::new(&functions, &data_types, &self.module_types) .generate(*right_src, vec![], false) .try_into() .unwrap(); Some(EvalHint { bin_op, left, right, }) } else { None }; let program = generator.generate(body.clone(), arguments.clone(), false); let script = Script::new( input_path, module_name, name.to_string(), program.try_into().unwrap(), evaluation_hint, ); programs.push(script); } Ok(programs) } fn eval_scripts(&self, scripts: Vec