Skip to content

Update Wallet Gateway OpenRPC reference #972

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
+1,482 −25
Draft

Update Wallet Gateway OpenRPC reference #972

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion config/x2mdx/wallet-gateway-openrpc/source-artifacts.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": "1.4.0",
"publish_version": "1.5.0",
"specs": [
{
"spec_id": "dapp-api",
Expand Down
4 changes: 4 additions & 0 deletions docs-main/docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1538,17 +1538,21 @@
"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/generateapikey",
"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/listapikeys",
"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/listsigningprovidervaults",
"reference/wallet-gateway-json-rpc/operations/user-api/listtransactions",
"reference/wallet-gateway-json-rpc/operations/user-api/listwallets",
"reference/wallet-gateway-json-rpc/operations/user-api/removeapikey",
"reference/wallet-gateway-json-rpc/operations/user-api/removeidp",
"reference/wallet-gateway-json-rpc/operations/user-api/removenetwork",
"reference/wallet-gateway-json-rpc/operations/user-api/removesession",
Expand Down
16 changes: 8 additions & 8 deletions docs-main/reference/wallet-gateway-json-rpc/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ description: "Versioned OpenRPC reference docs."

<span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">OpenRPC</span>

<span class="x2mdx-ref-badge x2mdx-ref-badge--neutral">1.4.0</span>
<span class="x2mdx-ref-badge x2mdx-ref-badge--neutral">1.5.0</span>

</div>

Expand All @@ -27,12 +27,12 @@ description: "Versioned OpenRPC reference docs."

<div class="x2mdx-ref-meta-item">
<dt>Publish version</dt>
<dd>1.4.0</dd>
<dd>1.5.0</dd>
</div>

<div class="x2mdx-ref-meta-item">
<dt>Versions compared</dt>
<dd>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</dd>
<dd>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, 1.5.0</dd>
</div>

<div class="x2mdx-ref-meta-item">
Expand Down Expand Up @@ -89,7 +89,7 @@ Choose a spec page to browse its methods, then drill into operation pages for re

<div class="x2mdx-ref-meta-item">
<dt>Latest version</dt>
<dd>1.4.0</dd>
<dd>1.5.0</dd>
</div>

<div class="x2mdx-ref-meta-item">
Expand Down Expand Up @@ -133,7 +133,7 @@ Choose a spec page to browse its methods, then drill into operation pages for re

<div class="x2mdx-ref-meta-item">
<dt>Latest version</dt>
<dd>1.4.0</dd>
<dd>1.5.0</dd>
</div>

<div class="x2mdx-ref-meta-item">
Expand Down Expand Up @@ -175,7 +175,7 @@ Choose a spec page to browse its methods, then drill into operation pages for re

<div class="x2mdx-ref-meta-item">
<dt>Latest version</dt>
<dd>1.4.0</dd>
<dd>1.5.0</dd>
</div>

<div class="x2mdx-ref-meta-item">
Expand Down Expand Up @@ -214,12 +214,12 @@ Choose a spec page to browse its methods, then drill into operation pages for re

<div class="x2mdx-ref-meta-item">
<dt>Methods</dt>
<dd>28</dd>
<dd>32</dd>
</div>

<div class="x2mdx-ref-meta-item">
<dt>Latest version</dt>
<dd>1.4.0</dd>
<dd>1.5.0</dd>
</div>

<div class="x2mdx-ref-meta-item">
Expand Down
2 changes: 1 addition & 1 deletion docs-main/reference/wallet-gateway-json-rpc/operations/dapp-api/details.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ description: "An OpenRPC specification for the dapp to interact with a Wallet Pr

<div class="x2mdx-ref-meta-item">
<dt>Publish version</dt>
<dd>1.4.0</dd>
<dd>1.5.0</dd>
</div>

<div class="x2mdx-ref-meta-item">
Expand Down
2 changes: 1 addition & 1 deletion docs-main/reference/wallet-gateway-json-rpc/operations/dapp-remote-api/details.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ description: "An OpenRPC specification for remotely hosted Wallet Providers. Due

<div class="x2mdx-ref-meta-item">
<dt>Publish version</dt>
<dd>1.4.0</dd>
<dd>1.5.0</dd>
</div>

<div class="x2mdx-ref-meta-item">
Expand Down
16 changes: 8 additions & 8 deletions docs-main/reference/wallet-gateway-json-rpc/operations/details.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ description: "Versioned OpenRPC reference docs."

<span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">OpenRPC</span>

<span class="x2mdx-ref-badge x2mdx-ref-badge--neutral">1.4.0</span>
<span class="x2mdx-ref-badge x2mdx-ref-badge--neutral">1.5.0</span>

</div>

Expand All @@ -27,12 +27,12 @@ description: "Versioned OpenRPC reference docs."

<div class="x2mdx-ref-meta-item">
<dt>Publish version</dt>
<dd>1.4.0</dd>
<dd>1.5.0</dd>
</div>

<div class="x2mdx-ref-meta-item">
<dt>Versions compared</dt>
<dd>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</dd>
<dd>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, 1.5.0</dd>
</div>

<div class="x2mdx-ref-meta-item">
Expand Down Expand Up @@ -89,7 +89,7 @@ Choose a spec page to browse its methods, then drill into operation pages for re

<div class="x2mdx-ref-meta-item">
<dt>Latest version</dt>
<dd>1.4.0</dd>
<dd>1.5.0</dd>
</div>

<div class="x2mdx-ref-meta-item">
Expand Down Expand Up @@ -133,7 +133,7 @@ Choose a spec page to browse its methods, then drill into operation pages for re

<div class="x2mdx-ref-meta-item">
<dt>Latest version</dt>
<dd>1.4.0</dd>
<dd>1.5.0</dd>
</div>

<div class="x2mdx-ref-meta-item">
Expand Down Expand Up @@ -175,7 +175,7 @@ Choose a spec page to browse its methods, then drill into operation pages for re

<div class="x2mdx-ref-meta-item">
<dt>Latest version</dt>
<dd>1.4.0</dd>
<dd>1.5.0</dd>
</div>

<div class="x2mdx-ref-meta-item">
Expand Down Expand Up @@ -214,12 +214,12 @@ Choose a spec page to browse its methods, then drill into operation pages for re

<div class="x2mdx-ref-meta-item">
<dt>Methods</dt>
<dd>28</dd>
<dd>32</dd>
</div>

<div class="x2mdx-ref-meta-item">
<dt>Latest version</dt>
<dd>1.4.0</dd>
<dd>1.5.0</dd>
</div>

<div class="x2mdx-ref-meta-item">
Expand Down
2 changes: 1 addition & 1 deletion docs-main/reference/wallet-gateway-json-rpc/operations/signing-api/details.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ description: "An OpenRPC specification for the Signing API which allows the Wall

<div class="x2mdx-ref-meta-item">
<dt>Publish version</dt>
<dd>1.4.0</dd>
<dd>1.5.0</dd>
</div>

<div class="x2mdx-ref-meta-item">
Expand Down
150 changes: 149 additions & 1 deletion docs-main/reference/wallet-gateway-json-rpc/operations/user-api/details.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ description: "An OpenRPC specification for the user to interact with the Wallet

<div class="x2mdx-ref-meta-item">
<dt>Publish version</dt>
<dd>1.4.0</dd>
<dd>1.5.0</dd>
</div>

<div class="x2mdx-ref-meta-item">
Expand Down Expand Up @@ -364,6 +364,43 @@ Method pages are the primary reference surface. This spec page stays focused on



<a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/user-api/generateapikey">

<div class="x2mdx-ref-card-head">
<h3>generateApiKey</h3>

<div class="x2mdx-ref-badges">

<span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">JSON-RPC</span>

<span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 1.5.0</span>

</div>

</div>

<p class="x2mdx-ref-card-summary">Generates a new API key for the current user and network.</p>


<dl class="x2mdx-ref-meta-grid">

<div class="x2mdx-ref-meta-item">
<dt>Parameters</dt>
<dd>1</dd>
</div>

<div class="x2mdx-ref-meta-item">
<dt>Result</dt>
<dd>object</dd>
</div>

</dl>


</a>



<a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/user-api/getmessagetosign">

<div class="x2mdx-ref-card-head">
Expand Down Expand Up @@ -549,6 +586,43 @@ Method pages are the primary reference surface. This spec page stays focused on



<a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/user-api/listapikeys">

<div class="x2mdx-ref-card-head">
<h3>listApiKeys</h3>

<div class="x2mdx-ref-badges">

<span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">JSON-RPC</span>

<span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 1.5.0</span>

</div>

</div>

<p class="x2mdx-ref-card-summary">Lists all API keys for the current user and network.</p>


<dl class="x2mdx-ref-meta-grid">

<div class="x2mdx-ref-meta-item">
<dt>Parameters</dt>
<dd>0</dd>
</div>

<div class="x2mdx-ref-meta-item">
<dt>Result</dt>
<dd>object</dd>
</div>

</dl>


</a>



<a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/user-api/listidps">

<div class="x2mdx-ref-card-head">
Expand Down Expand Up @@ -693,6 +767,43 @@ Method pages are the primary reference surface. This spec page stays focused on



<a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/user-api/listsigningprovidervaults">

<div class="x2mdx-ref-card-head">
<h3>listSigningProviderVaults</h3>

<div class="x2mdx-ref-badges">

<span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">JSON-RPC</span>

<span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 1.5.0</span>

</div>

</div>

<p class="x2mdx-ref-card-summary">Lists available vaults of a signing provider</p>


<dl class="x2mdx-ref-meta-grid">

<div class="x2mdx-ref-meta-item">
<dt>Parameters</dt>
<dd>1</dd>
</div>

<div class="x2mdx-ref-meta-item">
<dt>Result</dt>
<dd>object</dd>
</div>

</dl>


</a>



<a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/user-api/listtransactions">

<div class="x2mdx-ref-card-head">
Expand Down Expand Up @@ -767,6 +878,43 @@ Method pages are the primary reference surface. This spec page stays focused on



<a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/user-api/removeapikey">

<div class="x2mdx-ref-card-head">
<h3>removeApiKey</h3>

<div class="x2mdx-ref-badges">

<span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">JSON-RPC</span>

<span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 1.5.0</span>

</div>

</div>

<p class="x2mdx-ref-card-summary">Removes an API key for the current user and network.</p>


<dl class="x2mdx-ref-meta-grid">

<div class="x2mdx-ref-meta-item">
<dt>Parameters</dt>
<dd>1</dd>
</div>

<div class="x2mdx-ref-meta-item">
<dt>Result</dt>
<dd>null</dd>
</div>

</dl>


</a>



<a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/user-api/removeidp">

<div class="x2mdx-ref-card-head">
Expand Down
Loading