feat: add new parachain template and remove outdated one from parity #297

AlexD10S · 2024-08-28T20:59:45Z

This PR introduces the new Parity parachain template: Polkadot SDK's Parachain Template

Additionally, the Frontier Parachain template has been removed due to its lack of maintenance (no updates in the past 9 months). For now, we will keep the Contracts Parachain, as its last update was just 4 months ago, but it will remain marked as deprecated.

Closes #238

Note for reviewer:The version bump for Zombienet-SDK is necessary due to the following fix paritytech/zombienet-sdk#253

codecov · 2024-08-29T07:26:43Z

Codecov Report

Attention: Patch coverage is 88.88889% with 19 lines in your changes missing coverage. Please review.

Project coverage is 70.66%. Comparing base (582db18) to head (34ff183).

Files with missing lines	Patch %	Lines
crates/pop-parachains/src/up/mod.rs	87.39%	2 Missing and 13 partials ⚠️
crates/pop-cli/src/commands/new/parachain.rs	55.55%	4 Missing ⚠️

@@            Coverage Diff             @@
##             main     #297      +/-   ##
==========================================
+ Coverage   70.32%   70.66%   +0.33%     
==========================================
  Files          53       53              
  Lines        9098     9254     +156     
  Branches     9098     9254     +156     
==========================================
+ Hits         6398     6539     +141     
- Misses       1718     1721       +3     
- Partials      982      994      +12

Files with missing lines	Coverage Δ
crates/pop-common/src/templates/mod.rs	`64.58% <100.00%> (+7.08%)`	⬆️
crates/pop-parachains/src/templates.rs	`98.43% <100.00%> (+0.23%)`	⬆️
crates/pop-cli/src/commands/new/parachain.rs	`46.17% <55.55%> (+0.04%)`	⬆️
crates/pop-parachains/src/up/mod.rs	`87.52% <87.39%> (+0.11%)`	⬆️

evilrobot-01 · 2024-09-06T06:54:01Z

A reminder that removals should be deprecated, if not already

AlexD10S · 2024-09-06T07:40:56Z

A reminder that removals should be deprecated, if not already

In this case, we had a message from the start indicating that the Parity templates were deprecated: https://github.com/r0gue-io/pop-cli/blob/main/crates/pop-cli/src/commands/new/parachain.rs#L132. I believe it would be reasonable to remove the deprecated template in the next release.

evilrobot-01 · 2024-09-06T07:44:15Z

Perfect!

evilrobot-01

Just an initial quick review.

crates/pop-parachains/src/templates.rs

crates/pop-parachains/src/up/mod.rs

brunopgalvao

┌   Pop CLI : Launch a local network
│
▲  ⚠️ The following binaries required to launch the network cannot be found locally:
│     > polkadot-parachain
│  
◇  📦 Would you like to source them automatically now? It may take some time...
│     > polkadot-parachain v1.13.0
│  Yes 
│
⚙  ℹ️ Binaries will be cached at /Users/bruno/Library/Caches/pop
│  
◇  📦 Sourcing binaries...
│  ✅  polkadot-parachain
│
◐  🚀 Launching local network...                                                                                           
thread 'main' panicked at /Users/bruno/.cargo/registry/src/index.crates.io-6f17d22bba15001f/zombienet-orchestrator-0.2.7/src/lib.rs:390:36:
removal index (is 0) should be < len (is 0)
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

Steps to reproduce:

I generated the Polkadot SDK Parachain Template using pop new parachain command, then ran pop build then pop up parachain -f zombienet.toml

brunopgalvao · 2024-09-20T18:53:31Z

crates/pop-cli/src/commands/new/parachain.rs

@@ -216,7 +216,7 @@ async fn generate_parachain_from_template(
 	// add next steps
 	let mut next_steps = vec![
 		format!("cd into \"{name_template}\" and enjoy hacking! 🚀"),
-		"Use `pop build` to build your parachain.".into(),
+		"Use `pop build --release` to build your parachain.".into(),


I would keep it pop build. Adding --release takes way too long for development, and could degrade the UX for parachain development. --release should be suggested when prepping the chain for onboarding.

I made this change because it's common in the Zombienet configuration file to reference /target/release/. See https://github.com/OpenZeppelin/polkadot-runtime-templates/blob/main/generic-template/zombienet-config/devnet.toml#L21 or https://github.com/r0gue-io/pop-cli/blob/main/tests/networks/template.toml#L16.
Without running pop build --release, the path needs to be manually updated in the Zombienet file for things to work correctly.

brunopgalvao · 2024-09-20T18:55:51Z

crates/pop-parachains/src/templates.rs

-		message = "EVM",
-		detailed_message = "Template node for a Frontier (EVM) based parachain.",
+		serialize = "cpt",
+		message = "Contracts",


What is the different between our Pop contract template and the substrate-contract-node?

Parity one is paritytech/polkadot-sdk-parachain-template and our is contracts. The cpt command has been retained for backward compatibility as we changed the naming to paritytech/substrate-contracts-node but is now marked as deprecated: #297 (comment)

brunopgalvao · 2024-09-20T18:57:34Z

crates/pop-parachains/src/templates.rs

-		detailed_message = "Template node for a Frontier (EVM) based parachain.",
+		serialize = "cpt",
+		message = "Contracts",
+		detailed_message = "Minimal Substrate node configured for smart contracts via pallet-contracts.",


Change this:

(Minimal Substrate node configured for smart contracts via pallet-contracts. [deprecated])

To this:

(Minimal Substrate node configured for smart contracts via pallet-contracts. [deprecated]. Suggested to use Pop > Contracts template instead.)

Nitpick, there is an extra space after most of the template prompts e.g.:

(A standard parachain ) (Parachain configured with fungible and non-fungilble asset functionalities. ) (Parachain configured to support WebAssembly smart contracts. ) (Parachain configured with Frontier, enabling compatibility with the Ethereum Virtual Machine (EVM). ) (The Parachain-Ready Template From Polkadot SDK. )

Is this a parachain? The prompt says: "Select the type of parachain" and defaults to ./my-parachain:

◇ Select a template provider: │ Parity │ ◇ Select the type of parachain: │ Contracts │ ⚙ Template License: Unlicense │ ◇ Select a specific release: │ v0.41.0 │ ◆ Where should your project be created? │ ./my-parachain

If so, we should say:

(Minimal parachain configured for smart contracts via pallet-contracts. [deprecated]. Suggested to use Pop > Contracts template instead.)

I've addressed the first two nitpicks you mentioned, but I'm unsure about the last point. The question with the default value ./my-parachain is: "Where should your project be created?" To me, it doesn't make sense to add the description there. Could you clarify what you meant?

brunopgalvao · 2024-09-20T19:27:42Z

   Compiling polkadot-service v11.0.0
   Compiling cumulus-relay-chain-minimal-node v0.11.0
   Compiling cumulus-relay-chain-inprocess-interface v0.11.0
   Compiling cumulus-client-service v0.11.0
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 7m 42s
Error: Missing binary: contracts-node

Steps to reproduce

I generated the Parity substrate contracts node (v0.41.0) using pop new parachain then got this error when running pop build.

AlexD10S · 2024-09-22T07:16:11Z

┌   Pop CLI : Launch a local network
│
▲  ⚠️ The following binaries required to launch the network cannot be found locally:
│     > polkadot-parachain
│  
◇  📦 Would you like to source them automatically now? It may take some time...
│     > polkadot-parachain v1.13.0
│  Yes 
│
⚙  ℹ️ Binaries will be cached at /Users/bruno/Library/Caches/pop
│  
◇  📦 Sourcing binaries...
│  ✅  polkadot-parachain
│
◐  🚀 Launching local network...                                                                                           
thread 'main' panicked at /Users/bruno/.cargo/registry/src/index.crates.io-6f17d22bba15001f/zombienet-orchestrator-0.2.7/src/lib.rs:390:36:
removal index (is 0) should be < len (is 0)
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

Steps to reproduce:

I generated the Polkadot SDK Parachain Template using pop new parachain command, then ran pop build then pop up parachain -f zombienet.toml

It looks like you're using the pop installed from the main branch, not from the current branch. The error you're seeing occurs because the parachain template contains [parachain.collator], which was addressed in the latest version of Zombienet. That's why we're updating the Zombienet version in this branch (Read description).

AlexD10S · 2024-09-22T07:28:52Z

   Compiling polkadot-service v11.0.0
   Compiling cumulus-relay-chain-minimal-node v0.11.0
   Compiling cumulus-relay-chain-inprocess-interface v0.11.0
   Compiling cumulus-client-service v0.11.0
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 7m 42s
Error: Missing binary: contracts-node
Steps to reproduce

I generated the Parity substrate contracts node (v0.41.0) using pop new parachain then got this error when running pop build.

I see... If you run pop up parachain -f zombienet.toml, it works, but the error message during the build looks bad. Could you open an issue in their repository instead? https://github.com/paritytech/substrate-contracts-node. Alternatively, we could decide to remove this template if it's not going to be fixed.

AlexD10S added 3 commits August 28, 2024 11:31

feat: include new parachain template and remove old one for Parity

12610ef

fix: tests

31ac60d

fix: order in test

fec60a8

fix: export PATH

392bdd9

AlexD10S added 5 commits September 6, 2024 11:17

chore: merge main

c085a66

Merge branch 'main' into alex/parity-template

ba6b7e0

chore: bump zombienet-sdk version

e5ab436

fix: remove parity evm

5da07ef

fix: missing changes

6070af6

AlexD10S marked this pull request as ready for review September 12, 2024 12:25

AlexD10S added 3 commits September 12, 2024 15:26

fix: parse collator and parachain-template-node without path for spawn

dbf1ee7

chore: remove set PATH

d83700d

refactor: functionality and test

316de33

AlexD10S mentioned this pull request Sep 13, 2024

pop new: Use latest paritytech templates #238

Open

evilrobot-01 reviewed Sep 13, 2024

View reviewed changes

crates/pop-parachains/src/templates.rs Outdated Show resolved Hide resolved

refactor: prefix for external templates

9f2076b

AlexD10S requested review from evilrobot-01 and brunopgalvao September 17, 2024 08:51

evilrobot-01 changed the title ~~feat: add new parachain template and remove outdated one from Parity~~ feat: add new parachain template and remove outdated one from parity Sep 18, 2024

evilrobot-01 requested changes Sep 18, 2024

View reviewed changes

AlexD10S added 6 commits September 18, 2024 16:54

fix: deprecate old command for generating parity contracts template

7addd9b

test: update configure_works test to test new functionality

d40ec06

test: fix unit tests templates

7017d63

fix: show deprecation message and fixes

9871fe2

chore: merge main

2b549c4

docs: improve comments

7fbb66b

AlexD10S requested review from evilrobot-01 and al3mart September 18, 2024 17:33

brunopgalvao reviewed Sep 20, 2024

View reviewed changes

refactor: nitpicks in parachain description

abfca64

fix: logic for substrate-contracts-node without path in config file

34ff183

AlexD10S requested a review from brunopgalvao September 22, 2024 07:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add new parachain template and remove outdated one from parity #297

feat: add new parachain template and remove outdated one from parity #297

AlexD10S commented Aug 28, 2024 •

edited

Loading

codecov bot commented Aug 29, 2024 •

edited

Loading

evilrobot-01 commented Sep 6, 2024

AlexD10S commented Sep 6, 2024

evilrobot-01 commented Sep 6, 2024

evilrobot-01 left a comment

brunopgalvao left a comment

brunopgalvao Sep 20, 2024

AlexD10S Sep 22, 2024

brunopgalvao Sep 20, 2024

AlexD10S Sep 22, 2024 •

edited

Loading

brunopgalvao Sep 20, 2024

brunopgalvao Sep 20, 2024

brunopgalvao Sep 20, 2024

AlexD10S Sep 22, 2024

brunopgalvao commented Sep 20, 2024

AlexD10S commented Sep 22, 2024

Steps to reproduce:

AlexD10S commented Sep 22, 2024

Steps to reproduce

feat: add new parachain template and remove outdated one from parity #297

Are you sure you want to change the base?

feat: add new parachain template and remove outdated one from parity #297

Conversation

AlexD10S commented Aug 28, 2024 • edited Loading

codecov bot commented Aug 29, 2024 • edited Loading

Codecov Report

evilrobot-01 commented Sep 6, 2024

AlexD10S commented Sep 6, 2024

evilrobot-01 commented Sep 6, 2024

evilrobot-01 left a comment

Choose a reason for hiding this comment

brunopgalvao left a comment

Choose a reason for hiding this comment

Steps to reproduce:

brunopgalvao Sep 20, 2024

Choose a reason for hiding this comment

AlexD10S Sep 22, 2024

Choose a reason for hiding this comment

brunopgalvao Sep 20, 2024

Choose a reason for hiding this comment

AlexD10S Sep 22, 2024 • edited Loading

Choose a reason for hiding this comment

brunopgalvao Sep 20, 2024

Choose a reason for hiding this comment

brunopgalvao Sep 20, 2024

Choose a reason for hiding this comment

brunopgalvao Sep 20, 2024

Choose a reason for hiding this comment

AlexD10S Sep 22, 2024

Choose a reason for hiding this comment

brunopgalvao commented Sep 20, 2024

Steps to reproduce

AlexD10S commented Sep 22, 2024

Steps to reproduce:

AlexD10S commented Sep 22, 2024

Steps to reproduce

AlexD10S commented Aug 28, 2024 •

edited

Loading

codecov bot commented Aug 29, 2024 •

edited

Loading

AlexD10S Sep 22, 2024 •

edited

Loading