Skip to content

Commit 895209c

Browse files
PatrykLuckaPatrykLucka
authored
Merge pull request #1 from MetaMask/MMI-XXX-custodial-rename-institutional
chore: rename everything to institutional
2 parents 3322336 + f5b9936 commit 895209c

19 files changed

+73
-70
lines changed

‎README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Custodial Wallet Snap
1+
# Institutional Wallet Snap
22

33
## Description
44

5-
The custodian snap allows users to use custodial wallets with MetaMask. It acts as a client to any custodian which implements the Ethereum Custodian API.
5+
The institutional snap allows users to use custodial wallets with MetaMask. It acts as a client to any custodian which implements the Ethereum Custodian API.
66

77
Information on how to implement the Ethereum Custodian API and be supported in MetaMask can be found in the [integration docs](integration-docs/index.md).
88

@@ -14,7 +14,7 @@ yarn install && yarn start
1414

1515
## Testing
1616

17-
The custodial snap supports any of the custodians previously supported by MetaMask Institutional. The easiest way to test the snap is to run this repo and use the local companion site to test it with the local dev custodian.
17+
The institutional snap supports any of the custodians previously supported by MetaMask Institutional. The easiest way to test the snap is to run this repo and use the local companion site to test it with the local dev custodian.
1818

1919
It should also function with Neptune Custody which has a UI located at https://neptune-custody-ui.dev.metamask-institutional.io/
2020

‎package.json

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
{
2-
"name": "@metamask/snap-custodial-wallet",
2+
"name": "@metamask/snap-institutional-wallet",
33
"version": "0.0.1",
4-
"description": "Custodial accounts in MetaMask",
4+
"description": "Institutional accounts in MetaMask",
55
"keywords": [
66
"metamask",
77
"snap",
88
"keyring",
99
"account"
1010
],
11-
"homepage": "https://github.com/MetaMask/snap-custodial-wallet#readme",
11+
"homepage": "https://github.com/MetaMask/snap-institutional-wallet#readme",
1212
"bugs": {
13-
"url": "https://github.com/MetaMask/snap-custodial-wallet/issues"
13+
"url": "https://github.com/MetaMask/snap-institutional-wallet/issues"
1414
},
1515
"repository": {
1616
"type": "git",
17-
"url": "https://github.com/MetaMask/snap-custodial-wallet.git"
17+
"url": "https://github.com/MetaMask/snap-institutional-wallet.git"
1818
},
1919
"license": "(MIT-0 OR Apache-2.0)",
2020
"author": "",
@@ -23,8 +23,8 @@
2323
],
2424
"scripts": {
2525
"build": "yarn workspaces foreach --parallel --verbose --topological run build",
26-
"build:dapp": "yarn workspace @metamask/snap-custodial-wallet-site build",
27-
"build:snap": "yarn workspace @metamask/snap-custodial-wallet-snap build",
26+
"build:dapp": "yarn workspace @metamask/snap-institutional-wallet-site build",
27+
"build:snap": "yarn workspace @metamask/snap-institutional-wallet-snap build",
2828
"lint": "yarn workspaces foreach --parallel --verbose run lint",
2929
"lint:deps": "yarn workspaces foreach --parallel --verbose run depcheck",
3030
"lint:eslint": "yarn workspaces foreach --parallel --verbose run lint:eslint",

‎packages/api/CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Unreleased]
99

10-
[Unreleased]: https://github.com/MetaMask/snap-custodial-wallet/
10+
[Unreleased]: https://github.com/MetaMask/snap-institutional-wallet/

‎packages/api/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Local Custodian API
22

3-
The local custodian API partly implements the [Ethereum Custodian API version 3](https://consensys-vertical-apps.github.io/ethereum-custodian-api/) (ECA-3) for use with the custodial snap.
3+
The local custodian API partly implements the [Ethereum Custodian API version 3](https://consensys-vertical-apps.github.io/ethereum-custodian-api/) (ECA-3) for use with the institutional snap.
44

55
It makes available a refresh token API at
66

‎packages/api/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "@metamask/custodial-wallet-api",
2+
"name": "@metamask/institutional-wallet-api",
33
"description": "Example custodian API",
44
"packageManager": "[email protected]",
55
"dependencies": {

‎packages/site/CHANGELOG.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1313

1414
- Initial commit
1515

16-
[Unreleased]: https://github.com/MetaMask/snap-custodial-wallet/compare/v0.0.1...HEAD
17-
[0.0.1]: https://github.com/MetaMask/snap-custodial-wallet/releases/tag/v0.0.1
16+
[Unreleased]: https://github.com/MetaMask/snap-insitutional-wallet/compare/v0.0.1...HEAD
17+
[0.0.1]: https://github.com/MetaMask/snap-insitutional-wallet/releases/tag/v0.0.1

‎packages/site/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Custodial snap frontend
1+
# Institutional snap frontend
22

33
This project was forked from the original [Simple Snap Keyring Frontend](https://github.com/MetaMask/snap-simple-keyring/tree/main/packages/site)
44

5-
It's intended to work with the custodial snap as well as the Local Custodian API (in the /api package). By default that runs at http://localhost:3330.
5+
It's intended to work with the institutional snap as well as the Local Custodian API (in the /api package). By default that runs at http://localhost:3330.
66

77
## Available Scripts
88

‎packages/site/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "@metamask/snap-custodial-wallet-site",
2+
"name": "@metamask/snap-insitutional-wallet-site",
33
"version": "0.0.1",
44
"private": true,
55
"license": "(MIT-0 OR Apache-2.0)",

‎packages/snap/CHANGELOG.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1313

1414
- Initial commit
1515

16-
[Unreleased]: https://github.com/MetaMask/snap-custodial-wallet/compare/v0.0.1...HEAD
17-
[0.0.1]: https://github.com/MetaMask/snap-custodial-wallet/releases/tag/v0.0.1
16+
[Unreleased]: https://github.com/MetaMask/snap-insitutional-wallet/compare/v0.0.1...HEAD
17+
[0.0.1]: https://github.com/MetaMask/snap-insitutional-wallet/releases/tag/v0.0.1

‎packages/snap/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
# Custodial snap
1+
# Institutional snap
22

33
See the [main README](../../README.md) for more information.

‎packages/snap/package.json

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
{
2-
"name": "@metamask/snap-custodial-wallet-snap",
2+
"name": "@metamask/snap-institutional-wallet-snap",
33
"version": "0.0.1",
4-
"description": "Custodial accounts in MetaMask.",
4+
"description": "Institutional accounts in MetaMask.",
55
"keywords": [
66
"metamask",
77
"snap",
88
"keyring",
99
"account"
1010
],
11-
"homepage": "https://github.com/MetaMask/snap-custodial-wallet#readme",
11+
"homepage": "https://github.com/MetaMask/snap-institutional-wallet#readme",
1212
"bugs": {
13-
"url": "https://github.com/MetaMask/snap-custodial-wallet/issues"
13+
"url": "https://github.com/MetaMask/snap-institutional-wallet/issues"
1414
},
1515
"repository": {
1616
"type": "git",
17-
"url": "git+https://github.com/MetaMask/snap-custodial-wallet.git"
17+
"url": "git+https://github.com/MetaMask/snap-institutional-wallet.git"
1818
},
1919
"license": "(MIT-0 OR Apache-2.0)",
2020
"main": "dist/bundle.js",

‎packages/snap/scripts/build-preinstalled-snap.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,4 +68,4 @@ try {
6868
} catch (error) {
6969
console.error('Error writing combined file to disk:', error);
7070
throw error;
71-
}
71+
}

‎packages/snap/snap.config.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ const config: SnapConfig = {
1010
crypto: true,
1111
},
1212
environment: {
13-
DAPP_ORIGIN_PRODUCTION: 'https://metamask.github.io/snap-custodial-wallet/',
13+
DAPP_ORIGIN_PRODUCTION:
14+
'https://metamask.github.io/snap-insitutional-wallet/',
1415
DAPP_ORIGIN_DEVELOPMENT: 'http://localhost:8000/',
1516
},
1617
stats: {

‎packages/snap/snap.manifest.json

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
{
22
"version": "0.0.1",
3-
"description": "Custodial accounts in MetaMask.",
4-
"proposedName": "MetaMask Custodial Wallet",
3+
"description": "Institutional accounts in MetaMask.",
4+
"proposedName": "Institutional Wallet",
55
"repository": {
66
"type": "git",
7-
"url": "git+https://github.com/MetaMask/snap-custodial-wallet.git"
7+
"url": "git+https://github.com/MetaMask/snap-institutional-wallet.git"
88
},
99
"source": {
10-
"shasum": "vwn1nQknjYrb8+VxmW28i9j4fVxjyVJm4uQzryaUMAI=",
10+
"shasum": "pAM+McrqnMYKY0ctbnqvhb2POFwcXh5wdz8DnklnoXc=",
1111
"location": {
1212
"npm": {
1313
"filePath": "dist/bundle.js",
1414
"iconPath": "images/icon.svg",
15-
"packageName": "@metamask/snap-custodial-wallet-snap",
15+
"packageName": "@metamask/snap-institutional-wallet-snap",
1616
"registry": "https://registry.npmjs.org/"
1717
}
1818
}

‎packages/snap/src/features/homepage/components/AddToken.tsx

+3-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,9 @@ export const AddToken: SnapComponent<AddTokenProps> = ({
3535
<Field label="Paste your Refresh Token">
3636
<Input name="token" placeholder="Enter your Refresh Token" />
3737
</Field>
38-
<Field label={`${!selectedCustodian?.displayName} API URL`}>
38+
<Field
39+
label={`${selectedCustodian?.displayName ?? 'Custodian'} API URL`}
40+
>
3941
<Input name="apiUrl" placeholder={selectedCustodian?.apiBaseUrl} />
4042
</Field>
4143
</Form>

‎packages/snap/src/lib/custodian-types/eca1/ECA1CustodianApi.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ export class ECA1CustodianApi extends EventEmitter implements ICustodianApi {
239239
};
240240
}
241241

242-
// MMI Legacy feature that is not used in the custodial snap
242+
// MMI Legacy feature that is not used in the Institutional snap
243243
public async getCustomerProof(): Promise<string> {
244244
const { result } = await this.#client.getCustomerProof();
245245
return result.jwt;

‎packages/snap/src/lib/custodian-types/eca3/ECA3CustodianApi.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ export class ECA3CustodianApi extends EventEmitter implements ICustodianApi {
9393
);
9494
}
9595

96-
// MMI Legacy feature that is n ot used in the custodial snap
96+
// MMI Legacy feature that is n ot used in the Institutional snap
9797
async getListAccountsSigned(): Promise<string> {
9898
const { result } = await this.#client.listAccountsSigned();
9999

@@ -149,7 +149,7 @@ export class ECA3CustodianApi extends EventEmitter implements ICustodianApi {
149149
...(typeof txMeta.custodianPublishesTransaction === 'boolean' && {
150150
custodianPublishesTransaction: txMeta.custodianPublishesTransaction,
151151
}),
152-
...(txMeta.rpcUrl && { rpcUrl: txMeta.rpcUrl }), // MMI Legacy feature that is not used in the custodial snap
152+
...(txMeta.rpcUrl && { rpcUrl: txMeta.rpcUrl }), // MMI Legacy feature that is not used in the Institutional snap
153153
};
154154

155155
const { result } = await this.#client.createTransaction([
@@ -201,7 +201,7 @@ export class ECA3CustodianApi extends EventEmitter implements ICustodianApi {
201201
};
202202
}
203203

204-
// MMI Legacy feature that is not used in the custodial snap
204+
// MMI Legacy feature that is not used in the Institutional snap
205205
async replaceTransaction(
206206
txParams: ReplaceTransactionParams,
207207
): Promise<{ transactionId: string }> {
@@ -297,7 +297,7 @@ export class ECA3CustodianApi extends EventEmitter implements ICustodianApi {
297297
};
298298
}
299299

300-
// MMI Legacy feature that is not used in the custodial snap
300+
// MMI Legacy feature that is not used in the Institutional snap
301301
public async getCustomerProof(): Promise<string> {
302302
const { result } = await this.#client.getCustomerProof();
303303
return result.jwt;

‎packages/snap/src/logger.ts

+5-5
Original file line numberDiff line numberDiff line change
@@ -7,28 +7,28 @@
77
const logger = {
88
log: (...args: any[]) =>
99
console.log(
10-
'[Custodial snap]',
10+
'[Institutional snap]',
1111
...args.map((arg) =>
1212
typeof arg === 'object' ? JSON.stringify(arg, null, 2) : arg,
1313
),
1414
),
1515
info: (...args: any[]) =>
1616
console.info(
17-
'[Custodial snap]',
17+
'[Institutional snap]',
1818
...args.map((arg) =>
1919
typeof arg === 'object' ? JSON.stringify(arg, null, 2) : arg,
2020
),
2121
),
2222
warn: (...args: any[]) =>
2323
console.warn(
24-
'[Custodial snap]',
24+
'[Institutional snap]',
2525
...args.map((arg) =>
2626
typeof arg === 'object' ? JSON.stringify(arg, null, 2) : arg,
2727
),
2828
),
2929
error: (...args: any[]) => {
3030
console.error(
31-
'[Custodial snap]',
31+
'[Institutional snap]',
3232
...args.map((arg) =>
3333
typeof arg === 'object' ? JSON.stringify(arg, null, 2) : arg,
3434
),
@@ -37,7 +37,7 @@ const logger = {
3737
},
3838
debug: (...args: any[]) =>
3939
console.debug(
40-
'[Custodial snap]',
40+
'[Institutional snap]',
4141
...args.map((arg) =>
4242
typeof arg === 'object' ? JSON.stringify(arg, null, 2) : arg,
4343
),

‎yarn.lock

+26-26
Original file line numberDiff line numberDiff line change
@@ -4756,26 +4756,6 @@ __metadata:
47564756
languageName: node
47574757
linkType: hard
47584758

4759-
"@metamask/custodial-wallet-api@workspace:packages/api":
4760-
version: 0.0.0-use.local
4761-
resolution: "@metamask/custodial-wallet-api@workspace:packages/api"
4762-
dependencies:
4763-
"@ethereumjs/common": ^4.4.0
4764-
"@ethereumjs/tx": ^5.4.0
4765-
"@metamask/eth-hd-keyring": ^8.0.0
4766-
"@open-rpc/schema-utils-js": ^2.0.5
4767-
"@open-rpc/server-js": ^1.9.5
4768-
"@types/connect": ^3.4.38
4769-
dotenv: ^16.4.5
4770-
eip-712: ^1.0.0
4771-
ethers: ^6.13.4
4772-
express: ^4.21.1
4773-
nodemon: ^3.1.7
4774-
ts-node: ^10.9.2
4775-
typescript: ^5.6.3
4776-
languageName: unknown
4777-
linkType: soft
4778-
47794759
"@metamask/eslint-config-jest@npm:^12.1.0":
47804760
version: 12.1.0
47814761
resolution: "@metamask/eslint-config-jest@npm:12.1.0"
@@ -4944,6 +4924,26 @@ __metadata:
49444924
languageName: node
49454925
linkType: hard
49464926

4927+
"@metamask/institutional-wallet-api@workspace:packages/api":
4928+
version: 0.0.0-use.local
4929+
resolution: "@metamask/institutional-wallet-api@workspace:packages/api"
4930+
dependencies:
4931+
"@ethereumjs/common": ^4.4.0
4932+
"@ethereumjs/tx": ^5.4.0
4933+
"@metamask/eth-hd-keyring": ^8.0.0
4934+
"@open-rpc/schema-utils-js": ^2.0.5
4935+
"@open-rpc/server-js": ^1.9.5
4936+
"@types/connect": ^3.4.38
4937+
dotenv: ^16.4.5
4938+
eip-712: ^1.0.0
4939+
ethers: ^6.13.4
4940+
express: ^4.21.1
4941+
nodemon: ^3.1.7
4942+
ts-node: ^10.9.2
4943+
typescript: ^5.6.3
4944+
languageName: unknown
4945+
linkType: soft
4946+
49474947
"@metamask/json-rpc-engine@npm:^10.0.0, @metamask/json-rpc-engine@npm:^10.0.1":
49484948
version: 10.0.1
49494949
resolution: "@metamask/json-rpc-engine@npm:10.0.1"
@@ -5292,9 +5292,9 @@ __metadata:
52925292
languageName: node
52935293
linkType: hard
52945294

5295-
"@metamask/snap-custodial-wallet-site@workspace:packages/site":
5295+
"@metamask/snap-insitutional-wallet-site@workspace:packages/site":
52965296
version: 0.0.0-use.local
5297-
resolution: "@metamask/snap-custodial-wallet-site@workspace:packages/site"
5297+
resolution: "@metamask/snap-insitutional-wallet-site@workspace:packages/site"
52985298
dependencies:
52995299
"@emotion/react": ^11.11.1
53005300
"@emotion/styled": ^11.11.0
@@ -5344,9 +5344,9 @@ __metadata:
53445344
languageName: unknown
53455345
linkType: soft
53465346

5347-
"@metamask/snap-custodial-wallet-snap@workspace:packages/snap":
5347+
"@metamask/snap-institutional-wallet-snap@workspace:packages/snap":
53485348
version: 0.0.0-use.local
5349-
resolution: "@metamask/snap-custodial-wallet-snap@workspace:packages/snap"
5349+
resolution: "@metamask/snap-institutional-wallet-snap@workspace:packages/snap"
53505350
dependencies:
53515351
"@ethereumjs/common": ^3.1.2
53525352
"@ethereumjs/tx": ^4.1.2
@@ -5389,9 +5389,9 @@ __metadata:
53895389
languageName: unknown
53905390
linkType: soft
53915391

5392-
"@metamask/snap-custodial-wallet@workspace:.":
5392+
"@metamask/snap-institutional-wallet@workspace:.":
53935393
version: 0.0.0-use.local
5394-
resolution: "@metamask/snap-custodial-wallet@workspace:."
5394+
resolution: "@metamask/snap-institutional-wallet@workspace:."
53955395
dependencies:
53965396
"@metamask/eslint-config": ^12.2.0
53975397
"@metamask/eslint-config-jest": ^12.1.0

0 commit comments

Comments
 (0)