index

Ledger JSON API reference

These pages document LedgerJsonApiClient on canton.ledger, plus waitForCompletion and waitForCompletionWithMetadata, exported from @fairmint/canton-node-sdk alongside the client.

Commands

• submitAndWait — synchronous submit, minimal response
• submitAndWaitForTransaction — submit and return a transaction
• submitAndWaitForTransactionTree — submit and return a transaction tree
• submitAndWaitForReassignment — blocking reassignment batch
• asyncSubmit — non-blocking command submit
• asyncSubmitReassignment — non-blocking reassignment
• completions — HTTP completion polling (batch cursor)
• subscribeToCompletions — WebSocket completions

Parties

• allocateParty
• listParties
• getParties
• getPartyDetails
• updatePartyDetails
• getParticipantId
• generateExternalPartyTopology
• allocateExternalParty

Packages

• listPackages
• getPackageStatus
• uploadDarFile

State and ACS

• getLedgerEnd
• getActiveContracts
• getConnectedSynchronizers
• getLatestPrunedOffsets

Updates and transactions

• getUpdateById
• getUpdateByOffset
• getTransactionById
• getTransactionByOffset
• getTransactionTreeById
• getTransactionTreeByOffset
• subscribeToUpdates
• getEventsByContractId

Completion helpers

• waitForCompletion
• waitForCompletionWithMetadata

Interactive submission

• interactiveSubmissionPrepare
• interactiveSubmissionExecute
• interactiveSubmissionAllocateParty
• interactiveSubmissionCreateUser
• interactiveSubmissionUploadDar
• interactiveSubmissionGetPreferredPackageVersion
• interactiveSubmissionGetPreferredPackages

Users and rights

• createUser
• getUser
• updateUser
• deleteUser
• listUsers
• grantUserRights
• listUserRights
• revokeUserRights
• updateUserIdentityProvider

Identity providers

• createIdentityProviderConfig
• listIdentityProviderConfigs
• getIdentityProviderConfig
• updateIdentityProviderConfig
• deleteIdentityProviderConfig

Version and authenticated user

• getVersion
• getAuthenticatedUser