docs(release): update CW template for coordinator v2 #876

kulikthebird · 2025-07-18T10:30:26Z

No description provided.

releases/cosmwasm/EVM-CosmWasm-Release-Template.md

greptile-apps

Greptile Summary

This PR updates the CosmWasm deployment template documentation to use the new Coordinator script instead of individual contract instantiation commands. The changes represent a significant simplification of the deployment process, consolidating 11 individual governance proposal commands into 3 high-level coordinator commands.

The key transformation involves replacing manual contract deployment steps (VotingVerifier, Gateway, MultisigProver instantiation, Router registration, Coordinator registration, and Multisig authorization) with a single coordinator.ts instantiate command that handles the complex orchestration automatically. The PR also introduces a new register-deployment command and simplifies variable naming from camelCase to UPPER_CASE for environment variables.

This change aligns with the coordinator.ts script that exists in the codebase (visible in the cosmwasm/coordinator/ directory) and represents a move toward automated deployment workflows. The coordinator approach reduces the total deployment steps from 15 to 11 and eliminates the need for operators to manually manage complex inter-contract relationships and configurations. This fits into the broader Axelar ecosystem by providing a more reliable and consistent deployment experience across different blockchain environments in the Amplifier network.

Important Files Changed

Files Changed

Filename	Score	Overview
releases/cosmwasm/EVM-CosmWasm-Release-Template.md	4/5	Updated deployment template to use new Coordinator script, replacing 11 individual commands with 3 simplified coordinator commands

Confidence score: 4/5

This PR is safe to merge with minimal risk as it only updates documentation templates
Score reflects that this is documentation-only changes that align with existing coordinator infrastructure
Pay attention to ensuring the coordinator.ts script supports all the parameters and operations referenced in the new template

Sequence Diagram

sequenceDiagram
    participant User
    participant Coordinator
    participant Gateway
    participant VotingVerifier
    participant MultisigProver
    participant Rewards
    participant Router
    participant Multisig
    participant Governance

    User->>Coordinator: "Instantiate Gateway, Verifier and Prover contracts"
    Coordinator->>Gateway: "Deploy contract instance"
    Coordinator->>VotingVerifier: "Deploy contract instance"
    Coordinator->>MultisigProver: "Deploy contract instance"
    
    User->>Coordinator: "Register deployment for chain"
    Coordinator->>Coordinator: "Register chain deployment"
    
    User->>Governance: "Submit proposal: Create reward pool for voting verifier"
    Governance->>Rewards: "Create pool for voting verifier"
    
    User->>Governance: "Submit proposal: Create reward pool for multisig"
    Governance->>Rewards: "Create pool for multisig"
    
    User->>Governance: "Submit proposal: Register ITS edge contract on ITS Hub"
    Governance->>Router: "Register ITS edge contract"
    
    User->>Rewards: "Add funds to multisig reward pool"
    User->>Rewards: "Add funds to voting verifier reward pool"
    
    User->>Router: "Query chain info to verify Gateway registration"
    Router-->>User: "Return chain gateway info"
    
    User->>Multisig: "Query caller authorization for MultisigProver"
    Multisig-->>User: "Return authorization status"
    
    User->>User: "Update ampd configuration with chain handlers"
    User->>User: "Register chain support in ampd"
    
    User->>MultisigProver: "Create genesis verifier set"
    MultisigProver->>MultisigProver: "Update verifier set"
    
    User->>MultisigProver: "Query current verifier set"
    MultisigProver-->>User: "Return active verifier set"

_{1 file reviewed, no comments}

_{Edit Code Review Bot Settings | Greptile}

…cs/update_cw_contracts_deployment

…e deployment

releases/cosmwasm/EVM-CosmWasm-Release-Template.md

isi8787 · 2025-08-14T13:42:21Z

releases/cosmwasm/EVM-CosmWasm-Release-Template.md

-# Add under `config.axelar.contracts.VotingVerifier` based on Network
-"$CHAIN" : {
-  "governanceAddress": "[governance address]",
-  "serviceName": "[service name]",
-  "sourceGatewayAddress": "[external gateway address]",
-  "votingThreshold": "[voting threshold]",
-  "blockExpiry": 10,
-  "confirmationHeight": 1000000, # if $CHAIN uses a custom finality mechanism such as the "finalized" tag, set this value very high (i.e. 1000000) to prevent accidental use
-  "msgIdFormat": "hex_tx_hash_and_event_index",
-  "addressFormat": "eip55"
-}
-
-# Add under `config.axelar.contracts.MultisigProver` based on Network
-"$CHAIN" : {
-  "governanceAddress": "[governance address]",
-  "adminAddress": "[admin address]",
-  "signingThreshold": "[signing threshold]",
-  "serviceName": "[service name]",
-  "verifierSetDiffThreshold": 0,
-  "encoder": "abi",
-  "keyType": "ecdsa"
-}


why are we removing these. There are certain configuration that still need to be published and the scripts dont do that

It's covered by the new script

see the ts-node cosmwasm/coordinator.ts instantiate command below. It is automatically saved in the config file

i dont agree with this approach, in the new scripts and PR you have set constant DEFAULT value that only matches testnet, but you can see that the values are not equivalent across all the environments so this would make it harder for deployer since now they need to still pass values in manually.

User can override the DEFAULT values by using CLI options - everything can be updated when using a single CLI command. The default values were taken directly from this document. We can always remove them and make the options required to be provided by a user

Please check the new configure command

releases/cosmwasm/EVM-CosmWasm-Release-Template.md

isi8787 · 2025-08-14T13:46:10Z

releases/cosmwasm/EVM-CosmWasm-Release-Template.md

-```

 - Add a community post for the mainnet proposal. i.e: https://community.axelar.network/t/proposal-add-its-hub-to-mainnet/3227
+- Note: [ITS proposal](../evm/EVM-ITS-Release-Template.md) should also be submitted at this time if possible.


this step is already in the guide here, as step 10 (now step 6)

I refactored a little bit the - Note: all the following governance proposals should be submitted at one time so deployment doesn't get held up while waiting for voting. [ITS proposal](../evm/EVM-ITS-Release-Template.md) should also be submitted at this time if possible. note. It says that we can proceed with ITS in parallel, though I didn't check if that makes sense - only wanted to keep it as it was

lets just add the instruction to go to step 6 for the proposal instructions rather than linking the external guide

I read the EVM-ITS-Release-Template.md and it seems that the doc and the step.7 are something different. This should be analyzed from the ITS perspective once again

…cs/update_cw_contracts_deployment

kulikthebird · 2025-08-18T08:42:51Z

releases/cosmwasm/EVM-CosmWasm-Release-Template.md

 ```

-| Network              | `deployer address`                              |
+| Network              | `DEPLOYER_ADDRESS`                              |


I'm not sure where the deployer address is actually used at the moment. The instantiate message needs to be run by a governance account

I think it will change once we have the AddOperator functionality implemented in the Coordinator contract

kulikthebird · 2025-08-18T08:46:13Z

releases/cosmwasm/EVM-CosmWasm-Release-Template.md

- Check Gateway registered at Router
-```bash
-axelard q wasm contract-state smart $ROUTER "{\"chain_info\": \"$CHAIN\"}" --output json | jq .
-# You should see something like this:
-{
-  "data": {
-    "name": \"$CHAIN\",
-    "gateway": {
-      "address": "axelar1jah3ac59xke2r266yjhh45tugzsvnlzsefyvx6jgp0msk6tp7vqqaktuz2"
-    },
-    "frozen_status": 0,
-    "msg_id_format": "hex_tx_hash_and_event_index"
-  }
-}
-```
-
- Check Multisig Prover authorized on Multisig
-```bash
-axelard q wasm contract-state smart $MULTISIG "{\"is_caller_authorized\": {\"contract_address\": \"$MULTISIG_PROVER\", \"chain_name\": \"$CHAIN\"}}" --output json | jq .
-# Result should look like:
-{
-  "data": true
-}
-```
-


I removed the registration and authorization checks since they are now part of the Coordinator contract responsibility. We should not test the implementation details of the contract during each release

…deployment

kulikthebird self-assigned this Jul 18, 2025

kulikthebird mentioned this pull request Aug 4, 2025

chore(releases): coordinator v2.1.0, multisig v2.2.0 and router v1.3.0 migration docs #883

Closed

isi8787 reviewed Aug 5, 2025

View reviewed changes

releases/cosmwasm/EVM-CosmWasm-Release-Template.md Outdated Show resolved Hide resolved

kulikthebird added 2 commits August 8, 2025 16:36

docs: update CW contracts deployment - new Coordinator

100c482

chore: update docs

58ea502

kulikthebird force-pushed the docs/update_cw_contracts_deployment branch from a334217 to 58ea502 Compare August 8, 2025 14:36

kulikthebird changed the base branch from main to feat/coordinator_script August 8, 2025 14:36

kulikthebird added 2 commits August 8, 2025 17:21

chore: add note about admins

0045023

chore: consistent naming

aa80079

kulikthebird force-pushed the docs/update_cw_contracts_deployment branch from 810e932 to aa80079 Compare August 14, 2025 11:43

kulikthebird added 3 commits August 14, 2025 13:46

docs: add contract-admin & formatting

9d93fc3

chore: remove TODO

33fe524

docs: remove redundant step

29286d0

kulikthebird marked this pull request as ready for review August 14, 2025 12:07

kulikthebird requested a review from a team as a code owner August 14, 2025 12:07

greptile-apps bot reviewed Aug 14, 2025

View reviewed changes

This comment was marked as outdated.

Sign in to view

kulikthebird added 2 commits August 14, 2025 14:44

Merge remote-tracking branch 'origin/feat/coordinator_script' into do…

6debbab

…cs/update_cw_contracts_deployment

docs: add multisig admin support & switch positions - first finish th…

d03ba80

…e deployment

This comment was marked as outdated.

Sign in to view

isi8787 reviewed Aug 14, 2025

View reviewed changes

kulikthebird added 5 commits August 14, 2025 23:04

Merge remote-tracking branch 'origin/feat/coordinator_script' into do…

2d1ebc8

…cs/update_cw_contracts_deployment

docs: remove params that are taken from .env

e459344

docs: don't test coordinator implementation here

f233dee

Merge remote-tracking branch 'origin/feat/coordinator_script' into do…

5dc0422

…cs/update_cw_contracts_deployment

docs: update template doc

dddc449

kulikthebird commented Aug 18, 2025

View reviewed changes

nbayindirli changed the title ~~docs: update CW contracts deployment - new Coordinator~~ docs(release): update CW contracts deployment - new Coordinator Aug 22, 2025

nbayindirli changed the title ~~docs(release): update CW contracts deployment - new Coordinator~~ docs(release): update CW template for coordinator v2.0.0 Aug 22, 2025

Merge branch 'feat/coordinator_script' into docs/update_cw_contracts_…

a5fdf0a

…deployment

nbayindirli changed the title ~~docs(release): update CW template for coordinator v2.0.0~~ docs(release): update CW template for coordinator v2 Aug 22, 2025

nbayindirli mentioned this pull request Aug 26, 2025

docs(releases): update template for coordinator v2 #959

Merged

docs(release): update CW template for coordinator v2 #876

Are you sure you want to change the base?

docs(release): update CW template for coordinator v2 #876

Uh oh!

Conversation

kulikthebird commented Jul 18, 2025

Uh oh!

Uh oh!

greptile-apps bot left a comment

Choose a reason for hiding this comment

Greptile Summary

Important Files Changed

Confidence score: 4/5

Sequence Diagram

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants