update tools readme with polkadot-launch instructions (paritytech#300)

Co-authored-by: Amar Singh <[email protected]>
Co-authored-by: Joshy Orndorff <[email protected]>

tools/README.md

@@ -1,19 +1,25 @@
 # Tools
 
+_NB: this folder is yarn only_
+
 ## Moonbeam-Launch
 
-Moonbeam-launch is a fork of https://github.com/paritytech/polkadot-launch that allows to run
-a test script on multiple nodes.
+_Moonbeam-launch_ (https://github.com/PureStake/polkadot-launch/tree/moonbeam-launch) is a fork of polkadot-launch adapted for Moonbeam's needs for testing. Eventually, polkadot-launch should catch up and remove the need for a custom implementation.
+
+_Polkadot-launch_ (https://github.com/paritytech/polkadot-launch) allows to start a local network of polkadot relaychain and parachain nodes with the desired configuration.
 
-To use it, follow instructions to build polkadot in the same repo : (from https://github.com/PureStake/polkadot-launch/tree/moonbeam-launch)
+For this setup, you want to have moonbeam and polkadot cloned in the same repo:
+- repo
+    - moonbeam
+    - polkadot
 
 ### Build Parachain
 
 In the moonbeam repo, checkout to the desired commit of moonbeam and then run:
 
 ```
 cargo build --release
-./target/release/moonbase-alphanet --version
+./target/release/moonbeam --version
 ```
 
 ### Build Relaychain
@@ -27,15 +33,138 @@ git checkout <commit sha>
 cargo build --release --features=real-overseer
 ```
 
-### Launch script
+### Launch Script
+
+Run `yarn run build-moonbeam-launch` to install the correct dependency
+    - Installs PureStake moonbeam-launch branch
+
+Run `yarn run moonbeam-launch` to start a network with `config_moonbeam.json`
+    - Installs PureStake moonbeam-launch branch
+    - Starts a local network with `config_moonbeam.json`
+
+Run `yarn run moonbeam-test`, if you want to run a simple test sending transactions to different addresses:
+    - Installs PureStake moonbeam-launch branch
+    - Starts a local network with `config_moonbeam.json`
+    - Runs a simple test sending transactions and testing propagation
+
+### Launch Custom Scripts
+
+Before you run a custom script, run `yarn run build-moonbeam-launch` to install the correct dependency
+
+If you want to run the staking test, run `ts-node test-staking.ts`
 
-And then run `yarn run moonbeam-launch`
+If you want to write your own custom test, use the start function from `polkadot-launch` :
+
+`import { start } from "polkadot-launch";`
+
+And then you can call it with the desired test-config this way:
+
+`await start("config_moonbeam_staking.json");`
 
 ### Change Config
 
 Change the path in the config_moonbeam.json file to use polkadot in a different location.
 
+### Understand The Config
+
+Let's look at the staking test-config:
+
+```
+{
+  "relaychain": { // This field corresponds to the relaychain nodes config
+    "bin": "../../polkadot/target/release/polkadot", // The executable for the relay chain
+    "chain": "rococo-local", // chain param for relay-chain
+    "nodes": [ // # of nodes needs to be >= # of collator nodes
+      {
+        "name": "alice",
+        "wsPort": 36944,
+        "port": 36444
+      },
+      {
+        "name": "bob",
+        "wsPort": 36955,
+        "port": 36555
+      },
+      {
+        "name": "charlie",
+        "wsPort": 36956,
+        "port": 36556
+      },
+      {
+        "name": "dave",
+        "wsPort": 36957,
+        "port": 36557
+      }
+    ]
+  },
+  "parachains": [ // This field corresponds to the parachain nodes config
+    {
+      "bin": "../target/release/moonbeam", // parachain executable
+      "id": "1000", // Parachain id, use the same id if collators are of the same parachain
+      "rpcPort": 36846,
+      "wsPort": 36946, // Don't forget to increment the ports
+      "port": 36335,
+      "balance": "1000", // Balance of relaychain tokens used by the parachain to register
+      "chain": "staking-test-spec.json", // custom specs for the parachain
+      "flags": [
+        "--no-telemetry",
+        "--no-prometheus",
+        "--author-id=6be02d1d3665660d22ff9624b7be0551ee1ac91b",
+        "--", // before this are the collator flags, after are the relaychain related flags
+        "--execution=wasm"
+      ]
+    },
+    {
+      "bin": "../target/release/moonbeam",
+      "id": "1000", // this node is of the same parachain
+      "rpcPort": 36847,
+      "wsPort": 36947,
+      "port": 36336,
+      "balance": "1000",
+      "chain": "staking-test-spec.json",
+      "flags": [
+        "--no-telemetry",
+        "--no-prometheus",
+        "--author-id=C0F0f4ab324C46e55D02D0033343B4Be8A55532d",
+        "--",
+        "--execution=wasm"
+      ]
+    },
+    {
+      "bin": "../target/release/moonbeam",
+      "id": "1000",
+      "rpcPort": 36848,
+      "wsPort": 36948,
+      "port": 36337,
+      "balance": "1000",
+      "chain": "staking-test-spec.json",
+      "flags": [
+        "--no-telemetry",
+        "--no-prometheus",
+        "--author-id=Ff64d3F6efE2317EE2807d223a0Bdc4c0c49dfDB",
+        "--",
+        "--execution=wasm"
+      ]
+    }
+  ],
+  "simpleParachains": [], // This is used by paritytech to test "simple" (dev) parachains
+  "hrmpChannels": [], // This is used to setup hrmp channels from the start
+  // it would look like this:
+  // {
+  //		"sender": 200,
+  // 		"recipient": 300,
+  //		"maxCapacity": 8,
+  //   		"maxMessageSize": 512
+  // }
+  "types": { // This is were relaychain types are added. We are adding this due to discrepancy
+  // between polkadot repo and published polkadot rococo
+    "Address": "MultiAddress",
+    "LookupSource": "MultiAddress"
+  }
+}
+```
+
 ### Generate Test Specs
 
-To update the specs, run :
-`./target/release/moonbeam build-spec --chain local >test.json`
+To generate the specs, run :
+`./target/release/moonbeam build-spec --chain local >new-specs.json`

tools/yarn.lock

@@ -4112,7 +4112,7 @@ pkg@^4.4.9:
 
 polkadot-launch@PureStake/polkadot-launch#moonbeam-launch:
   version "1.0.12"
-  resolved "https://codeload.github.com/PureStake/polkadot-launch/tar.gz/e0ab521ca814a1a2ec7af4914ea5b8087bb85c1c"
+  resolved "https://codeload.github.com/PureStake/polkadot-launch/tar.gz/077ecbe74d0ebc30d337ce98429e1306d87ac04c"
   dependencies:
     "@polkadot/api" "^3.11.1"
     "@polkadot/util" "^5.9.2"