Skip to content

CHANGELOG.md

Latest commit

 

History

History
87 lines (73 loc) · 6.01 KB

CHANGELOG.md

File metadata and controls

87 lines (73 loc) · 6.01 KB
Raw

Changelog

All notable changes to this project are documented here. The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Port note. didwebvh-dart is a faithful port of didwebvh-java, built to behave identically and verified against the same shared interop vectors, written with a Dart-idiomatic mindset.

[Unreleased]

[0.1.2] - 2026-06-14

Added

  • tool/bump-version.sh: an interactive, colorized version-bump wizard. Bumps all three packages in lockstep — version: fields, inter-package ^ constraints, the README install snippet, the generated version.g.dart, and every CHANGELOG (promoting each Unreleased section to the new dated version) — choosing patch/minor/major or an explicit version, explaining what the jump means, always confirming, loudly double-confirming a downgrade, and warning (with a continue/abort prompt) if any changelog's Unreleased section is empty.
  • tool/changelog-extract.sh: prints a single version's CHANGELOG section, used by CI for release notes.
  • CI: a github_release job in the publish workflow that, after all packages publish, creates the GitHub Release with the matching CHANGELOG.md section as its body (mirroring the didwebvh-java reference).
  • didwebvh_wizard now derives its --version string from pubspec.yaml via a generated lib/src/version.g.dart (regenerate with dart run tool/generate_version.dart) instead of a hardcoded literal.
  • Regression tests pinning that a single-element service.type array (e.g. ["DIDCommMessaging"]) survives SCID and entry-hash verification, guarding against the typed-model array-collapse bug fixed upstream in affinidi/affinidi-ssi-dart#290. This port already keeps the DID document state as a verbatim map (so it was never affected); the tests lock that in.

Changed

  • Documented and standardized the changelog conventions (in docs/AGENTS.md and the README): the root CHANGELOG.md follows Keep a Changelog (## [Unreleased] / ## [X.Y.Z] - DATE); per-package changelogs use the plain Dart-idiomatic style (## Unreleased / ## X.Y.Z - DATE).
  • tool/verify.sh now fails fast if version.g.dart is out of sync with the wizard's pubspec.yaml, and if the README install snippet pins package versions that don't match their pubspec.yaml.

[0.1.1] - 2026-06-13

Packaging-only patch (no API or behaviour change), fixing pub.dev metadata:

Fixed

  • Restored the canonical Apache-2.0 APPENDIX block in LICENSE (and each package's copy) so pub.dev's license detector recognizes it as Apache-2.0.
  • Trimmed the didwebvh package description to pub.dev's 60–180 character range.

Changed

  • Bumped all three packages to 0.1.1 and the inter-package constraints to ^0.1.1 (lockstep versioning).

[0.1.0] - 2026-06-13

First release — a complete, interop-verified Dart port of the three didwebvh-java modules across a pub workspace (didwebvh, didwebvh_signing_local, didwebvh_wizard).

Added

  • did:webvh v1.0 method (didwebvh). Full create / resolve / update / migrate / deactivate, plus parallel did:web publishing (spec §3.7.10), behind the DidWebVh facade and DidWebVhState holder.
  • Byte-exact crypto primitives ported from the Java crypto/ package: JCS (RFC 8785 canonicalization), sha2-256 multihash, base58btc multibase (z) framing, Ed25519 W3C Multikey (0xed01), SCID, entry-hash, and pre-rotation commitment generators — all gated against the shared cross-language interop vectors.
  • Model + serialization: LogEntry, Parameters, DidDocument, VersionId, DataIntegrityProof, ResolveResult/ResolutionMetadata, witness types, and the exception hierarchy. Hand-written toJson/fromJson over dart:convert (no codegen) reproduces Java's null-preserving vs null-omitting serialization exactly.
  • Signing: the async Signer interface (the one intentional architectural delta from Java — supports local keys, KMS, and HSM), eddsa-jcs-2022 ProofGenerator, and ProofVerifier (verify/isAuthorized); every proof in all vendored interop logs verifies.
  • DID URL handling: DidWebVhUrl parsing and the DidToHttpsTransformer DID→HTTPS/witness/did:web transform (NFC + IDNA/Punycode host mapping via punycode + unorm_dart).
  • Validation & witness: the full spec §3.6.2 log-chain validator (parameter merge, SCID/entry-hash/proof checks, versionTime monotonicity, pre-rotation commitment, deactivation) and threshold witness verification (spec §3.7.5/§3.7.8). Async, mirroring the async Signer.
  • Resolution: DidResolver over HTTPS (HttpDidFetcher, with a 10 s timeout and a streamed 200 KB response cap), local files, and in-memory logs, with version selection (ResolveOptions) and implicit #files/#whois services (spec §3.8/§3.9).
  • didwebvh_signing_local: LocalKeySigner — an async in-memory Ed25519 Signer on package:cryptography, with generate/fromPrivateKey/fromJson and JWK-style toJson import/export.
  • didwebvh_wizard: an interactive CLI (didwebvh_wizard, installable via dart pub global activate) for create / update (modify, migrate, deactivate) / resolve / export-did:web, with --dir/--action options and an automatic witness key store + proof collection.
  • Runnable example/ programs for didwebvh (create → resolve → update with an inline signer) and didwebvh_signing_local (full create → sign → resolve round-trip).
  • Project infrastructure: pub-workspace layout (sdk: ^3.6.0), very_good_analysis (pinned ^7.0.0 for the 3.6 floor), the tool/verify.sh one-shot gate, Codecov (80% on didwebvh; didwebvh ships at ~95%), CI SDK matrix (3.6.0/stable/beta), and tag-triggered pub.dev OIDC publishing. The full porting history and decisions live under docs/.