Skip to main content

Back to overview

OpenRPC Spec

User API

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

Latest source pathapi-specs/openrpc-user-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.
addIdp
JSON-RPC

Adds a new identity provider.

Parameters1
Resultnull
addNetwork
JSON-RPC

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

Parameters1
Resultnull
addSession
JSON-RPCUpdated 1.7.0

Adds a network session.

Parameters1
Resultobject

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

Parameters1
Resultobject
changeSigningProvider
JSON-RPCAdded 1.10.0

Change signing provider for the specified party

Parameters1
Resultnull
createWallet
JSON-RPC

Creates a new wallet and party with the given hint.

Parameters1
Resultobject
deleteMessageToSign
JSON-RPCAdded 1.4.0

Rejects a pending message signing request.

Parameters1
Resultnull
deleteTransaction
JSON-RPCUpdated 0.27.0

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

Parameters1
Resultnull
execute
JSON-RPCUpdated 0.27.0

Executes a signed transaction.

Parameters1
Resultobject
generateApiKey
JSON-RPCAdded 1.5.0

Generates a new API key for the current user and network.

Parameters1
Resultobject
getMessageToSign
JSON-RPCAdded 1.4.0

Gets a pending message signing request.

Parameters1
Resultobject
getNetwork
JSON-RPCAdded 1.4.0

Returns full network configuration including auth details. Admin only.

Parameters1
Resultobject
getTransaction
JSON-RPCUpdated 0.27.0
Parameters1
Resultobject
getUser
JSON-RPC

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

Parameters0
Resultobject
getWallet
JSON-RPCAdded 1.10.0

Get a wallet by party ID for the connected user on the current network.

Parameters1
ResultoneOf

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

Parameters0
Resultobject
listApiKeys
JSON-RPCAdded 1.5.0

Lists all API keys for the current user and network.

Parameters0
Resultobject
listIdps
JSON-RPC
Parameters0
Resultobject
listMessagesToSign
JSON-RPCAdded 1.4.0
Parameters0
Resultobject
listNetworks
JSON-RPCUpdated 1.4.0

Lists configured networks without sensitive authentication details.

Parameters0
Resultobject
listSessions
JSON-RPC
Parameters0
Resultobject
listSigningProviderKeys
JSON-RPCAdded 1.10.0

Lists available keys of a signing provider

Parameters1
Resultobject
listTransactions
JSON-RPCUpdated 1.7.0
Parameters1
Resultobject
listWallets
JSON-RPC

Lists wallets.

Parameters1
Resultarray[object]
removeApiKey
JSON-RPCAdded 1.5.0

Removes an API key for the current user and network.

Parameters1
Resultnull
removeIdp
JSON-RPC

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

Parameters1
Resultnull

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

Parameters1
Resultnull

Removes the current network session.

Parameters0
Resultnull
removeWallet
JSON-RPC

Removes a party with the given hint.

Parameters1
Resultobject
selfSignedAccessToken
JSON-RPCAdded 1.4.0Updated 1.10.0

Mints a self-signed access token using server-side network credentials. Used for login on self-signed networks.

Parameters1
Resultobject

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

Parameters1
Resultnull
sign
JSON-RPCUpdated 0.27.0

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

Parameters1
ResultoneOf
signMessage
JSON-RPCAdded 1.4.0

Signs an arbitrary UTF-8 message with the wallet’s private key (Ed25519). The message bytes are signed as-is; callers are expected to embed any application-level domai…

Parameters1
Resultobject
syncWallets
JSON-RPC

Synchronizes wallets with the connected network.

Parameters0
Resultobject
listSigningProviderVaults
JSON-RPCAdded 1.5.0Removed in 1.10.0

Lists available vaults of a signing provider

Parameters1
Resultobject

History

Methods removed in1.10.0

listSigningProviderVaults: Last available in 1.9.0. Retained for historical reference.

Updated1.10.0

selfSignedAccessToken: params updated: params

Added1.10.0
Updated1.7.0

addSession: params updated: params

listTransactions: params added: params; result updated (required fields)

Added1.5.0
Updated1.4.0

listNetworks: description updated

Added1.4.0
Updated0.27.0

deleteTransaction: params updated: params

execute: params updated: params

getTransaction: params updated: params; result updated (required fields)

listTransactions: The method was updated in this snapshot.

sign: params updated: params

Updated0.26.0

sign: params updated: params