Skip to content

docs(canton): document heightId block lookups - #9591

Draft
bitgo-ai-agent-dev[bot] wants to merge 1 commit into
masterfrom
CHALO-1391-document-canton-heightid
Draft

docs(canton): document heightId block lookups#9591
bitgo-ai-agent-dev[bot] wants to merge 1 commit into
masterfrom
CHALO-1391-document-canton-heightid

Conversation

@bitgo-ai-agent-dev

Copy link
Copy Markdown
Contributor

What

  • Document Canton block lookup with the transfer response's canonical heightId.
  • Explain the ledger offset/version format and show the public block endpoint example.
  • Clarify that numeric height lookups are not reliable for Canton and that
    no other coin-specific heightId exception is defined by this package.

Why

  • Canton ledger offsets can reset, so integrations using the numeric height
    from Get Transfer receive block not found even when the transfer exists.
    Documenting heightId gives consumers the stable identifier required to
    retrieve the block.

Test plan

  • git diff --check
  • Documentation-only change; no runtime tests required.

Ticket: CHALO-1391

Document that Canton block endpoints require the canonical heightId, which combines the ledger offset with its version. This prevents integrations from using the resettable numeric height and receiving block-not-found responses.

Ticket: CHALO-1391
Session-Id: aac79c39-de9d-43ad-95cc-a5eeff6b03f4
Task-Id: 26024075-bd80-4b4b-928c-179360ccf2bf
@linear-code

linear-code Bot commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

CHALO-1391

@bitgo-ai-agent-dev
bitgo-ai-agent-dev Bot force-pushed the CHALO-1391-document-canton-heightid branch from 124c68a to c6f8180 Compare August 28, 2026 12:33
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.

1 participant