diff --git a/.github/workflows/update-version-dashboard.yml b/.github/workflows/update-version-dashboard.yml
index 4e50007ca..133587813 100644
--- a/.github/workflows/update-version-dashboard.yml
+++ b/.github/workflows/update-version-dashboard.yml
@@ -23,8 +23,14 @@ jobs:
- name: Set up Nix
uses: cachix/install-nix-action@v31
- - name: Update version dashboard
- run: nix-shell --run 'npm run generate:version-compatibility-dashboard'
+ - name: Update version dashboard and Wallet Gateway OpenRPC
+ env:
+ GH_TOKEN: ${{ github.token }}
+ GITHUB_TOKEN: ${{ github.token }}
+ run: |
+ nix-shell --run 'npm run generate:version-compatibility-dashboard'
+ nix-shell --run 'npm run update:generated-reference-sources -- --source wallet-gateway-openrpc'
+ nix-shell --run 'npm run generate:wallet-gateway-openrpc-reference'
- name: Detect changes
id: changes
@@ -45,8 +51,9 @@ jobs:
if: steps.changes.outputs.has_changes == 'true'
env:
GH_TOKEN: ${{ github.token }}
+ PR_BASE_BRANCH: ${{ github.ref_name }}
PR_BRANCH: version-dashboard/update
- PR_TITLE: Update version dashboard data
+ PR_TITLE: Update version dashboard and generated references
run: |
set -euo pipefail
@@ -54,7 +61,12 @@ jobs:
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
git switch -c "$PR_BRANCH"
- git add config/repo-version-config.json docs-main/snippets/generated/version-dashboard-data.mdx
+ git add \
+ config/repo-version-config.json \
+ config/x2mdx/wallet-gateway-openrpc/source-artifacts.json \
+ docs-main/docs.json \
+ docs-main/reference/wallet-gateway-json-rpc \
+ docs-main/snippets/generated/version-dashboard-data.mdx
git commit -m "$PR_TITLE"
if remote_sha="$(git ls-remote --heads origin "$PR_BRANCH" | awk '{print $1}')" && [[ -n "$remote_sha" ]]; then
@@ -67,8 +79,12 @@ jobs:
cat > "$pr_body" <<'EOF'
Updates the committed Canton Network version dashboard data from public network, package, and installer sources.
+ Also updates the Wallet Gateway OpenRPC source pin to the latest stable wallet-gateway-remote release and regenerates the checked-in Wallet Gateway OpenRPC reference pages.
+
Validation run by the workflow:
- `npm run generate:version-compatibility-dashboard`
+ - `npm run update:generated-reference-sources -- --source wallet-gateway-openrpc`
+ - `npm run generate:wallet-gateway-openrpc-reference`
- `git diff --check`
EOF
@@ -76,7 +92,7 @@ jobs:
gh pr list \
--repo "$GITHUB_REPOSITORY" \
--head "$PR_BRANCH" \
- --base main \
+ --base "$PR_BASE_BRANCH" \
--state open \
--json number \
--jq '.[0].number // empty'
@@ -87,11 +103,15 @@ jobs:
--repo "$GITHUB_REPOSITORY" \
--title "$PR_TITLE" \
--body-file "$pr_body"
+ gh pr ready "$existing_pr_number" \
+ --repo "$GITHUB_REPOSITORY" \
+ --undo
else
gh pr create \
- --base main \
+ --base "$PR_BASE_BRANCH" \
--head "$PR_BRANCH" \
--repo "$GITHUB_REPOSITORY" \
+ --draft \
--title "$PR_TITLE" \
--body-file "$pr_body"
fi
diff --git a/config/x2mdx/wallet-gateway-openrpc/source-artifacts.json b/config/x2mdx/wallet-gateway-openrpc/source-artifacts.json
index bafd8ccc0..325d463b3 100644
--- a/config/x2mdx/wallet-gateway-openrpc/source-artifacts.json
+++ b/config/x2mdx/wallet-gateway-openrpc/source-artifacts.json
@@ -4,7 +4,7 @@
"remote": "https://github.com/hyperledger-labs/splice-wallet-kernel.git",
"tag_prefix": "@canton-network/wallet-gateway-remote@",
"min_version": "0.24.0",
- "publish_version": "0.25.0",
+ "publish_version": "1.4.0",
"specs": [
{
"spec_id": "dapp-api",
diff --git a/docs-main/docs.json b/docs-main/docs.json
index cd3e0c2c8..84c9ca1de 100644
--- a/docs-main/docs.json
+++ b/docs-main/docs.json
@@ -1499,8 +1499,10 @@
"reference/wallet-gateway-json-rpc/operations/dapp-api/disconnect",
"reference/wallet-gateway-json-rpc/operations/dapp-api/getactivenetwork",
"reference/wallet-gateway-json-rpc/operations/dapp-api/getprimaryaccount",
+ "reference/wallet-gateway-json-rpc/operations/dapp-api/isconnected",
"reference/wallet-gateway-json-rpc/operations/dapp-api/ledgerapi",
"reference/wallet-gateway-json-rpc/operations/dapp-api/listaccounts",
+ "reference/wallet-gateway-json-rpc/operations/dapp-api/messagesignature",
"reference/wallet-gateway-json-rpc/operations/dapp-api/prepareexecute",
"reference/wallet-gateway-json-rpc/operations/dapp-api/prepareexecuteandwait",
"reference/wallet-gateway-json-rpc/operations/dapp-api/signmessage",
@@ -1518,8 +1520,10 @@
"reference/wallet-gateway-json-rpc/operations/dapp-remote-api/disconnect",
"reference/wallet-gateway-json-rpc/operations/dapp-remote-api/getactivenetwork",
"reference/wallet-gateway-json-rpc/operations/dapp-remote-api/getprimaryaccount",
+ "reference/wallet-gateway-json-rpc/operations/dapp-remote-api/isconnected",
"reference/wallet-gateway-json-rpc/operations/dapp-remote-api/ledgerapi",
"reference/wallet-gateway-json-rpc/operations/dapp-remote-api/listaccounts",
+ "reference/wallet-gateway-json-rpc/operations/dapp-remote-api/messagesignature",
"reference/wallet-gateway-json-rpc/operations/dapp-remote-api/onstatuschanged",
"reference/wallet-gateway-json-rpc/operations/dapp-remote-api/prepareexecute",
"reference/wallet-gateway-json-rpc/operations/dapp-remote-api/signmessage",
@@ -1541,12 +1545,16 @@
"reference/wallet-gateway-json-rpc/operations/user-api/addsession",
"reference/wallet-gateway-json-rpc/operations/user-api/allocatepartyforwallet",
"reference/wallet-gateway-json-rpc/operations/user-api/createwallet",
+ "reference/wallet-gateway-json-rpc/operations/user-api/deletemessagetosign",
"reference/wallet-gateway-json-rpc/operations/user-api/deletetransaction",
"reference/wallet-gateway-json-rpc/operations/user-api/execute",
+ "reference/wallet-gateway-json-rpc/operations/user-api/getmessagetosign",
+ "reference/wallet-gateway-json-rpc/operations/user-api/getnetwork",
"reference/wallet-gateway-json-rpc/operations/user-api/gettransaction",
"reference/wallet-gateway-json-rpc/operations/user-api/getuser",
"reference/wallet-gateway-json-rpc/operations/user-api/iswalletsyncneeded",
"reference/wallet-gateway-json-rpc/operations/user-api/listidps",
+ "reference/wallet-gateway-json-rpc/operations/user-api/listmessagestosign",
"reference/wallet-gateway-json-rpc/operations/user-api/listnetworks",
"reference/wallet-gateway-json-rpc/operations/user-api/listsessions",
"reference/wallet-gateway-json-rpc/operations/user-api/listtransactions",
@@ -1555,8 +1563,10 @@
"reference/wallet-gateway-json-rpc/operations/user-api/removenetwork",
"reference/wallet-gateway-json-rpc/operations/user-api/removesession",
"reference/wallet-gateway-json-rpc/operations/user-api/removewallet",
+ "reference/wallet-gateway-json-rpc/operations/user-api/selfsignedaccesstoken",
"reference/wallet-gateway-json-rpc/operations/user-api/setprimarywallet",
"reference/wallet-gateway-json-rpc/operations/user-api/sign",
+ "reference/wallet-gateway-json-rpc/operations/user-api/signmessage",
"reference/wallet-gateway-json-rpc/operations/user-api/syncwallets",
"reference/wallet-gateway-json-rpc/operations/user-api/details"
]
@@ -1570,6 +1580,7 @@
"reference/wallet-gateway-json-rpc/operations/signing-api/gettransaction",
"reference/wallet-gateway-json-rpc/operations/signing-api/gettransactions",
"reference/wallet-gateway-json-rpc/operations/signing-api/setconfiguration",
+ "reference/wallet-gateway-json-rpc/operations/signing-api/signmessage",
"reference/wallet-gateway-json-rpc/operations/signing-api/signtransaction",
"reference/wallet-gateway-json-rpc/operations/signing-api/subscribetransactions",
"reference/wallet-gateway-json-rpc/operations/signing-api/details"
diff --git a/docs-main/reference/wallet-gateway-json-rpc/index.mdx b/docs-main/reference/wallet-gateway-json-rpc/index.mdx
index 6da44fddf..86dd2810e 100644
--- a/docs-main/reference/wallet-gateway-json-rpc/index.mdx
+++ b/docs-main/reference/wallet-gateway-json-rpc/index.mdx
@@ -4,47 +4,47 @@ description: "Versioned OpenRPC reference docs."
---
-
+
OpenRPC Reference
-
-
+
+
Wallet Gateway
-
-
+
+
Operation-first JSON-RPC reference pages with version history carried from the snapshot lifecycle report.
-
-
+
+
-
+
OpenRPC
-
- 0.25.0
-
+
+ 1.4.0
+
-
+
-
+
- Publish version
- - 0.25.0
+ - 1.4.0
-
+
- Versions compared
- - 0.24.0, 0.25.0
+ - 0.24.0, 0.25.0, 0.26.0, 0.27.0, 1.1.0, 1.2.0, 1.2.1, 1.3.0, 1.4.0
-
+
- Source
- - Wallet Gateway OpenRPC specs from wallet-gateway-remote releases
+ - splice-wallet-kernel Wallet Gateway OpenRPC specs from wallet-gateway-remote releases
-
+
- Version filter
- @canton-network/wallet-gateway-remote@ GitHub releases
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
Sync dApp API
-
-
+
+
›
-
-
-
+
+
+
accountsChanged
-
-
-
+
+
+
-
+
Sync dApp API
-
-
+
+
accountsChanged
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC accountsChanged
@@ -63,32 +63,32 @@ title: "accountsChanged"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- accountsChanged
-
+
- Parameters
- 0
-
+
- Result
- array[object]
-
+
@@ -102,47 +102,47 @@ title: "accountsChanged"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- array[object]
-
+
- Schema
- AccountsChangedEvent
-
+
-
-
-
+
+
+
-
+
items
object
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -157,25 +157,25 @@ title: "accountsChanged"
-
-
+
+
-
+
items
object
-
+
required
-
+
-
+
-
+
-
-
+
+
-
+
cURL
-
+
```bash cURL
@@ -208,14 +208,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -235,7 +235,7 @@ EOF
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
Sync dApp API
-
-
+
+
›
-
-
-
+
+
+
connect
-
-
-
+
+
+
-
+
Sync dApp API
-
-
+
+
connect
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC connect
@@ -63,32 +63,32 @@ title: "connect"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- connect
-
+
- Parameters
- 0
-
+
- Result
- object
-
+
@@ -102,63 +102,63 @@ title: "connect"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Schema
- ConnectResult
-
+
- Required
- isConnected, isNetworkConnected
-
+
-
-
-
+
+
+
-
+
isConnected
string
-
+
required
-
+
-
+
-
+
isNetworkConnected
string
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -173,36 +173,36 @@ title: "connect"
-
-
+
+
-
+
isConnected
string
-
+
required
-
+
-
+
-
+
isNetworkConnected
string
-
+
required
-
+
-
+
-
+
-
-
+
+
-
+
cURL
-
+
```bash cURL
@@ -235,14 +235,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -254,7 +254,7 @@ EOF
-
+
Back to overview
-
-
+
+
OpenRPC Spec
-
-
-
openrpc spec
-
-
Sync dApp API
-
Details and history
-
An OpenRPC specification for the dapp to interact with a Wallet Provider.
-
-
-
- JSON-RPC
-
- Since 0.24.0
-
-
-
-
+
Sync dApp API
+
+
+
An OpenRPC specification for the dapp to interact with a Wallet Provider.
+
+
+
+
+ JSON-RPC
+
+ Since 0.24.0
+
+ Changed 1.4.0
+
+
+
-
-
+
- Latest source path
- api-specs/openrpc-dapp-api.json
-
+
- Publish version
- - 0.25.0
+ - 1.4.0
-
+
- OpenRPC version
- 1.2.6
-
+
- Spec info.version
- 0.5.0
-
+
@@ -63,445 +62,521 @@ Method pages are the primary reference surface. This spec page stays focused on
diff --git a/docs-main/reference/wallet-gateway-json-rpc/operations/dapp-api/disconnect.mdx b/docs-main/reference/wallet-gateway-json-rpc/operations/dapp-api/disconnect.mdx
index 6545ad4b0..920b936f7 100644
--- a/docs-main/reference/wallet-gateway-json-rpc/operations/dapp-api/disconnect.mdx
+++ b/docs-main/reference/wallet-gateway-json-rpc/operations/dapp-api/disconnect.mdx
@@ -9,53 +9,53 @@ title: "disconnect"
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
Sync dApp API
-
-
+
+
›
-
-
-
+
+
+
disconnect
-
-
-
+
+
+
-
+
Sync dApp API
-
-
+
+
disconnect
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC disconnect
@@ -63,32 +63,32 @@ title: "disconnect"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- disconnect
-
+
- Parameters
- 0
-
+
- Result
- null
-
+
@@ -102,32 +102,32 @@ title: "disconnect"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- null
-
+
- Schema
- Null
-
+
-
-
-
-
-
-
-
+
+
+
+
+
+
+
@@ -142,10 +142,10 @@ title: "disconnect"
-
-
-
-
+
+
+
+
@@ -155,12 +155,12 @@ title: "disconnect"
-
+
cURL
-
+
```bash cURL
@@ -178,14 +178,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -194,7 +194,7 @@ EOF
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
Sync dApp API
-
-
+
+
›
-
-
-
+
+
+
getActiveNetwork
-
-
-
+
+
+
-
+
Sync dApp API
-
-
+
+
getActiveNetwork
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC getActiveNetwork
@@ -63,32 +63,32 @@ title: "getActiveNetwork"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- getActiveNetwork
-
+
- Parameters
- 0
-
+
- Result
- object
-
+
@@ -102,52 +102,52 @@ title: "getActiveNetwork"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Schema
- Network
-
+
- Required
- networkId
-
+
-
-
-
+
+
+
-
+
networkId
string
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -162,25 +162,25 @@ title: "getActiveNetwork"
-
-
+
+
-
+
networkId
string
-
+
required
-
+
-
+
-
+
-
-
+
+
-
+
cURL
-
+
```bash cURL
@@ -213,14 +213,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -231,7 +231,7 @@ EOF
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
Sync dApp API
-
-
+
+
›
-
-
-
+
+
+
getPrimaryAccount
-
-
-
+
+
+
-
+
Sync dApp API
-
-
+
+
getPrimaryAccount
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC getPrimaryAccount
@@ -63,32 +63,32 @@ title: "getPrimaryAccount"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- getPrimaryAccount
-
+
- Parameters
- 0
-
+
- Result
- object
-
+
@@ -102,129 +102,129 @@ title: "getPrimaryAccount"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Schema
- Wallet
-
+
- Required
- hint, namespace, networkId, partyId, primary, publicKey, signingProviderId, status
-
+
-
-
-
+
+
+
-
+
primary
string
-
+
required
-
+
-
+
-
+
partyId
string
-
+
required
-
+
-
+
-
+
status
string
-
+
required
-
+
-
+
-
+
hint
string
-
+
required
-
+
-
+
-
+
publicKey
string
-
+
required
-
+
-
+
-
+
namespace
string
-
+
required
-
+
-
+
-
+
networkId
string
-
+
required
-
+
-
+
-
+
signingProviderId
string
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -239,102 +239,102 @@ title: "getPrimaryAccount"
-
-
+
+
-
+
primary
string
-
+
required
-
+
-
+
-
+
partyId
string
-
+
required
-
+
-
+
-
+
status
string
-
+
required
-
+
-
+
-
+
hint
string
-
+
required
-
+
-
+
-
+
publicKey
string
-
+
required
-
+
-
+
-
+
namespace
string
-
+
required
-
+
-
+
-
+
networkId
string
-
+
required
-
+
-
+
-
+
signingProviderId
string
-
+
required
-
+
-
+
-
+
-
-
+
+
-
+
cURL
-
+
```bash cURL
@@ -367,14 +367,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -392,7 +392,7 @@ EOF
-
+
+
+
+
+
+
+
+
Wallet Gateway
+
+
+
›
+
+
+
+
Sync dApp API
+
+
+
›
+
+
+
+
isConnected
+
+
+
+
+
+
+
+
+
Sync dApp API
+
+
+
isConnected
+
+
+
+
+
+ JSON-RPC
+
+ Since 0.26.0
+
+
+
+
+
+
+
+
+ POST
+
+ JSON-RPC isConnected
+
+
+## Protocol Details
+
+
+
+
+
+
- Protocol
+ - JSON-RPC
+
+
+
+
- Transport
+ - HTTP POST
+
+
+
+
- Method
+ - isConnected
+
+
+
+
- Parameters
+ - 0
+
+
+
+
- Result
+ - object
+
+
+
+
+
+## Inputs
+
+
+
+## Outputs
+
+
+
+
+
result
+
+
+
+
+
+
+
+
+
- Shape
+ - object
+
+
+
+
- Schema
+ - ConnectResult
+
+
+
+
- Required
+ - isConnected, isNetworkConnected
+
+
+
+
+
+
+
+
+
+
+
+ isConnected
+ string
+
+ required
+
+
+
+
+
+
+
+ isNetworkConnected
+ string
+
+ required
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Related Schemas
+
+
+
+
+
+
+
+
+
+
+
+ isConnected
+ string
+
+ required
+
+
+
+
+
+
+
+ isNetworkConnected
+ string
+
+ required
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cURL
+
+
+
+```bash cURL
+curl \
+
\
+ -H 'content-type: application/json' \
+ --data @- <<'EOF'
+{
+ "jsonrpc": "2.0",
+ "id": 1,
+ "method": "isConnected"
+}
+EOF
+```
+
+
+
+
+
+
+
+ Result
+
+ application/json
+
+
+
+```json Result
+{
+ "isConnected": "
",
+ "isNetworkConnected": ""
+}
+```
+
+
+
+
+
+
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
Sync dApp API
-
-
+
+
›
-
-
-
+
+
+
ledgerApi
-
-
-
+
+
+
-
+
Sync dApp API
-
-
+
+
ledgerApi
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC ledgerApi
@@ -63,32 +63,32 @@ title: "ledgerApi"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- ledgerApi
-
+
- Parameters
- 1
-
+
- Result
- object
-
+
@@ -98,63 +98,63 @@ title: "ledgerApi"
params
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Schema
- LedgerApiRequest
-
+
- Required
- requestMethod, resource
-
+
-
-
-
+
+
+
-
+
requestMethod
string
-
+
required
-
+
-
+
-
+
resource
string
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -164,32 +164,32 @@ title: "ledgerApi"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Schema
- LedgerApiResult
-
+
-
-
-
-
-
-
-
+
+
+
+
+
+
+
@@ -204,45 +204,45 @@ title: "ledgerApi"
-
-
+
+
-
+
requestMethod
string
-
+
required
-
+
-
+
-
+
resource
string
-
+
required
-
+
-
+
-
+
-
-
+
+
-
-
-
-
+
+
+
+
@@ -252,12 +252,12 @@ title: "ledgerApi"
-
+
cURL
-
+
```bash cURL
@@ -281,14 +281,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -297,7 +297,7 @@ EOF
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
Sync dApp API
-
-
+
+
›
-
-
-
+
+
+
listAccounts
-
-
-
+
+
+
-
+
Sync dApp API
-
-
+
+
listAccounts
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC listAccounts
@@ -63,32 +63,32 @@ title: "listAccounts"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- listAccounts
-
+
- Parameters
- 0
-
+
- Result
- array[object]
-
+
@@ -102,47 +102,47 @@ title: "listAccounts"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- array[object]
-
+
- Schema
- ListAccountsResult
-
+
-
-
-
+
+
+
-
+
items
object
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -157,25 +157,25 @@ title: "listAccounts"
-
-
+
+
-
+
items
object
-
+
required
-
+
-
+
-
+
-
-
+
+
-
+
cURL
-
+
```bash cURL
@@ -208,14 +208,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -235,7 +235,7 @@ EOF
-
+
+
+
+
+
+
+
+
Wallet Gateway
+
+
+
›
+
+
+
+
Sync dApp API
+
+
+
›
+
+
+
+
messageSignature
+
+
+
+
+
+
+
+
+
Sync dApp API
+
+
+
messageSignature
+
+
+
+
+
+ JSON-RPC
+
+ Since 1.4.0
+
+
+
+
+
+
+
+
+ POST
+
+ JSON-RPC messageSignature
+
+
+## Protocol Details
+
+
+
+
+
+
- Protocol
+ - JSON-RPC
+
+
+
+
- Transport
+ - HTTP POST
+
+
+
+
- Method
+ - messageSignature
+
+
+
+
- Parameters
+ - 0
+
+
+
+
- Result
+ - oneOf
+
+
+
+
+
+## Inputs
+
+
+
+## Outputs
+
+
+
+
+
result
+
+
+
+
+
+
+
+
+
- Shape
+ - oneOf
+
+
+
+
- Schema
+ - MessageSignatureEvent
+
+
+
+
+
+
+
+
+
+
+
+ status
+ string
+
+
+
+
+
+
+
+ messageId
+ string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Related Schemas
+
+
+
+
+
+
+
+
+
+
+
+ status
+ string
+
+
+
+
+
+
+
+ messageId
+ string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cURL
+
+
+
+```bash cURL
+curl \
+
\
+ -H 'content-type: application/json' \
+ --data @- <<'EOF'
+{
+ "jsonrpc": "2.0",
+ "id": 1,
+ "method": "messageSignature"
+}
+EOF
+```
+
+
+
+
+
+
+
+ Result
+
+ application/json
+
+
+
+```json Result
+{
+ "status": "
",
+ "messageId": ""
+}
+```
+
+
+
+
+
+
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
Sync dApp API
-
-
+
+
›
-
-
-
+
+
+
prepareExecute
-
-
-
+
+
+
-
+
Sync dApp API
-
-
+
+
prepareExecute
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
+ Changed 1.4.0
+
-
+
-
+
POST
-
+
JSON-RPC prepareExecute
@@ -63,32 +65,32 @@ title: "prepareExecute"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- prepareExecute
-
+
- Parameters
- 1
-
+
- Result
- null
-
+
@@ -98,52 +100,52 @@ title: "prepareExecute"
params
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Schema
- JsPrepareSubmissionRequest
-
+
- Required
- commands
-
+
-
-
-
+
+
+
-
+
commands
- object
-
+ array[object]
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -153,38 +155,49 @@ title: "prepareExecute"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- null
-
+
- Schema
- Null
-
+
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+## Lifecycle Changes
+
+
+
+
+ 1.4.0
+ details updated
+
+
+
-
-
+
+
-
+
commands
- object
-
+ array[object]
+
required
-
+
-
+
-
+
-
-
+
+
-
-
-
-
+
+
+
+
@@ -230,12 +243,12 @@ title: "prepareExecute"
-
+
cURL
-
+
```bash cURL
@@ -249,7 +262,11 @@ curl \
"method": "prepareExecute",
"params": {
"params": {
- "commands": {}
+ "commands": [
+ {
+ "CreateCommand": {}
+ }
+ ]
}
}
}
@@ -258,14 +275,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -274,7 +291,7 @@ EOF
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
Sync dApp API
-
-
+
+
›
-
-
-
+
+
+
prepareExecuteAndWait
-
-
-
+
+
+
-
+
Sync dApp API
-
-
+
+
prepareExecuteAndWait
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
+ Changed 1.4.0
+
-
+
-
+
POST
-
+
JSON-RPC prepareExecuteAndWait
@@ -63,32 +65,32 @@ title: "prepareExecuteAndWait"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- prepareExecuteAndWait
-
+
- Parameters
- 1
-
+
- Result
- object
-
+
@@ -98,52 +100,52 @@ title: "prepareExecuteAndWait"
params
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Schema
- JsPrepareSubmissionRequest
-
+
- Required
- commands
-
+
-
-
-
+
+
+
-
+
commands
- object
-
+ array[object]
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -153,53 +155,64 @@ title: "prepareExecuteAndWait"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Required
- tx
-
+
-
-
-
+
+
+
-
+
tx
object
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
+## Lifecycle Changes
+
+
+
+
+ 1.4.0
+ details updated
+
+
+
-
-
+
+
-
+
commands
- object
-
+ array[object]
+
required
-
+
-
+
-
+
-
-
+
+
-
-
+
+
-
+
tx
object
-
+
required
-
+
-
+
-
+
-
-
+
+
-
+
cURL
-
+
```bash cURL
@@ -279,7 +292,11 @@ curl \
"method": "prepareExecuteAndWait",
"params": {
"params": {
- "commands": {}
+ "commands": [
+ {
+ "CreateCommand": {}
+ }
+ ]
}
}
}
@@ -288,14 +305,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -313,7 +330,7 @@ EOF
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
Sync dApp API
-
-
+
+
›
-
-
-
+
+
+
signMessage
-
-
-
+
+
+
-
+
Sync dApp API
-
-
+
+
signMessage
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC signMessage
@@ -63,32 +63,32 @@ title: "signMessage"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- signMessage
-
+
- Parameters
- 1
-
+
- Result
- object
-
+
@@ -98,52 +98,52 @@ title: "signMessage"
params
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Schema
- SignMessageRequest
-
+
- Required
- message
-
+
-
-
-
+
+
+
-
+
message
string
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -153,52 +153,52 @@ title: "signMessage"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Schema
- SignMessageResult
-
+
- Required
- signature
-
+
-
-
-
+
+
+
-
+
signature
string
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -213,49 +213,49 @@ title: "signMessage"
-
-
+
+
-
+
message
string
-
+
required
-
+
-
+
-
+
-
-
+
+
-
-
+
+
-
+
signature
string
-
+
required
-
+
-
+
-
+
-
-
+
+
-
+
cURL
-
+
```bash cURL
@@ -293,14 +293,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -311,7 +311,7 @@ EOF
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
Sync dApp API
-
-
+
+
›
-
-
-
+
+
+
status
-
-
-
+
+
+
-
+
Sync dApp API
-
-
+
+
status
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC status
@@ -63,32 +63,32 @@ title: "status"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- status
-
+
- Parameters
- 0
-
+
- Result
- object
-
+
@@ -102,63 +102,63 @@ title: "status"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Schema
- StatusEvent
-
+
- Required
- connection, provider
-
+
-
-
-
+
+
+
-
+
provider
object
-
+
required
-
+
-
+
-
+
connection
object
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -173,36 +173,36 @@ title: "status"
-
-
+
+
-
+
provider
object
-
+
required
-
+
-
+
-
+
connection
object
-
+
required
-
+
-
+
-
+
-
-
+
+
-
+
cURL
-
+
```bash cURL
@@ -235,14 +235,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -259,7 +259,7 @@ EOF
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
Sync dApp API
-
-
+
+
›
-
-
-
+
+
+
txChanged
-
-
-
+
+
+
-
+
Sync dApp API
-
-
+
+
txChanged
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC txChanged
@@ -63,32 +63,32 @@ title: "txChanged"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- txChanged
-
+
- Parameters
- 0
-
+
- Result
- oneOf
-
+
@@ -102,54 +102,54 @@ title: "txChanged"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- oneOf
-
+
- Schema
- TxChangedEvent
-
+
-
-
-
+
+
+
-
-
-
-
+
+
+
+
@@ -164,32 +164,32 @@ title: "txChanged"
@@ -199,12 +199,12 @@ title: "txChanged"
-
+
cURL
-
+
```bash cURL
@@ -222,14 +222,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -241,7 +241,7 @@ EOF
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
Async dApp API
-
-
+
+
›
-
-
-
+
+
+
accountsChanged
-
-
-
+
+
+
-
+
Async dApp API
-
-
+
+
accountsChanged
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC accountsChanged
@@ -63,32 +63,32 @@ title: "accountsChanged"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- accountsChanged
-
+
- Parameters
- 0
-
+
- Result
- array[object]
-
+
@@ -102,47 +102,47 @@ title: "accountsChanged"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- array[object]
-
+
- Schema
- AccountsChangedEvent
-
+
-
-
-
+
+
+
-
+
items
object
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -157,25 +157,25 @@ title: "accountsChanged"
-
-
+
+
-
+
items
object
-
+
required
-
+
-
+
-
+
-
-
+
+
-
+
cURL
-
+
```bash cURL
@@ -208,14 +208,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -235,7 +235,7 @@ EOF
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
Async dApp API
-
-
+
+
›
-
-
-
+
+
+
connect
-
-
-
+
+
+
-
+
Async dApp API
-
-
+
+
connect
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC connect
@@ -63,32 +63,32 @@ title: "connect"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- connect
-
+
- Parameters
- 0
-
+
- Result
- object
-
+
@@ -102,63 +102,63 @@ title: "connect"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Schema
- ConnectResult
-
+
- Required
- isConnected, isNetworkConnected
-
+
-
-
-
+
+
+
-
+
isConnected
string
-
+
required
-
+
-
+
-
+
isNetworkConnected
string
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -173,36 +173,36 @@ title: "connect"
-
-
+
+
-
+
isConnected
string
-
+
required
-
+
-
+
-
+
isNetworkConnected
string
-
+
required
-
+
-
+
-
+
-
-
+
+
-
+
cURL
-
+
```bash cURL
@@ -235,14 +235,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -254,7 +254,7 @@ EOF
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
Async dApp API
-
-
+
+
›
-
-
-
+
+
+
connected
-
-
-
+
+
+
-
+
Async dApp API
-
-
+
+
connected
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC connected
@@ -63,32 +63,32 @@ title: "connected"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- connected
-
+
- Parameters
- 0
-
+
- Result
- object
-
+
@@ -102,63 +102,63 @@ title: "connected"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Schema
- StatusEvent
-
+
- Required
- connection, provider
-
+
-
-
-
+
+
+
-
+
provider
object
-
+
required
-
+
-
+
-
+
connection
object
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -173,36 +173,36 @@ title: "connected"
-
-
+
+
-
+
provider
object
-
+
required
-
+
-
+
-
+
connection
object
-
+
required
-
+
-
+
-
+
-
-
+
+
-
+
cURL
-
+
```bash cURL
@@ -235,14 +235,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -259,7 +259,7 @@ EOF
-
+
Back to overview
-
-
+
+
OpenRPC Spec
-
-
-
openrpc spec
-
-
Async dApp API
-
Details and history
-
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-RPC
-
- Since 0.24.0
-
-
-
-
+
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-RPC
+
+ Since 0.24.0
+
+ Changed 1.4.0
+
+
+
-
+
- Latest source path
- api-specs/openrpc-dapp-remote-api.json
-
+
- Publish version
- - 0.25.0
+ - 1.4.0
-
+
- OpenRPC version
- 1.2.6
-
+
- Spec info.version
- 0.1.0
-
+
@@ -62,478 +62,554 @@ Method pages are the primary reference surface. This spec page stays focused on
diff --git a/docs-main/reference/wallet-gateway-json-rpc/operations/dapp-remote-api/disconnect.mdx b/docs-main/reference/wallet-gateway-json-rpc/operations/dapp-remote-api/disconnect.mdx
index 5d3f2e7d1..750e58536 100644
--- a/docs-main/reference/wallet-gateway-json-rpc/operations/dapp-remote-api/disconnect.mdx
+++ b/docs-main/reference/wallet-gateway-json-rpc/operations/dapp-remote-api/disconnect.mdx
@@ -9,53 +9,53 @@ title: "disconnect"
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
Async dApp API
-
-
+
+
›
-
-
-
+
+
+
disconnect
-
-
-
+
+
+
-
+
Async dApp API
-
-
+
+
disconnect
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC disconnect
@@ -63,32 +63,32 @@ title: "disconnect"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- disconnect
-
+
- Parameters
- 0
-
+
- Result
- null
-
+
@@ -102,32 +102,32 @@ title: "disconnect"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- null
-
+
- Schema
- Null
-
+
-
-
-
-
-
-
-
+
+
+
+
+
+
+
@@ -142,10 +142,10 @@ title: "disconnect"
-
-
-
-
+
+
+
+
@@ -155,12 +155,12 @@ title: "disconnect"
-
+
cURL
-
+
```bash cURL
@@ -178,14 +178,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -194,7 +194,7 @@ EOF
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
Async dApp API
-
-
+
+
›
-
-
-
+
+
+
getActiveNetwork
-
-
-
+
+
+
-
+
Async dApp API
-
-
+
+
getActiveNetwork
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC getActiveNetwork
@@ -63,32 +63,32 @@ title: "getActiveNetwork"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- getActiveNetwork
-
+
- Parameters
- 0
-
+
- Result
- object
-
+
@@ -102,52 +102,52 @@ title: "getActiveNetwork"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Schema
- Network
-
+
- Required
- networkId
-
+
-
-
-
+
+
+
-
+
networkId
string
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -162,25 +162,25 @@ title: "getActiveNetwork"
-
-
+
+
-
+
networkId
string
-
+
required
-
+
-
+
-
+
-
-
+
+
-
+
cURL
-
+
```bash cURL
@@ -213,14 +213,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -231,7 +231,7 @@ EOF
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
Async dApp API
-
-
+
+
›
-
-
-
+
+
+
getPrimaryAccount
-
-
-
+
+
+
-
+
Async dApp API
-
-
+
+
getPrimaryAccount
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC getPrimaryAccount
@@ -63,32 +63,32 @@ title: "getPrimaryAccount"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- getPrimaryAccount
-
+
- Parameters
- 0
-
+
- Result
- object
-
+
@@ -102,129 +102,129 @@ title: "getPrimaryAccount"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Schema
- Wallet
-
+
- Required
- hint, namespace, networkId, partyId, primary, publicKey, rights, signingProviderId, status
-
+
-
-
-
+
+
+
-
+
primary
string
-
+
required
-
+
-
+
-
+
partyId
string
-
+
required
-
+
-
+
-
+
status
string
-
+
required
-
+
-
+
-
+
hint
string
-
+
required
-
+
-
+
-
+
publicKey
string
-
+
required
-
+
-
+
-
+
namespace
string
-
+
required
-
+
-
+
-
+
networkId
string
-
+
required
-
+
-
+
-
+
signingProviderId
string
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -239,102 +239,102 @@ title: "getPrimaryAccount"
-
-
+
+
-
+
primary
string
-
+
required
-
+
-
+
-
+
partyId
string
-
+
required
-
+
-
+
-
+
status
string
-
+
required
-
+
-
+
-
+
hint
string
-
+
required
-
+
-
+
-
+
publicKey
string
-
+
required
-
+
-
+
-
+
namespace
string
-
+
required
-
+
-
+
-
+
networkId
string
-
+
required
-
+
-
+
-
+
signingProviderId
string
-
+
required
-
+
-
+
-
+
-
-
+
+
-
+
cURL
-
+
```bash cURL
@@ -367,14 +367,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -392,7 +392,7 @@ EOF
-
+
+
+
+
+
+
+
+
Wallet Gateway
+
+
+
›
+
+
+
+
Async dApp API
+
+
+
›
+
+
+
+
isConnected
+
+
+
+
+
+
+
+
+
Async dApp API
+
+
+
isConnected
+
+
+
+
+
+ JSON-RPC
+
+ Since 0.26.0
+
+
+
+
+
+
+
+
+ POST
+
+ JSON-RPC isConnected
+
+
+## Protocol Details
+
+
+
+
+
+
- Protocol
+ - JSON-RPC
+
+
+
+
- Transport
+ - HTTP POST
+
+
+
+
- Method
+ - isConnected
+
+
+
+
- Parameters
+ - 0
+
+
+
+
- Result
+ - object
+
+
+
+
+
+## Inputs
+
+
+
+## Outputs
+
+
+
+
+
result
+
+
+
+
+
+
+
+
+
- Shape
+ - object
+
+
+
+
- Schema
+ - ConnectResult
+
+
+
+
- Required
+ - isConnected, isNetworkConnected
+
+
+
+
+
+
+
+
+
+
+
+ isConnected
+ string
+
+ required
+
+
+
+
+
+
+
+ isNetworkConnected
+ string
+
+ required
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Related Schemas
+
+
+
+
+
+
+
+
+
+
+
+ isConnected
+ string
+
+ required
+
+
+
+
+
+
+
+ isNetworkConnected
+ string
+
+ required
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cURL
+
+
+
+```bash cURL
+curl \
+
\
+ -H 'content-type: application/json' \
+ --data @- <<'EOF'
+{
+ "jsonrpc": "2.0",
+ "id": 1,
+ "method": "isConnected"
+}
+EOF
+```
+
+
+
+
+
+
+
+ Result
+
+ application/json
+
+
+
+```json Result
+{
+ "isConnected": "
",
+ "isNetworkConnected": ""
+}
+```
+
+
+
+
+
+
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
Async dApp API
-
-
+
+
›
-
-
-
+
+
+
ledgerApi
-
-
-
+
+
+
-
+
Async dApp API
-
-
+
+
ledgerApi
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC ledgerApi
@@ -63,32 +63,32 @@ title: "ledgerApi"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- ledgerApi
-
+
- Parameters
- 1
-
+
- Result
- object
-
+
@@ -98,63 +98,63 @@ title: "ledgerApi"
params
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Schema
- LedgerApiRequest
-
+
- Required
- requestMethod, resource
-
+
-
-
-
+
+
+
-
+
requestMethod
string
-
+
required
-
+
-
+
-
+
resource
string
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -164,32 +164,32 @@ title: "ledgerApi"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Schema
- LedgerApiResult
-
+
-
-
-
-
-
-
-
+
+
+
+
+
+
+
@@ -204,45 +204,45 @@ title: "ledgerApi"
-
-
+
+
-
+
requestMethod
string
-
+
required
-
+
-
+
-
+
resource
string
-
+
required
-
+
-
+
-
+
-
-
+
+
-
-
-
-
+
+
+
+
@@ -252,12 +252,12 @@ title: "ledgerApi"
-
+
cURL
-
+
```bash cURL
@@ -281,14 +281,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -297,7 +297,7 @@ EOF
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
Async dApp API
-
-
+
+
›
-
-
-
+
+
+
listAccounts
-
-
-
+
+
+
-
+
Async dApp API
-
-
+
+
listAccounts
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC listAccounts
@@ -63,32 +63,32 @@ title: "listAccounts"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- listAccounts
-
+
- Parameters
- 0
-
+
- Result
- array[object]
-
+
@@ -102,47 +102,47 @@ title: "listAccounts"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- array[object]
-
+
- Schema
- ListAccountsResult
-
+
-
-
-
+
+
+
-
+
items
object
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -157,25 +157,25 @@ title: "listAccounts"
-
-
+
+
-
+
items
object
-
+
required
-
+
-
+
-
+
-
-
+
+
-
+
cURL
-
+
```bash cURL
@@ -208,14 +208,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -235,7 +235,7 @@ EOF
-
+
+
+
+
+
+
+
+
Wallet Gateway
+
+
+
›
+
+
+
+
Async dApp API
+
+
+
›
+
+
+
+
messageSignature
+
+
+
+
+
+
+
+
+
Async dApp API
+
+
+
messageSignature
+
+
+
+
+
+ JSON-RPC
+
+ Since 1.4.0
+
+
+
+
+
+
+
+
+ POST
+
+ JSON-RPC messageSignature
+
+
+## Protocol Details
+
+
+
+
+
+
- Protocol
+ - JSON-RPC
+
+
+
+
- Transport
+ - HTTP POST
+
+
+
+
- Method
+ - messageSignature
+
+
+
+
- Parameters
+ - 0
+
+
+
+
- Result
+ - oneOf
+
+
+
+
+
+## Inputs
+
+
+
+## Outputs
+
+
+
+
+
result
+
+
+
+
+
+
+
+
+
- Shape
+ - oneOf
+
+
+
+
- Schema
+ - MessageSignatureEvent
+
+
+
+
+
+
+
+
+
+
+
+ status
+ string
+
+
+
+
+
+
+
+ messageId
+ string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Related Schemas
+
+
+
+
+
+
+
+
+
+
+
+ status
+ string
+
+
+
+
+
+
+
+ messageId
+ string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cURL
+
+
+
+```bash cURL
+curl \
+
\
+ -H 'content-type: application/json' \
+ --data @- <<'EOF'
+{
+ "jsonrpc": "2.0",
+ "id": 1,
+ "method": "messageSignature"
+}
+EOF
+```
+
+
+
+
+
+
+
+ Result
+
+ application/json
+
+
+
+```json Result
+{
+ "status": "
",
+ "messageId": ""
+}
+```
+
+
+
+
+
+
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
Async dApp API
-
-
+
+
›
-
-
-
+
+
+
onStatusChanged
-
-
-
+
+
+
-
+
Async dApp API
-
-
+
+
onStatusChanged
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC onStatusChanged
@@ -63,32 +63,32 @@ title: "onStatusChanged"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- onStatusChanged
-
+
- Parameters
- 0
-
+
- Result
- object
-
+
@@ -102,63 +102,63 @@ title: "onStatusChanged"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Schema
- StatusEvent
-
+
- Required
- connection, provider
-
+
-
-
-
+
+
+
-
+
provider
object
-
+
required
-
+
-
+
-
+
connection
object
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -173,36 +173,36 @@ title: "onStatusChanged"
-
-
+
+
-
+
provider
object
-
+
required
-
+
-
+
-
+
connection
object
-
+
required
-
+
-
+
-
+
-
-
+
+
-
+
cURL
-
+
```bash cURL
@@ -235,14 +235,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -259,7 +259,7 @@ EOF
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
Async dApp API
-
-
+
+
›
-
-
-
+
+
+
prepareExecute
-
-
-
+
+
+
-
+
Async dApp API
-
-
+
+
prepareExecute
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
+ Changed 1.4.0
+
-
+
-
+
POST
-
+
JSON-RPC prepareExecute
@@ -63,32 +65,32 @@ title: "prepareExecute"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- prepareExecute
-
+
- Parameters
- 1
-
+
- Result
- object
-
+
@@ -98,52 +100,52 @@ title: "prepareExecute"
params
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Schema
- JsPrepareSubmissionRequest
-
+
- Required
- commands
-
+
-
-
-
+
+
+
-
+
commands
- object
-
+ array[object]
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -153,53 +155,64 @@ title: "prepareExecute"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Required
- userUrl
-
+
-
-
-
+
+
+
-
+
userUrl
string
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
+## Lifecycle Changes
+
+
+
+
+ 1.4.0
+ details updated
+
+
+
-
-
+
+
-
+
commands
- object
-
+ array[object]
+
required
-
+
-
+
-
+
-
-
+
+
-
-
+
+
-
+
userUrl
string
-
+
required
-
+
-
+
-
+
-
-
+
+
-
+
cURL
-
+
```bash cURL
@@ -279,7 +292,11 @@ curl \
"method": "prepareExecute",
"params": {
"params": {
- "commands": {}
+ "commands": [
+ {
+ "CreateCommand": {}
+ }
+ ]
}
}
}
@@ -288,14 +305,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -306,7 +323,7 @@ EOF
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
Async dApp API
-
-
+
+
›
-
-
-
+
+
+
signMessage
-
-
-
+
+
+
-
+
Async dApp API
-
-
+
+
signMessage
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
+ Changed 1.4.0
+
-
+
-
+
POST
-
+
JSON-RPC signMessage
@@ -63,32 +65,32 @@ title: "signMessage"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- signMessage
-
+
- Parameters
- 1
-
+
- Result
- object
-
+
@@ -98,52 +100,52 @@ title: "signMessage"
params
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Schema
- SignMessageRequest
-
+
- Required
- message
-
+
-
-
-
+
+
+
-
+
message
string
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -153,58 +155,75 @@ title: "signMessage"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
-
-
- Schema
- - SignMessageResult
-
-
+
- Required
- - signature
+ - messageId, userUrl
-
+
-
-
-
+
+
+
-
+
+
+
+ messageId
+ string
+
+ required
+
+
+
+
+
- signature
+ userUrl
string
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
+## Lifecycle Changes
+
+
+
+
+ 1.4.0
+ description updated; result updated (schema ref, required fields)
+
+
+
-
-
+
+
-
+
message
string
-
+
required
-
+
-
+
-
+
-
-
+
+
-
-
+
+
-
+
- signature
+ messageId
string
-
+
required
-
+
-
+
-
+
+
+
+ userUrl
+ string
+
+ required
+
+
+
+
+
-
-
+
+
-
+
cURL
-
+
```bash cURL
@@ -293,25 +323,26 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
{
- "signature": "
"
+ "messageId": "",
+ "userUrl": ""
}
```
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
Async dApp API
-
-
+
+
›
-
-
-
+
+
+
status
-
-
-
+
+
+
-
+
Async dApp API
-
-
+
+
status
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC status
@@ -63,32 +63,32 @@ title: "status"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- status
-
+
- Parameters
- 0
-
+
- Result
- object
-
+
@@ -102,63 +102,63 @@ title: "status"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Schema
- StatusEvent
-
+
- Required
- connection, provider
-
+
-
-
-
+
+
+
-
+
provider
object
-
+
required
-
+
-
+
-
+
connection
object
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -173,36 +173,36 @@ title: "status"
-
-
+
+
-
+
provider
object
-
+
required
-
+
-
+
-
+
connection
object
-
+
required
-
+
-
+
-
+
-
-
+
+
-
+
cURL
-
+
```bash cURL
@@ -235,14 +235,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -259,7 +259,7 @@ EOF
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
Async dApp API
-
-
+
+
›
-
-
-
+
+
+
txChanged
-
-
-
+
+
+
-
+
Async dApp API
-
-
+
+
txChanged
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC txChanged
@@ -63,32 +63,32 @@ title: "txChanged"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- txChanged
-
+
- Parameters
- 0
-
+
- Result
- oneOf
-
+
@@ -102,54 +102,54 @@ title: "txChanged"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- oneOf
-
+
- Schema
- TxChangedEvent
-
+
-
-
-
+
+
+
-
-
-
-
+
+
+
+
@@ -164,32 +164,32 @@ title: "txChanged"
@@ -199,12 +199,12 @@ title: "txChanged"
-
+
cURL
-
+
```bash cURL
@@ -222,14 +222,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -241,7 +241,7 @@ EOF
-
+
-
+
OpenRPC Reference
-
-
+
+
Wallet Gateway
-
-
+
+
Operation-first JSON-RPC reference pages with version history carried from the snapshot lifecycle report.
-
-
+
+
-
+
OpenRPC
-
- 0.25.0
-
+
+ 1.4.0
+
-
+
-
+
- Publish version
- - 0.25.0
+ - 1.4.0
-
+
- Versions compared
- - 0.24.0, 0.25.0
+ - 0.24.0, 0.25.0, 0.26.0, 0.27.0, 1.1.0, 1.2.0, 1.2.1, 1.3.0, 1.4.0
-
+
- Source
- - Wallet Gateway OpenRPC specs from wallet-gateway-remote releases
+ - splice-wallet-kernel Wallet Gateway OpenRPC specs from wallet-gateway-remote releases
-
+
- Version filter
- @canton-network/wallet-gateway-remote@ GitHub releases
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
Signing API
-
-
+
+
›
-
-
-
+
+
+
createKey
-
-
-
+
+
+
-
+
Signing API
-
-
+
+
createKey
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC createKey
@@ -63,32 +63,32 @@ title: "createKey"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- createKey
-
+
- Parameters
- 1
-
+
- Result
- oneOf
-
+
@@ -98,47 +98,47 @@ title: "createKey"
params
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Required
- name
-
+
-
-
-
+
+
+
-
+
name
string
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -148,49 +148,49 @@ title: "createKey"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- oneOf
-
+
-
-
-
+
+
+
-
+
-
+
error_description
string
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -205,56 +205,56 @@ title: "createKey"
-
-
+
+
-
+
name
string
-
+
required
-
+
-
+
-
+
-
-
+
+
-
-
+
+
-
+
-
+
error_description
string
-
+
-
+
-
+
-
-
+
+
-
+
cURL
-
+
```bash cURL
@@ -292,14 +292,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -311,7 +311,7 @@ EOF
-
+
Back to overview
-
-
+
+
OpenRPC Spec
-
-
-
openrpc spec
-
-
Signing API
-
Details and history
-
An OpenRPC specification for the Signing API which allows the Wallet Gateway to interact with a Wallet Providers.
-
-
-
- JSON-RPC
-
- Since 0.24.0
-
-
-
-
+
Signing API
+
+
+
An OpenRPC specification for the Signing API which allows the Wallet Gateway to interact with a Wallet Providers.
+
+
+
+
+ JSON-RPC
+
+ Since 0.24.0
+
+
+
-
-
+
- Latest source path
- api-specs/openrpc-signing-api.json
-
+
- Publish version
- - 0.25.0
+ - 1.4.0
-
+
- OpenRPC version
- 1.2.6
-
+
- Spec info.version
- 0.1.0
-
+
@@ -63,299 +60,336 @@ Method pages are the primary reference surface. This spec page stays focused on
diff --git a/docs-main/reference/wallet-gateway-json-rpc/operations/signing-api/getconfiguration.mdx b/docs-main/reference/wallet-gateway-json-rpc/operations/signing-api/getconfiguration.mdx
index d3f4496ff..d78651340 100644
--- a/docs-main/reference/wallet-gateway-json-rpc/operations/signing-api/getconfiguration.mdx
+++ b/docs-main/reference/wallet-gateway-json-rpc/operations/signing-api/getconfiguration.mdx
@@ -9,53 +9,53 @@ title: "getConfiguration"
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
Signing API
-
-
+
+
›
-
-
-
+
+
+
getConfiguration
-
-
-
+
+
+
-
+
Signing API
-
-
+
+
getConfiguration
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC getConfiguration
@@ -63,32 +63,32 @@ title: "getConfiguration"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- getConfiguration
-
+
- Parameters
- 0
-
+
- Result
- object
-
+
@@ -102,27 +102,27 @@ title: "getConfiguration"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
-
-
-
-
-
-
-
+
+
+
+
+
+
+
@@ -137,10 +137,10 @@ title: "getConfiguration"
-
-
-
-
+
+
+
+
@@ -150,12 +150,12 @@ title: "getConfiguration"
-
+
cURL
-
+
```bash cURL
@@ -173,14 +173,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -189,7 +189,7 @@ EOF
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
Signing API
-
-
+
+
›
-
-
-
+
+
+
getKeys
-
-
-
+
+
+
-
+
Signing API
-
-
+
+
getKeys
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC getKeys
@@ -63,32 +63,32 @@ title: "getKeys"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- getKeys
-
+
- Parameters
- 0
-
+
- Result
- oneOf
-
+
@@ -102,49 +102,49 @@ title: "getKeys"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- oneOf
-
+
-
-
-
+
+
+
-
+
-
+
error_description
string
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -159,32 +159,32 @@ title: "getKeys"
-
-
+
+
-
+
-
+
error_description
string
-
+
-
+
-
+
-
-
+
+
-
+
cURL
-
+
```bash cURL
@@ -217,14 +217,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -236,7 +236,7 @@ EOF
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
Signing API
-
-
+
+
›
-
-
-
+
+
+
getTransaction
-
-
-
+
+
+
-
+
Signing API
-
-
+
+
getTransaction
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC getTransaction
@@ -63,32 +63,32 @@ title: "getTransaction"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- getTransaction
-
+
- Parameters
- 1
-
+
- Result
- oneOf
-
+
@@ -98,47 +98,47 @@ title: "getTransaction"
params
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Required
- txId
-
+
-
-
-
+
+
+
-
+
txId
string
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -148,49 +148,49 @@ title: "getTransaction"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- oneOf
-
+
-
-
-
+
+
+
-
+
-
+
error_description
string
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -205,56 +205,56 @@ title: "getTransaction"
-
-
+
+
-
+
txId
string
-
+
required
-
+
-
+
-
+
-
-
+
+
-
-
+
+
-
+
-
+
error_description
string
-
+
-
+
-
+
-
-
+
+
-
+
cURL
-
+
```bash cURL
@@ -292,14 +292,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -311,7 +311,7 @@ EOF
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
Signing API
-
-
+
+
›
-
-
-
+
+
+
getTransactions
-
-
-
+
+
+
-
+
Signing API
-
-
+
+
getTransactions
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC getTransactions
@@ -63,32 +63,32 @@ title: "getTransactions"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- getTransactions
-
+
- Parameters
- 1
-
+
- Result
- oneOf
-
+
@@ -98,49 +98,49 @@ title: "getTransactions"
params
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
-
-
-
+
+
+
-
+
txIds
array[string]
-
+
-
+
-
+
publicKeys
array[string]
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -150,49 +150,49 @@ title: "getTransactions"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- oneOf
-
+
-
-
-
+
+
+
-
+
-
+
error_description
string
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -207,63 +207,63 @@ title: "getTransactions"
-
-
+
+
-
+
txIds
array[string]
-
+
-
+
-
+
publicKeys
array[string]
-
+
-
+
-
+
-
-
+
+
-
-
+
+
-
+
-
+
error_description
string
-
+
-
+
-
+
-
-
+
+
-
+
cURL
-
+
```bash cURL
@@ -306,14 +306,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -325,7 +325,7 @@ EOF
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
Signing API
-
-
+
+
›
-
-
-
+
+
+
setConfiguration
-
-
-
+
+
+
-
+
Signing API
-
-
+
+
setConfiguration
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC setConfiguration
@@ -63,32 +63,32 @@ title: "setConfiguration"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- setConfiguration
-
+
- Parameters
- 1
-
+
- Result
- object
-
+
@@ -98,27 +98,27 @@ title: "setConfiguration"
params
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
-
-
-
-
-
-
-
+
+
+
+
+
+
+
@@ -128,27 +128,27 @@ title: "setConfiguration"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
-
-
-
-
-
-
-
+
+
+
+
+
+
+
@@ -163,19 +163,19 @@ title: "setConfiguration"
-
-
-
-
+
+
+
+
-
-
-
-
+
+
+
+
@@ -185,12 +185,12 @@ title: "setConfiguration"
-
+
cURL
-
+
```bash cURL
@@ -211,14 +211,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -227,7 +227,7 @@ EOF
-
+
+
+
+
+
+
+
+
Wallet Gateway
+
+
+
›
+
+
+
+
Signing API
+
+
+
›
+
+
+
+
signMessage
+
+
+
+
+
+
+
+
+
Signing API
+
+
+
signMessage
+
+
+
+
+
+ JSON-RPC
+
+ Since 1.4.0
+
+
+
+
+
+
+
+
+ POST
+
+ JSON-RPC signMessage
+
+
+## Protocol Details
+
+
+
+
+
+
- Protocol
+ - JSON-RPC
+
+
+
+
- Transport
+ - HTTP POST
+
+
+
+
- Method
+ - signMessage
+
+
+
+
- Parameters
+ - 1
+
+
+
+
- Result
+ - oneOf
+
+
+
+
+
+## Inputs
+
+
+
+
+
params
+
+
+
+
+
+
+
+
+
- Shape
+ - object
+
+
+
+
- Required
+ - message
+
+
+
+
+
+
+
+
+
+
+
+ message
+ string
+
+ required
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Outputs
+
+
+
+
+
result
+
+
+
+
+
+
+
+
+
- Shape
+ - oneOf
+
+
+
+
+
+
+
+
+
+
+
+ error
+ string
+
+
+
+
+
+
+
+ error_description
+ string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Related Schemas
+
+
+
+
+
+
+
+
+
+
+
+ message
+ string
+
+ required
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ error
+ string
+
+
+
+
+
+
+
+ error_description
+ string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cURL
+
+
+
+```bash cURL
+curl \
+
\
+ -H 'content-type: application/json' \
+ --data @- <<'EOF'
+{
+ "jsonrpc": "2.0",
+ "id": 1,
+ "method": "signMessage",
+ "params": {
+ "params": {
+ "message": ""
+ }
+ }
+}
+EOF
+```
+
+
+
+
+
+
+
+ Result
+
+ application/json
+
+
+
+```json Result
+{
+ "error": "
",
+ "error_description": ""
+}
+```
+
+
+
+
+
+
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
Signing API
-
-
+
+
›
-
-
-
+
+
+
signTransaction
-
-
-
+
+
+
-
+
Signing API
-
-
+
+
signTransaction
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC signTransaction
@@ -63,32 +63,32 @@ title: "signTransaction"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- signTransaction
-
+
- Parameters
- 1
-
+
- Result
- oneOf
-
+
@@ -98,69 +98,69 @@ title: "signTransaction"
params
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Required
- keyIdentifier, tx, txHash
-
+
-
-
-
+
+
+
-
+
tx
string
-
+
required
-
+
-
+
-
+
txHash
string
-
+
required
-
+
-
+
-
+
keyIdentifier
object
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -170,49 +170,49 @@ title: "signTransaction"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- oneOf
-
+
-
-
-
+
+
+
-
+
-
+
error_description
string
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -227,78 +227,78 @@ title: "signTransaction"
-
-
+
+
-
+
tx
string
-
+
required
-
+
-
+
-
+
txHash
string
-
+
required
-
+
-
+
-
+
keyIdentifier
object
-
+
required
-
+
-
+
-
+
-
-
+
+
-
-
+
+
-
+
-
+
error_description
string
-
+
-
+
-
+
-
-
+
+
-
+
cURL
-
+
```bash cURL
@@ -340,14 +340,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -359,7 +359,7 @@ EOF
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
Signing API
-
-
+
+
›
-
-
-
+
+
+
subscribeTransactions
-
-
-
+
+
+
-
+
Signing API
-
-
+
+
subscribeTransactions
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC subscribeTransactions
@@ -63,32 +63,32 @@ title: "subscribeTransactions"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- subscribeTransactions
-
+
- Parameters
- 1
-
+
- Result
- object
-
+
@@ -98,47 +98,47 @@ title: "subscribeTransactions"
params
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Required
- txIds
-
+
-
-
-
+
+
+
-
+
txIds
array[string]
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -148,63 +148,63 @@ title: "subscribeTransactions"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Schema
- Transaction
-
+
- Required
- status, txId
-
+
-
-
-
+
+
+
-
+
txId
string
-
+
required
-
+
-
+
-
+
status
string
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -219,60 +219,60 @@ title: "subscribeTransactions"
-
-
+
+
-
+
txIds
array[string]
-
+
required
-
+
-
+
-
+
-
-
+
+
-
-
+
+
-
+
txId
string
-
+
required
-
+
-
+
-
+
status
string
-
+
required
-
+
-
+
-
+
-
-
+
+
-
+
cURL
-
+
```bash cURL
@@ -312,14 +312,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -331,7 +331,7 @@ EOF
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
User API
-
-
+
+
›
-
-
-
+
+
+
addIdp
-
-
-
+
+
+
-
+
User API
-
-
+
+
addIdp
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC addIdp
@@ -63,32 +63,32 @@ title: "addIdp"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- addIdp
-
+
- Parameters
- 1
-
+
- Result
- null
-
+
@@ -98,47 +98,47 @@ title: "addIdp"
params
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Required
- idp
-
+
-
-
-
+
+
+
-
+
idp
object
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -148,32 +148,32 @@ title: "addIdp"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- null
-
+
- Schema
- Null
-
+
-
-
-
-
-
-
-
+
+
+
+
+
+
+
@@ -188,34 +188,34 @@ title: "addIdp"
-
-
+
+
-
+
idp
object
-
+
required
-
+
-
+
-
+
-
-
+
+
-
-
-
-
+
+
+
+
@@ -225,12 +225,12 @@ title: "addIdp"
-
+
cURL
-
+
```bash cURL
@@ -257,14 +257,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -273,7 +273,7 @@ EOF
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
User API
-
-
+
+
›
-
-
-
+
+
+
addNetwork
-
-
-
+
+
+
-
+
User API
-
-
+
+
addNetwork
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC addNetwork
@@ -63,32 +63,32 @@ title: "addNetwork"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- addNetwork
-
+
- Parameters
- 1
-
+
- Result
- null
-
+
@@ -98,47 +98,47 @@ title: "addNetwork"
params
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Required
- network
-
+
-
-
-
+
+
+
-
+
network
object
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -148,32 +148,32 @@ title: "addNetwork"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- null
-
+
- Schema
- Null
-
+
-
-
-
-
-
-
-
+
+
+
+
+
+
+
@@ -188,34 +188,34 @@ title: "addNetwork"
-
-
+
+
-
+
network
object
-
+
required
-
+
-
+
-
+
-
-
+
+
-
-
-
-
+
+
+
+
@@ -225,12 +225,12 @@ title: "addNetwork"
-
+
cURL
-
+
```bash cURL
@@ -265,14 +265,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -281,7 +281,7 @@ EOF
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
User API
-
-
+
+
›
-
-
-
+
+
+
addSession
-
-
-
+
+
+
-
+
User API
-
-
+
+
addSession
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC addSession
@@ -63,32 +63,32 @@ title: "addSession"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- addSession
-
+
- Parameters
- 1
-
+
- Result
- object
-
+
@@ -98,47 +98,47 @@ title: "addSession"
params
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Required
- networkId
-
+
-
-
-
+
+
+
-
+
networkId
string
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -148,107 +148,107 @@ title: "addSession"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Schema
- Session
-
+
- Required
- accessToken, id, idp, network, rights, status
-
+
-
-
-
+
+
+
-
+
id
string
-
+
required
-
+
-
+
-
+
network
object
-
+
required
-
+
-
+
-
+
idp
object
-
+
required
-
+
-
+
-
+
accessToken
string
-
+
required
-
+
-
+
-
+
status
string
-
+
required
-
+
-
+
-
+
rights
array[string]
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -263,104 +263,104 @@ title: "addSession"
-
-
+
+
-
+
networkId
string
-
+
required
-
+
-
+
-
+
-
-
+
+
-
-
+
+
-
+
id
string
-
+
required
-
+
-
+
-
+
network
object
-
+
required
-
+
-
+
-
+
idp
object
-
+
required
-
+
-
+
-
+
accessToken
string
-
+
required
-
+
-
+
-
+
status
string
-
+
required
-
+
-
+
-
+
rights
array[string]
-
+
required
-
+
-
+
-
+
-
-
+
+
-
+
cURL
-
+
```bash cURL
@@ -398,14 +398,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -439,7 +439,7 @@ EOF
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
User API
-
-
+
+
›
-
-
-
+
+
+
allocatePartyForWallet
-
-
-
+
+
+
-
+
User API
-
-
+
+
allocatePartyForWallet
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC allocatePartyForWallet
@@ -63,32 +63,32 @@ title: "allocatePartyForWallet"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- allocatePartyForWallet
-
+
- Parameters
- 1
-
+
- Result
- object
-
+
@@ -98,47 +98,47 @@ title: "allocatePartyForWallet"
params
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Required
- partyId
-
+
-
-
-
+
+
+
-
+
partyId
string
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -148,47 +148,47 @@ title: "allocatePartyForWallet"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Required
- wallet
-
+
-
-
-
+
+
+
-
+
wallet
object
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -203,49 +203,49 @@ title: "allocatePartyForWallet"
-
-
+
+
-
+
partyId
string
-
+
required
-
+
-
+
-
+
-
-
+
+
-
-
+
+
-
+
wallet
object
-
+
required
-
+
-
+
-
+
-
-
+
+
-
+
cURL
-
+
```bash cURL
@@ -283,14 +283,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -310,7 +310,7 @@ EOF
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
User API
-
-
+
+
›
-
-
-
+
+
+
createWallet
-
-
-
+
+
+
-
+
User API
-
-
+
+
createWallet
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC createWallet
@@ -63,32 +63,32 @@ title: "createWallet"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- createWallet
-
+
- Parameters
- 1
-
+
- Result
- object
-
+
@@ -98,58 +98,58 @@ title: "createWallet"
params
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Required
- partyHint, signingProviderId, networkId
-
+
-
-
-
+
+
+
-
+
partyHint
string
-
+
required
-
+
-
+
-
+
signingProviderId
string
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -159,47 +159,47 @@ title: "createWallet"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Required
- wallet
-
+
-
-
-
+
+
+
-
+
wallet
object
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -214,60 +214,60 @@ title: "createWallet"
-
-
+
+
-
+
partyHint
string
-
+
required
-
+
-
+
-
+
signingProviderId
string
-
+
required
-
+
-
+
-
+
-
-
+
+
-
-
+
+
-
+
wallet
object
-
+
required
-
+
-
+
-
+
-
-
+
+
-
+
cURL
-
+
```bash cURL
@@ -306,14 +306,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -333,7 +333,7 @@ EOF
-
+
+
+
+
+
+
+
+
Wallet Gateway
+
+
+
›
+
+
+
+
User API
+
+
+
›
+
+
+
+
deleteMessageToSign
+
+
+
+
+
+
+
+
+
User API
+
+
+
deleteMessageToSign
+
+
+
+
+
+ JSON-RPC
+
+ Since 1.4.0
+
+
+
+
+
+
+
+
+ POST
+
+ JSON-RPC deleteMessageToSign
+
+
+## Protocol Details
+
+
+
+
+
+
- Protocol
+ - JSON-RPC
+
+
+
+
- Transport
+ - HTTP POST
+
+
+
+
- Method
+ - deleteMessageToSign
+
+
+
+
- Parameters
+ - 1
+
+
+
+
- Result
+ - null
+
+
+
+
+
+## Inputs
+
+
+
+
+
params
+
+
+
+
+
+
+
+
+
- Shape
+ - object
+
+
+
+
- Required
+ - messageId
+
+
+
+
+
+
+
+
+
+
+
+ messageId
+ string
+
+ required
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Outputs
+
+
+
+
+
result
+
+
+
+
+
+
+
+
+
- Shape
+ - null
+
+
+
+
- Schema
+ - Null
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Related Schemas
+
+
+
+
+
+
+
+
+
+
+
+ messageId
+ string
+
+ required
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cURL
+
+
+
+```bash cURL
+curl \
+
\
+ -H 'content-type: application/json' \
+ --data @- <<'EOF'
+{
+ "jsonrpc": "2.0",
+ "id": 1,
+ "method": "deleteMessageToSign",
+ "params": {
+ "params": {
+ "messageId": ""
+ }
+ }
+}
+EOF
+```
+
+
+
+
+
+
+
+ Result
+
+ application/json
+
+
+
+```json Result
+"
"
+```
+
+
+
+
+
+
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
User API
-
-
+
+
›
-
-
-
+
+
+
deleteTransaction
-
-
-
+
+
+
-
+
User API
-
-
+
+
deleteTransaction
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
+ Changed 0.27.0
+
-
+
-
+
POST
-
+
JSON-RPC deleteTransaction
@@ -63,32 +65,32 @@ title: "deleteTransaction"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- deleteTransaction
-
+
- Parameters
- 1
-
+
- Result
- null
-
+
@@ -98,47 +100,47 @@ title: "deleteTransaction"
params
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Required
- - commandId
+ - transactionId
-
+
-
-
-
+
+
+
-
+
- commandId
+ transactionId
string
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -148,38 +150,49 @@ title: "deleteTransaction"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- null
-
+
- Schema
- Null
-
+
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+## Lifecycle Changes
+
+
+
+
+ 0.27.0
+ params updated: `params`
+
+
+
-
-
+
+
-
+
- commandId
+ transactionId
string
-
+
required
-
+
-
+
-
+
-
-
+
+
-
-
-
-
+
+
+
+
@@ -225,12 +238,12 @@ title: "deleteTransaction"
-
+
cURL
-
+
```bash cURL
@@ -244,7 +257,7 @@ curl \
"method": "deleteTransaction",
"params": {
"params": {
- "commandId": "
"
+ "transactionId": ""
}
}
}
@@ -253,14 +266,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -269,7 +282,7 @@ EOF
-
+
Back to overview
-
diff --git a/docs-main/reference/wallet-gateway-json-rpc/operations/user-api/getmessagetosign.mdx b/docs-main/reference/wallet-gateway-json-rpc/operations/user-api/getmessagetosign.mdx
new file mode 100644
index 000000000..e9e27c21a
--- /dev/null
+++ b/docs-main/reference/wallet-gateway-json-rpc/operations/user-api/getmessagetosign.mdx
@@ -0,0 +1,314 @@
+---
+title: "getMessageToSign"
+---
+
+
+
+
+
+
+
+
+
+
+
Wallet Gateway
+
+
+
›
+
+
+
+
User API
+
+
+
›
+
+
+
+
getMessageToSign
+
+
+
+
+
+
+
+
+
User API
+
+
+
getMessageToSign
+
+
+
+
+
+ JSON-RPC
+
+ Since 1.4.0
+
+
+
+
+
+
+
+
+ POST
+
+ JSON-RPC getMessageToSign
+
+
+## Protocol Details
+
+
+
+
+
+
- Protocol
+ - JSON-RPC
+
+
+
+
- Transport
+ - HTTP POST
+
+
+
+
- Method
+ - getMessageToSign
+
+
+
+
- Parameters
+ - 1
+
+
+
+
- Result
+ - object
+
+
+
+
+
+## Inputs
+
+
+
+
+
params
+
+
+
+
+
+
+
+
+
- Shape
+ - object
+
+
+
+
- Required
+ - messageId
+
+
+
+
+
+
+
+
+
+
+
+ messageId
+ string
+
+ required
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Outputs
+
+
+
+
+
result
+
+
+
+
+
+
+
+
+
- Shape
+ - object
+
+
+
+
- Required
+ - message
+
+
+
+
+
+
+
+
+
+
+
+ message
+ object
+
+ required
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Related Schemas
+
+
+
+
+
+
+
+
+
+
+
+ messageId
+ string
+
+ required
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ message
+ object
+
+ required
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cURL
+
+
+
+```bash cURL
+curl \
+
\
+ -H 'content-type: application/json' \
+ --data @- <<'EOF'
+{
+ "jsonrpc": "2.0",
+ "id": 1,
+ "method": "getMessageToSign",
+ "params": {
+ "params": {
+ "messageId": ""
+ }
+ }
+}
+EOF
+```
+
+
+
+
+
+
+
+ Result
+
+ application/json
+
+
+
+```json Result
+{
+ "message": {
+ "id": "
",
+ "status": "",
+ "partyId": "",
+ "publicKey": "",
+ "message": "",
+ "createdAt": ""
+ }
+}
+```
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Wallet Gateway
+
+
+
›
+
+
+
+
User API
+
+
+
›
+
+
+
+
getNetwork
+
+
+
+
+
+
+
+
+
User API
+
+
+
getNetwork
+
+
+
+
+
+ JSON-RPC
+
+ Since 1.4.0
+
+
+
+
+
+
+
+
+ POST
+
+ JSON-RPC getNetwork
+
+
+## Protocol Details
+
+
+
+
+
+
- Protocol
+ - JSON-RPC
+
+
+
+
- Transport
+ - HTTP POST
+
+
+
+
- Method
+ - getNetwork
+
+
+
+
- Parameters
+ - 1
+
+
+
+
- Result
+ - object
+
+
+
+
+
+## Inputs
+
+
+
+
+
params
+
+
+
+
+
+
+
+
+
- Shape
+ - object
+
+
+
+
- Required
+ - networkId
+
+
+
+
+
+
+
+
+
+
+
+ networkId
+ string
+
+ required
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Outputs
+
+
+
+
+
result
+
+
+
+
+
+
+
+
+
- Shape
+ - object
+
+
+
+
- Required
+ - network
+
+
+
+
+
+
+
+
+
+
+
+ network
+ object
+
+ required
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Related Schemas
+
+
+
+
+
+
+
+
+
+
+
+ networkId
+ string
+
+ required
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ network
+ object
+
+ required
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cURL
+
+
+
+```bash cURL
+curl \
+
\
+ -H 'content-type: application/json' \
+ --data @- <<'EOF'
+{
+ "jsonrpc": "2.0",
+ "id": 1,
+ "method": "getNetwork",
+ "params": {
+ "params": {
+ "networkId": ""
+ }
+ }
+}
+EOF
+```
+
+
+
+
+
+
+
+ Result
+
+ application/json
+
+
+
+```json Result
+{
+ "network": {
+ "id": "
",
+ "name": "",
+ "description": "",
+ "identityProviderId": "",
+ "auth": {
+ "method": "",
+ "scope": "",
+ "clientId": "",
+ "audience": ""
+ },
+ "ledgerApi": ""
+ }
+}
+```
+
+
+
+
+
+
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
User API
-
-
+
+
›
-
-
-
+
+
+
getTransaction
-
-
-
+
+
+
-
+
User API
-
-
+
+
getTransaction
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
+ Changed 0.27.0
+
-
+
-
+
POST
-
+
JSON-RPC getTransaction
@@ -63,32 +65,32 @@ title: "getTransaction"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- getTransaction
-
+
- Parameters
- 1
-
+
- Result
- object
-
+
@@ -98,47 +100,47 @@ title: "getTransaction"
params
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Required
- - commandId
+ - transactionId
-
+
-
-
-
+
+
+
-
+
- commandId
+ transactionId
string
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -148,91 +150,113 @@ title: "getTransaction"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Schema
- Transaction
-
+
- Required
- - commandId, preparedTransaction, preparedTransactionHash, status
+ - commandId, id, preparedTransaction, preparedTransactionHash, status
-
+
-
-
-
+
+
+
-
+
+
+
+ id
+ string
+
+ required
+
+
+
+
+
commandId
string
-
+
required
-
+
-
+
-
+
status
string
-
+
required
-
+
-
+
-
+
preparedTransaction
string
-
+
required
-
+
-
+
-
+
preparedTransactionHash
string
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
+## Lifecycle Changes
+
+
+
+
+ 0.27.0
+ params updated: `params`; result updated (required fields)
+
+
+
-
-
+
+
-
+
- commandId
+ transactionId
string
-
+
required
-
+
-
+
-
+
-
-
+
+
-
-
+
+
-
+
+
+
+ id
+ string
+
+ required
+
+
+
+
+
commandId
string
-
+
required
-
+
-
+
-
+
status
string
-
+
required
-
+
-
+
-
+
preparedTransaction
string
-
+
required
-
+
-
+
-
+
preparedTransactionHash
string
-
+
required
-
+
-
+
-
+
-
-
+
+
-
+
cURL
-
+
```bash cURL
@@ -345,7 +380,7 @@ curl \
"method": "getTransaction",
"params": {
"params": {
- "commandId": "
"
+ "transactionId": ""
}
}
}
@@ -354,18 +389,19 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
{
+ "id": "
",
"commandId": "",
"status": "",
"preparedTransaction": "",
@@ -375,7 +411,7 @@ EOF
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
User API
-
-
+
+
›
-
-
-
+
+
+
getUser
-
-
-
+
+
+
-
+
User API
-
-
+
+
getUser
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC getUser
@@ -63,32 +63,32 @@ title: "getUser"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- getUser
-
+
- Parameters
- 0
-
+
- Result
- object
-
+
@@ -102,58 +102,58 @@ title: "getUser"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Required
- isAdmin, userId
-
+
-
-
-
+
+
+
-
+
userId
string
-
+
required
-
+
-
+
-
+
isAdmin
string
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -168,36 +168,36 @@ title: "getUser"
-
-
+
+
-
+
userId
string
-
+
required
-
+
-
+
-
+
isAdmin
string
-
+
required
-
+
-
+
-
+
-
-
+
+
-
+
cURL
-
+
```bash cURL
@@ -230,14 +230,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -249,7 +249,7 @@ EOF
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
User API
-
-
+
+
›
-
-
-
+
+
+
isWalletSyncNeeded
-
-
-
+
+
+
-
+
User API
-
-
+
+
isWalletSyncNeeded
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC isWalletSyncNeeded
@@ -63,32 +63,32 @@ title: "isWalletSyncNeeded"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- isWalletSyncNeeded
-
+
- Parameters
- 0
-
+
- Result
- object
-
+
@@ -102,47 +102,47 @@ title: "isWalletSyncNeeded"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Required
- walletSyncNeeded
-
+
-
-
-
+
+
+
-
+
walletSyncNeeded
string
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -157,25 +157,25 @@ title: "isWalletSyncNeeded"
-
-
+
+
-
+
walletSyncNeeded
string
-
+
required
-
+
-
+
-
+
-
-
+
+
-
+
cURL
-
+
```bash cURL
@@ -208,14 +208,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -226,7 +226,7 @@ EOF
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
User API
-
-
+
+
›
-
-
-
+
+
+
listIdps
-
-
-
+
+
+
-
+
User API
-
-
+
+
listIdps
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC listIdps
@@ -63,32 +63,32 @@ title: "listIdps"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- listIdps
-
+
- Parameters
- 0
-
+
- Result
- object
-
+
@@ -102,47 +102,47 @@ title: "listIdps"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Required
- idps
-
+
-
-
-
+
+
+
-
+
idps
array[object]
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -157,25 +157,25 @@ title: "listIdps"
-
-
+
+
-
+
idps
array[object]
-
+
required
-
+
-
+
-
+
-
-
+
+
-
+
cURL
-
+
```bash cURL
@@ -208,14 +208,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -232,7 +232,7 @@ EOF
-
+
+
+
+
+
+
+
+
Wallet Gateway
+
+
+
›
+
+
+
+
User API
+
+
+
›
+
+
+
+
listMessagesToSign
+
+
+
+
+
+
+
+
+
User API
+
+
+
listMessagesToSign
+
+
+
+
+
+ JSON-RPC
+
+ Since 1.4.0
+
+
+
+
+
+
+
+
+ POST
+
+ JSON-RPC listMessagesToSign
+
+
+## Protocol Details
+
+
+
+
+
+
- Protocol
+ - JSON-RPC
+
+
+
+
- Transport
+ - HTTP POST
+
+
+
+
- Method
+ - listMessagesToSign
+
+
+
+
- Parameters
+ - 0
+
+
+
+
- Result
+ - object
+
+
+
+
+
+## Inputs
+
+
+
+## Outputs
+
+
+
+
+
result
+
+
+
+
+
+
+
+
+
- Shape
+ - object
+
+
+
+
- Required
+ - messages
+
+
+
+
+
+
+
+
+
+
+
+ messages
+ array[object]
+
+ required
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Related Schemas
+
+
+
+
+
+
+
+
+
+
+
+ messages
+ array[object]
+
+ required
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cURL
+
+
+
+```bash cURL
+curl \
+
\
+ -H 'content-type: application/json' \
+ --data @- <<'EOF'
+{
+ "jsonrpc": "2.0",
+ "id": 1,
+ "method": "listMessagesToSign"
+}
+EOF
+```
+
+
+
+
+
+
+
+ Result
+
+ application/json
+
+
+
+```json Result
+{
+ "messages": [
+ {
+ "id": "
",
+ "status": "",
+ "partyId": "",
+ "publicKey": "",
+ "message": "",
+ "createdAt": ""
+ }
+ ]
+}
+```
+
+
+
+
+
+
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
User API
-
-
+
+
›
-
-
-
+
+
+
listNetworks
-
-
-
+
+
+
-
+
User API
-
-
+
+
listNetworks
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
+ Changed 1.4.0
+
-
+
-
+
POST
-
+
JSON-RPC listNetworks
@@ -63,32 +65,32 @@ title: "listNetworks"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- listNetworks
-
+
- Parameters
- 0
-
+
- Result
- object
-
+
@@ -102,53 +104,64 @@ title: "listNetworks"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Required
- networks
-
+
-
-
-
+
+
+
-
+
networks
array[object]
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
+## Lifecycle Changes
+
+
+
+
+ 1.4.0
+ description updated
+
+
+
-
-
+
+
-
+
networks
array[object]
-
+
required
-
+
-
+
-
+
-
-
+
+
-
+
cURL
-
+
```bash cURL
@@ -208,14 +221,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -226,13 +239,8 @@ EOF
"name": "
",
"description": "",
"identityProviderId": "",
- "auth": {
- "method": "",
- "scope": "",
- "clientId": "",
- "audience": ""
- },
- "ledgerApi": ""
+ "ledgerApi": "",
+ "authMethod": ""
}
]
}
@@ -240,7 +248,7 @@ EOF
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
User API
-
-
+
+
›
-
-
-
+
+
+
listSessions
-
-
-
+
+
+
-
+
User API
-
-
+
+
listSessions
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC listSessions
@@ -63,32 +63,32 @@ title: "listSessions"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- listSessions
-
+
- Parameters
- 0
-
+
- Result
- object
-
+
@@ -102,47 +102,47 @@ title: "listSessions"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Required
- sessions
-
+
-
-
-
+
+
+
-
+
sessions
array[object]
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -157,25 +157,25 @@ title: "listSessions"
-
-
+
+
-
+
sessions
array[object]
-
+
required
-
+
-
+
-
+
-
-
+
+
-
+
cURL
-
+
```bash cURL
@@ -208,14 +208,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -248,7 +248,7 @@ EOF
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
User API
-
-
+
+
›
-
-
-
+
+
+
listTransactions
-
-
-
+
+
+
-
+
User API
-
-
+
+
listTransactions
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
+ Changed 0.27.0
+
-
+
-
+
POST
-
+
JSON-RPC listTransactions
@@ -63,32 +65,32 @@ title: "listTransactions"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- listTransactions
-
+
- Parameters
- 0
-
+
- Result
- object
-
+
@@ -102,53 +104,64 @@ title: "listTransactions"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Required
- transactions
-
+
-
-
-
+
+
+
-
+
transactions
array[object]
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
+## Lifecycle Changes
+
+
+
+
+ 0.27.0
+ details updated
+
+
+
-
-
+
+
-
+
transactions
array[object]
-
+
required
-
+
-
+
-
+
-
-
+
+
-
+
cURL
-
+
```bash cURL
@@ -208,20 +221,21 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
{
"transactions": [
{
+ "id": "
",
"commandId": "",
"status": "",
"preparedTransaction": "",
@@ -233,7 +247,7 @@ EOF
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
User API
-
-
+
+
›
-
-
-
+
+
+
listWallets
-
-
-
+
+
+
-
+
User API
-
-
+
+
listWallets
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC listWallets
@@ -63,32 +63,32 @@ title: "listWallets"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- listWallets
-
+
- Parameters
- 1
-
+
- Result
- array[object]
-
+
@@ -98,40 +98,40 @@ title: "listWallets"
params
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
-
-
-
+
+
+
-
-
-
-
+
+
+
+
@@ -141,42 +141,42 @@ title: "listWallets"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- array[object]
-
+
-
-
-
+
+
+
-
+
items
object
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -191,47 +191,47 @@ title: "listWallets"
-
-
+
+
-
+
items
object
-
+
required
-
+
-
+
-
+
-
-
+
+
-
+
cURL
-
+
```bash cURL
@@ -276,14 +276,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -303,7 +303,7 @@ EOF
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
User API
-
-
+
+
›
-
-
-
+
+
+
removeIdp
-
-
-
+
+
+
-
+
User API
-
-
+
+
removeIdp
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC removeIdp
@@ -63,32 +63,32 @@ title: "removeIdp"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- removeIdp
-
+
- Parameters
- 1
-
+
- Result
- null
-
+
@@ -98,47 +98,47 @@ title: "removeIdp"
params
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Required
- identityProviderId
-
+
-
-
-
+
+
+
-
+
identityProviderId
string
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -148,32 +148,32 @@ title: "removeIdp"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- null
-
+
- Schema
- Null
-
+
-
-
-
-
-
-
-
+
+
+
+
+
+
+
@@ -188,34 +188,34 @@ title: "removeIdp"
-
-
+
+
-
+
identityProviderId
string
-
+
required
-
+
-
+
-
+
-
-
+
+
-
-
-
-
+
+
+
+
@@ -225,12 +225,12 @@ title: "removeIdp"
-
+
cURL
-
+
```bash cURL
@@ -253,14 +253,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -269,7 +269,7 @@ EOF
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
User API
-
-
+
+
›
-
-
-
+
+
+
removeNetwork
-
-
-
+
+
+
-
+
User API
-
-
+
+
removeNetwork
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC removeNetwork
@@ -63,32 +63,32 @@ title: "removeNetwork"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- removeNetwork
-
+
- Parameters
- 1
-
+
- Result
- null
-
+
@@ -98,47 +98,47 @@ title: "removeNetwork"
params
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Required
- networkName
-
+
-
-
-
+
+
+
-
+
networkName
string
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -148,32 +148,32 @@ title: "removeNetwork"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- null
-
+
- Schema
- Null
-
+
-
-
-
-
-
-
-
+
+
+
+
+
+
+
@@ -188,34 +188,34 @@ title: "removeNetwork"
-
-
+
+
-
+
networkName
string
-
+
required
-
+
-
+
-
+
-
-
+
+
-
-
-
-
+
+
+
+
@@ -225,12 +225,12 @@ title: "removeNetwork"
-
+
cURL
-
+
```bash cURL
@@ -253,14 +253,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -269,7 +269,7 @@ EOF
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
User API
-
-
+
+
›
-
-
-
+
+
+
removeSession
-
-
-
+
+
+
-
+
User API
-
-
+
+
removeSession
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC removeSession
@@ -63,32 +63,32 @@ title: "removeSession"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- removeSession
-
+
- Parameters
- 0
-
+
- Result
- null
-
+
@@ -102,32 +102,32 @@ title: "removeSession"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- null
-
+
- Schema
- Null
-
+
-
-
-
-
-
-
-
+
+
+
+
+
+
+
@@ -142,10 +142,10 @@ title: "removeSession"
-
-
-
-
+
+
+
+
@@ -155,12 +155,12 @@ title: "removeSession"
-
+
cURL
-
+
```bash cURL
@@ -178,14 +178,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -194,7 +194,7 @@ EOF
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
User API
-
-
+
+
›
-
-
-
+
+
+
removeWallet
-
-
-
+
+
+
-
+
User API
-
-
+
+
removeWallet
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC removeWallet
@@ -63,32 +63,32 @@ title: "removeWallet"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- removeWallet
-
+
- Parameters
- 1
-
+
- Result
- object
-
+
@@ -98,47 +98,47 @@ title: "removeWallet"
params
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Required
- partyId
-
+
-
-
-
+
+
+
-
+
partyId
string
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -148,27 +148,27 @@ title: "removeWallet"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
-
-
-
-
-
-
-
+
+
+
+
+
+
+
@@ -183,34 +183,34 @@ title: "removeWallet"
-
-
+
+
-
+
partyId
string
-
+
required
-
+
-
+
-
+
-
-
+
+
-
-
-
-
+
+
+
+
@@ -220,12 +220,12 @@ title: "removeWallet"
-
+
cURL
-
+
```bash cURL
@@ -248,14 +248,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -264,7 +264,7 @@ EOF
-
+
+
+
+
+
+
+
+
Wallet Gateway
+
+
+
›
+
+
+
+
User API
+
+
+
›
+
+
+
+
selfSignedAccessToken
+
+
+
+
+
+
+
+
+
User API
+
+
+
selfSignedAccessToken
+
+
+
+
+
+ JSON-RPC
+
+ Since 1.4.0
+
+
+
+
+
+
+
+
+ POST
+
+ JSON-RPC selfSignedAccessToken
+
+
+## Protocol Details
+
+
+
+
+
+
- Protocol
+ - JSON-RPC
+
+
+
+
- Transport
+ - HTTP POST
+
+
+
+
- Method
+ - selfSignedAccessToken
+
+
+
+
- Parameters
+ - 1
+
+
+
+
- Result
+ - object
+
+
+
+
+
+## Inputs
+
+
+
+
+
params
+
+
+
+
+
+
+
+
+
- Shape
+ - object
+
+
+
+
- Required
+ - clientId, networkId
+
+
+
+
+
+
+
+
+
+
+
+ networkId
+ string
+
+ required
+
+
+
+
+
+
+
+ clientId
+ string
+
+ required
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Outputs
+
+
+
+
+
result
+
+
+
+
+
+
+
+
+
- Shape
+ - object
+
+
+
+
- Required
+ - accessToken
+
+
+
+
+
+
+
+
+
+
+
+ accessToken
+ string
+
+ required
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Related Schemas
+
+
+
+
+
+
+
+
+
+
+
+ networkId
+ string
+
+ required
+
+
+
+
+
+
+
+ clientId
+ string
+
+ required
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ accessToken
+ string
+
+ required
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cURL
+
+
+
+```bash cURL
+curl \
+
\
+ -H 'content-type: application/json' \
+ --data @- <<'EOF'
+{
+ "jsonrpc": "2.0",
+ "id": 1,
+ "method": "selfSignedAccessToken",
+ "params": {
+ "params": {
+ "networkId": "",
+ "clientId": ""
+ }
+ }
+}
+EOF
+```
+
+
+
+
+
+
+
+ Result
+
+ application/json
+
+
+
+```json Result
+{
+ "accessToken": "
"
+}
+```
+
+
+
+
+
+
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
User API
-
-
+
+
›
-
-
-
+
+
+
setPrimaryWallet
-
-
-
+
+
+
-
+
User API
-
-
+
+
setPrimaryWallet
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC setPrimaryWallet
@@ -63,32 +63,32 @@ title: "setPrimaryWallet"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- setPrimaryWallet
-
+
- Parameters
- 1
-
+
- Result
- null
-
+
@@ -98,47 +98,47 @@ title: "setPrimaryWallet"
params
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Required
- partyId
-
+
-
-
-
+
+
+
-
+
partyId
string
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -148,32 +148,32 @@ title: "setPrimaryWallet"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- null
-
+
- Schema
- Null
-
+
-
-
-
-
-
-
-
+
+
+
+
+
+
+
@@ -188,34 +188,34 @@ title: "setPrimaryWallet"
-
-
+
+
-
+
partyId
string
-
+
required
-
+
-
+
-
+
-
-
+
+
-
-
-
-
+
+
+
+
@@ -225,12 +225,12 @@ title: "setPrimaryWallet"
-
+
cURL
-
+
```bash cURL
@@ -253,14 +253,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -269,7 +269,7 @@ EOF
-
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
User API
-
-
+
+
›
-
-
-
+
+
+
sign
-
-
-
+
+
+
-
+
User API
-
-
+
+
sign
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
+ Changed 0.27.0
+
-
+
-
+
POST
-
+
JSON-RPC sign
@@ -63,32 +65,32 @@ title: "sign"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- sign
-
+
- Parameters
- 1
-
+
- Result
- oneOf
-
+
@@ -98,80 +100,58 @@ title: "sign"
params
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Required
- - commandId, partyId, preparedTransaction, preparedTransactionHash
+ - partyId, transactionId
-
+
-
-
-
+
+
+
-
-
-
- preparedTransaction
- string
-
- required
-
-
-
-
-
-
-
- preparedTransactionHash
- string
-
- required
-
-
-
-
-
+
- commandId
+ transactionId
string
-
+
required
-
+
-
+
-
+
partyId
string
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -181,73 +161,89 @@ title: "sign"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- oneOf
-
+
-
-
-
+
+
+
-
-
-
-
+
+
+
+
+## Lifecycle Changes
+
+
+
+
+ 0.26.0
+ params updated: `params`
+
+
+
+ 0.27.0
+ params updated: `params`
+
+
+
-
-
+
+
-
-
-
- preparedTransaction
- string
-
- required
-
-
-
-
-
-
-
- preparedTransactionHash
- string
-
- required
-
-
-
-
-
+
- commandId
+ transactionId
string
-
+
required
-
+
-
+
-
+
partyId
string
-
+
required
-
+
-
+
-
+
-
-
+
+
-
+
cURL
-
+
```bash cURL
@@ -385,9 +359,7 @@ curl \
"method": "sign",
"params": {
"params": {
- "preparedTransaction": "
",
- "preparedTransactionHash": "",
- "commandId": "",
+ "transactionId": "",
"partyId": ""
}
}
@@ -397,14 +369,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -418,7 +390,7 @@ EOF
-
+
+
+
+
+
+
+
+
Wallet Gateway
+
+
+
›
+
+
+
+
User API
+
+
+
›
+
+
+
+
signMessage
+
+
+
+
+
+
+
+
+
User API
+
+
+
signMessage
+
+
+
+
+
+ JSON-RPC
+
+ Since 1.4.0
+
+
+
+
+
+
+
+
+ POST
+
+ JSON-RPC signMessage
+
+
+## Protocol Details
+
+
+
+
+
+
- Protocol
+ - JSON-RPC
+
+
+
+
- Transport
+ - HTTP POST
+
+
+
+
- Method
+ - signMessage
+
+
+
+
- Parameters
+ - 1
+
+
+
+
- Result
+ - object
+
+
+
+
+
+## Inputs
+
+
+
+
+
params
+
+
+
+
+
+
+
+
+
- Shape
+ - object
+
+
+
+
- Required
+ - messageId
+
+
+
+
+
+
+
+
+
+
+
+ messageId
+ string
+
+ required
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Outputs
+
+
+
+
+
result
+
+
+
+
+
+
+
+
+
- Shape
+ - object
+
+
+
+
- Required
+ - publicKey, signature
+
+
+
+
+
+
+
+
+
+
+
+ signature
+ string
+
+ required
+
+
+
+
+
+
+
+ publicKey
+ string
+
+ required
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Related Schemas
+
+
+
+
+
+
+
+
+
+
+
+ messageId
+ string
+
+ required
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ signature
+ string
+
+ required
+
+
+
+
+
+
+
+ publicKey
+ string
+
+ required
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cURL
+
+
+
+```bash cURL
+curl \
+
\
+ -H 'content-type: application/json' \
+ --data @- <<'EOF'
+{
+ "jsonrpc": "2.0",
+ "id": 1,
+ "method": "signMessage",
+ "params": {
+ "params": {
+ "messageId": ""
+ }
+ }
+}
+EOF
+```
+
+
+
+
+
+
+
+ Result
+
+ application/json
+
+
+
+```json Result
+{
+ "signature": "
",
+ "publicKey": ""
+}
+```
+
+
+
+
+
+
+
-
-
+
+
Wallet Gateway
-
-
+
+
›
-
-
-
+
+
+
User API
-
-
+
+
›
-
-
-
+
+
+
syncWallets
-
-
-
+
+
+
-
+
User API
-
-
+
+
syncWallets
-
-
-
+
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
POST
-
+
JSON-RPC syncWallets
@@ -63,32 +63,32 @@ title: "syncWallets"
-
+
- Protocol
- JSON-RPC
-
+
- Transport
- HTTP POST
-
+
- Method
- syncWallets
-
+
- Parameters
- 0
-
+
- Result
- object
-
+
@@ -102,69 +102,69 @@ title: "syncWallets"
result
-
+
-
-
-
+
+
+
-
+
- Shape
- object
-
+
- Required
- added, disabled, updated
-
+
-
-
-
+
+
+
-
+
added
array[object]
-
+
required
-
+
-
+
-
+
updated
array[object]
-
+
required
-
+
-
+
-
+
disabled
array[object]
-
+
required
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -179,47 +179,47 @@ title: "syncWallets"
-
-
+
+
-
+
added
array[object]
-
+
required
-
+
-
+
-
+
updated
array[object]
-
+
required
-
+
-
+
-
+
disabled
array[object]
-
+
required
-
+
-
+
-
+
-
-
+
+
-
+
cURL
-
+
```bash cURL
@@ -252,14 +252,14 @@ EOF
-
+
Result
-
+
application/json
-
+
```json Result
@@ -305,7 +305,7 @@ EOF
-
+
Back to overview
-
+
OpenRPC Spec
-
-
+
+
Sync dApp API
-
-
+
+
An OpenRPC specification for the dapp to interact with a Wallet Provider.
-
-
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
+ Changed 1.4.0
+
-
+
-
+
- Latest source path
- api-specs/openrpc-dapp-api.json
-
+
- Publish version
- - 0.25.0
+ - 1.4.0
-
+
- OpenRPC version
- 1.2.6
-
+
- Spec info.version
- 0.5.0
-
+
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-RPC
-
+
Since 0.24.0
-
+
+ Changed 1.4.0
+
-
+
-
+
- Latest source path
- api-specs/openrpc-dapp-remote-api.json
-
+
- Publish version
- - 0.25.0
+ - 1.4.0
-
+
- OpenRPC version
- 1.2.6
-
+
- Spec info.version
- 0.1.0
-
+
Back to overview
-
+
OpenRPC Spec
-
-
+
+
Signing API
-
-
+
+
An OpenRPC specification for the Signing API which allows the Wallet Gateway to interact with a Wallet Providers.
-
-
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
-
+
-
+
- Latest source path
- api-specs/openrpc-signing-api.json
-
+
- Publish version
- - 0.25.0
+ - 1.4.0
-
+
- OpenRPC version
- 1.2.6
-
+
- Spec info.version
- 0.1.0
-
+
Back to overview
-
+
OpenRPC Spec
-
-
+
+
User API
-
-
+
+
An OpenRPC specification for the user to interact with the Wallet Gateway.
-
-
+
+
-
+
JSON-RPC
-
+
Since 0.24.0
-
+
+ Changed 1.4.0
+
-
+
-
+
- Latest source path
- api-specs/openrpc-user-api.json
-
+
- Publish version
- - 0.25.0
+ - 1.4.0
-
+
- OpenRPC version
- 1.2.6
-
+
- Spec info.version
- 0.1.0
-
+