Skip to content

docs(heimdall): add operator-facing quick-start guide

2d687a2
Select commit
Loading
Failed to load commit list.
Draft

Adding heimdall commands to polycli #904

docs(heimdall): add operator-facing quick-start guide
2d687a2
Select commit
Loading
Failed to load commit list.
SonarQubeCloud / SonarCloud Code Analysis failed Apr 20, 2026 in 31s

Quality Gate failed

Failed conditions
13.7% Duplication on New Code (required ≤ 3%)
E Security Rating on New Code (required ≥ A)

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE

Annotations

Check failure on line 57 in scripts/capture-heimdall-fixtures.sh

See this annotation in the file changed.

@sonarqubecloud sonarqubecloud / SonarCloud Code Analysis

Use '[[' instead of '[' for conditional tests. The '[[' construct is safer and more feature-rich.

See more on https://sonarcloud.io/project/issues?id=0xPolygon_polygon-cli&issues=AZ2suoJrMEXeMQGE-yJt&open=AZ2suoJrMEXeMQGE-yJt&pullRequest=904

Check failure on line 21 in cmd/heimdall/tx/msgs/stake_join.go

See this annotation in the file changed.

@sonarqubecloud sonarqubecloud / SonarCloud Code Analysis

Refactor this method to reduce its Cognitive Complexity from 19 to the 15 allowed.

See more on https://sonarcloud.io/project/issues?id=0xPolygon_polygon-cli&issues=AZ2sun-rMEXeMQGE-yIk&open=AZ2sun-rMEXeMQGE-yIk&pullRequest=904

Check failure on line 143 in internal/heimdall/config/config.go

See this annotation in the file changed.

@sonarqubecloud sonarqubecloud / SonarCloud Code Analysis

Refactor this method to reduce its Cognitive Complexity from 19 to the 15 allowed.

See more on https://sonarcloud.io/project/issues?id=0xPolygon_polygon-cli&issues=AZ2suoJgMEXeMQGE-yJp&open=AZ2suoJgMEXeMQGE-yJp&pullRequest=904

Check failure on line 16 in cmd/heimdall/topup/proof.go

See this annotation in the file changed.

@sonarqubecloud sonarqubecloud / SonarCloud Code Analysis

Refactor this method to reduce its Cognitive Complexity from 24 to the 15 allowed.

See more on https://sonarcloud.io/project/issues?id=0xPolygon_polygon-cli&issues=AZ2sun7OMEXeMQGE-yIN&open=AZ2sun7OMEXeMQGE-yIN&pullRequest=904

Check failure on line 20 in cmd/heimdall/clerk/sequence.go

See this annotation in the file changed.

@sonarqubecloud sonarqubecloud / SonarCloud Code Analysis

Refactor this method to reduce its Cognitive Complexity from 24 to the 15 allowed.

See more on https://sonarcloud.io/project/issues?id=0xPolygon_polygon-cli&issues=AZ2suoAYMEXeMQGE-yIw&open=AZ2suoAYMEXeMQGE-yIw&pullRequest=904

Check failure on line 39 in cmd/heimdall/milestone/get.go

See this annotation in the file changed.

@sonarqubecloud sonarqubecloud / SonarCloud Code Analysis

Refactor this method to reduce its Cognitive Complexity from 20 to the 15 allowed.

See more on https://sonarcloud.io/project/issues?id=0xPolygon_polygon-cli&issues=AZ2suoCvMEXeMQGE-yI9&open=AZ2suoCvMEXeMQGE-yI9&pullRequest=904

Check failure on line 17 in cmd/heimdall/validator/status.go

See this annotation in the file changed.

@sonarqubecloud sonarqubecloud / SonarCloud Code Analysis

Refactor this method to reduce its Cognitive Complexity from 22 to the 15 allowed.

See more on https://sonarcloud.io/project/issues?id=0xPolygon_polygon-cli&issues=AZ2suoGSMEXeMQGE-yJU&open=AZ2suoGSMEXeMQGE-yJU&pullRequest=904

Check failure on line 102 in scripts/capture-heimdall-fixtures.sh

See this annotation in the file changed.

@sonarqubecloud sonarqubecloud / SonarCloud Code Analysis

Use '[[' instead of '[' for conditional tests. The '[[' construct is safer and more feature-rich.

See more on https://sonarcloud.io/project/issues?id=0xPolygon_polygon-cli&issues=AZ2suoJrMEXeMQGE-yJv&open=AZ2suoJrMEXeMQGE-yJv&pullRequest=904

Check failure on line 138 in scripts/capture-heimdall-fixtures.sh

See this annotation in the file changed.

@sonarqubecloud sonarqubecloud / SonarCloud Code Analysis

Use '[[' instead of '[' for conditional tests. The '[[' construct is safer and more feature-rich.

See more on https://sonarcloud.io/project/issues?id=0xPolygon_polygon-cli&issues=AZ2suoJrMEXeMQGE-yJ0&open=AZ2suoJrMEXeMQGE-yJ0&pullRequest=904

Check failure on line 32 in cmd/heimdall/ops/peers.go

See this annotation in the file changed.

@sonarqubecloud sonarqubecloud / SonarCloud Code Analysis

Refactor this method to reduce its Cognitive Complexity from 21 to the 15 allowed.

See more on https://sonarcloud.io/project/issues?id=0xPolygon_polygon-cli&issues=AZ2sun6dMEXeMQGE-yIG&open=AZ2sun6dMEXeMQGE-yIG&pullRequest=904

Check failure on line 44 in cmd/heimdall/ops/consensus.go

See this annotation in the file changed.

@sonarqubecloud sonarqubecloud / SonarCloud Code Analysis

Refactor this method to reduce its Cognitive Complexity from 17 to the 15 allowed.

See more on https://sonarcloud.io/project/issues?id=0xPolygon_polygon-cli&issues=AZ2sun54MEXeMQGE-yIB&open=AZ2sun54MEXeMQGE-yIB&pullRequest=904

Check failure on line 72 in cmd/heimdall/tx/msgs/execute.go

See this annotation in the file changed.

@sonarqubecloud sonarqubecloud / SonarCloud Code Analysis

Refactor this method to reduce its Cognitive Complexity from 28 to the 15 allowed.

See more on https://sonarcloud.io/project/issues?id=0xPolygon_polygon-cli&issues=AZ2sun-MMEXeMQGE-yIg&open=AZ2sun-MMEXeMQGE-yIg&pullRequest=904

Check failure on line 138 in scripts/capture-heimdall-fixtures.sh

See this annotation in the file changed.

@sonarqubecloud sonarqubecloud / SonarCloud Code Analysis

Use '[[' instead of '[' for conditional tests. The '[[' construct is safer and more feature-rich.

See more on https://sonarcloud.io/project/issues?id=0xPolygon_polygon-cli&issues=AZ2suoJrMEXeMQGE-yJ1&open=AZ2suoJrMEXeMQGE-yJ1&pullRequest=904

Check failure on line 21 in cmd/heimdall/checkpoint/lastnoack.go

See this annotation in the file changed.

@sonarqubecloud sonarqubecloud / SonarCloud Code Analysis

Refactor this method to reduce its Cognitive Complexity from 16 to the 15 allowed.

See more on https://sonarcloud.io/project/issues?id=0xPolygon_polygon-cli&issues=AZ2suoD6MEXeMQGE-yJE&open=AZ2suoD6MEXeMQGE-yJE&pullRequest=904

Check failure on line 207 in internal/heimdall/proto/msgs_stake.go

See this annotation in the file changed.

@sonarqubecloud sonarqubecloud / SonarCloud Code Analysis

Refactor this method to reduce its Cognitive Complexity from 17 to the 15 allowed.

See more on https://sonarcloud.io/project/issues?id=0xPolygon_polygon-cli&issues=AZ2suoI8MEXeMQGE-yJk&open=AZ2suoI8MEXeMQGE-yJk&pullRequest=904

Check warning on line 30 in cmd/heimdall/ops/commit.go

See this annotation in the file changed.

@sonarqubecloud sonarqubecloud / SonarCloud Code Analysis

Extract this nested anonymous struct into a named type for better readability and reusability.

See more on https://sonarcloud.io/project/issues?id=0xPolygon_polygon-cli&issues=AZ2sun6nMEXeMQGE-yIK&open=AZ2sun6nMEXeMQGE-yIK&pullRequest=904

Check failure on line 19 in cmd/heimdall/topup/sequence.go

See this annotation in the file changed.

@sonarqubecloud sonarqubecloud / SonarCloud Code Analysis

Refactor this method to reduce its Cognitive Complexity from 27 to the 15 allowed.

See more on https://sonarcloud.io/project/issues?id=0xPolygon_polygon-cli&issues=AZ2sun7hMEXeMQGE-yIP&open=AZ2sun7hMEXeMQGE-yIP&pullRequest=904

Check failure on line 18 in cmd/heimdall/decode/msg.go

See this annotation in the file changed.

@sonarqubecloud sonarqubecloud / SonarCloud Code Analysis

Refactor this method to reduce its Cognitive Complexity from 21 to the 15 allowed.

See more on https://sonarcloud.io/project/issues?id=0xPolygon_polygon-cli&issues=AZ2suoE7MEXeMQGE-yJM&open=AZ2suoE7MEXeMQGE-yJM&pullRequest=904

Check warning on line 30 in cmd/heimdall/ops/consensus.go

See this annotation in the file changed.

@sonarqubecloud sonarqubecloud / SonarCloud Code Analysis

Extract this nested anonymous struct into a named type for better readability and reusability.

See more on https://sonarcloud.io/project/issues?id=0xPolygon_polygon-cli&issues=AZ2sun54MEXeMQGE-yID&open=AZ2sun54MEXeMQGE-yID&pullRequest=904

Check failure on line 18 in cmd/heimdall/util/version.go

See this annotation in the file changed.

@sonarqubecloud sonarqubecloud / SonarCloud Code Analysis

Refactor this method to reduce its Cognitive Complexity from 17 to the 15 allowed.

See more on https://sonarcloud.io/project/issues?id=0xPolygon_polygon-cli&issues=AZ2suoFcMEXeMQGE-yJP&open=AZ2suoFcMEXeMQGE-yJP&pullRequest=904

Check warning on line 29 in cmd/heimdall/ops/consensus.go

See this annotation in the file changed.

@sonarqubecloud sonarqubecloud / SonarCloud Code Analysis

Extract this nested anonymous struct into a named type for better readability and reusability.

See more on https://sonarcloud.io/project/issues?id=0xPolygon_polygon-cli&issues=AZ2sun54MEXeMQGE-yIC&open=AZ2sun54MEXeMQGE-yIC&pullRequest=904

Check failure on line 21 in cmd/heimdall/wallet/address.go

See this annotation in the file changed.

@sonarqubecloud sonarqubecloud / SonarCloud Code Analysis

Refactor this method to reduce its Cognitive Complexity from 17 to the 15 allowed.

See more on https://sonarcloud.io/project/issues?id=0xPolygon_polygon-cli&issues=AZ2sun8qMEXeMQGE-yIW&open=AZ2sun8qMEXeMQGE-yIW&pullRequest=904

Check failure on line 28 in cmd/heimdall/tx/logs.go

See this annotation in the file changed.

@sonarqubecloud sonarqubecloud / SonarCloud Code Analysis

Refactor this method to reduce its Cognitive Complexity from 26 to the 15 allowed.

See more on https://sonarcloud.io/project/issues?id=0xPolygon_polygon-cli&issues=AZ2sun_iMEXeMQGE-yIr&open=AZ2sun_iMEXeMQGE-yIr&pullRequest=904

Check failure on line 119 in internal/heimdall/render/render.go

See this annotation in the file changed.

@sonarqubecloud sonarqubecloud / SonarCloud Code Analysis

Refactor this method to reduce its Cognitive Complexity from 26 to the 15 allowed.

See more on https://sonarcloud.io/project/issues?id=0xPolygon_polygon-cli&issues=AZ2suoHJMEXeMQGE-yJZ&open=AZ2suoHJMEXeMQGE-yJZ&pullRequest=904

Check failure on line 303 in cmd/heimdall/decode/tx.go

See this annotation in the file changed.

@sonarqubecloud sonarqubecloud / SonarCloud Code Analysis

Refactor this method to reduce its Cognitive Complexity from 21 to the 15 allowed.

See more on https://sonarcloud.io/project/issues?id=0xPolygon_polygon-cli&issues=AZ2suoExMEXeMQGE-yJL&open=AZ2suoExMEXeMQGE-yJL&pullRequest=904