From 757b1ed9f07e15ebc39ffbb62683c5c11e6a6510 Mon Sep 17 00:00:00 2001 From: Sergej Sakac <73715684+Szegoo@users.noreply.github.com> Date: Thu, 18 Jan 2024 19:16:15 +0100 Subject: [PATCH] Improve docs (#40) * use latest coretim-utils * improve docs --- README.md | 8 ++++++++ package-lock.json | 8 ++++---- package.json | 2 +- 3 files changed, 13 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index cd4bee8..460cb3f 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,9 @@ The local environment consists of three chains: ### Getting started with Zombienet +NOTE: Before proceeding make sure to have zombienet setup on your machine and accessible from your PATH. +You can find linux and macOS executables of the Zombienet CLI [here](https://github.com/paritytech/zombienet/releases) + ```sh # Clone the repo: git clone https://github.com/RegionX-Labs/Coretime-Mock.git @@ -78,8 +81,13 @@ This repo provides an init program which will based on the selected options set - Description: Specify an account on the coretime chain. When specified the program will transfer a mock region to this account. **An example with all options:** + +> NOTE: As explained above `npm run zombienet:full` must be running in the background to be able to proceed with the following steps: + ```sh # Before executing the zombienet-init:full command, ensure that the contracts within the RegionX directory are compiled. +# Before compiling the contract make sure the pallet index is configured correctly for Shibuya: +# https://github.com/RegionX-Labs/RegionX?tab=readme-ov-file#4-deploy # To compile the contracts, navigate to the RegionX directory and execute the following commands: # # cd RegionX/contracts/xc-regions diff --git a/package-lock.json b/package-lock.json index 1339e5b..d150479 100644 --- a/package-lock.json +++ b/package-lock.json @@ -16,7 +16,7 @@ "@polkadot/util-crypto": "^12.6.2", "bn.js": "^5.2.1", "commander": "^11.1.0", - "coretime-utils": "^0.1.9", + "coretime-utils": "^0.2.3", "ts-node": "^10.9.2" }, "devDependencies": { @@ -1734,9 +1734,9 @@ "integrity": "sha512-ty/fTekppD2fIwRvnZAVdeOiGd1c7YXEixbgJTNzqcxJWKQnjJ/V1bNEEE6hygpM3WjwHFUVK6HTjWSzV4a8sQ==" }, "node_modules/coretime-utils": { - "version": "0.1.9", - "resolved": "https://registry.npmjs.org/coretime-utils/-/coretime-utils-0.1.9.tgz", - "integrity": "sha512-njZ+pPHYVS7CsJRbKrQHc5XRWkXd+ILbXTbqnPlpM4jB4JY/O3ScpvtKpMrhYvihKsUsQbKlStpHgxiIp7NCjg==", + "version": "0.2.3", + "resolved": "https://registry.npmjs.org/coretime-utils/-/coretime-utils-0.2.3.tgz", + "integrity": "sha512-dhKdYwv7XOd5LUYIQR1R3FZGtEG75buzmoKoYXov5Cnc0xcBXwdAC33rAKR1NbTTXiImQvEG/kpgOVhG+H7RwA==", "dependencies": { "@polkadot/util": "^12.6.2" } diff --git a/package.json b/package.json index 803eb0b..94b8d18 100644 --- a/package.json +++ b/package.json @@ -25,7 +25,7 @@ "@polkadot/util-crypto": "^12.6.2", "bn.js": "^5.2.1", "commander": "^11.1.0", - "coretime-utils": "^0.1.9", + "coretime-utils": "^0.2.3", "ts-node": "^10.9.2" }, "devDependencies": {