diff --git a/config/x2mdx/wallet-gateway-openrpc/source-artifacts.json b/config/x2mdx/wallet-gateway-openrpc/source-artifacts.json index 325d463b3..c75c7d9a3 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": "1.4.0", + "publish_version": "1.5.0", "specs": [ { "spec_id": "dapp-api", diff --git a/docs-main/docs.json b/docs-main/docs.json index e219a699a..8fd2f51b0 100644 --- a/docs-main/docs.json +++ b/docs-main/docs.json @@ -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", diff --git a/docs-main/reference/wallet-gateway-json-rpc/index.mdx b/docs-main/reference/wallet-gateway-json-rpc/index.mdx index 86dd2810e..6ae559968 100644 --- a/docs-main/reference/wallet-gateway-json-rpc/index.mdx +++ b/docs-main/reference/wallet-gateway-json-rpc/index.mdx @@ -18,7 +18,7 @@ description: "Versioned OpenRPC reference docs." OpenRPC - 1.4.0 + 1.5.0 @@ -27,12 +27,12 @@ description: "Versioned OpenRPC reference docs."
Publish version
-
1.4.0
+
1.5.0
Versions compared
-
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
+
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
@@ -89,7 +89,7 @@ Choose a spec page to browse its methods, then drill into operation pages for re
Latest version
-
1.4.0
+
1.5.0
@@ -133,7 +133,7 @@ Choose a spec page to browse its methods, then drill into operation pages for re
Latest version
-
1.4.0
+
1.5.0
@@ -175,7 +175,7 @@ Choose a spec page to browse its methods, then drill into operation pages for re
Latest version
-
1.4.0
+
1.5.0
@@ -214,12 +214,12 @@ Choose a spec page to browse its methods, then drill into operation pages for re
Methods
-
28
+
32
Latest version
-
1.4.0
+
1.5.0
diff --git a/docs-main/reference/wallet-gateway-json-rpc/operations/dapp-api/details.mdx b/docs-main/reference/wallet-gateway-json-rpc/operations/dapp-api/details.mdx index 24af966c8..1d731d084 100644 --- a/docs-main/reference/wallet-gateway-json-rpc/operations/dapp-api/details.mdx +++ b/docs-main/reference/wallet-gateway-json-rpc/operations/dapp-api/details.mdx @@ -36,7 +36,7 @@ description: "An OpenRPC specification for the dapp to interact with a Wallet Pr
Publish version
-
1.4.0
+
1.5.0
diff --git a/docs-main/reference/wallet-gateway-json-rpc/operations/dapp-remote-api/details.mdx b/docs-main/reference/wallet-gateway-json-rpc/operations/dapp-remote-api/details.mdx index b966ef79b..4e2af4fff 100644 --- a/docs-main/reference/wallet-gateway-json-rpc/operations/dapp-remote-api/details.mdx +++ b/docs-main/reference/wallet-gateway-json-rpc/operations/dapp-remote-api/details.mdx @@ -36,7 +36,7 @@ description: "An OpenRPC specification for remotely hosted Wallet Providers. Due
Publish version
-
1.4.0
+
1.5.0
diff --git a/docs-main/reference/wallet-gateway-json-rpc/operations/details.mdx b/docs-main/reference/wallet-gateway-json-rpc/operations/details.mdx index 4a607bbac..429d4f9ca 100644 --- a/docs-main/reference/wallet-gateway-json-rpc/operations/details.mdx +++ b/docs-main/reference/wallet-gateway-json-rpc/operations/details.mdx @@ -18,7 +18,7 @@ description: "Versioned OpenRPC reference docs." OpenRPC - 1.4.0 + 1.5.0
@@ -27,12 +27,12 @@ description: "Versioned OpenRPC reference docs."
Publish version
-
1.4.0
+
1.5.0
Versions compared
-
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
+
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
@@ -89,7 +89,7 @@ Choose a spec page to browse its methods, then drill into operation pages for re
Latest version
-
1.4.0
+
1.5.0
@@ -133,7 +133,7 @@ Choose a spec page to browse its methods, then drill into operation pages for re
Latest version
-
1.4.0
+
1.5.0
@@ -175,7 +175,7 @@ Choose a spec page to browse its methods, then drill into operation pages for re
Latest version
-
1.4.0
+
1.5.0
@@ -214,12 +214,12 @@ Choose a spec page to browse its methods, then drill into operation pages for re
Methods
-
28
+
32
Latest version
-
1.4.0
+
1.5.0
diff --git a/docs-main/reference/wallet-gateway-json-rpc/operations/signing-api/details.mdx b/docs-main/reference/wallet-gateway-json-rpc/operations/signing-api/details.mdx index bb683de1b..11256506f 100644 --- a/docs-main/reference/wallet-gateway-json-rpc/operations/signing-api/details.mdx +++ b/docs-main/reference/wallet-gateway-json-rpc/operations/signing-api/details.mdx @@ -34,7 +34,7 @@ description: "An OpenRPC specification for the Signing API which allows the Wall
Publish version
-
1.4.0
+
1.5.0
diff --git a/docs-main/reference/wallet-gateway-json-rpc/operations/user-api/details.mdx b/docs-main/reference/wallet-gateway-json-rpc/operations/user-api/details.mdx index cc373effb..bbcb61482 100644 --- a/docs-main/reference/wallet-gateway-json-rpc/operations/user-api/details.mdx +++ b/docs-main/reference/wallet-gateway-json-rpc/operations/user-api/details.mdx @@ -36,7 +36,7 @@ description: "An OpenRPC specification for the user to interact with the Wallet
Publish version
-
1.4.0
+
1.5.0
@@ -364,6 +364,43 @@ Method pages are the primary reference surface. This spec page stays focused on + + +
+

generateApiKey

+ +
+ + JSON-RPC + + Since 1.5.0 + +
+ +
+ +

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

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + + + + +
@@ -549,6 +586,43 @@ Method pages are the primary reference surface. This spec page stays focused on + + +
+

listApiKeys

+ +
+ + JSON-RPC + + Since 1.5.0 + +
+ +
+ +

Lists all API keys for the current user and network.

+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + + + + +
@@ -693,6 +767,43 @@ Method pages are the primary reference surface. This spec page stays focused on + + +
+

listSigningProviderVaults

+ +
+ + JSON-RPC + + Since 1.5.0 + +
+ +
+ +

Lists available vaults of a signing provider

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + + + + +
@@ -767,6 +878,43 @@ Method pages are the primary reference surface. This spec page stays focused on + + +
+

removeApiKey

+ +
+ + JSON-RPC + + Since 1.5.0 + +
+ +
+ +

Removes an API key for the current user and network.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
null
+
+ +
+ + + + + +
diff --git a/docs-main/reference/wallet-gateway-json-rpc/operations/user-api/generateapikey.mdx b/docs-main/reference/wallet-gateway-json-rpc/operations/user-api/generateapikey.mdx new file mode 100644 index 000000000..9a89dd336 --- /dev/null +++ b/docs-main/reference/wallet-gateway-json-rpc/operations/user-api/generateapikey.mdx @@ -0,0 +1,335 @@ +--- +title: "generateApiKey" +--- + +
+ +
+
+ + + + + +
+ +

User API

+ + +

generateApiKey

+ + + +
+ + JSON-RPC + + Since 1.5.0 + +
+ + +
+ +
+ + POST + + JSON-RPC generateApiKey +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
generateApiKey
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
name
+
+ +
+ + + + +
+ +
+
+ name + string + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Schema
+
GeneratedApiKey
+
+ +
+
Required
+
apiKey, id, createdAt
+
+ +
+ + + + +
+ +
+
+ id + string + + required + +
+ +
+ +
+
+ apiKey + string + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ name + string + + required + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ id + string + + required + +
+ +
+ +
+
+ apiKey + string + + required + +
+ +
+ +
+ + + +
+ + + + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "generateApiKey", + "params": { + "params": { + "name": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "id": "", + "apiKey": "" +} +``` + +
+
+ +
+ +
diff --git a/docs-main/reference/wallet-gateway-json-rpc/operations/user-api/listapikeys.mdx b/docs-main/reference/wallet-gateway-json-rpc/operations/user-api/listapikeys.mdx new file mode 100644 index 000000000..0d635cde1 --- /dev/null +++ b/docs-main/reference/wallet-gateway-json-rpc/operations/user-api/listapikeys.mdx @@ -0,0 +1,238 @@ +--- +title: "listApiKeys" +--- + +
+ +
+
+ + + + + +
+ +

User API

+ + +

listApiKeys

+ + + +
+ + JSON-RPC + + Since 1.5.0 + +
+ + +
+ +
+ + POST + + JSON-RPC listApiKeys +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
listApiKeys
+
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
apiKeys
+
+ +
+ + + + +
+ +
+
+ apiKeys + array[object] + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ apiKeys + array[object] + + required + +
+ +
+ +
+ + + +
+ + + + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "listApiKeys" +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "apiKeys": [ + { + "id": "", + "name": "", + "createdAt": "" + } + ] +} +``` + +
+
+ +
+ +
diff --git a/docs-main/reference/wallet-gateway-json-rpc/operations/user-api/listsigningprovidervaults.mdx b/docs-main/reference/wallet-gateway-json-rpc/operations/user-api/listsigningprovidervaults.mdx new file mode 100644 index 000000000..e5950f064 --- /dev/null +++ b/docs-main/reference/wallet-gateway-json-rpc/operations/user-api/listsigningprovidervaults.mdx @@ -0,0 +1,309 @@ +--- +title: "listSigningProviderVaults" +--- + +
+ +
+
+ + + + + +
+ +

User API

+ + +

listSigningProviderVaults

+ + + +
+ + JSON-RPC + + Since 1.5.0 + +
+ + +
+ +
+ + POST + + JSON-RPC listSigningProviderVaults +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
listSigningProviderVaults
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
signingProviderId
+
+ +
+ + + + +
+ +
+
+ signingProviderId + string + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
vaults
+
+ +
+ + + + +
+ +
+
+ vaults + array[string] + + required + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ signingProviderId + string + + required + +
+ +
+ +
+ + + +
+ + + +
+ + +
+ +
+
+ vaults + array[string] + + required + +
+ +
+ +
+ + + +
+ + + + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "listSigningProviderVaults", + "params": { + "params": { + "signingProviderId": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +{ + "vaults": [ + "" + ] +} +``` + +
+
+ +
+ +
diff --git a/docs-main/reference/wallet-gateway-json-rpc/operations/user-api/removeapikey.mdx b/docs-main/reference/wallet-gateway-json-rpc/operations/user-api/removeapikey.mdx new file mode 100644 index 000000000..a8cd05d9d --- /dev/null +++ b/docs-main/reference/wallet-gateway-json-rpc/operations/user-api/removeapikey.mdx @@ -0,0 +1,275 @@ +--- +title: "removeApiKey" +--- + +
+ +
+
+ + + + + +
+ +

User API

+ + +

removeApiKey

+ + + +
+ + JSON-RPC + + Since 1.5.0 + +
+ + +
+ +
+ + POST + + JSON-RPC removeApiKey +
+ +## Protocol Details + + +
+ +
+
Protocol
+
JSON-RPC
+
+ +
+
Transport
+
HTTP POST
+
+ +
+
Method
+
removeApiKey
+
+ +
+
Parameters
+
1
+
+ +
+
Result
+
null
+
+ +
+ + +## Inputs + + +
+
+

params

+ +
+ + + +
+ +
+
Shape
+
object
+
+ +
+
Required
+
id
+
+ +
+ + + + +
+ +
+
+ id + string + + required + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

result

+ +
+ + + +
+ +
+
Shape
+
null
+
+ +
+
Schema
+
Null
+
+ +
+ + + + + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ id + string + + required + +
+ +
+ +
+ + + +
+ + + +
+ + + + +
+ + + + + +
+ +
+ +
+
+
+ cURL + +
+ +```bash cURL +curl \ + \ + -H 'content-type: application/json' \ + --data @- <<'EOF' +{ + "jsonrpc": "2.0", + "id": 1, + "method": "removeApiKey", + "params": { + "params": { + "id": "" + } + } +} +EOF +``` + +
+
+ +
+
+
+ Result + + application/json + +
+ +```json Result +"" +``` + +
+
+ +
+ +
diff --git a/docs-main/reference/wallet-gateway-json-rpc/specs/dapp-api.mdx b/docs-main/reference/wallet-gateway-json-rpc/specs/dapp-api.mdx index 8447b06c1..0da094c44 100644 --- a/docs-main/reference/wallet-gateway-json-rpc/specs/dapp-api.mdx +++ b/docs-main/reference/wallet-gateway-json-rpc/specs/dapp-api.mdx @@ -36,7 +36,7 @@ description: "An OpenRPC specification for the dapp to interact with a Wallet Pr
Publish version
-
1.4.0
+
1.5.0
diff --git a/docs-main/reference/wallet-gateway-json-rpc/specs/dapp-remote-api.mdx b/docs-main/reference/wallet-gateway-json-rpc/specs/dapp-remote-api.mdx index 0bbd7885f..437f3f578 100644 --- a/docs-main/reference/wallet-gateway-json-rpc/specs/dapp-remote-api.mdx +++ b/docs-main/reference/wallet-gateway-json-rpc/specs/dapp-remote-api.mdx @@ -36,7 +36,7 @@ description: "An OpenRPC specification for remotely hosted Wallet Providers. Due
Publish version
-
1.4.0
+
1.5.0
diff --git a/docs-main/reference/wallet-gateway-json-rpc/specs/signing-api.mdx b/docs-main/reference/wallet-gateway-json-rpc/specs/signing-api.mdx index 09dd08a2e..9b0dcafd3 100644 --- a/docs-main/reference/wallet-gateway-json-rpc/specs/signing-api.mdx +++ b/docs-main/reference/wallet-gateway-json-rpc/specs/signing-api.mdx @@ -34,7 +34,7 @@ description: "An OpenRPC specification for the Signing API which allows the Wall
Publish version
-
1.4.0
+
1.5.0
diff --git a/docs-main/reference/wallet-gateway-json-rpc/specs/user-api.mdx b/docs-main/reference/wallet-gateway-json-rpc/specs/user-api.mdx index 0fea02b6a..c001c4803 100644 --- a/docs-main/reference/wallet-gateway-json-rpc/specs/user-api.mdx +++ b/docs-main/reference/wallet-gateway-json-rpc/specs/user-api.mdx @@ -36,7 +36,7 @@ description: "An OpenRPC specification for the user to interact with the Wallet
Publish version
-
1.4.0
+
1.5.0
@@ -364,6 +364,43 @@ Method pages are the primary reference surface. This spec page stays focused on + + +
+

generateApiKey

+ +
+ + JSON-RPC + + Since 1.5.0 + +
+ +
+ +

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

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + + + + +
@@ -549,6 +586,43 @@ Method pages are the primary reference surface. This spec page stays focused on + + +
+

listApiKeys

+ +
+ + JSON-RPC + + Since 1.5.0 + +
+ +
+ +

Lists all API keys for the current user and network.

+ + +
+ +
+
Parameters
+
0
+
+ +
+
Result
+
object
+
+ +
+ + + + + +
@@ -693,6 +767,43 @@ Method pages are the primary reference surface. This spec page stays focused on + + +
+

listSigningProviderVaults

+ +
+ + JSON-RPC + + Since 1.5.0 + +
+ +
+ +

Lists available vaults of a signing provider

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
object
+
+ +
+ + + + + +
@@ -767,6 +878,43 @@ Method pages are the primary reference surface. This spec page stays focused on + + +
+

removeApiKey

+ +
+ + JSON-RPC + + Since 1.5.0 + +
+ +
+ +

Removes an API key for the current user and network.

+ + +
+ +
+
Parameters
+
1
+
+ +
+
Result
+
null
+
+ +
+ + + + + +