Skip to content

Commit f5e94e7

Browse files
Update multichain Scope properties (#295)
* Update multichain `Scope` properties * combine and add more changes * minor fix
1 parent 2706c59 commit f5e94e7

File tree

1 file changed

+23
-20
lines changed

1 file changed

+23
-20
lines changed

multichain/openrpc.yaml

Lines changed: 23 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
openrpc: 1.2.4
22
info:
3-
title: MetaMask MultiChain API
3+
title: MetaMask Multichain API
44
version: 1.0.0
55
description: >-
6-
This provides the specs for the MultiChain API Layer for the MetaMask API
6+
Specification for the Multichain API layer of MetaMask's Wallet API.
77
methods:
88
- name: wallet_notify
99
paramStructure: by-name
1010
params:
1111
- name: scope
12-
description: a valid `scope` string that has been previously authorized via `provider_authorize`
12+
description: A valid `scope` string that has been previously authorized to the dapp.
1313
required: true
1414
schema:
1515
$ref: "#/components/schemas/ScopeString"
1616
- name: notification
17-
description: an object containing a JSON-RPC notification with `method` and `params`
17+
description: An object containing a JSON-RPC notification with `method` and `params`.
1818
deprecated: false
1919
required: true
2020
schema:
@@ -27,12 +27,12 @@ methods:
2727
paramStructure: by-name
2828
params:
2929
- name: scope
30-
description: a valid `scope` string that has been previously authorized via `provider_authorize`
30+
description: A valid `scope` string that has been previously authorized to the dapp.
3131
required: true
3232
schema:
3333
$ref: "#/components/schemas/ScopeString"
3434
- name: request
35-
description: an object containing a JSON-RPC request with `method` and `params`
35+
description: An object containing a JSON-RPC request with `method` and `params`.
3636
deprecated: false
3737
required: true
3838
schema:
@@ -587,35 +587,38 @@ components:
587587
Scope:
588588
type: object
589589
title: Scope
590-
description: Scope for a multi-chain connection
590+
description: Scope for a multichain connection.
591591
additionalProperties: true
592592
required:
593593
- notifications
594594
- methods
595595
properties:
596-
scopes:
596+
references:
597+
description: >-
598+
References to specific blockchains associated with this scope.
599+
Primarily used for shorthand when there would otherwise be
600+
duplicate scopes. Supported only in requests.
597601
type: array
598602
items:
599-
$ref: "#/components/schemas/ScopeString"
603+
type: string
600604
methods:
601-
description: Methods that the wallet must support in order to be used with this provider.
605+
description: >-
606+
Methods associated with this scope. Supported in both requests and
607+
responses.
602608
type: array
603609
items:
604610
type: string
605611
notifications:
606-
description: Notifications that the wallet must support in order to be used with this provider.
607-
type: array
608-
items:
609-
type: string
610-
rpcEndpoints:
611-
description: JSON-RPC endpoints for this namespace.
612+
description: >-
613+
Notifications associated with this scope. Supported in both requests
614+
and responses.
612615
type: array
613616
items:
614617
type: string
615-
format: uri
616-
rpcDocuments:
618+
accounts:
617619
type: array
618-
description: OpenRPC documents that define RPC methods in which to anchor the methods authorized in a CAIP-25 interaction.
620+
description: >-
621+
Account associated with this scope. Supported in both requests and
622+
responses.
619623
items:
620624
type: string
621-
format: uri

0 commit comments

Comments
 (0)