Skip to main content

Back to overview

OpenRPC Spec

ā€‹
Async dApp API

An OpenRPC specification for remotely hosted Wallet Providers. Due to the remote nature, an implementing provider must bridge certain functionality on the client-side to satisfy the general dApp API spec.

JSON-RPCAdded 1.4.0Updated 1.4.0
Latest source pathapi-specs/openrpc-dapp-remote-api.json
Publish version1.11.1
OpenRPC version1.2.6
Spec info.version0.1.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.

Parameters0
Resultobject
connected
JSON-RPC

Informs when the user connects to a network.

Parameters0
Resultobject
disconnect
JSON-RPC

Invoke a disconnect of the wallet gateway 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
Parameters0
Resultarray[object]
messageSignature
JSON-RPCAdded 1.4.0
Parameters0
ResultoneOf
onStatusChanged
JSON-RPC
Parameters0
Resultobject
prepareExecute
JSON-RPCUpdated 1.4.0

Prepares, signs, and executes a transaction.

Parameters1
Resultobject
signMessage
JSON-RPCUpdated 1.4.0

Requests a message signature. The wallet will prompt the user for confirmation.

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.

signMessage: description updated; result updated (schema ref, required fields)

Added1.4.0
Added0.26.0