From 3f119436bb1f214ec0f174fddebd366e456e2433 Mon Sep 17 00:00:00 2001 From: cuteolaf Date: Mon, 6 May 2024 23:55:42 -0700 Subject: [PATCH] Update readme & zombienet test scripts (#112) * update readme * update tests * fix description(zombienet test scripts) --- README.md | 12 ++++++++++++ pallets/regions/README.md | 8 ++++---- zombienet_tests/0004-delegated-governance.zndsl | 2 +- zombienet_tests/0005-native-governance.zndsl | 2 +- 4 files changed, 18 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index cd0e92c5..b715bdb7 100644 --- a/README.md +++ b/README.md @@ -38,4 +38,16 @@ ``` zombienet-linux -p native test ./zombienet_tests/0003-custom-fee-payment.zndsl + ``` + + - delegated governance(relay chain token holders) + + ``` + zombienet-linux -p native test ./zombienet_tests/0004-delegated-governance.zndsl + ``` + + - native governance(RegionX token holders) + + ``` + zombienet-linux -p native test ./zombienet_tests/0005-native-governance.zndsl ``` \ No newline at end of file diff --git a/pallets/regions/README.md b/pallets/regions/README.md index 942d348a..f863f50b 100644 --- a/pallets/regions/README.md +++ b/pallets/regions/README.md @@ -6,9 +6,9 @@ The path for transferring a region to the RegionX chain is as follows: 1. A user goes to the CoreHub frontend and initiates a cross-chain region transfer. This triggers a `limited_reserve_transfer_assets` call on the Coretime chain, where the asset is specified as a non-fungible asset with the `Index` set to the encoded `RegionId`. -2. Upon receipt on the RegionX parachain, the XCM executor calls the RegionX `AssetTransactor`(yet to be implemented). The `AssetTransactor` handles the incoming region by making a call to the region pallet, specifically the `mint_into` function, where it passes the encoded `RegionId` as the item identifier. +2. Upon receipt on the RegionX parachain, the XCM executor calls the RegionX `AssetTransactor`(yet to be implemented). The `AssetTransactor` handles the incoming region by making a call to the **region** pallet, specifically the `mint_into` function, where it passes the encoded `RegionId` as the item identifier. -3. At this point, the RegionX chain can construct the `RegionId` from the encoded ID. However, it's still missing the region record since that's not part of the ID. mint_into makes a calls the `do_request_region_record` function, which sends an ISMP GET request to fetch the associated data from the Coretime chain. +3. At this point, the RegionX chain can construct the `RegionId` from the encoded ID. However, it's still missing the region record since that's not part of the ID. `mint_into` makes a calls the `do_request_region_record` function, which sends an ISMP GET request to fetch the associated data from the Coretime chain. 4. The ISMP pallet emits a GET request event, which the frontend has been waiting for so far. When the frontend detects a GET request event which contains the region Id of the region the user transferred, it reads the region record from the Coretime chain along with its state proof. @@ -16,6 +16,6 @@ The path for transferring a region to the RegionX chain is as follows: 6. The ISMP pallet verifies the result by checking the proof against the Coretime chain state root, which it obtains from the relay chain. -7. Upon successful validation, the ISMP pallet calls the on_response function implemented in the region pallet, passing the response as an argument. +7. Upon successful validation, the ISMP pallet calls the `on_response` function implemented in the **region** pallet, passing the response as an argument. -8. The region pallet attempts to decode the record and the associated RegionId and writes the region data do the state. +8. The **region** pallet attempts to decode the record and the associated RegionId and writes the region data do the state. diff --git a/zombienet_tests/0004-delegated-governance.zndsl b/zombienet_tests/0004-delegated-governance.zndsl index 4c63880c..3c286414 100644 --- a/zombienet_tests/0004-delegated-governance.zndsl +++ b/zombienet_tests/0004-delegated-governance.zndsl @@ -1,4 +1,4 @@ -Description: Native currency fee payment +Description: Governance by relay chain token holders Network: ./0004-delegated-governance.toml Creds: config diff --git a/zombienet_tests/0005-native-governance.zndsl b/zombienet_tests/0005-native-governance.zndsl index 3830e72c..ee0c02b8 100644 --- a/zombienet_tests/0005-native-governance.zndsl +++ b/zombienet_tests/0005-native-governance.zndsl @@ -1,4 +1,4 @@ -Description: Native currency fee payment +Description: Governance by RegionX token holders Network: ./0005-native-governance.toml Creds: config