Skip to content

v0.1.4 — documentation fixes from the Foundation review

Choose a tag to compare

@dmitryk-cf dmitryk-cf released this 05 Aug 18:50
· 152 commits to main since this release

Documentation and developer-experience fixes from the Canton Foundation review
of the M1 submission. No library code changes; 0.1.3 and 0.1.4 are the same
SDK.

Fixed

  • Examples: version_and_health and submit_and_read read the same
    CANTON_TEST_* variables as the live tests (the unprefixed CANTON_*
    spellings still work and take precedence). They previously required a second,
    undocumented set of six names, so following the README's own setup and then
    running the example it links to failed on set CANTON_TOKEN_URL.
  • Live tests: the ACS token-paging test no longer caps the walk at 500
    pages. At page size 1 that bounded the ledger rather than the loop, so on a
    participant with a few hundred contracts a healthy walk reported "paging did
    not terminate". It now fails when the page token stops advancing, which is
    the condition it was meant to catch.

Documentation

  • README: the live-test variables are documented under their real names
    (every one is CANTON_TEST_-prefixed) in a table that says what each gates,
    with a copy-pasteable export block. CANTON_TEST_JSON_ENDPOINT (the JSON and
    WebSocket tests) and CANTON_TEST_SYNC_ID were previously undocumented, and
    six names were listed without their prefix.
  • README: node setup lists the
    Canton Builder Tool
    and Splice LocalNet
    alongside cn-quickstart, with what each one actually provides: Splice
    LocalNet is unauthenticated, so the OIDC-gated tests skip there as well as the
    command-submission ones; the Builder Tool's canton builder deploy uploads a
    DAR, which is how to get CANTON_TEST_LICENSING_PKG without cn-quickstart.

All six crates release in lockstep at 0.1.4 (canton, canton-core, canton-proto, canton-auth, canton-ledger, canton-admin) — mix only equal versions.

cargo add canton@0.1.4