Skip to content

Commit

Permalink
improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Szegoo committed Jan 18, 2024
1 parent 54f1c6a commit a5d450f
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 8 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 1 addition & 4 deletions src/common.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,7 @@ export async function transferRegion(
log(`Transferring a reigon to ${receiver}`);

const callTx = async (resolve: () => void) => {
const transfer = coretimeApi.tx.broker.transfer(
{ begin: regionId.begin, core: regionId.core, mask: regionId.mask.getMask() },
receiver
);
const transfer = coretimeApi.tx.broker.transfer(regionId, receiver);
const unsub = await transfer.signAndSend(sender, (result: any) => {

Check warning on line 33 in src/common.ts

View workflow job for this annotation

GitHub Actions / build-and-test

Unexpected any. Specify a different type
if (result.status.isInBlock) {
unsub();
Expand Down

0 comments on commit a5d450f

Please sign in to comment.