Skip to content

docs: record the install argument hash in canister history - #449

Open
mraszyk wants to merge 3 commits into
mainfrom
docs/canister-history-args-hash
Open

mraszyk wants to merge 3 commits into
mainfrom
docs/canister-history-args-hash

Conversation

@mraszyk

@mraszyk mraszyk commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Documents dfinity/ic#12077, which adds the SHA-256 hash of the install_code argument to code_deployment entries in the canister history.

  • public/references/ic.did: new field args_hash : opt blob in code_deployment.
  • Interface spec prose (canister_info): a code deployment is also described by the hash of the argument passed to canister_init or canister_post_upgrade; null for entries recorded before the field existed.
  • Formal model: CodeDeployment gains args_hash : opt Blob; install/reinstall and upgrade record opt SHA-256(A.arg). install_chunked_code is covered because it is rewritten to install_code.
  • Changelog: new entry 0.71.0.

Before merging: the changelog date is a placeholder (2026-11-XX, with a Needs human verification comment). dfinity/ic#12077 is not merged yet; the entry should be dated by the day the change reaches all subnets.

didc check public/references/ic.did passes. npm run build was not run locally (Node 18 on this machine; Astro needs >= 22.12), so CI is the first build check.

Document the new args_hash field of code_deployment canister history
entries introduced by dfinity/ic#12077.
@mraszyk
mraszyk requested review from a team as code owners November 12, 2026 11:42
Copilot AI balanced review requested due to automatic review settings November 12, 2026 11:42
@github-actions github-actions Bot added the interface-spec Changes to the IC interface specification label Nov 12, 2026
@github-actions

github-actions Bot commented Nov 12, 2026 •

Copy link
Copy Markdown

🤖 Here's your preview: https://4aj73-iyaaa-aaaam-aha2q-cai.icp0.io

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🔵 Needs a closer look

The upstream PR dfinity/ic#12077 remains unmerged, and a maintainer must verify rollout to all subnets and replace the placeholder changelog date before publication.

No open issues 🎉

What changed in this PR

This PR updates the Candid interface and ICP reference documentation to describe install-argument hashes in canister deployment history, corresponding to dfinity/ic#12077.

Changes:

  • Adds optional args_hash to code deployment records.
  • Updates the formal model and reference prose to describe SHA-256 argument hashing and null values for older entries.
  • Adds changelog entry 0.71.0 with a rollout-date placeholder explicitly pending verification.
File Description
public/​references/​ic.did Adds args_hash : opt blob to code_deployment.
docs/​references/​management-canister.md Describes deployment history fields returned by canister_info.
docs/​references/​ic-interface-spec/​management-canister.md Defines argument-hash semantics and compatibility with older entries.
docs/​references/​ic-interface-spec/​changelog.md Records the addition in version 0.71.0.
docs/​references/​ic-interface-spec/​abstract-behavior.md Models argument hashes for install, reinstall, and upgrade history entries.

Review effort: Balanced

Copilot AI balanced review requested due to automatic review settings November 12, 2026 11:45

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🔵 Needs a closer look

The linked implementation PR dfinity/ic#12077 remains unmerged, so a maintainer must confirm rollout to all subnets and finalize the changelog date before publication.

No open issues 🎉

Review effort: Balanced

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

interface-spec Changes to the IC interface specification

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants