ZombieNet new SDK

[pepoviola]

The Vision

This issue will track the progress of the new ZombieNet SDK.

We want to create a new SDK for ZombieNet that allow users to build more complex use cases and interact with the network in a more flexible and programatic way.
The SDK will provide a set of building blocks that users can combine in order to spawn and interact (test/query/etc) with the network providing a fluent api to craft different topologies and assertions to the running network. The new SDK will support the same range of providers and configurations that can be created in the current version (v1).

We also want to continue supporting the CLI interface but should be updated to use the SDK under the hood.

The Plan

We plan to divide the work phases to. ensure we cover all the requirement and inside each phase in small tasks, covering one of the building blocks and the interaction between them.

Prototype building blocks

Prototype each building block with a clear interface and how to interact with it

• [SDK] Building block Network #525
• [SDK] Building block Node #529
• [SDK] Building block NodeGroup #530
• [SDK] Building block Parachain #531
• [SDK] Building block Collator #532
• [SDK] Building block CollatorGroup #533
• [SDK] Building block Assertion #534

Integrate, test interactions and document

We want to integrate the interactions for all building blocks and document the way that they work together.

• [SDK] Spawning integration #536
• [SDK] Assertion integration #535
• [SDK] Docs #538

Refactor CLI and ensure backwards compatibility

Refactor the CLI module to use the new SDK under the hood.

• [SDK] Refactor CLI #539
• [SDK] Ensure spawning from toml works #537
• [SDK] Ensure test-runner from DSL works #540

Open Questions

• We have to revisit some of the defaults assumptions that we use today:
  • [SDK] Make cumulus_based (true) the default behavior and need to set to false to use adder/undying collators. #542
  • [SDK] SDK can be written in TS allowing to re-use some of the existing code and also have a smooth integration with polkadot.js/Capi or Rust and have a better integration with the polkadot code. #543

---

Here you can find the board with specific sub-tasks to this milestone:
https://github.com/orgs/paritytech/projects/55/views/2

[wirednkod]

Moved to paritytech/zombienet-sdk#1