BREAKING: Rename packages to start with snaps- (#937)

* Rename execution-environments to snaps-execution-environments * Rename snap-utils to snaps-utils * Rename snap-types to snaps-types * Rename rollup-plugin-snaps to snaps-rollup-plugin * Rename snap-controllers to snaps-controllers * Fix TypeScript configurations * Fix ignore list * Fix rebase issue
MetaMask · Nov 10, 2022 · 409cd77 · 409cd77
1 parent 93b85fc
commit 409cd77
Show file tree

Hide file tree

Showing 262 changed files with 345 additions and 345 deletions.
diff --git a/.github/workflows/build-lint-test.yml b/.github/workflows/build-lint-test.yml
@@ -52,7 +52,7 @@ jobs:
           key: yarn-cache-${{ runner.os }}-${{ needs.prepare.outputs.YARN_VERSION }}-${{ hashFiles('yarn.lock') }}
       - run: yarn --immutable
       - run: yarn build
-      - run: yarn workspace @metamask/snap-controllers run test:ci
+      - run: yarn workspace @metamask/snaps-controllers run test:ci
       - name: Require clean working directory
         shell: bash
         run: |
@@ -114,7 +114,7 @@ jobs:
           path: ${{ needs.prepare.outputs.YARN_CACHE_DIR }}
           key: yarn-cache-${{ runner.os }}-${{ needs.prepare.outputs.YARN_VERSION }}-${{ hashFiles('yarn.lock') }}
       - run: yarn --immutable
-      - run: yarn workspaces foreach --parallel --verbose --exclude @metamask/snap-controllers --exclude root run test:ci
+      - run: yarn workspaces foreach --parallel --verbose --exclude @metamask/snaps-controllers --exclude root run test:ci
       - name: CodeCov
         uses: codecov/codecov-action@d9f34f8cd5cb3b3eb79b3e4b5dae3a16df499a70
       - name: Require clean working directory

diff --git a/packages/examples/examples/browserify/package.json b/packages/examples/examples/browserify/package.json
@@ -27,9 +27,9 @@
     "@metamask/eslint-config-jest": "^9.0.0",
     "@metamask/eslint-config-nodejs": "^9.0.0",
     "@metamask/eslint-config-typescript": "^9.0.1",
-    "@metamask/snap-types": "^0.23.0",
     "@metamask/snaps-browserify-plugin": "^0.23.0",
     "@metamask/snaps-cli": "^0.23.0",
+    "@metamask/snaps-types": "^0.23.0",
     "@types/browserify": "^12.0.37",
     "@types/gulp": "^4.0.9",
     "@types/node": "^17.0.33",

diff --git a/packages/examples/examples/browserify/src/snap.ts b/packages/examples/examples/browserify/src/snap.ts
@@ -1,4 +1,4 @@
-import { OnRpcRequestHandler } from '@metamask/snap-types';
+import { OnRpcRequestHandler } from '@metamask/snaps-types';
 
 /**
  * Handle incoming JSON-RPC requests, sent through `wallet_invokeSnap`.

diff --git a/packages/examples/examples/insights/README.md b/packages/examples/examples/insights/README.md
@@ -9,6 +9,6 @@ This Snap demonstrates how to use the transaction insights feature.
 - For the global `wallet` type to work, you have to add the following to your `tsconfig.json`:
   ```json
   {
-    "files": ["./node_modules/@metamask/snap-types/global.d.ts"]
+    "files": ["./node_modules/@metamask/snaps-types/global.d.ts"]
   }
   ```
diff --git a/packages/examples/examples/insights/package.json b/packages/examples/examples/insights/package.json
@@ -36,8 +36,8 @@
     "@metamask/eslint-config-jest": "^9.0.0",
     "@metamask/eslint-config-nodejs": "^9.0.0",
     "@metamask/eslint-config-typescript": "^9.0.1",
-    "@metamask/snap-types": "^0.23.0",
     "@metamask/snaps-cli": "^0.23.0",
+    "@metamask/snaps-types": "^0.23.0",
     "eslint": "^7.30.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-import": "^2.23.4",

diff --git a/packages/examples/examples/insights/src/index.ts b/packages/examples/examples/insights/src/index.ts
@@ -1,4 +1,4 @@
-import { OnTransactionHandler } from '@metamask/snap-types';
+import { OnTransactionHandler } from '@metamask/snaps-types';
 import { getInsights } from './insights';
 
 /**

diff --git a/packages/examples/examples/rollup/package.json b/packages/examples/examples/rollup/package.json
@@ -27,9 +27,9 @@
     "@metamask/eslint-config-jest": "^9.0.0",
     "@metamask/eslint-config-nodejs": "^9.0.0",
     "@metamask/eslint-config-typescript": "^9.0.1",
-    "@metamask/rollup-plugin-snaps": "^0.23.0",
-    "@metamask/snap-types": "^0.23.0",
     "@metamask/snaps-cli": "^0.23.0",
+    "@metamask/snaps-rollup-plugin": "^0.23.0",
+    "@metamask/snaps-types": "^0.23.0",
     "@rollup/plugin-babel": "^5.3.1",
     "@types/node": "^17.0.33",
     "concurrently": "^7.1.0",

diff --git a/packages/examples/examples/rollup/rollup.config.js b/packages/examples/examples/rollup/rollup.config.js
@@ -1,5 +1,5 @@
 const { babel } = require('@rollup/plugin-babel');
-const snaps = require('@metamask/rollup-plugin-snaps').default;
+const snaps = require('@metamask/snaps-rollup-plugin').default;
 
 /**
  * @type {RollupOptions}

diff --git a/packages/examples/examples/rollup/src/snap.ts b/packages/examples/examples/rollup/src/snap.ts
@@ -1,4 +1,4 @@
-import { OnRpcRequestHandler } from '@metamask/snap-types';
+import { OnRpcRequestHandler } from '@metamask/snaps-types';
 
 /**
  * Handle incoming JSON-RPC requests, sent through `wallet_invokeSnap`.

diff --git a/packages/examples/examples/typescript/README.md b/packages/examples/examples/typescript/README.md
@@ -9,6 +9,6 @@ This Snap demonstrates how to develop a Snap with TypeScript.
 - For the global `wallet` type to work, you have to add the following to your `tsconfig.json`:
   ```json
   {
-    "files": ["./node_modules/@metamask/snap-types/global.d.ts"]
+    "files": ["./node_modules/@metamask/snaps-types/global.d.ts"]
   }
   ```
diff --git a/packages/examples/examples/typescript/package.json b/packages/examples/examples/typescript/package.json
@@ -32,8 +32,8 @@
     "@metamask/eslint-config-jest": "^9.0.0",
     "@metamask/eslint-config-nodejs": "^9.0.0",
     "@metamask/eslint-config-typescript": "^9.0.1",
-    "@metamask/snap-types": "^0.23.0",
     "@metamask/snaps-cli": "^0.23.0",
+    "@metamask/snaps-types": "^0.23.0",
     "eslint": "^7.30.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-import": "^2.23.4",

diff --git a/packages/examples/examples/typescript/src/index.ts b/packages/examples/examples/typescript/src/index.ts
@@ -1,4 +1,4 @@
-import { OnRpcRequestHandler } from '@metamask/snap-types';
+import { OnRpcRequestHandler } from '@metamask/snaps-types';
 import { getMessage } from './message';
 
 /**

diff --git a/packages/examples/examples/webpack/package.json b/packages/examples/examples/webpack/package.json
@@ -29,8 +29,8 @@
     "@metamask/eslint-config-jest": "^9.0.0",
     "@metamask/eslint-config-nodejs": "^9.0.0",
     "@metamask/eslint-config-typescript": "^9.0.1",
-    "@metamask/snap-types": "^0.23.0",
     "@metamask/snaps-cli": "^0.23.0",
+    "@metamask/snaps-types": "^0.23.0",
     "@metamask/snaps-webpack-plugin": "^0.23.0",
     "@types/node": "^17.0.33",
     "babel-loader": "^8.2.5",

diff --git a/packages/examples/examples/webpack/src/snap.ts b/packages/examples/examples/webpack/src/snap.ts
@@ -1,4 +1,4 @@
-import { OnRpcRequestHandler } from '@metamask/snap-types';
+import { OnRpcRequestHandler } from '@metamask/snaps-types';
 
 /**
  * Handle incoming JSON-RPC requests, sent through `wallet_invokeSnap`.

diff --git a/packages/multichain-provider/package.json b/packages/multichain-provider/package.json
@@ -26,7 +26,7 @@
   },
   "dependencies": {
     "@metamask/safe-event-emitter": "^2.0.0",
-    "@metamask/snap-types": "^0.23.0",
+    "@metamask/snaps-types": "^0.23.0",
     "@metamask/utils": "^3.3.0",
     "nanoid": "^3.1.31"
   },
@@ -37,7 +37,7 @@
     "@metamask/eslint-config-jest": "^9.0.0",
     "@metamask/eslint-config-nodejs": "^9.0.0",
     "@metamask/eslint-config-typescript": "^9.0.1",
-    "@metamask/snap-utils": "^0.23.0",
+    "@metamask/snaps-utils": "^0.23.0",
     "@types/jest": "^27.5.1",
     "deepmerge": "^4.2.2",
     "eslint": "^7.30.0",

diff --git a/packages/multichain-provider/src/MultiChainProvider.test.ts b/packages/multichain-provider/src/MultiChainProvider.test.ts
@@ -1,9 +1,9 @@
-import { SnapProvider } from '@metamask/snap-types';
-import { NamespaceId, RequestNamespace } from '@metamask/snap-utils';
+import { SnapProvider } from '@metamask/snaps-types';
+import { NamespaceId, RequestNamespace } from '@metamask/snaps-utils';
 import {
   getRequestNamespace,
   getSessionNamespace,
-} from '@metamask/snap-utils/test-utils';
+} from '@metamask/snaps-utils/test-utils';
 import { MultiChainProvider } from './MultiChainProvider';
 
 Object.assign(globalThis, {

diff --git a/packages/multichain-provider/src/MultiChainProvider.ts b/packages/multichain-provider/src/MultiChainProvider.ts
@@ -11,9 +11,9 @@ import {
   RequestArguments,
   RequestNamespace,
   Session,
-} from '@metamask/snap-utils';
+} from '@metamask/snaps-utils';
 import { JsonRpcRequest } from '@metamask/utils';
-import type { SnapProvider } from '@metamask/snap-types';
+import type { SnapProvider } from '@metamask/snaps-types';
 import { Provider } from './Provider';
 
 declare global {

diff --git a/packages/multichain-provider/src/Provider.ts b/packages/multichain-provider/src/Provider.ts
@@ -4,7 +4,7 @@ import {
   RequestArguments,
   Session,
   Event,
-} from '@metamask/snap-utils';
+} from '@metamask/snaps-utils';
 
 /* eslint-disable camelcase */
 type ProviderEventMap = {

diff --git a/packages/multichain-provider/src/index.ts b/packages/multichain-provider/src/index.ts
@@ -5,4 +5,4 @@ export {
   ConnectArguments,
   RequestArguments,
   Session,
-} from '@metamask/snap-utils';
+} from '@metamask/snaps-utils';
diff --git a/packages/multichain-provider/tsconfig.build.json b/packages/multichain-provider/tsconfig.build.json
@@ -14,7 +14,7 @@
   ],
   "references": [
     {
-      "path": "../snap-utils/tsconfig.build.json"
+      "path": "../snaps-utils/tsconfig.build.json"
     }
   ]
 }
diff --git a/packages/multichain-provider/tsconfig.json b/packages/multichain-provider/tsconfig.json
@@ -4,5 +4,5 @@
     "baseUrl": "./"
   },
   "include": ["./src"],
-  "references": [{ "path": "../snap-utils" }]
+  "references": [{ "path": "../snaps-utils" }]
 }
diff --git a/packages/rpc-methods/package.json b/packages/rpc-methods/package.json
@@ -28,7 +28,7 @@
   "dependencies": {
     "@metamask/controllers": "^32.0.2",
     "@metamask/key-tree": "^6.0.0",
-    "@metamask/snap-utils": "^0.23.0",
+    "@metamask/snaps-utils": "^0.23.0",
     "@metamask/types": "^1.1.0",
     "@metamask/utils": "^3.3.0",
     "eth-rpc-errors": "^4.0.2",

diff --git a/packages/rpc-methods/src/index.ts b/packages/rpc-methods/src/index.ts
@@ -3,5 +3,5 @@ export {
   PermittedRpcMethodHooks,
 } from './permitted';
 export * from './restricted';
-export { SnapCaveatType } from '@metamask/snap-utils';
+export { SnapCaveatType } from '@metamask/snaps-utils';
 export { selectHooks } from './utils';
diff --git a/packages/rpc-methods/src/permitted/common/snapInstallation.ts b/packages/rpc-methods/src/permitted/common/snapInstallation.ts
@@ -1,9 +1,9 @@
 import { ethErrors } from 'eth-rpc-errors';
 import { RequestedPermissions } from '@metamask/controllers';
 import { isObject } from '@metamask/utils';
-import { InstallSnapsResult } from '@metamask/snap-utils';
+import { InstallSnapsResult } from '@metamask/snaps-utils';
 
-export { InstallSnapsResult } from '@metamask/snap-utils';
+export { InstallSnapsResult } from '@metamask/snaps-utils';
 
 export type InstallSnapsHook = (
   requestedSnaps: RequestedPermissions,

diff --git a/packages/rpc-methods/src/permitted/getSnaps.ts b/packages/rpc-methods/src/permitted/getSnaps.ts
@@ -1,4 +1,4 @@
-import { InstallSnapsResult } from '@metamask/snap-utils';
+import { InstallSnapsResult } from '@metamask/snaps-utils';
 import {
   PermittedHandlerExport,
   PendingJsonRpcResponse,

diff --git a/packages/rpc-methods/src/permitted/invokeSnapSugar.ts b/packages/rpc-methods/src/permitted/invokeSnapSugar.ts
@@ -6,7 +6,7 @@ import {
   JsonRpcEngineEndCallback,
 } from '@metamask/types';
 import { isObject } from '@metamask/utils';
-import { SNAP_PREFIX } from '@metamask/snap-utils';
+import { SNAP_PREFIX } from '@metamask/snaps-utils';
 
 /**
  * `wallet_invokeSnap` attempts to invoke an RPC method of the specified Snap.

diff --git a/packages/rpc-methods/src/permitted/requestSnaps.test.ts b/packages/rpc-methods/src/permitted/requestSnaps.test.ts
@@ -1,7 +1,7 @@
 import {
   MOCK_SNAP_ID,
   getTruncatedSnap,
-} from '@metamask/snap-utils/test-utils';
+} from '@metamask/snaps-utils/test-utils';
 import {
   JsonRpcRequest,
   JsonRpcSuccess,
@@ -10,7 +10,7 @@ import {
 import {
   getSnapPermissionName,
   InstallSnapsResult,
-} from '@metamask/snap-utils';
+} from '@metamask/snaps-utils';
 import { JsonRpcEngine } from 'json-rpc-engine';
 import { RequestedPermissions } from '@metamask/controllers';
 import { requestSnapsHandler } from './requestSnaps';

diff --git a/packages/rpc-methods/src/permitted/requestSnaps.ts b/packages/rpc-methods/src/permitted/requestSnaps.ts
@@ -9,7 +9,7 @@ import {
   PendingJsonRpcResponse,
   JsonRpcEngineEndCallback,
 } from '@metamask/types';
-import { getSnapPermissionName } from '@metamask/snap-utils';
+import { getSnapPermissionName } from '@metamask/snaps-utils';
 import { hasProperty, isObject } from '@metamask/utils';
 import {
   handleInstallSnaps,

diff --git a/packages/rpc-methods/src/restricted/getBip32Entropy.test.ts b/packages/rpc-methods/src/restricted/getBip32Entropy.test.ts
@@ -1,4 +1,4 @@
-import { SnapCaveatType } from '@metamask/snap-utils';
+import { SnapCaveatType } from '@metamask/snaps-utils';
 import {
   getBip32EntropyBuilder,
   getBip32EntropyCaveatMapper,

diff --git a/packages/rpc-methods/src/restricted/getBip32Entropy.ts b/packages/rpc-methods/src/restricted/getBip32Entropy.ts
@@ -16,7 +16,7 @@ import {
   NonEmptyArray,
 } from '@metamask/utils';
 import { BIP32Node, JsonSLIP10Node, SLIP10Node } from '@metamask/key-tree';
-import { SnapCaveatType } from '@metamask/snap-utils';
+import { SnapCaveatType } from '@metamask/snaps-utils';
 import { isEqual } from '../utils';
 
 const INDEX_REGEX = /^\d+'?$/u;

diff --git a/packages/rpc-methods/src/restricted/getBip32PublicKey.test.ts b/packages/rpc-methods/src/restricted/getBip32PublicKey.test.ts
@@ -1,4 +1,4 @@
-import { SnapCaveatType } from '@metamask/snap-utils';
+import { SnapCaveatType } from '@metamask/snaps-utils';
 import {
   getBip32PublicKeyBuilder,
   getBip32PublicKeyCaveatSpecifications,

diff --git a/packages/rpc-methods/src/restricted/getBip32PublicKey.ts b/packages/rpc-methods/src/restricted/getBip32PublicKey.ts
@@ -10,7 +10,7 @@ import {
 import { ethErrors } from 'eth-rpc-errors';
 import { NonEmptyArray } from '@metamask/utils';
 import { BIP32Node, SLIP10Node } from '@metamask/key-tree';
-import { SnapCaveatType } from '@metamask/snap-utils';
+import { SnapCaveatType } from '@metamask/snaps-utils';
 import { isEqual } from '../utils';
 import { validateCaveatPaths, validatePath } from './getBip32Entropy';
 

diff --git a/packages/rpc-methods/src/restricted/getBip44Entropy.test.ts b/packages/rpc-methods/src/restricted/getBip44Entropy.test.ts
@@ -1,4 +1,4 @@
-import { SnapCaveatType } from '@metamask/snap-utils';
+import { SnapCaveatType } from '@metamask/snaps-utils';
 import {
   getBip44EntropyBuilder,
   getBip44EntropyCaveatMapper,

diff --git a/packages/rpc-methods/src/restricted/getBip44Entropy.ts b/packages/rpc-methods/src/restricted/getBip44Entropy.ts
@@ -16,7 +16,7 @@ import {
   Json,
   NonEmptyArray,
 } from '@metamask/utils';
-import { SnapCaveatType } from '@metamask/snap-utils';
+import { SnapCaveatType } from '@metamask/snaps-utils';
 
 const targetKey = 'snap_getBip44Entropy';
 

diff --git a/packages/rpc-methods/src/restricted/invokeSnap.test.ts b/packages/rpc-methods/src/restricted/invokeSnap.test.ts
@@ -3,7 +3,7 @@ import {
   MOCK_SNAP_ID,
   MOCK_ORIGIN,
   getTruncatedSnap,
-} from '@metamask/snap-utils/test-utils';
+} from '@metamask/snaps-utils/test-utils';
 import { invokeSnapBuilder, getInvokeSnapImplementation } from './invokeSnap';
 
 describe('builder', () => {

diff --git a/packages/rpc-methods/src/restricted/invokeSnap.ts b/packages/rpc-methods/src/restricted/invokeSnap.ts
@@ -12,7 +12,7 @@ import {
   SnapId,
   HandlerType,
   SnapRpcHookArgs,
-} from '@metamask/snap-utils';
+} from '@metamask/snaps-utils';
 import { nanoid } from 'nanoid';
 
 const methodPrefix = SNAP_PREFIX;

diff --git a/packages/rpc-methods/tsconfig.build.json b/packages/rpc-methods/tsconfig.build.json
@@ -14,7 +14,7 @@
   ],
   "references": [
     {
-      "path": "../snap-utils/tsconfig.build.json"
+      "path": "../snaps-utils/tsconfig.build.json"
     }
   ]
 }
diff --git a/packages/rpc-methods/tsconfig.json b/packages/rpc-methods/tsconfig.json
@@ -4,5 +4,5 @@
     "baseUrl": "./"
   },
   "include": ["./src"],
-  "references": [{ "path": "../snap-utils" }]
+  "references": [{ "path": "../snaps-utils" }]
 }
diff --git a/packages/snaps-browserify-plugin/package.json b/packages/snaps-browserify-plugin/package.json
@@ -28,7 +28,7 @@
     "publish:package": "../../scripts/publish-package.sh"
   },
   "dependencies": {
-    "@metamask/snap-utils": "^0.23.0",
+    "@metamask/snaps-utils": "^0.23.0",
     "convert-source-map": "^1.8.0"
   },
   "devDependencies": {

diff --git a/packages/snaps-browserify-plugin/src/plugin.test.ts b/packages/snaps-browserify-plugin/src/plugin.test.ts
@@ -9,14 +9,14 @@ import concat from 'concat-stream';
 import {
   DEFAULT_SNAP_BUNDLE,
   getSnapManifest,
-} from '@metamask/snap-utils/test-utils';
-import { checkManifest, evalBundle } from '@metamask/snap-utils';
+} from '@metamask/snaps-utils/test-utils';
+import { checkManifest, evalBundle } from '@metamask/snaps-utils';
 import plugin, { Options, SnapsBrowserifyTransform } from './plugin';
 
 jest.mock('fs');
 
-jest.mock('@metamask/snap-utils', () => ({
-  ...jest.requireActual('@metamask/snap-utils'),
+jest.mock('@metamask/snaps-utils', () => ({
+  ...jest.requireActual('@metamask/snaps-utils'),
   evalBundle: jest.fn(),
   checkManifest: jest.fn(),
 }));

diff --git a/packages/snaps-browserify-plugin/src/plugin.ts b/packages/snaps-browserify-plugin/src/plugin.ts
@@ -8,7 +8,7 @@ import {
   evalBundle,
   postProcessBundle,
   PostProcessOptions,
-} from '@metamask/snap-utils';
+} from '@metamask/snaps-utils';
 import { fromSource } from 'convert-source-map';
 
 const TEMP_BUNDLE_PATH = pathUtils.join(os.tmpdir(), 'snaps-bundle.js');

diff --git a/packages/snaps-browserify-plugin/tsconfig.build.json b/packages/snaps-browserify-plugin/tsconfig.build.json
@@ -14,7 +14,7 @@
   ],
   "references": [
     {
-      "path": "../snap-utils/tsconfig.build.json"
+      "path": "../snaps-utils/tsconfig.build.json"
     }
   ]
 }