feat: use snaps sdk (#526)

Co-authored-by: martines3000 <[email protected]>
blockchain-lab-um · Dec 1, 2023 · 9504781 · 9504781
1 parent 3952981
commit 9504781
Show file tree

Hide file tree

Showing 42 changed files with 249 additions and 205 deletions.
diff --git a/.changeset/chilled-bugs-remember.md b/.changeset/chilled-bugs-remember.md
@@ -0,0 +1,5 @@
+---
+'@blockchain-lab-um/masca': patch
+---
+
+Replaced @metamask/snaps-types, snaps-utils and snaps-ui with @metamask/snaps-sdk
diff --git a/package.json b/package.json
@@ -96,8 +96,7 @@
       "[email protected]": "patches/[email protected]",
       "@ceramicnetwork/[email protected]": "patches/@[email protected]",
       "@changesets/[email protected]": "patches/@[email protected]",
-      "@metamask/[email protected]": "patches/@[email protected]",
-      "@metamask/[email protected]": "patches/@[email protected]"
+      "@metamask/[email protected]": "patches/@[email protected]"
     },
     "allowNonAppliedPatches": true
   }

diff --git a/packages/snap/package.json b/packages/snap/package.json
@@ -70,10 +70,9 @@
     "@iden3/js-jwz": "1.0.1",
     "@iden3/js-merkletree": "1.0.0",
     "@metamask/key-tree": "^9.0.0",
-    "@metamask/providers": "13.1.0",
-    "@metamask/snaps-types": "3.0.1",
-    "@metamask/snaps-ui": "3.1.0",
-    "@metamask/utils": "^8.2.0",
+    "@metamask/providers": "14.0.2",
+    "@metamask/snaps-sdk": "1.2.0",
+    "@metamask/utils": "^8.2.1",
     "@types/lodash.clonedeep": "^4.5.7",
     "@veramo/core": "5.5.3",
     "@veramo/credential-eip712": "5.5.3",
@@ -103,8 +102,7 @@
   },
   "devDependencies": {
     "@ceramicnetwork/streamid": "2.17.0",
-    "@metamask/snaps-cli": "3.0.1",
-    "@metamask/snaps-utils": "3.2.0",
+    "@metamask/snaps-cli": "3.0.3",
     "@types/elliptic": "^6.4.16",
     "@types/jsonpath": "^0.2.2",
     "@types/lodash.clonedeep": "^4.5.8",

diff --git a/packages/snap/snap.manifest.json b/packages/snap/snap.manifest.json
@@ -26,7 +26,7 @@
       "./files/circuits/credentialAtomicQuerySigV2/circuit_final.zkey",
       "./files/circuits/credentialAtomicQuerySigV2/verification_key.json"
     ],
-    "shasum": "WpJFHZRVxpZbp/XiJ2lU+H/rvJ9QrGUs7mMInPfmHP8="
+    "shasum": "fb99U1A+m3KT+osaZo2Jrk8adHkz+AVHKK6pY7L6nHQ="
   },
   "initialPermissions": {
     "endowment:ethereum-provider": {},

diff --git a/packages/snap/src/Ethereum.service.ts b/packages/snap/src/Ethereum.service.ts
@@ -3,7 +3,7 @@ import {
   didMethodChainIdMapping,
   MethodsRequiringNetwork,
 } from '@blockchain-lab-um/masca-types';
-import { divider, heading, panel, text } from '@metamask/snaps-ui';
+import { divider, heading, panel, text } from '@metamask/snaps-sdk';
 
 import UIService from './UI.service';
 

diff --git a/packages/snap/src/UI.service.ts b/packages/snap/src/UI.service.ts
@@ -12,7 +12,7 @@ import {
   heading,
   panel,
   text,
-} from '@metamask/snaps-ui';
+} from '@metamask/snaps-sdk';
 import { W3CVerifiableCredential } from '@veramo/core';
 
 import StorageService from './storage/Storage.service';

diff --git a/packages/snap/src/index.ts b/packages/snap/src/index.ts
@@ -2,7 +2,7 @@ import './polyfills/intl';
 
 import { isValidSetCurrentAccountRequest } from '@blockchain-lab-um/masca-types';
 import { ResultObject, type Result } from '@blockchain-lab-um/utils';
-import type { OnRpcRequestHandler } from '@metamask/snaps-types';
+import type { OnRpcRequestHandler } from '@metamask/snaps-sdk';
 
 import GeneralService from './General.service';
 import SnapService from './Snap.service';
@@ -14,7 +14,7 @@ import WalletService from './Wallet.service';
 export const onRpcRequest: OnRpcRequestHandler = async ({
   request,
   origin,
-}): Promise<Result<unknown>> => {
+}): Promise<Result<any>> => {
   try {
     await StorageService.init();
 

diff --git a/packages/snap/tests/cron/handleAuthorizationFlow.spec.ts b/packages/snap/tests/cron/handleAuthorizationFlow.spec.ts
@@ -1,6 +1,6 @@
 import { isError, Result } from '@blockchain-lab-um/utils';
 import { MetaMaskInpageProvider } from '@metamask/providers';
-import type { SnapsGlobalObject } from '@metamask/snaps-types';
+import { SnapsProvider } from '@metamask/snaps-sdk';
 import { beforeAll, describe, expect, it } from 'vitest';
 
 import { onRpcRequest } from '../../src';
@@ -10,7 +10,7 @@ import { getDefaultSnapState } from '../data/defaultSnapState';
 import { createMockSnap, SnapMock } from '../helpers/snapMock';
 
 describe('handlePolygonFlow', () => {
-  let snapMock: SnapsGlobalObject & SnapMock;
+  let snapMock: SnapsProvider & SnapMock;
 
   beforeAll(async () => {
     snapMock = createMockSnap();

diff --git a/packages/snap/tests/e2e/addFriendlyDapp.spec.ts b/packages/snap/tests/e2e/addFriendlyDapp.spec.ts
@@ -1,7 +1,7 @@
 import { CURRENT_STATE_VERSION } from '@blockchain-lab-um/masca-types';
 import { isError, Result } from '@blockchain-lab-um/utils';
 import { MetaMaskInpageProvider } from '@metamask/providers';
-import type { SnapsGlobalObject } from '@metamask/snaps-types';
+import { SnapsProvider } from '@metamask/snaps-sdk';
 import { beforeAll, describe, expect, it, vi } from 'vitest';
 
 import { onRpcRequest } from '../../src';
@@ -11,7 +11,7 @@ import { getDefaultSnapState } from '../data/defaultSnapState';
 import { createMockSnap, SnapMock } from '../helpers/snapMock';
 
 describe('addFriendlyDapp', () => {
-  let snapMock: SnapsGlobalObject & SnapMock;
+  let snapMock: SnapsProvider & SnapMock;
 
   beforeAll(async () => {
     snapMock = createMockSnap();

diff --git a/packages/snap/tests/e2e/createVerifiableCredential.spec.ts b/packages/snap/tests/e2e/createVerifiableCredential.spec.ts
@@ -5,7 +5,7 @@ import {
 } from '@blockchain-lab-um/masca-types';
 import { isError, Result } from '@blockchain-lab-um/utils';
 import { MetaMaskInpageProvider } from '@metamask/providers';
-import type { SnapsGlobalObject } from '@metamask/snaps-types';
+import { SnapsProvider } from '@metamask/snaps-sdk';
 import type { VerifiableCredential } from '@veramo/core';
 import { beforeAll, describe, expect, it } from 'vitest';
 
@@ -35,7 +35,7 @@ const stores: AvailableCredentialStores[][] = [
 
 describe('createVerifiableCredential', () => {
   describe.each(methods)('Using method %s', (method) => {
-    let snapMock: SnapsGlobalObject & SnapMock;
+    let snapMock: SnapsProvider & SnapMock;
     let issuer: string;
     let agent: Agent;
 

diff --git a/packages/snap/tests/e2e/createVerifiablePresentation.spec.ts b/packages/snap/tests/e2e/createVerifiablePresentation.spec.ts
@@ -1,7 +1,7 @@
 import { AvailableMethods, ProofOptions } from '@blockchain-lab-um/masca-types';
 import { isError, Result } from '@blockchain-lab-um/utils';
 import { MetaMaskInpageProvider } from '@metamask/providers';
-import type { Json, SnapsGlobalObject } from '@metamask/snaps-types';
+import { SnapsProvider, type Json } from '@metamask/snaps-sdk';
 import { VerifiablePresentation } from '@veramo/core';
 import { beforeAll, describe, expect, it } from 'vitest';
 
@@ -45,7 +45,7 @@ const vcs = [
 
 describe('createVerifiablePresentation', () => {
   describe.each(methods)('Using method %s', (method) => {
-    let snapMock: SnapsGlobalObject & SnapMock;
+    let snapMock: SnapsProvider & SnapMock;
     let issuer: string;
     let agent: Agent;
 

diff --git a/packages/snap/tests/e2e/deleteVerifiableCredentials.spec.ts b/packages/snap/tests/e2e/deleteVerifiableCredentials.spec.ts
@@ -2,7 +2,7 @@ import { isError, isSuccess, Result } from '@blockchain-lab-um/utils';
 import { IDataManagerSaveResult } from '@blockchain-lab-um/veramo-datamanager';
 import { DIDDataStore } from '@glazed/did-datastore';
 import { MetaMaskInpageProvider } from '@metamask/providers';
-import type { SnapsGlobalObject } from '@metamask/snaps-types';
+import { SnapsProvider } from '@metamask/snaps-sdk';
 import type { VerifiableCredential } from '@veramo/core';
 import { beforeAll, beforeEach, describe, expect, it, vi } from 'vitest';
 
@@ -18,7 +18,7 @@ import { createMockSnap, SnapMock } from '../helpers/snapMock';
 
 describe('deleteCredential', () => {
   let ceramicData: StoredCredentials;
-  let snapMock: SnapsGlobalObject & SnapMock;
+  let snapMock: SnapsProvider & SnapMock;
   let agent: Agent;
   let generatedVC: VerifiableCredential;
 

diff --git a/packages/snap/tests/e2e/exportStateBackup.spec.ts b/packages/snap/tests/e2e/exportStateBackup.spec.ts
@@ -1,7 +1,7 @@
 import { isError, Result } from '@blockchain-lab-um/utils';
 import { IDataManagerSaveResult } from '@blockchain-lab-um/veramo-datamanager';
 import { MetaMaskInpageProvider } from '@metamask/providers';
-import type { SnapsGlobalObject } from '@metamask/snaps-types';
+import { SnapsProvider } from '@metamask/snaps-sdk';
 import type { IIdentifier, VerifiableCredential } from '@veramo/core';
 import { beforeAll, describe, expect, it } from 'vitest';
 
@@ -16,7 +16,7 @@ import { createTestVCs } from '../helpers/generateTestVCs';
 import { createMockSnap, SnapMock } from '../helpers/snapMock';
 
 describe('exportStateBackup', () => {
-  let snapMock: SnapsGlobalObject & SnapMock;
+  let snapMock: SnapsProvider & SnapMock;
   let identifier: IIdentifier;
   let agent: Agent;
   let generatedVC: VerifiableCredential;

diff --git a/packages/snap/tests/e2e/getAccountSettings.spec.ts b/packages/snap/tests/e2e/getAccountSettings.spec.ts
@@ -1,7 +1,7 @@
 import { CURRENT_STATE_VERSION } from '@blockchain-lab-um/masca-types';
 import { isError, Result } from '@blockchain-lab-um/utils';
 import { MetaMaskInpageProvider } from '@metamask/providers';
-import type { SnapsGlobalObject } from '@metamask/snaps-types';
+import { SnapsProvider } from '@metamask/snaps-sdk';
 import { beforeAll, describe, expect, it } from 'vitest';
 
 import { onRpcRequest } from '../../src';
@@ -10,7 +10,7 @@ import { getDefaultSnapState } from '../data/defaultSnapState';
 import { createMockSnap, SnapMock } from '../helpers/snapMock';
 
 describe('getAccountSettings', () => {
-  let snapMock: SnapsGlobalObject & SnapMock;
+  let snapMock: SnapsProvider & SnapMock;
 
   beforeAll(async () => {
     snapMock = createMockSnap();

diff --git a/packages/snap/tests/e2e/getAvailableMethods.spec.ts b/packages/snap/tests/e2e/getAvailableMethods.spec.ts
@@ -1,7 +1,7 @@
 import { availableMethods } from '@blockchain-lab-um/masca-types';
 import { isError, Result } from '@blockchain-lab-um/utils';
 import { MetaMaskInpageProvider } from '@metamask/providers';
-import type { SnapsGlobalObject } from '@metamask/snaps-types';
+import { SnapsProvider } from '@metamask/snaps-sdk';
 import { beforeAll, describe, expect, it } from 'vitest';
 
 import { onRpcRequest } from '../../src';
@@ -10,7 +10,7 @@ import { getDefaultSnapState } from '../data/defaultSnapState';
 import { createMockSnap, SnapMock } from '../helpers/snapMock';
 
 describe('getAvailableMethods', () => {
-  let snapMock: SnapsGlobalObject & SnapMock;
+  let snapMock: SnapsProvider & SnapMock;
 
   beforeAll(async () => {
     snapMock = createMockSnap();

diff --git a/packages/snap/tests/e2e/getAvailableVCStores.spec.ts b/packages/snap/tests/e2e/getAvailableVCStores.spec.ts
@@ -1,7 +1,7 @@
 import { availableCredentialStores } from '@blockchain-lab-um/masca-types';
 import { isError, Result } from '@blockchain-lab-um/utils';
 import { MetaMaskInpageProvider } from '@metamask/providers';
-import type { SnapsGlobalObject } from '@metamask/snaps-types';
+import { SnapsProvider } from '@metamask/snaps-sdk';
 import { beforeAll, describe, expect, it } from 'vitest';
 
 import { onRpcRequest } from '../../src';
@@ -10,7 +10,7 @@ import { getDefaultSnapState } from '../data/defaultSnapState';
 import { createMockSnap, SnapMock } from '../helpers/snapMock';
 
 describe('getAvailableCredentialStores', () => {
-  let snapMock: SnapsGlobalObject & SnapMock;
+  let snapMock: SnapsProvider & SnapMock;
 
   beforeAll(async () => {
     snapMock = createMockSnap();

diff --git a/packages/snap/tests/e2e/getDID.spec.ts b/packages/snap/tests/e2e/getDID.spec.ts
@@ -1,6 +1,6 @@
 import { isError, Result } from '@blockchain-lab-um/utils';
 import { MetaMaskInpageProvider } from '@metamask/providers';
-import type { SnapsGlobalObject } from '@metamask/snaps-types';
+import { SnapsProvider } from '@metamask/snaps-sdk';
 import { beforeAll, describe, expect, it } from 'vitest';
 
 import { onRpcRequest } from '../../src';
@@ -34,7 +34,7 @@ const methods = [
 ];
 
 describe('getDID', () => {
-  let snapMock: SnapsGlobalObject & SnapMock;
+  let snapMock: SnapsProvider & SnapMock;
 
   beforeAll(async () => {
     snapMock = createMockSnap();

diff --git a/packages/snap/tests/e2e/getSelectedMethod.spec.ts b/packages/snap/tests/e2e/getSelectedMethod.spec.ts
@@ -1,6 +1,6 @@
 import { isError, Result } from '@blockchain-lab-um/utils';
 import { MetaMaskInpageProvider } from '@metamask/providers';
-import type { SnapsGlobalObject } from '@metamask/snaps-types';
+import { SnapsProvider } from '@metamask/snaps-sdk';
 import { beforeAll, describe, expect, it } from 'vitest';
 
 import { onRpcRequest } from '../../src';
@@ -9,7 +9,7 @@ import { getDefaultSnapState } from '../data/defaultSnapState';
 import { createMockSnap, SnapMock } from '../helpers/snapMock';
 
 describe('getSelectedMethod', () => {
-  let snapMock: SnapsGlobalObject & SnapMock;
+  let snapMock: SnapsProvider & SnapMock;
 
   beforeAll(async () => {
     snapMock = createMockSnap();

diff --git a/packages/snap/tests/e2e/getSnapSettings.spec.ts b/packages/snap/tests/e2e/getSnapSettings.spec.ts
@@ -1,7 +1,7 @@
 import { CURRENT_STATE_VERSION } from '@blockchain-lab-um/masca-types';
 import { isError, Result } from '@blockchain-lab-um/utils';
 import { MetaMaskInpageProvider } from '@metamask/providers';
-import type { SnapsGlobalObject } from '@metamask/snaps-types';
+import { SnapsProvider } from '@metamask/snaps-sdk';
 import { beforeAll, describe, expect, it } from 'vitest';
 
 import { onRpcRequest } from '../../src';
@@ -10,7 +10,7 @@ import { getDefaultSnapState } from '../data/defaultSnapState';
 import { createMockSnap, SnapMock } from '../helpers/snapMock';
 
 describe('getSnapSettings', () => {
-  let snapMock: SnapsGlobalObject & SnapMock;
+  let snapMock: SnapsProvider & SnapMock;
 
   beforeAll(async () => {
     snapMock = createMockSnap();

diff --git a/packages/snap/tests/e2e/getVCStore.spec.ts b/packages/snap/tests/e2e/getVCStore.spec.ts
@@ -1,6 +1,6 @@
 import { isError, Result } from '@blockchain-lab-um/utils';
 import { MetaMaskInpageProvider } from '@metamask/providers';
-import type { SnapsGlobalObject } from '@metamask/snaps-types';
+import { SnapsProvider } from '@metamask/snaps-sdk';
 import { beforeAll, describe, expect, it } from 'vitest';
 
 import { onRpcRequest } from '../../src';
@@ -9,7 +9,7 @@ import { getDefaultSnapState } from '../data/defaultSnapState';
 import { createMockSnap, SnapMock } from '../helpers/snapMock';
 
 describe('getVCStore', () => {
-  let snapMock: SnapsGlobalObject & SnapMock;
+  let snapMock: SnapsProvider & SnapMock;
 
   beforeAll(async () => {
     snapMock = createMockSnap();

diff --git a/packages/snap/tests/e2e/importStateBackup.spec.ts b/packages/snap/tests/e2e/importStateBackup.spec.ts
@@ -2,7 +2,7 @@ import { type MascaState } from '@blockchain-lab-um/masca-types';
 import { isError, Result } from '@blockchain-lab-um/utils';
 import { IDataManagerSaveResult } from '@blockchain-lab-um/veramo-datamanager';
 import { MetaMaskInpageProvider } from '@metamask/providers';
-import type { SnapsGlobalObject } from '@metamask/snaps-types';
+import { SnapsProvider } from '@metamask/snaps-sdk';
 import type { IIdentifier, VerifiableCredential } from '@veramo/core';
 import cloneDeep from 'lodash.clonedeep';
 import { beforeAll, describe, expect, it } from 'vitest';
@@ -17,7 +17,7 @@ import { createTestVCs } from '../helpers/generateTestVCs';
 import { createMockSnap, SnapMock } from '../helpers/snapMock';
 
 describe('importStateBackup', () => {
-  let snapMock: SnapsGlobalObject & SnapMock;
+  let snapMock: SnapsProvider & SnapMock;
   let identifier: IIdentifier;
   let agent: Agent;
   let generatedVC: VerifiableCredential;

diff --git a/packages/snap/tests/e2e/queryVerifiableCredentials.spec.ts b/packages/snap/tests/e2e/queryVerifiableCredentials.spec.ts
@@ -2,7 +2,7 @@ import { isError, Result } from '@blockchain-lab-um/utils';
 import { IDataManagerSaveResult } from '@blockchain-lab-um/veramo-datamanager';
 import { DIDDataStore } from '@glazed/did-datastore';
 import { MetaMaskInpageProvider } from '@metamask/providers';
-import type { SnapsGlobalObject } from '@metamask/snaps-types';
+import { SnapsProvider } from '@metamask/snaps-sdk';
 import { VerifiableCredential } from '@veramo/core';
 import { beforeAll, beforeEach, describe, expect, it, vi } from 'vitest';
 
@@ -18,7 +18,7 @@ import { createMockSnap, SnapMock } from '../helpers/snapMock';
 
 describe('queryVerifiableCredentials', () => {
   let ceramicData: StoredCredentials;
-  let snapMock: SnapsGlobalObject & SnapMock;
+  let snapMock: SnapsProvider & SnapMock;
   let agent: Agent;
   let generatedVC: VerifiableCredential;
 

diff --git a/packages/snap/tests/e2e/removeFriendlyDapp.spec.ts b/packages/snap/tests/e2e/removeFriendlyDapp.spec.ts
@@ -2,7 +2,7 @@ import { CURRENT_STATE_VERSION } from '@blockchain-lab-um/masca-types';
 import { isError, Result } from '@blockchain-lab-um/utils';
 import { IDataManagerSaveResult } from '@blockchain-lab-um/veramo-datamanager';
 import { MetaMaskInpageProvider } from '@metamask/providers';
-import type { SnapsGlobalObject } from '@metamask/snaps-types';
+import { SnapsProvider } from '@metamask/snaps-sdk';
 import { VerifiableCredential } from '@veramo/core';
 import { beforeAll, describe, expect, it, vi } from 'vitest';
 
@@ -17,7 +17,7 @@ import { createTestVCs } from '../helpers/generateTestVCs';
 import { createMockSnap, SnapMock } from '../helpers/snapMock';
 
 describe('removeFriendlyDapp', () => {
-  let snapMock: SnapsGlobalObject & SnapMock;
+  let snapMock: SnapsProvider & SnapMock;
   let generatedVC: VerifiableCredential;
 
   beforeAll(async () => {

diff --git a/packages/snap/tests/e2e/resolveDID.spec.ts b/packages/snap/tests/e2e/resolveDID.spec.ts
@@ -1,6 +1,6 @@
 import { isError, Result } from '@blockchain-lab-um/utils';
 import { MetaMaskInpageProvider } from '@metamask/providers';
-import { SnapsGlobalObject } from '@metamask/snaps-types';
+import { SnapsProvider } from '@metamask/snaps-sdk';
 import { DIDResolutionResult } from 'did-resolver';
 import { beforeAll, describe, expect, it } from 'vitest';
 
@@ -19,7 +19,7 @@ import {
 import { createMockSnap, SnapMock } from '../helpers/snapMock';
 
 describe('resolveDID', () => {
-  let snapMock: SnapsGlobalObject & SnapMock;
+  let snapMock: SnapsProvider & SnapMock;
 
   const methods = [EBSI, ENS, ION, CHEQD, WEB, ETHR, KEY] as const;