Skip to main content

Back to overview

OpenRPC Spec

User API

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

JSON-RPCSince 0.24.0Changed 1.4.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.

deleteMessageToSign
JSON-RPCSince 1.4.0

Rejects a pending message signing request.

deleteTransaction
JSON-RPCSince 0.24.0Changed 0.27.0

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

execute
JSON-RPCSince 0.24.0Changed 0.27.0

Executes a signed transaction.

generateApiKey
JSON-RPCSince 1.5.0

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

getMessageToSign
JSON-RPCSince 1.4.0

Gets a pending message signing request.

getNetwork
JSON-RPCSince 1.4.0

Returns full network configuration including auth details. Admin only.

getTransaction
JSON-RPCSince 0.24.0Changed 0.27.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).

listApiKeys
JSON-RPCSince 1.5.0

Lists all API keys for the current user and network.

listIdps
JSON-RPCSince 0.24.0
listMessagesToSign
JSON-RPCSince 1.4.0
listNetworks
JSON-RPCSince 0.24.0Changed 1.4.0

Lists configured networks without sensitive authentication details.

listSessions
JSON-RPCSince 0.24.0
listSigningProviderVaults
JSON-RPCSince 1.5.0

Lists available vaults of a signing provider

listTransactions
JSON-RPCSince 0.24.0Changed 0.27.0
listWallets
JSON-RPCSince 0.24.0

Lists wallets.

removeApiKey
JSON-RPCSince 1.5.0

Removes an API key for the current user and network.

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.

selfSignedAccessToken
JSON-RPCSince 1.4.0

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

setPrimaryWallet
JSON-RPCSince 0.24.0

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

sign
JSON-RPCSince 0.24.0Changed 0.27.0

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

signMessage
JSON-RPCSince 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-RPCSince 0.24.0

Synchronizes wallets with the connected network.