feat: liquid standard templates #231
Conversation
| let template_generation_args = GenerateArgs { | ||
| template_path: standard_template_path, | ||
| name: Some(target.file_name().unwrap().to_str().unwrap().to_string()), | ||
| destination: Some(target.parent().unwrap().to_path_buf()), |
There was a problem hiding this comment.
The type conversions here could maybe be done in a cleaner way ?
| use tempfile::tempdir; | ||
|
|
||
| #[test] | ||
| fn test_write_to_file() -> Result<(), Box<dyn std::error::Error>> { |
There was a problem hiding this comment.
We don't do this anymore, hence the removal.
There was a problem hiding this comment.
Nice!
About generating the Zombienet file, we can keep the previous work for that no? In the instantiate_standard_template:
// Add network configuration
use askama::Template;
let network = Network { node: "name-we-want".into() };
write_to_file(&target.join("network.toml"), network.render().expect("infallible").as_ref())?;And keep the generator/parachain.rs file with:
#[derive(Template)]
#[template(path = "base/network.templ", escape = "none")]
pub(crate) struct Network {
pub(crate) node: String,
}
| @@ -80,12 +89,19 @@ mod tests { | |||
|
|
|||
| fn setup_template_and_instantiate() -> Result<tempfile::TempDir> { | |||
| let temp_dir = tempfile::tempdir().expect("Failed to create temp dir"); | |||
| println!("{:?}", temp_dir); | |||
|
|
||
| let tag = Git::clone_and_degit(template.repository_url()?, source, tag_version)?; | ||
| // Placeholder customization | ||
| token_symbol.push_str(&*config.symbol); |
There was a problem hiding this comment.
Just small comment, this:
let mut token_symbol: String = "token-symbol=".to_string();
token_symbol.push_str(&*config.symbol);
can be refactor to:
let token_symbol: String = format!("token-symbol={}", config.symbol);There was a problem hiding this comment.
Thanks, this makes more sense!
| git: Some( | ||
| template | ||
| .repository_url() | ||
| .map_or(String::from("https://github.com/r0gue.io/base-parachain"), |r| { |
There was a problem hiding this comment.
The template.repository_url() should never produce an error because it is our responsibility to set the repository URL correctly.
Not sure the best approach here, personally I'd throw an error instead of hardcoding the base-parachain url, or if we don't want to throw an error return a the DEFAULT value in the repository_url function(https://github.com/r0gue-io/pop-cli/blob/main/crates/pop-parachains/src/templates.rs#L225, )
This PR adapts pop-cli so that it generates templates with
PopasProviderfrom a liquid template (r0gue-io/base-parachain).Includes the ability to customize the name of the project based on user's input.
The specific customized fields are:
We maintain the customization of the token's
symbolanddecimalsas well as theinitial-endowmentfor dev accounts.NewParachainCommand.decimalsis now of typeStringinstead ofu8.As it stands at this point base-parachain needs work to include the rest of templates that we are maintaining today that are not the "standard" one.
Jinja templates for parachain generation are removed as we don't need them anymore after this change.
Adds a check to verify that the decimals input given by the user is numeric.
Future work, worth to include in this PR:
The flow for initializing projects out of the templates effectively changes, meaning that trying to generate a project from
base-parachain#v1.11.0would not servenetwork.tomlwith the current binary name for the generated parachain, for instance.An option could be handling the different versions with different ways of generating the tempaltes.
Another option could be marking the templates released prior to releasing liquid tempaltes as deprecated.
How to test:
This build can be tested against the current liquid tempalted pushed to
base-parachain#liquid-templatelike this:pop new parachain --template standard -r liquid-template -s LIQUID -d 10 -i "2u64 << 60" test-parachainNote:
The flow guiding the user only presents them with the released versions of the tempalte, the liquid template hasn't been released yet. But can be used as shown above.
test_parachain_instantiate_standard_templateis not passing due to a discrepancy in the naming of the project folder created byTempDirand the generated. The generated is created using kebab-case while the temporary one seems to use camelCase . This needs addressing.