Use new APIs in examples

MetaMask · Nov 11, 2022 · 18c8a47 · 18c8a47
1 parent b2d7970
commit 18c8a47
Show file tree

Hide file tree

Showing 19 changed files with 58 additions and 39 deletions.
diff --git a/packages/examples/.eslintrc.js b/packages/examples/.eslintrc.js
@@ -9,7 +9,8 @@ module.exports = {
         browser: true,
       },
       globals: {
-        wallet: true,
+        ethereum: true,
+        snap: true,
       },
       rules: {
         'no-alert': 'off',

diff --git a/packages/examples/examples/bls-signer/snap.manifest.json b/packages/examples/examples/bls-signer/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps-monorepo.git"
   },
   "source": {
-    "shasum": "qNYd+o17O8kEwz40rxgBftRiyss2sYS7ir++rlLBQXo=",
+    "shasum": "1fzkG9r7VgCFvFzKqrhap9Q8KAhk0+HOiZFaLeS8tz8=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",

diff --git a/packages/examples/examples/bls-signer/src/index.js b/packages/examples/examples/bls-signer/src/index.js
@@ -30,7 +30,7 @@ module.exports.onRpcRequest = async ({ request }) => {
       if (!approved) {
         throw rpcErrors.eth.unauthorized();
       }
-      const PRIVATE_KEY = await wallet.request({
+      const PRIVATE_KEY = await snap.request({
         method: 'snap_getAppKey',
       });
       const signature = await bls.sign(request.params[0], PRIVATE_KEY, DOMAIN);
@@ -48,7 +48,7 @@ module.exports.onRpcRequest = async ({ request }) => {
  * @returns {Promise<Uint8Array>} The BLS12-381 public key.
  */
 async function getPubKey() {
-  const PRIV_KEY = await wallet.request({
+  const PRIV_KEY = await snap.request({
     method: 'snap_getAppKey',
   });
   return bls.getPublicKey(PRIV_KEY);
@@ -65,7 +65,7 @@ async function getPubKey() {
  * and `false` otherwise.
  */
 async function promptUser(header, message) {
-  const response = await wallet.request({
+  const response = await snap.request({
     method: 'snap_confirm',
     params: [{ prompt: header, textAreaContent: message }],
   });

diff --git a/packages/examples/examples/browserify/snap.manifest.json b/packages/examples/examples/browserify/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps-monorepo.git"
   },
   "source": {
-    "shasum": "C25lIsH+SbFGCJM9i1lGLdPYq7YsUX0UHr/tZFMfsHI=",
+    "shasum": "NOiOxPyR8Iu9y+I/6ziTImUC223pg/bLd6z9hRVrPtc=",
     "location": {
       "npm": {
         "filePath": "dist/snap.js",

diff --git a/packages/examples/examples/browserify/src/snap.ts b/packages/examples/examples/browserify/src/snap.ts
@@ -14,7 +14,7 @@ import { OnRpcRequestHandler } from '@metamask/snaps-types';
 export const onRpcRequest: OnRpcRequestHandler = ({ origin, request }) => {
   switch (request.method) {
     case 'inApp':
-      return wallet.request({
+      return snap.request({
         method: 'snap_notify',
         params: [
           {
@@ -24,7 +24,7 @@ export const onRpcRequest: OnRpcRequestHandler = ({ origin, request }) => {
         ],
       });
     case 'native':
-      return wallet.request({
+      return snap.request({
         method: 'snap_notify',
         params: [
           {

diff --git a/packages/examples/examples/ethers-js/snap.manifest.json b/packages/examples/examples/ethers-js/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps-monorepo.git"
   },
   "source": {
-    "shasum": "zLzPFhtq7ZvlAkDtR+hmKm0fS/qh51QTE1eyAqpsuYQ=",
+    "shasum": "ZKh05KNz06P5GlNCYOuSUe3QQX6OuhSbMjH7RyCQmHo=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",
@@ -16,6 +16,8 @@
       }
     }
   },
-  "initialPermissions": {},
+  "initialPermissions": {
+    "endowment:eip1193": {}
+  },
   "manifestVersion": "0.1"
 }
diff --git a/packages/examples/examples/ethers-js/src/index.js b/packages/examples/examples/ethers-js/src/index.js
@@ -5,11 +5,7 @@
 
 const ethers = require('ethers');
 
-/*
- * The `wallet` API is a superset of the standard provider,
- * and can be used to initialize an ethers.js provider like this:
- */
-const provider = new ethers.providers.Web3Provider(wallet);
+const provider = new ethers.providers.Web3Provider(ethereum);
 
 /**
  * Handle incoming JSON-RPC requests, sent through `wallet_invokeSnap`.
@@ -22,7 +18,7 @@ const provider = new ethers.providers.Web3Provider(wallet);
  */
 module.exports.onRpcRequest = async ({ request }) => {
   console.log('received request', request);
-  const privKey = await wallet.request({
+  const privKey = await snap.request({
     method: 'snap_getAppKey',
   });
   console.log(`privKey is ${privKey}`);

diff --git a/packages/examples/examples/notifications/snap.manifest.json b/packages/examples/examples/notifications/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snap-template.git"
   },
   "source": {
-    "shasum": "7FEkvygLr4v+1VdoUCTGPLz4BNWRZe5q4F46tHbEWMA=",
+    "shasum": "4aAg0VXdfByp6BWb6DuQo5Ui8rq+dx03/zuVgxp+KG4=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",

diff --git a/packages/examples/examples/notifications/src/index.js b/packages/examples/examples/notifications/src/index.js
@@ -13,7 +13,7 @@
 module.exports.onRpcRequest = async ({ origin, request }) => {
   switch (request.method) {
     case 'inApp':
-      return wallet.request({
+      return snap.request({
         method: 'snap_notify',
         params: [
           {
@@ -23,7 +23,7 @@ module.exports.onRpcRequest = async ({ origin, request }) => {
         ],
       });
     case 'native':
-      return wallet.request({
+      return snap.request({
         method: 'snap_notify',
         params: [
           {

diff --git a/packages/examples/examples/rollup/snap.manifest.json b/packages/examples/examples/rollup/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps-monorepo.git"
   },
   "source": {
-    "shasum": "KBCbe8PgRkiublGQuK8NPeUex737E8Px3fSrSdnYuIg=",
+    "shasum": "LLph+wooA1BT1BgEem4w2xzfocSKhSOcuQOyHnSNM/4=",
     "location": {
       "npm": {
         "filePath": "dist/snap.js",

diff --git a/packages/examples/examples/rollup/src/snap.ts b/packages/examples/examples/rollup/src/snap.ts
@@ -14,7 +14,7 @@ import { OnRpcRequestHandler } from '@metamask/snaps-types';
 export const onRpcRequest: OnRpcRequestHandler = ({ origin, request }) => {
   switch (request.method) {
     case 'inApp':
-      return wallet.request({
+      return snap.request({
         method: 'snap_notify',
         params: [
           {
@@ -24,7 +24,7 @@ export const onRpcRequest: OnRpcRequestHandler = ({ origin, request }) => {
         ],
       });
     case 'native':
-      return wallet.request({
+      return snap.request({
         method: 'snap_notify',
         params: [
           {

diff --git a/packages/examples/examples/typescript/snap.manifest.json b/packages/examples/examples/typescript/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snap-template.git"
   },
   "source": {
-    "shasum": "yUHyjRd6jE4MaIr2yc9eqRV2ndwBQAiYHlOpPQITY4c=",
+    "shasum": "PFi6gpY6a3nVdQwkAvujHDe0hnFmdUKjS8bKMlM/qKs=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",

diff --git a/packages/examples/examples/typescript/src/index.ts b/packages/examples/examples/typescript/src/index.ts
@@ -15,7 +15,7 @@ import { getMessage } from './message';
 export const onRpcRequest: OnRpcRequestHandler = ({ origin, request }) => {
   switch (request.method) {
     case 'hello':
-      return wallet.request({
+      return snap.request({
         method: 'snap_notify',
         params: [
           {

diff --git a/packages/examples/examples/webpack/snap.manifest.json b/packages/examples/examples/webpack/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps-monorepo.git"
   },
   "source": {
-    "shasum": "ZWFcrhWfJfQko9o1PLh+IdOh+GbmDVpA5Ndhq8rhLJM=",
+    "shasum": "LMGtgd574bqP5aJQSJXJwgeOzB0sBaeJ6c8t9fkIdqM=",
     "location": {
       "npm": {
         "filePath": "dist/snap.js",

diff --git a/packages/examples/examples/webpack/src/snap.ts b/packages/examples/examples/webpack/src/snap.ts
@@ -14,7 +14,7 @@ import { OnRpcRequestHandler } from '@metamask/snaps-types';
 export const onRpcRequest: OnRpcRequestHandler = ({ origin, request }) => {
   switch (request.method) {
     case 'inApp':
-      return wallet.request({
+      return snap.request({
         method: 'snap_notify',
         params: [
           {
@@ -24,7 +24,7 @@ export const onRpcRequest: OnRpcRequestHandler = ({ origin, request }) => {
         ],
       });
     case 'native':
-      return wallet.request({
+      return snap.request({
         method: 'snap_notify',
         params: [
           {

diff --git a/packages/snaps-execution-environments/src/common/BaseSnapExecutor.ts b/packages/snaps-execution-environments/src/common/BaseSnapExecutor.ts
@@ -372,7 +372,7 @@ export class BaseSnapExecutor {
   }
 
   /**
-   * Instantiates a snap provider object (i.e. `globalThis.wallet`).
+   * Instantiates a snap API object (i.e. `globalThis.snap`).
    *
    * @param provider - A StreamProvider connected to MetaMask.
    * @returns The snap provider object.

diff --git a/packages/snaps-types/global.d.ts b/packages/snaps-types/global.d.ts
@@ -1,6 +1,8 @@
-import { SnapProvider } from './src';
+import { MetaMaskInpageProvider } from '@metamask/providers';
+import { SnapAPI } from './src';
 
 // Types that should be available globally within a Snap
 declare global {
-  const wallet: SnapProvider;
+  const ethereum: MetaMaskInpageProvider;
+  const snap: SnapAPI;
 }
diff --git a/packages/snaps-utils/src/mock.test.ts b/packages/snaps-utils/src/mock.test.ts
@@ -3,10 +3,15 @@ import crypto from 'crypto';
 import { generateMockEndowments, isConstructor } from './mock';
 
 describe('generateMockEndowments', () => {
-  it('includes mock snap provider', async () => {
+  it('includes mock snap API', async () => {
     const endowments = generateMockEndowments();
-    expect(endowments.wallet).toBeInstanceOf(EventEmitter);
-    expect(await endowments.wallet.request()).toBe(true);
+    expect(await endowments.snap.request()).toBe(true);
+  });
+
+  it('includes mock ethereum provider', async () => {
+    const endowments = generateMockEndowments();
+    expect(endowments.ethereum).toBeInstanceOf(EventEmitter);
+    expect(await endowments.ethereum.request()).toBe(true);
   });
 
   it('returns mock class WebSocket', () => {

diff --git a/packages/snaps-utils/src/mock.ts b/packages/snaps-utils/src/mock.ts
@@ -6,19 +6,32 @@ const NETWORK_APIS = ['fetch', 'WebSocket'];
 
 export const ALL_APIS: string[] = [...DEFAULT_ENDOWMENTS, ...NETWORK_APIS];
 
-type MockSnapProvider = EventEmitter & {
+type MockSnapProvider = {
+  request: () => Promise<any>;
+};
+
+type MockEthereumProvider = EventEmitter & {
   request: () => Promise<any>;
 };
 
 /**
- * Get a mock snap provider, that always returns `true` for requests.
+ * Get a mock snap API, that always returns `true` for requests.
  *
  * @returns A mocked snap provider.
  */
-function getMockSnapProvider(): MockSnapProvider {
-  const mockProvider = new EventEmitter() as Partial<MockSnapProvider>;
+function getMockSnapAPI(): MockSnapProvider {
+  return { request: async () => true };
+}
+
+/**
+ * Get a mock Ethereum provider, that always returns `true` for requests.
+ *
+ * @returns A mocked ethereum provider.
+ */
+function getMockEthereumProvider(): MockEthereumProvider {
+  const mockProvider = new EventEmitter() as Partial<MockEthereumProvider>;
   mockProvider.request = async () => true;
-  return mockProvider as MockSnapProvider;
+  return mockProvider as MockEthereumProvider;
 }
 
 /**
@@ -104,6 +117,6 @@ const generateMockEndowment = (key: string) => {
 export const generateMockEndowments = () => {
   return ALL_APIS.reduce<Record<string, any>>(
     (acc, cur) => ({ ...acc, [cur]: generateMockEndowment(cur) }),
-    { wallet: getMockSnapProvider() },
+    { snap: getMockSnapAPI(), ethereum: getMockEthereumProvider() },
   );
 };