Move UI functionality to SDK (#1954)

This moves all UI-related functionality (at least the public API) to the SDK package. The only exception is the two validation functions, which have been moved to `snaps-utils` instead.
MetaMask · Nov 13, 2023 · 80e39bd · 80e39bd
1 parent f621a33
commit 80e39bd
Show file tree

Hide file tree

Showing 163 changed files with 1,635 additions and 1,431 deletions.
diff --git a/package.json b/package.json
@@ -80,7 +80,7 @@
     "@types/node": "18.14.2",
     "@typescript-eslint/eslint-plugin": "^5.42.1",
     "@typescript-eslint/parser": "^5.42.1",
-    "chromedriver": "^119.0.0",
+    "chromedriver": "^119.0.1",
     "depcheck": "^1.4.7",
     "eslint": "^8.27.0",
     "eslint-config-prettier": "^8.5.0",

diff --git a/packages/examples/packages/bip32/package.json b/packages/examples/packages/bip32/package.json
@@ -34,7 +34,6 @@
     "@metamask/key-tree": "^9.0.0",
     "@metamask/rpc-errors": "^6.1.0",
     "@metamask/snaps-sdk": "workspace:^",
-    "@metamask/snaps-ui": "workspace:^",
     "@metamask/utils": "^8.1.0",
     "@noble/ed25519": "^1.6.0",
     "@noble/secp256k1": "^1.7.1"

diff --git a/packages/examples/packages/bip32/snap.manifest.json b/packages/examples/packages/bip32/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "a6nSBZXDUyWbimLESJxAVZRqTWFy5YXXO/+Si9nhLNY=",
+    "shasum": "u5ivjgGAAm03S12NIHiNd0gcQvdarn/VSZvSgCR0Zdo=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",

diff --git a/packages/examples/packages/bip32/src/index.test.ts b/packages/examples/packages/bip32/src/index.test.ts
@@ -1,6 +1,6 @@
 import { expect } from '@jest/globals';
 import { installSnap } from '@metamask/snaps-jest';
-import { copyable, heading, panel, text } from '@metamask/snaps-ui';
+import { copyable, heading, panel, text } from '@metamask/snaps-sdk';
 import { assert } from '@metamask/utils';
 
 describe('onRpcRequest', () => {

diff --git a/packages/examples/packages/bip32/src/index.ts b/packages/examples/packages/bip32/src/index.ts
@@ -1,7 +1,12 @@
 import { providerErrors, rpcErrors } from '@metamask/rpc-errors';
 import type { OnRpcRequestHandler } from '@metamask/snaps-sdk';
-import { DialogType } from '@metamask/snaps-sdk';
-import { panel, text, heading, copyable } from '@metamask/snaps-ui';
+import {
+  DialogType,
+  panel,
+  text,
+  heading,
+  copyable,
+} from '@metamask/snaps-sdk';
 import {
   add0x,
   assert,

diff --git a/packages/examples/packages/bip32/tsconfig.json b/packages/examples/packages/bip32/tsconfig.json
@@ -11,9 +11,6 @@
     {
       "path": "../../../snaps-sdk"
     },
-    {
-      "path": "../../../snaps-ui"
-    },
     {
       "path": "../../../snaps-jest"
     },

diff --git a/packages/examples/packages/bip44/package.json b/packages/examples/packages/bip44/package.json
@@ -34,7 +34,6 @@
     "@metamask/key-tree": "^9.0.0",
     "@metamask/rpc-errors": "^6.1.0",
     "@metamask/snaps-sdk": "workspace:^",
-    "@metamask/snaps-ui": "workspace:^",
     "@metamask/utils": "^8.1.0",
     "@noble/bls12-381": "^1.2.0"
   },

diff --git a/packages/examples/packages/bip44/snap.manifest.json b/packages/examples/packages/bip44/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "kC7naDIca71EEh+FvGppoEgpkdOCNzgSC2noYtZVgKk=",
+    "shasum": "Tsdg8tuhFAWXwivAnEU6IwDMWc+4TMz3gJNBZx0650M=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",

diff --git a/packages/examples/packages/bip44/src/index.test.ts b/packages/examples/packages/bip44/src/index.test.ts
@@ -1,6 +1,6 @@
 import { expect } from '@jest/globals';
 import { installSnap } from '@metamask/snaps-jest';
-import { copyable, heading, panel, text } from '@metamask/snaps-ui';
+import { copyable, heading, panel, text } from '@metamask/snaps-sdk';
 import { assert } from '@metamask/utils';
 
 describe('onRpcRequest', () => {

diff --git a/packages/examples/packages/bip44/src/index.ts b/packages/examples/packages/bip44/src/index.ts
@@ -1,7 +1,12 @@
 import { rpcErrors, providerErrors } from '@metamask/rpc-errors';
 import type { OnRpcRequestHandler } from '@metamask/snaps-sdk';
-import { DialogType } from '@metamask/snaps-sdk';
-import { panel, text, heading, copyable } from '@metamask/snaps-ui';
+import {
+  DialogType,
+  panel,
+  text,
+  heading,
+  copyable,
+} from '@metamask/snaps-sdk';
 import { bytesToHex, stringToBytes } from '@metamask/utils';
 import { getPublicKey, sign } from '@noble/bls12-381';
 

diff --git a/packages/examples/packages/bip44/tsconfig.json b/packages/examples/packages/bip44/tsconfig.json
@@ -11,9 +11,6 @@
     {
       "path": "../../../snaps-sdk"
     },
-    {
-      "path": "../../../snaps-ui"
-    },
     {
       "path": "../../../snaps-jest"
     },

diff --git a/packages/examples/packages/cronjobs/package.json b/packages/examples/packages/cronjobs/package.json
@@ -32,8 +32,7 @@
   },
   "dependencies": {
     "@metamask/rpc-errors": "^6.1.0",
-    "@metamask/snaps-sdk": "workspace:^",
-    "@metamask/snaps-ui": "workspace:^"
+    "@metamask/snaps-sdk": "workspace:^"
   },
   "devDependencies": {
     "@jest/globals": "^29.5.0",

diff --git a/packages/examples/packages/cronjobs/snap.manifest.json b/packages/examples/packages/cronjobs/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "B9GYMaxJ9+WDY+AxjCGZT/CF8EOqhPE8TWag16+Q0vI=",
+    "shasum": "KIFU8apM9tqRwrSFQfX2uxUPWOPvo5eAgTYnKkCDKmo=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",

diff --git a/packages/examples/packages/cronjobs/src/index.test.ts b/packages/examples/packages/cronjobs/src/index.test.ts
@@ -1,6 +1,6 @@
 import { expect } from '@jest/globals';
 import { installSnap } from '@metamask/snaps-jest';
-import { heading, panel, text } from '@metamask/snaps-ui';
+import { heading, panel, text } from '@metamask/snaps-sdk';
 
 describe('onCronjob', () => {
   describe('execute', () => {

diff --git a/packages/examples/packages/cronjobs/src/index.ts b/packages/examples/packages/cronjobs/src/index.ts
@@ -1,6 +1,6 @@
 import { rpcErrors } from '@metamask/rpc-errors';
 import type { OnCronjobHandler } from '@metamask/snaps-sdk';
-import { panel, text, heading } from '@metamask/snaps-ui';
+import { panel, text, heading } from '@metamask/snaps-sdk';
 
 /**
  * Handle cronjob execution requests from MetaMask. This handler handles one

diff --git a/packages/examples/packages/cronjobs/tsconfig.json b/packages/examples/packages/cronjobs/tsconfig.json
@@ -11,9 +11,6 @@
     {
       "path": "../../../snaps-sdk"
     },
-    {
-      "path": "../../../snaps-ui"
-    },
     {
       "path": "../../../snaps-jest"
     },

diff --git a/packages/examples/packages/dialogs/package.json b/packages/examples/packages/dialogs/package.json
@@ -32,8 +32,7 @@
   },
   "dependencies": {
     "@metamask/rpc-errors": "^6.1.0",
-    "@metamask/snaps-sdk": "workspace:^",
-    "@metamask/snaps-ui": "workspace:^"
+    "@metamask/snaps-sdk": "workspace:^"
   },
   "devDependencies": {
     "@jest/globals": "^29.5.0",

diff --git a/packages/examples/packages/dialogs/snap.manifest.json b/packages/examples/packages/dialogs/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "p1WpZhW7JUQMqqNVoMPpK3kRu0bN2TLBFMU4IU0ayDA=",
+    "shasum": "4c2ZW/go/unSldGCQRo8G3/t0QxKxSzlK85ggomynwA=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",

diff --git a/packages/examples/packages/dialogs/src/index.test.ts b/packages/examples/packages/dialogs/src/index.test.ts
@@ -1,6 +1,6 @@
 import { expect } from '@jest/globals';
 import { installSnap } from '@metamask/snaps-jest';
-import { heading, panel, text } from '@metamask/snaps-ui';
+import { heading, panel, text } from '@metamask/snaps-sdk';
 import { assert } from '@metamask/utils';
 
 describe('onRpcRequest', () => {

diff --git a/packages/examples/packages/dialogs/src/index.ts b/packages/examples/packages/dialogs/src/index.ts
@@ -1,7 +1,6 @@
 import { rpcErrors } from '@metamask/rpc-errors';
-import { DialogType } from '@metamask/snaps-sdk';
 import type { OnRpcRequestHandler } from '@metamask/snaps-sdk';
-import { panel, text, heading } from '@metamask/snaps-ui';
+import { DialogType, panel, text, heading } from '@metamask/snaps-sdk';
 
 /**
  * Handle incoming JSON-RPC requests from the dapp, sent through the

diff --git a/packages/examples/packages/dialogs/tsconfig.json b/packages/examples/packages/dialogs/tsconfig.json
@@ -11,9 +11,6 @@
     {
       "path": "../../../snaps-sdk"
     },
-    {
-      "path": "../../../snaps-ui"
-    },
     {
       "path": "../../../snaps-jest"
     },

diff --git a/packages/examples/packages/ethers-js/package.json b/packages/examples/packages/ethers-js/package.json
@@ -33,7 +33,6 @@
   "dependencies": {
     "@metamask/rpc-errors": "^6.1.0",
     "@metamask/snaps-sdk": "workspace:^",
-    "@metamask/snaps-ui": "workspace:^",
     "ethers": "^6.3.0"
   },
   "devDependencies": {

diff --git a/packages/examples/packages/ethers-js/snap.manifest.json b/packages/examples/packages/ethers-js/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "kVxlpDWxMNSztVRiVmpavQX/dlZOZoT0uIl3CuULhIk=",
+    "shasum": "GC0840frLvW2m7j5R3W/Zc8jxn42mCSdO4O4xwGFWRQ=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",

diff --git a/packages/examples/packages/ethers-js/src/index.test.ts b/packages/examples/packages/ethers-js/src/index.test.ts
@@ -1,6 +1,6 @@
 import { expect } from '@jest/globals';
 import { installSnap } from '@metamask/snaps-jest';
-import { copyable, heading, panel, text } from '@metamask/snaps-ui';
+import { copyable, heading, panel, text } from '@metamask/snaps-sdk';
 import { assert } from '@metamask/utils';
 
 describe('onRpcRequest', () => {

diff --git a/packages/examples/packages/ethers-js/src/index.ts b/packages/examples/packages/ethers-js/src/index.ts
@@ -1,6 +1,6 @@
 import { providerErrors, rpcErrors } from '@metamask/rpc-errors';
 import type { OnRpcRequestHandler } from '@metamask/snaps-sdk';
-import { panel, heading, copyable, text } from '@metamask/snaps-ui';
+import { panel, heading, copyable, text } from '@metamask/snaps-sdk';
 import { Wallet } from 'ethers';
 
 import type { SignMessageParams } from './types';

diff --git a/packages/examples/packages/ethers-js/tsconfig.json b/packages/examples/packages/ethers-js/tsconfig.json
@@ -11,9 +11,6 @@
     {
       "path": "../../../snaps-sdk"
     },
-    {
-      "path": "../../../snaps-ui"
-    },
     {
       "path": "../../../snaps-jest"
     },

diff --git a/packages/examples/packages/get-entropy/package.json b/packages/examples/packages/get-entropy/package.json
@@ -33,7 +33,6 @@
   "dependencies": {
     "@metamask/rpc-errors": "^6.1.0",
     "@metamask/snaps-sdk": "workspace:^",
-    "@metamask/snaps-ui": "workspace:^",
     "@metamask/utils": "^8.1.0",
     "@noble/bls12-381": "^1.2.0"
   },

diff --git a/packages/examples/packages/get-entropy/snap.manifest.json b/packages/examples/packages/get-entropy/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "WcUEK4cnEAv1J4efCUFaXxK4XvzzSIYf9j8qscNOOQ0=",
+    "shasum": "j2L8jJLuo90o0YIDvdmG0D2sHiuEXWk6s7BngVDWmOE=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",

diff --git a/packages/examples/packages/get-entropy/src/index.test.ts b/packages/examples/packages/get-entropy/src/index.test.ts
@@ -1,6 +1,6 @@
 import { expect } from '@jest/globals';
 import { installSnap } from '@metamask/snaps-jest';
-import { copyable, heading, panel, text } from '@metamask/snaps-ui';
+import { copyable, heading, panel, text } from '@metamask/snaps-sdk';
 
 describe('onRpcRequest', () => {
   it('throws an error if the requested method does not exist', async () => {

diff --git a/packages/examples/packages/get-entropy/src/index.ts b/packages/examples/packages/get-entropy/src/index.ts
@@ -1,7 +1,12 @@
 import { rpcErrors, providerErrors } from '@metamask/rpc-errors';
-import { DialogType } from '@metamask/snaps-sdk';
 import type { OnRpcRequestHandler } from '@metamask/snaps-sdk';
-import { panel, text, heading, copyable } from '@metamask/snaps-ui';
+import {
+  DialogType,
+  panel,
+  text,
+  heading,
+  copyable,
+} from '@metamask/snaps-sdk';
 import { bytesToHex, stringToBytes } from '@metamask/utils';
 import { sign } from '@noble/bls12-381';
 

diff --git a/packages/examples/packages/get-entropy/tsconfig.json b/packages/examples/packages/get-entropy/tsconfig.json
@@ -11,9 +11,6 @@
     {
       "path": "../../../snaps-sdk"
     },
-    {
-      "path": "../../../snaps-ui"
-    },
     {
       "path": "../../../snaps-jest"
     },

diff --git a/packages/examples/packages/home-page/package.json b/packages/examples/packages/home-page/package.json
@@ -31,8 +31,7 @@
     "lint:dependencies": "depcheck"
   },
   "dependencies": {
-    "@metamask/snaps-sdk": "workspace:^",
-    "@metamask/snaps-ui": "workspace:^"
+    "@metamask/snaps-sdk": "workspace:^"
   },
   "devDependencies": {
     "@jest/globals": "^29.5.0",

diff --git a/packages/examples/packages/home-page/snap.manifest.json b/packages/examples/packages/home-page/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "wPZUr6vMqCfxKlW2OJjfFGZHLCcLEXS1epk8mkngclc=",
+    "shasum": "axgWN0FsQyfCgOWKgtC1jlThZUr1oSgx2/fjLgTjwvI=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",

diff --git a/packages/examples/packages/home-page/src/index.test.ts b/packages/examples/packages/home-page/src/index.test.ts
@@ -1,5 +1,5 @@
 import { describe, it } from '@jest/globals';
-import { panel, text, heading } from '@metamask/snaps-ui';
+import { panel, text, heading } from '@metamask/snaps-sdk';
 
 import { onHomePage } from '.';
 

diff --git a/packages/examples/packages/home-page/src/index.ts b/packages/examples/packages/home-page/src/index.ts
@@ -1,5 +1,5 @@
 import type { OnHomePageHandler } from '@metamask/snaps-sdk';
-import { panel, text, heading } from '@metamask/snaps-ui';
+import { panel, text, heading } from '@metamask/snaps-sdk';
 
 /**
  * Handle incoming home page requests from the MetaMask clients.

diff --git a/packages/examples/packages/home-page/tsconfig.json b/packages/examples/packages/home-page/tsconfig.json
@@ -11,9 +11,6 @@
     {
       "path": "../../../snaps-sdk"
     },
-    {
-      "path": "../../../snaps-ui"
-    },
     {
       "path": "../../../snaps-jest"
     },

diff --git a/packages/examples/packages/invoke-snap/packages/core-signer/package.json b/packages/examples/packages/invoke-snap/packages/core-signer/package.json
@@ -34,7 +34,6 @@
     "@metamask/key-tree": "^9.0.0",
     "@metamask/rpc-errors": "^6.1.0",
     "@metamask/snaps-sdk": "workspace:^",
-    "@metamask/snaps-ui": "workspace:^",
     "@metamask/utils": "^8.1.0",
     "@noble/curves": "^1.1.0",
     "async-mutex": "^0.4.0"

diff --git a/packages/examples/packages/invoke-snap/packages/core-signer/snap.manifest.json b/packages/examples/packages/invoke-snap/packages/core-signer/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "mGKJ1s3TMRHRpWEB274UktA7EBsNRbVfWwnms6BE434=",
+    "shasum": "Ewa08BobfvENHwbCt3sYFKoTA7g4dxEANeVgiuDKamY=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",

diff --git a/packages/examples/packages/invoke-snap/packages/core-signer/src/index.ts b/packages/examples/packages/invoke-snap/packages/core-signer/src/index.ts
@@ -1,7 +1,12 @@
 import { rpcErrors, providerErrors } from '@metamask/rpc-errors';
-import { DialogType } from '@metamask/snaps-sdk';
 import type { OnRpcRequestHandler } from '@metamask/snaps-sdk';
-import { panel, text, heading, copyable } from '@metamask/snaps-ui';
+import {
+  DialogType,
+  panel,
+  text,
+  heading,
+  copyable,
+} from '@metamask/snaps-sdk';
 import { add0x, assert, hexToBytes } from '@metamask/utils';
 import { secp256k1 } from '@noble/curves/secp256k1';
 

diff --git a/packages/examples/packages/invoke-snap/packages/core-signer/tsconfig.json b/packages/examples/packages/invoke-snap/packages/core-signer/tsconfig.json
@@ -12,7 +12,7 @@
       "path": "../../../../../snaps-sdk"
     },
     {
-      "path": "../../../../../snaps-ui"
+      "path": "../../../../../snaps-sdk"
     },
     {
       "path": "../../../../../snaps-jest"

diff --git a/packages/examples/packages/lifecycle-hooks/package.json b/packages/examples/packages/lifecycle-hooks/package.json
@@ -31,8 +31,7 @@
     "lint:dependencies": "depcheck"
   },
   "dependencies": {
-    "@metamask/snaps-sdk": "workspace:^",
-    "@metamask/snaps-ui": "workspace:^"
+    "@metamask/snaps-sdk": "workspace:^"
   },
   "devDependencies": {
     "@jest/globals": "^29.5.0",

diff --git a/packages/examples/packages/lifecycle-hooks/snap.manifest.json b/packages/examples/packages/lifecycle-hooks/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "SIhRLP4UwJFtKmFA+s+iM5aNxPp5K1TIUxqsLnwaq1E=",
+    "shasum": "Hsk3bjjJhL83pHCiXCe7HXVdCNsWi2mF/xeHlNR77kQ=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",
-Original file line number
+Diff line change
@@ Expand Up / @@ -11,9 +11,6 @@ @@
         {
           "path": "../../../snaps-sdk"
         },
-        {
-          "path": "../../../snaps-ui"
-        },
         {
           "path": "../../../snaps-jest"
         },
@@ Expand Down @@