Skip to content

Add a new protocol configuration markers runbook - #3451

Merged
turmelclem merged 1 commit into
mainfrom
ctl/3399-create-runbook-for-on-chain-configuration-parameters
Aug 24, 2026
Merged

Add a new protocol configuration markers runbook#3451
turmelclem merged 1 commit into
mainfrom
ctl/3399-create-runbook-for-on-chain-configuration-parameters

Conversation

@turmelclem

@turmelclem turmelclem commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Content

Introduce a new runbook to persist protocol configuration on chain, it described how to :

  • use the new aggregator CLI command to export protocol current protocol configuration
  • manually edit JSON
  • use the new aggregator CLI command to generate datum
  • write datum on chain

Pre-submit checklist

  • Branch
    • Tests are provided (if possible)
    • Crates versions are updated (if relevant)
    • CHANGELOG file is updated (if relevant)
    • Commit sequence broadly makes sense
    • Key commits have useful messages
  • PR
    • All check jobs of the CI have succeeded
    • Self-reviewed the diff
    • Useful pull request description
    • Reviewer requested
  • Documentation
    • Update README file (if relevant)
    • Update documentation website (if relevant)
    • Add dev blog post (if relevant)
    • Add ADR blog post or Dev ADR entry (if relevant)
    • No new TODOs introduced

Issue(s)

This PR closes #3399

@turmelclem turmelclem self-assigned this Aug 3, 2026
@turmelclem
turmelclem force-pushed the ctl/3399-create-runbook-for-on-chain-configuration-parameters branch from aa703e7 to 836f6c5 Compare August 3, 2026 10:12
@github-actions

github-actions Bot commented Aug 3, 2026

Copy link
Copy Markdown

Test Results

     5 files     209 suites   51m 16s ⏱️
 3 396 tests  3 396 ✅ 0 💤 0 ❌
11 250 runs  11 250 ✅ 0 💤 0 ❌

Results for commit 23a4070.

♻️ This comment has been updated with latest results.

@turmelclem
turmelclem force-pushed the ctl/3399-create-runbook-for-on-chain-configuration-parameters branch 2 times, most recently from 9356c71 to 8a8f185 Compare August 17, 2026 13:04
@turmelclem
turmelclem temporarily deployed to testing-2-preview August 17, 2026 13:27 — with GitHub Actions Inactive
@turmelclem
turmelclem marked this pull request as ready for review August 19, 2026 13:01
@jpraynaud
jpraynaud requested a lite review from Copilot August 23, 2026 14:34

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR introduces a new operator runbook under docs/runbook/ that documents how to persist Mithril protocol configuration markers on-chain (bootstrap and update), using the mithril-aggregator CLI and cardano-cli.

Changes:

  • Added a step-by-step runbook for exporting current protocol configuration markers, editing the JSON, generating a datum payload, and submitting it on-chain.
  • Documented both initial bootstrap (first datum UTxO) and subsequent update flows (re-spending existing datum UTxO).

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/runbook/protocol-configuration-markers/README.md Outdated
Comment thread docs/runbook/protocol-configuration-markers/README.md Outdated
Comment thread docs/runbook/protocol-configuration-markers/README.md Outdated
Comment thread docs/runbook/protocol-configuration-markers/README.md Outdated
Comment thread docs/runbook/protocol-configuration-markers/README.md Outdated
Comment thread docs/runbook/protocol-configuration-markers/README.md Outdated
Comment thread docs/runbook/protocol-configuration-markers/README.md Outdated

@Alenar Alenar left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jpraynaud jpraynaud left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

I left few comments below to make the UX seamless.

Comment thread docs/runbook/protocol-configuration-markers/README.md Outdated
Comment thread docs/runbook/protocol-configuration-markers/README.md Outdated
Comment thread docs/runbook/protocol-configuration-markers/README.md Outdated
Comment thread docs/runbook/protocol-configuration-markers/README.md Outdated
Comment thread docs/runbook/protocol-configuration-markers/README.md Outdated
Comment thread docs/runbook/protocol-configuration-markers/README.md
@turmelclem
turmelclem force-pushed the ctl/3399-create-runbook-for-on-chain-configuration-parameters branch 2 times, most recently from 51049bf to 216f4cb Compare August 24, 2026 15:34
@turmelclem
turmelclem force-pushed the ctl/3399-create-runbook-for-on-chain-configuration-parameters branch from 216f4cb to 23a4070 Compare August 24, 2026 15:49
@turmelclem
turmelclem temporarily deployed to testing-2-preview August 24, 2026 16:04 — with GitHub Actions Inactive
@turmelclem
turmelclem merged commit 6ca6181 into main Aug 24, 2026
50 checks passed
@turmelclem
turmelclem deleted the ctl/3399-create-runbook-for-on-chain-configuration-parameters branch August 24, 2026 16:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create runbook for on-chain configuration parameters

4 participants