Skip to main content

Back to overview

OpenRPC Spec

User API

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

Methods

Method pages are the primary reference surface. This spec page stays focused on grouping and discovery.
addIdp
JSON-RPCAdded 0.24.0

Adds a new identity provider.

addNetwork
JSON-RPCAdded 0.24.0

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

addSession
JSON-RPCAdded 0.24.0Updated 1.7.0

Adds a network session.

allocatePartyForWallet
JSON-RPCAdded 0.24.0

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

createWallet
JSON-RPCAdded 0.24.0

Creates a new wallet and party with the given hint.

deleteMessageToSign
JSON-RPCAdded 1.4.0

Rejects a pending message signing request.

deleteTransaction
JSON-RPCAdded 0.24.0Updated 0.27.0

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

execute
JSON-RPCAdded 0.24.0Updated 0.27.0

Executes a signed transaction.

generateApiKey
JSON-RPCAdded 1.5.0

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

getMessageToSign
JSON-RPCAdded 1.4.0

Gets a pending message signing request.

getNetwork
JSON-RPCAdded 1.4.0

Returns full network configuration including auth details. Admin only.

getTransaction
JSON-RPCAdded 0.24.0Updated 0.27.0
getUser
JSON-RPCAdded 0.24.0

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

isWalletSyncNeeded
JSON-RPCAdded 0.24.0

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

listApiKeys
JSON-RPCAdded 1.5.0

Lists all API keys for the current user and network.

listIdps
JSON-RPCAdded 0.24.0
listMessagesToSign
JSON-RPCAdded 1.4.0
listNetworks
JSON-RPCAdded 0.24.0Updated 1.4.0

Lists configured networks without sensitive authentication details.

listSessions
JSON-RPCAdded 0.24.0
listSigningProviderVaults
JSON-RPCAdded 1.5.0

Lists available vaults of a signing provider

listTransactions
JSON-RPCAdded 0.24.0Updated 1.7.0
listWallets
JSON-RPCAdded 0.24.0

Lists wallets.

removeApiKey
JSON-RPCAdded 1.5.0

Removes an API key for the current user and network.

removeIdp
JSON-RPCAdded 0.24.0

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

removeNetwork
JSON-RPCAdded 0.24.0

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

removeSession
JSON-RPCAdded 0.24.0

Removes the current network session.

removeWallet
JSON-RPCAdded 0.24.0

Removes a party with the given hint.

selfSignedAccessToken
JSON-RPCAdded 1.4.0

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

setPrimaryWallet
JSON-RPCAdded 0.24.0

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

sign
JSON-RPCAdded 0.24.0Updated 0.27.0

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

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…

syncWallets
JSON-RPCAdded 0.24.0

Synchronizes wallets with the connected network.

History

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

Added0.24.0