Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

polkadot-parachains folder restructuring. #1240

Closed
hbulgarini opened this issue May 6, 2022 · 4 comments · Fixed by #1266
Closed

polkadot-parachains folder restructuring. #1240

hbulgarini opened this issue May 6, 2022 · 4 comments · Fixed by #1266
Assignees

Comments

@hbulgarini
Copy link
Contributor

hbulgarini commented May 6, 2022

In order to enhance the developer experience and documentation for engineers working with the parachains living under polkadot-parachains, a new folder called parachain-runtimes will be created with the following structure:

  • parachain-runtimes
    • chain-specs (formerly known as res)
    • common
      • utilities (common shared code / libraries)
      • tests ( folder containing unit tests for different functionalities ) Moved topolkadot-parachain folder
    • pallets
      • specific pallets for parachains (e.g. collator-selection)
    • src (entry point folder for commands/services etc ) Moved to polkadot-parachain folder
    • starters
      • shell (can be used to launch an "empty" runtime that can be upgraded via a downward message)
      • seedling (runtime with sudo to register prior to migrating a solo-chain into a parachain)
      • scaffold (formerly known as parachain-template, a scaffold/template for teams to start from when developing a runtime) Discussion
    • testing
      • pen-pal (parachain runtime ready with the necessary XCM setup to test interactions with Statemine/Statemint)
      • rococo-parachain (used for creating Tick/Trick/Track parachains). Discussion Is rococo-parachain necessary? #1222
    • assets
      • statemine
      • statemint
    • contracts
      • substrate-contracts
    • governance (as an example of a potential common good parachain dedicated to governance)
      • kusama-gov
      • polkadot-gov
    • etc...

Also based as a result of a diagnostic of the existing parachains on the folder, Wesmint would be removed since we would be deploying the Statemint runtime directly on Westend.

Every parachain runtime should include a rust doc with the purpose of it.

@joepetrowski

@gilescope
Copy link
Contributor

Would like penpal not hyphenated but it's all fine with me.

@hbulgarini hbulgarini self-assigned this May 6, 2022
@bkchr
Copy link
Member

bkchr commented May 9, 2022

starters

* shell (can be used to launch an "empty" runtime that can be upgraded via a downward message)

* seedling (runtime with sudo to register prior to migrating a solo-chain into a parachain)

* scaffold (formerly known as `parachain-template`, a scaffold/template for teams to start from when developing a runtime)

Why should this entire stuff be moved there? I mean I get that shell and seedling are already there as a runtime, but the template is an entire node. Not sure this makes sense.

@hbulgarini
Copy link
Contributor Author

Why should this entire stuff be moved there? I mean I get that shell and seedling are already there as a runtime, but the template is an entire node. Not sure this makes sense.

OK. Fair enough. We will not move the parachain-template into the polkadot-parachains folder and it can remain as it is with no changes.

@hbulgarini hbulgarini changed the title polkadot-parachains folder restructure. polkadot-parachains folder restructuring. May 10, 2022
@gilescope
Copy link
Contributor

gilescope commented May 17, 2022

As discussed in the meeting, having the polkadot-parachain collator in the same dir as the runtimes does not lend itself to trying to separate out these two things (which have separate release cycles). The suggestion that seemed to have some backing is to split the contents of polkadot-parachains into polkadot-parachain (the collator) and parachain-runtimes (the runtimes).

@hbulgarini hbulgarini changed the title polkadot-parachains folder restructuring. parachain-runtimes folder restructuring. May 18, 2022
@hbulgarini hbulgarini changed the title parachain-runtimes folder restructuring. polkadot-parachains folder restructuring. May 18, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants