Skip to content

Commit

Permalink
doc: update user guides with latest changes in partner-chains-cli (#304)
Browse files Browse the repository at this point in the history
* doc: update user guides with latest changes in partner-chains-cli
* doc: fix chain builder guide and update local env diagram
  • Loading branch information
alexromanov authored Dec 11, 2024
1 parent 2a10d8f commit aacddc0
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 6 deletions.
Binary file modified dev/local-environment/pc-local-env.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
23 changes: 19 additions & 4 deletions docs/user-guides/chain-builder.md
Original file line number Diff line number Diff line change
Expand Up @@ -265,14 +265,17 @@ Now the wizard will output `partner-chains-public-keys.json` containing three ke

### 3. Run the prepare-configuration wizard

Before running this wizard, be sure that `cardano-cli` is available and has an exposed socket to a running `cardano-node`.
Before running this wizard, be sure that `ogmios` is available by host and port.

1. Start the wizard:`./partner-chains-cli prepare-configuration`
2. Update the bootnodes array and provide public ip or hostname
3. Set the partner-chains parameters
4. Store the main chain configuration
3. Provide required payment keys and select genesis utxo to initialize the chain
4. Configure initial native token supply address (optional)
5. Store the main chain configuration

This wizard will submit a governance initialisation transaction, that spends the genesis utxo. It will also result in a `partner-chains-cli-chain-config.json` file. After it has been generated, it should be updated with your keys and the keys of other *permissioned* candidates in the `initial_permissioned_candidates` array.
This wizard will submit a governance initialization transaction, that spends the genesis utxo. It will also result in a `partner-chains-cli-chain-config.json` file. The wizard also adds required cardano addresses and policy ids to the configuration file.

After chain-config file has been generated, it should be updated with your keys and the keys of other *permissioned* candidates in the `initial_permissioned_candidates` array.

Example:

Expand Down Expand Up @@ -317,6 +320,18 @@ A sample file:
"network": 0,
"security_parameter": 2160
},
"cardano_addresses": {
"committee_candidates_address": "addr_...",
"d_parameter_policy_id": "bd292a4e...",
"native_token": {
"asset": {
"asset_name": "0x",
"policy_id": "0x00000000000000000000000000000000000000000000000000000000"
},
"illiquid_supply_address": "addr_..."
},
"permissioned_candidates_policy_id": "63ecb396..."
},
"chain_parameters": {
"genesis_utxo": "0000000000000000000000000000000000000000000000000000000000000000#0",
},
Expand Down
1 change: 0 additions & 1 deletion docs/user-guides/permissioned.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,6 @@ The configuration of the chain is stored in the file `partner-chains-cli-chain-c

---

---
**NOTE**

Information about the resources used by each node is stored in the file `partner-chain-cli-resources-config.json`. This file should be present on every node in the network, but its contents are specific to each node.
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guides/registered.md
Original file line number Diff line number Diff line change
Expand Up @@ -344,7 +344,7 @@ To deregister from the list of block producer candidates, you need to run the de

The configuration of the chain is stored in the file `partner-chains-cli-chain-config.json`. This file needs to remain identical with other nodes in the network.

---

---

**NOTE**
Expand Down

0 comments on commit aacddc0

Please sign in to comment.