CCPEDIAby Unity Nodes
Documentation/Canton Network Docs/dApp API › Sync dApp APIView on Canton Network Docs ↗

Sync dApp API

Back to overview

OpenRPC Spec

​
Sync dApp API

An OpenRPC specification for the dapp to interact with a Wallet Provider.

JSON-RPCAdded 1.4.0Updated 1.4.0
Latest source pathapi-specs/openrpc-dapp-api.json
Publish version1.11.1
OpenRPC version1.2.6
Spec info.version0.5.0

​
Methods

Method pages are the primary reference surface. This spec page stays focused on grouping and discovery.
accountsChanged
JSON-RPC
Parameters0
Resultarray[object]
connect
JSON-RPC

Ensures ledger connectivity and returns the connected network information along with the session information.

Parameters0
Resultobject
disconnect
JSON-RPC

Invoke a disconnect of the wallet provider session.

Parameters0
Resultnull
getActiveNetwork
JSON-RPC

Returns the active network.

Parameters0
Resultobject
getPrimaryAccount
JSON-RPC

Returns the primary account.

Parameters0
Resultobject
isConnected
JSON-RPCAdded 0.26.0

Returns the connection status and the connected network information.

Parameters0
Resultobject
ledgerApi
JSON-RPC

Proxy for the JSON-API endpoints. Injects authorization headers automatically.

Parameters1
Resultobject
listAccounts
JSON-RPC

Lists the addresses (wallets) with their properties; including which network they are associated to and with signing provider is used.

Parameters0
Resultarray[object]
messageSignature
JSON-RPCAdded 1.4.0
Parameters0
ResultoneOf
prepareExecute
JSON-RPCUpdated 1.4.0

Prepares a transaction for subsequent signing & execution.

Parameters1
Resultnull
prepareExecuteAndWait
JSON-RPCUpdated 1.4.0

Like prepareExecute, but waits for the transaction to be executed on the ledger.

Parameters1
Resultobject
signMessage
JSON-RPC

Signs a message.

Parameters1
Resultobject
status
JSON-RPC

Returns the current status of the wallet provider session.

Parameters0
Resultobject
txChanged
JSON-RPC
Parameters0
ResultoneOf

​
History

Updated1.4.0

prepareExecute: The method was updated in this snapshot.

prepareExecuteAndWait: The method was updated in this snapshot.

Added1.4.0
Added0.26.0