Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.canton.network/llms.txt

Use this file to discover all available pages before exploring further.

Back to overview

OpenRPC Spec

User API

An OpenRPC specification for the user to interact with the Wallet Gateway.

JSON-RPCSince 0.24.0

Methods

Method pages are the primary reference surface. This spec page stays focused on grouping and discovery.

addIdp

JSON-RPCSince 0.24.0

Adds a new identity provider.

addNetwork

JSON-RPCSince 0.24.0

Adds a new network configuration (similar to EIP-3085).

addSession

JSON-RPCSince 0.24.0

Adds a network session.

allocatePartyForWallet

JSON-RPCSince 0.24.0

Allocates a party for an already initialized wallet if external signing is complete.

createWallet

JSON-RPCSince 0.24.0

Creates a new wallet and party with the given hint.

deleteTransaction

JSON-RPCSince 0.24.0

Deletes a pending transaction. Only transactions with status ‘pending’ can be deleted.

execute

JSON-RPCSince 0.24.0

Executes a signed transaction.

getTransaction

JSON-RPCSince 0.24.0

getUser

JSON-RPCSince 0.24.0

Returns information about the current user, including whether they are an admin.

isWalletSyncNeeded

JSON-RPCSince 0.24.0

Checks if wallet sync is needed (disabled wallets or new parties on ledger).

listIdps

JSON-RPCSince 0.24.0

listNetworks

JSON-RPCSince 0.24.0

listSessions

JSON-RPCSince 0.24.0

listTransactions

JSON-RPCSince 0.24.0

listWallets

JSON-RPCSince 0.24.0

Lists wallets.

removeIdp

JSON-RPCSince 0.24.0

Removes an identity provider. Fails if an existing network is using the identity provider.

removeNetwork

JSON-RPCSince 0.24.0

Removes a new network configuration (similar to EIP-3085).

removeSession

JSON-RPCSince 0.24.0

Removes the current network session.

removeWallet

JSON-RPCSince 0.24.0

Removes a party with the given hint.

setPrimaryWallet

JSON-RPCSince 0.24.0

Sets the specified wallet as the primary wallet for dApp usage.

sign

JSON-RPCSince 0.24.0

Signs the provided data with the private key of the specified or active party.

syncWallets

JSON-RPCSince 0.24.0

Synchronizes wallets with the connected network.