fix: replace custom types with metamask types (#214)

* replace custom types with metamask types * fix sematic PR ci
ChainSafe · Jul 28, 2022 · 5fd1801 · 5fd1801
1 parent 9f6e1a6
commit 5fd1801
Show file tree

Hide file tree

Showing 34 changed files with 331 additions and 236 deletions.
diff --git a/.github/workflows/pr.yaml b/.github/workflows/pr.yaml
@@ -17,5 +17,4 @@ jobs:
           types: |
             fix
             feat
-            chore
-          validateSingleCommit: true #single commit can ovveride squash merge commit message
+            chore
diff --git a/packages/snap/package.json b/packages/snap/package.json
@@ -9,7 +9,7 @@
     "manifest": "mm-snap manifest",
     "lint": "yarn run lint:types && yarn run lint:style",
     "lint:types": "tsc --noEmit --pretty",
-    "lint:style": "eslint --color '{src, @types}/**/*.{js,ts,tsx}'",
+    "lint:style": "eslint --color '{src, test, @types}/**/*.{js,ts,tsx}'",
     "lint:style:fix": "yarn run lint --fix",
     "start": "yarn run build && yarn run serve",
     "prebuild": "rm -rf build && rm -rf dist",
@@ -48,6 +48,7 @@
   "homepage": "https://github.com/chainsafe/filecoin-metamask-snap#readme",
   "devDependencies": {
     "@chainsafe/filsnap-types": "workspace:^",
+    "@metamask/providers": "^9.0.0",
     "@metamask/snaps-cli": "^0.18.1",
     "@types/bn.js": "^4.11.6",
     "@types/chai": "^4.2.10",

diff --git a/packages/snap/snap.manifest.json b/packages/snap/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/Chainsafe/filsnap.git"
   },
   "source": {
-    "shasum": "46bjmrAu8YQbX6LXa90Hutv4vc32XLY08rdhvO22a9Q=",
+    "shasum": "HFK3+OvYHpbPxh1VHoDDJNZltHSzYXLTbGmDLD6wcrA=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",

diff --git a/packages/snap/src/configuration/index.ts b/packages/snap/src/configuration/index.ts
@@ -1,5 +1,6 @@
 import { SnapConfig } from "@chainsafe/filsnap-types";
-import { MetamaskState, Wallet } from "../interfaces";
+import { SnapProvider } from "@metamask/snap-types";
+import { MetamaskState } from "../interfaces";
 import {
   defaultConfiguration,
   filecoinMainnetConfiguration,
@@ -19,7 +20,9 @@ export function getDefaultConfiguration(networkName?: string): SnapConfig {
   }
 }
 
-export async function getConfiguration(wallet: Wallet): Promise<SnapConfig> {
+export async function getConfiguration(
+  wallet: SnapProvider
+): Promise<SnapConfig> {
   const state = (await wallet.request({
     method: "snap_manageState",
     params: ["get"],

diff --git a/packages/snap/src/filecoin/account.ts b/packages/snap/src/filecoin/account.ts
@@ -8,14 +8,15 @@ import {
   getBIP44AddressKeyDeriver,
   JsonBIP44CoinTypeNode,
 } from "@metamask/key-tree";
+import { SnapProvider } from "@metamask/snap-types";
 import { getMetamaskVersion, isNewerVersion } from "../util/version";
-import { MetamaskState, Wallet } from "../interfaces";
+import { MetamaskState } from "../interfaces";
 
 /**
  * Return derived KeyPair from seed.
  * @param wallet
  */
-export async function getKeyPair(wallet: Wallet): Promise<KeyPair> {
+export async function getKeyPair(wallet: SnapProvider): Promise<KeyPair> {
   const snapState = (await wallet.request({
     method: "snap_manageState",
     params: ["get"],

diff --git a/packages/snap/src/filecoin/api.ts b/packages/snap/src/filecoin/api.ts
@@ -5,11 +5,11 @@ import {
 } from "@filecoin-shipyard/lotus-client-provider-nodejs";
 import { testnet } from "@filecoin-shipyard/lotus-client-schema";
 import { SnapConfig } from "@chainsafe/filsnap-types";
+import { SnapProvider } from "@metamask/snap-types";
 import { getConfiguration } from "../configuration";
-import { Wallet } from "../interfaces";
 import { LotusRpcApi } from "./types";
 
-export async function getApi(wallet: Wallet): Promise<LotusRpcApi> {
+export async function getApi(wallet: SnapProvider): Promise<LotusRpcApi> {
   const configuration = await getConfiguration(wallet);
   return getApiFromConfig(configuration);
 }

diff --git a/packages/snap/src/filecoin/message.ts b/packages/snap/src/filecoin/message.ts
@@ -1,8 +1,9 @@
 import { MessageStatus } from "@chainsafe/filsnap-types";
-import { MetamaskState, Wallet } from "../interfaces";
+import { SnapProvider } from "@metamask/snap-types";
+import { MetamaskState } from "../interfaces";
 
 export async function updateMessageInState(
-  wallet: Wallet,
+  wallet: SnapProvider,
   message: MessageStatus
 ): Promise<void> {
   const state = (await wallet.request({

diff --git a/packages/snap/src/index.ts b/packages/snap/src/index.ts
@@ -1,5 +1,5 @@
 import { OnRpcRequestHandler } from "@metamask/snap-types";
-import { EmptyMetamaskState, Wallet } from "./interfaces";
+import { EmptyMetamaskState } from "./interfaces";
 import { getAddress } from "./rpc/getAddress";
 import { exportPrivateKey } from "./rpc/exportPrivateKey";
 import { getPublicKey } from "./rpc/getPublicKey";
@@ -18,8 +18,6 @@ import {
   isValidSignRequest,
 } from "./util/params";
 
-declare let wallet: Wallet;
-
 const apiDependentMethods = [
   "fil_getBalance",
   "fil_signMessage",

diff --git a/packages/snap/src/interfaces.ts b/packages/snap/src/interfaces.ts
@@ -20,7 +20,3 @@ export type MetamaskState = {
 export const EmptyMetamaskState: () => MetamaskState = () => ({
   filecoin: { config: defaultConfiguration, messages: [] },
 });
-
-export interface Wallet {
-  request(options: { method: string; params?: unknown[] }): unknown;
-}
diff --git a/packages/snap/src/rpc/configure.ts b/packages/snap/src/rpc/configure.ts
@@ -1,17 +1,18 @@
-import deepmerge from "deepmerge";
 import { SnapConfig } from "@chainsafe/filsnap-types";
-import { MetamaskState, Wallet } from "../interfaces";
+import { SnapProvider } from "@metamask/snap-types";
+import deepmerge from "deepmerge";
 import { getDefaultConfiguration } from "../configuration";
-import { LotusRpcApi } from "../filecoin/types";
 import { getApiFromConfig } from "../filecoin/api";
+import { LotusRpcApi } from "../filecoin/types";
+import { MetamaskState } from "../interfaces";
 
 export interface ConfigureResponse {
   api: LotusRpcApi;
   snapConfig: SnapConfig;
 }
 
 export async function configure(
-  wallet: Wallet,
+  wallet: SnapProvider,
   networkName: string,
   overrides?: unknown
 ): Promise<ConfigureResponse> {
@@ -44,7 +45,7 @@ export async function configure(
     params: ["get"],
   })) as MetamaskState;
   state.filecoin.config = configuration;
-  wallet.request({
+  await wallet.request({
     method: "snap_manageState",
     params: ["update", state],
   });

diff --git a/packages/snap/src/rpc/estimateMessageGas.ts b/packages/snap/src/rpc/estimateMessageGas.ts
@@ -4,12 +4,12 @@ import {
   MessageRequest,
 } from "@chainsafe/filsnap-types";
 import { FilecoinNumber } from "@glif/filecoin-number/dist";
-import { Wallet } from "../interfaces";
+import { SnapProvider } from "@metamask/snap-types";
 import { getKeyPair } from "../filecoin/account";
 import { LotusRpcApi } from "../filecoin/types";
 
 export async function estimateMessageGas(
-  wallet: Wallet,
+  wallet: SnapProvider,
   api: LotusRpcApi,
   messageRequest: MessageRequest,
   maxFee?: string

diff --git a/packages/snap/src/rpc/exportPrivateKey.ts b/packages/snap/src/rpc/exportPrivateKey.ts
@@ -1,8 +1,10 @@
-import { Wallet } from "../interfaces";
-import { showConfirmationDialog } from "../util/confirmation";
+import { SnapProvider } from "@metamask/snap-types";
 import { getKeyPair } from "../filecoin/account";
+import { showConfirmationDialog } from "../util/confirmation";
 
-export async function exportPrivateKey(wallet: Wallet): Promise<string | null> {
+export async function exportPrivateKey(
+  wallet: SnapProvider
+): Promise<string | null> {
   // ask for confirmation
   const confirmation = await showConfirmationDialog(wallet, {
     prompt: "Do you want to export your private key?",

diff --git a/packages/snap/src/rpc/getAddress.ts b/packages/snap/src/rpc/getAddress.ts
@@ -1,7 +1,7 @@
-import { Wallet } from "../interfaces";
+import { SnapProvider } from "@metamask/snap-types";
 import { getKeyPair } from "../filecoin/account";
 
-export async function getAddress(wallet: Wallet): Promise<string> {
+export async function getAddress(wallet: SnapProvider): Promise<string> {
   const keyPair = await getKeyPair(wallet);
   return keyPair.address;
 }
diff --git a/packages/snap/src/rpc/getBalance.ts b/packages/snap/src/rpc/getBalance.ts
@@ -1,10 +1,10 @@
 import { FilecoinNumber } from "@glif/filecoin-number/dist";
-import { Wallet } from "../interfaces";
+import { SnapProvider } from "@metamask/snap-types";
 import { getKeyPair } from "../filecoin/account";
 import { LotusRpcApi } from "../filecoin/types";
 
 export async function getBalance(
-  wallet: Wallet,
+  wallet: SnapProvider,
   api: LotusRpcApi,
   address?: string
 ): Promise<string> {

diff --git a/packages/snap/src/rpc/getMessages.ts b/packages/snap/src/rpc/getMessages.ts
@@ -1,7 +1,10 @@
 import { MessageStatus } from "@chainsafe/filsnap-types";
-import { MetamaskState, Wallet } from "../interfaces";
+import { SnapProvider } from "@metamask/snap-types";
+import { MetamaskState } from "../interfaces";
 
-export async function getMessages(wallet: Wallet): Promise<MessageStatus[]> {
+export async function getMessages(
+  wallet: SnapProvider
+): Promise<MessageStatus[]> {
   const state = (await wallet.request({
     method: "snap_manageState",
     params: ["get"],

diff --git a/packages/snap/src/rpc/getPublicKey.ts b/packages/snap/src/rpc/getPublicKey.ts
@@ -1,7 +1,7 @@
-import { Wallet } from "../interfaces";
+import { SnapProvider } from "@metamask/snap-types";
 import { getKeyPair } from "../filecoin/account";
 
-export async function getPublicKey(wallet: Wallet): Promise<string> {
+export async function getPublicKey(wallet: SnapProvider): Promise<string> {
   const keyPair = await getKeyPair(wallet);
   return keyPair.publicKey;
 }
diff --git a/packages/snap/src/rpc/sendMessage.ts b/packages/snap/src/rpc/sendMessage.ts
@@ -1,10 +1,10 @@
 import { MessageStatus, SignedMessage } from "@chainsafe/filsnap-types";
-import { Wallet } from "../interfaces";
-import { LotusRpcApi } from "../filecoin/types";
+import { SnapProvider } from "@metamask/snap-types";
 import { updateMessageInState } from "../filecoin/message";
+import { LotusRpcApi } from "../filecoin/types";
 
 export async function sendMessage(
-  wallet: Wallet,
+  wallet: SnapProvider,
   api: LotusRpcApi,
   signedMessage: SignedMessage
 ): Promise<MessageStatus> {

diff --git a/packages/snap/src/rpc/signMessage.ts b/packages/snap/src/rpc/signMessage.ts
@@ -1,23 +1,23 @@
+import {
+  MessageRequest,
+  SignMessageResponse,
+  SignRawMessageResponse,
+} from "@chainsafe/filsnap-types";
+import { FilecoinNumber } from "@glif/filecoin-number/dist";
+import { SnapProvider } from "@metamask/snap-types";
 import {
   Message,
   SignedMessage,
   transactionSign,
   transactionSignRaw,
 } from "@zondax/filecoin-signing-tools/js";
-import { FilecoinNumber } from "@glif/filecoin-number/dist";
-import {
-  MessageRequest,
-  SignMessageResponse,
-  SignRawMessageResponse,
-} from "@chainsafe/filsnap-types";
-import { Wallet } from "../interfaces";
 import { getKeyPair } from "../filecoin/account";
-import { showConfirmationDialog } from "../util/confirmation";
 import { LotusRpcApi } from "../filecoin/types";
+import { showConfirmationDialog } from "../util/confirmation";
 import { messageCreator } from "../util/messageCreator";
 
 export async function signMessage(
-  wallet: Wallet,
+  wallet: SnapProvider,
   api: LotusRpcApi,
   messageRequest: MessageRequest
 ): Promise<SignMessageResponse> {
@@ -100,7 +100,7 @@ export async function signMessage(
 }
 
 export async function signMessageRaw(
-  wallet: Wallet,
+  wallet: SnapProvider,
   rawMessage: string
 ): Promise<SignRawMessageResponse> {
   try {

diff --git a/packages/snap/src/util/confirmation.ts b/packages/snap/src/util/confirmation.ts
@@ -1,4 +1,4 @@
-import { Wallet } from "../interfaces";
+import { SnapProvider } from "@metamask/snap-types";
 
 type ConfirmationDialogContent = {
   prompt: string;
@@ -7,7 +7,7 @@ type ConfirmationDialogContent = {
 };
 
 export async function showConfirmationDialog(
-  wallet: Wallet,
+  wallet: SnapProvider,
   message: ConfirmationDialogContent
 ): Promise<boolean> {
   return (await wallet.request({

diff --git a/packages/snap/src/util/version.ts b/packages/snap/src/util/version.ts
@@ -1,6 +1,8 @@
-import { Wallet } from "../interfaces";
+import { SnapProvider } from "@metamask/snap-types";
 
-export const getMetamaskVersion = async (wallet: Wallet): Promise<string> =>
+export const getMetamaskVersion = async (
+  wallet: SnapProvider
+): Promise<string> =>
   (await wallet.request({
     method: "web3_clientVersion",
     params: [],

diff --git a/packages/snap/test/unit/configuration/index.test.ts b/packages/snap/test/unit/configuration/index.test.ts
@@ -4,4 +4,4 @@ import sinonChai from "sinon-chai";
 chai.use(sinonChai);
 
 // eslint-disable-next-line @typescript-eslint/no-empty-function
-describe('Test configuration functions', function() {});
+describe("Test configuration functions", function () {});