Skip to content

Commit ad56a57

Browse files
committed
chore: fix integration docs
1 parent 895209c commit ad56a57

File tree

6 files changed

+21
-21
lines changed

6 files changed

+21
-21
lines changed

integration-docs/accounts.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@ Custodians are responsible for maintaining the list of accounts a user can acces
22

33
These can correspond to private keys held in a HSM, EOAs that are controlled by shared secrets, or any other mechanism that allows the custodian to sign transactions on behalf of the user. Contract wallets are also supported, although they generally cannot sign messages.
44

5-
The custodial snap, once authenticated, will ask the custodian for a list of accounts for this user using the custodian_listAccounts method of the Ethereum Custodian API.
5+
The institutional snap, once authenticated, will ask the custodian for a list of accounts for this user using the custodian_listAccounts method of the Ethereum Custodian API.

integration-docs/architecture.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Overview
22

3-
The custodial snap is a preinstalled component of MetaMask that allows users to interact with decentralised applications across EVMs and propose transactions to custodians as if the keys were stored in the extension. It is a thin client that runs in the browser and communicates directly with a custodian service to initiate transactions and message signing.
3+
The institutional snap is a preinstalled component of MetaMask that allows users to interact with decentralised applications across EVMs and propose transactions to custodians as if the keys were stored in the extension. It is a thin client that runs in the browser and communicates directly with a custodian service to initiate transactions and message signing.
44

55
Custodians are responsible for account management abd transaction/message signing, including being ultimately accountable for nonce and gas parameters. They are also responsible for providing the user with a way to authenticate with the extension.

integration-docs/authentication.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
When users import their custodial accounts, they enter a refresh token, or multiple tokens for access to multiple accounts. This token is used to fetch access tokens use to make requests to the custodian API. See below for the specification of the token refresh endpoint.
44

5-
All requests made by the custodial snap to the Ethereum Custodian API (JSON-RPC API) will use this access token.
5+
All requests made by the institutional snap to the Ethereum Custodian API (JSON-RPC API) will use this access token.
66

7-
!!! important Custodians must keep separate any tokens issued to users (for example, in the custodian UI) that are capable of signing transactions. In other words, credentials used in the custodial snap should never have the capability to actually cause transfer of funds.
7+
!!! important Custodians must keep separate any tokens issued to users (for example, in the custodian UI) that are capable of signing transactions. In other words, credentials used in the institutional snap should never have the capability to actually cause transfer of funds.
88

99
If the custodian has a web UI, they should implement a button or link that takes advantage of RPC Onboarding.
1010

@@ -16,7 +16,7 @@ Your refresh token endpoint must support application/json request bodies.
1616

1717
## Example requests
1818

19-
Here are some example requests. that would be made by the custodial snap to your refresh token endpoint.
19+
Here are some example requests. that would be made by the institutional snap to your refresh token endpoint.
2020

2121
```json
2222
application/json
@@ -48,18 +48,18 @@ It is intended that refresh tokens should last a long time, if not forever. Howe
4848

4949
### Non-interactive token replacement
5050

51-
Any time the custodial snap encounters a refresh token in the `refresh_token` field of the response from the token refresh endpoint which is different from the stored refresh token, it will be saved as the new refresh token for any accounts that were onboarded using the old token.
51+
Any time the institutional snap encounters a refresh token in the `refresh_token` field of the response from the token refresh endpoint which is different from the stored refresh token, it will be saved as the new refresh token for any accounts that were onboarded using the old token.
5252

5353

5454
## FAQ
5555

5656
### Are refresh tokens securely stored?
57-
The custodial snap stores the custodian refresh token in a vault (keyring) which is encrypted while the extension is locked. After injection, this token never leaves the vault. The security is the same as MetaMask's storage of private keys and seed phrases.
57+
The institutional snap stores the custodian refresh token in a vault (keyring) which is encrypted while the extension is locked. After injection, this token never leaves the vault. The security is the same as MetaMask's storage of private keys and seed phrases.
5858

59-
### Does the custodial snap support Oauth 2.0?
60-
The custodial snap does not use a standard Oauth 2.0 flow. However, it does contain elements of the client credentials grant and the refresh token grant. This is to facilitate custodian web applications, mobile apps, and desktop applications.
59+
### Does the institutional snap support Oauth 2.0?
60+
The institutional snap does not use a standard Oauth 2.0 flow. However, it does contain elements of the client credentials grant and the refresh token grant. This is to facilitate custodian web applications, mobile apps, and desktop applications.
6161

62-
The user provides, from the custodian, a refresh token. The custodial snap uses this token to obtain the actual token for accompanying requests.
62+
The user provides, from the custodian, a refresh token. The institutional snap uses this token to obtain the actual token for accompanying requests.
6363

64-
Ideally, this token is issued in a non-interactive way; i.e. the credential exchange happens at the custodian and this is effectively a Machine-to-Machine token. Since the custodial snap is an extension and not an ordinary web application, it cannot accept redirects.x
64+
Ideally, this token is issued in a non-interactive way; i.e. the credential exchange happens at the custodian and this is effectively a Machine-to-Machine token. Since the institutional snap is an extension and not an ordinary web application, it cannot accept redirects.x
6565
```

integration-docs/index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
This document is for crypto custodians looking to integrate with the custodial snap.
1+
This document is for crypto custodians looking to integrate with the institutional MetaMask snap.
22

3-
The custodial snap provides a customized client library that supports custodian APIs. This document is a guide to the API a custodian must have in order for it to be usable with the custodial snap.
3+
The institutional snap provides a customized client library that supports custodian APIs. This document is a guide to the API a custodian must have in order for it to be usable with the institutional snap.
44

55
## How it works
66

@@ -20,4 +20,4 @@ The custodial snap provides a customized client library that supports custodian
2020

2121
## How to get allowlisted
2222

23-
Please create a pull request on this repository adding your API to the list of allowlisted custodians in [this file](/packages/snap/src/lib/custodian-types/custodianMetadata.ts.
23+
Please create a pull request on this repository adding your API to the list of allowlisted custodians in [this file](/packages/snap/src/lib/custodian-types/custodianMetadata.ts.)

integration-docs/rpc-api.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# MMI's JSON-RPC provider
1+
# JSON-RPC provider
22

33
!!! info "Terminology information"
44
This document refers to the `injected RPC provider` also known as `window.ethereum`. This is the provider that is injected into the browser by Metamask. It does not refer to the JSON-RPC endpoint served by the custodian, or the JSON-RPC provider endpoint served by Ethereum nodes.
@@ -7,18 +7,18 @@ The browser ethereum provider is used by dapps to communicate with the extension
77

88
### Initial connection
99

10-
In order to first check if the custodial snap is installed and to use later method, it's first necessary to establish a connection.
10+
In order to first check if the institutional snap is installed and to use later method, it's first necessary to establish a connection.
1111

1212
```
1313
await window.ethereum.request({
1414
method: "wallet_requestSnaps",
1515
params: {
16-
"npm:@metamask/custodial-wallet-snap": {},
16+
"npm:@metamask/institutional-wallet-snap": {},
1717
},
1818
})
1919
```
2020

21-
Once the custodial is fully integrated, the custodian UI can be added as an initial connection and this step can be skipped.
21+
Once the custodian is fully integrated, the custodian UI can be added as an initial connection and this step can be skipped.
2222

2323
## authentication.onboard : Inject the token
2424

@@ -34,7 +34,7 @@ Several values here will depend on the your integration process.
3434
await window.ethereum.request({
3535
method: 'wallet_invokeSnap',
3636
params: {
37-
snapId: 'npm:@metamask/custodial-wallet-snap',
37+
snapId: 'npm:@metamask/institutional-wallet-snap',
3838
request: {
3939
method: 'authentication.onboard',
4040
params: {

integration-docs/transactions.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Relevant JSON-RPC method: `custodian_createTransaction`
55

66
![Areas of responsibility - transactions](../../assets/images/transaction-responsibility.png)
77

8-
MetaMask via the custodial snap creates/proposes transactions to the custodian API, including a proposed gas price. However, custodians may (at their users' request, or automatically) use a different gas price. Custodians are responsible for the ordering of transactions.
8+
MetaMask via the institutional snap creates/proposes transactions to the custodian API, including a proposed gas price. However, custodians may (at their users' request, or automatically) use a different gas price. Custodians are responsible for the ordering of transactions.
99

1010
## Supporting multiple chains
1111

@@ -21,7 +21,7 @@ This is the network that the user intended to create the transaction on.
2121
This parameter is needed to sign an ethereum transaction, and custodians can also use it to decide where to broadcast the transaction.
2222

2323
`custodian_listAccountChainIds`
24-
A custodian_listAccountChainIds method exists on the Custodian JSON-RPC API which is executed when the extension is unlocked, for each custodian account stored in MMI.
24+
A custodian_listAccountChainIds method exists on the Custodian JSON-RPC API which is executed when the extension is unlocked, for each custodian account stored in the institutional snap.
2525

2626
This method takes a single parameter, the ethereum account address in question. Custodians may ignore this parameter if users use their addresses with all their configured chains.
2727

0 commit comments

Comments
 (0)