@mento-protocol/mento-sdk 0.1.1 → 0.1.3

package/dist/esm/utils.d.ts

@@ -1,5 +1,17 @@
-import { BigNumber, Signer, providers } from 'ethers';
+import { BigNumber, providers, Signer } from 'ethers';
 import { Address } from './types';
+/**
+ * Ensures that given signer is truly a a connected signer
+ * @param signer an ethers signer
+ * @throws if signer is invalid or not connected
+ */
+export declare function validateSigner(signer: Signer): void;
+/**
+ * Ensures that given signerOrProvider is truly a provider or a connected signer
+ * @param signerOrProvider an ethers provider or signer
+ * @throws if signerOrProvider is invalid or not connected
+ */
+export declare function validateSignerOrProvider(signerOrProvider: Signer | providers.Provider): void;
 /**
  * Returns the broker address from the Celo registry
  * @param signerOrProvider an ethers provider or signer

package/dist/esm/utils.js

@@ -7,8 +7,35 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-// SPDX-License-Identifier: GPL-3.0-or-later
-import { Contract, constants } from 'ethers';
+import { constants, Contract, providers, Signer } from 'ethers';
+/**
+ * Ensures that given signer is truly a a connected signer
+ * @param signer an ethers signer
+ * @throws if signer is invalid or not connected
+ */
+export function validateSigner(signer) {
+    if (!Signer.isSigner(signer)) {
+        throw new Error('A valid signer must be provided');
+    }
+    if (!providers.Provider.isProvider(signer.provider)) {
+        throw new Error('Signer must be connected to a provider');
+    }
+}
+/**
+ * Ensures that given signerOrProvider is truly a provider or a connected signer
+ * @param signerOrProvider an ethers provider or signer
+ * @throws if signerOrProvider is invalid or not connected
+ */
+export function validateSignerOrProvider(signerOrProvider) {
+    const isSigner = Signer.isSigner(signerOrProvider);
+    const isProvider = providers.Provider.isProvider(signerOrProvider);
+    if (!isSigner && !isProvider) {
+        throw new Error('A valid signer or provider must be provided');
+    }
+    if (isSigner && !providers.Provider.isProvider(signerOrProvider.provider)) {
+        throw new Error('Signer must be connected to a provider');
+    }
+}
 /**
  * Returns the broker address from the Celo registry
  * @param signerOrProvider an ethers provider or signer

package/package.json

@@ -1,26 +1,32 @@
 {
   "name": "@mento-protocol/mento-sdk",
   "description": "Official SDK for interacting with the Mento Protocol",
-  "version": "0.1.1",
-  "license": "GPL-3.0-or-later",
+  "version": "0.1.3",
+  "license": "MIT",
   "author": "Mento Labs",
   "keywords": [
     "mento",
     "celo",
     "solidity"
   ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mento-protocol/mento-sdk.git"
+  },
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "typings": "dist/esm/index.d.ts",
   "files": [
-    "dist"
+    "dist",
+    "!dist/**/*.test.*"
   ],
   "scripts": {
     "analyze": "size-limit --why",
     "build": "yarn build:cjs && yarn build:esm",
     "build:cjs": "tsc --project ./tsconfig.json",
     "build:esm": "tsc --project ./tsconfig.esm.json",
-    "lint": "eslint --config ./.eslintrc.json **/*.{json,ts}",
+    "clean": "rm -rf ./dist",
+    "lint": "eslint --config ./.eslintrc.json src/**/*.ts",
     "prettier": "prettier --config ./.prettierrc.json --write **/*.{json,md,js,ts,yml}",
     "size": "size-limit",
     "test": "jest --runInBand --verbose",
@@ -57,15 +63,17 @@
     "@tsconfig/recommended": "^1.0.1",
     "@types/jest": "^29.4.0",
     "@types/node": "^18.13.0",
-    "@typescript-eslint/eslint-plugin": "^5.51.0",
-    "@typescript-eslint/parser": "^5.51.0",
-    "eslint": "^8.33.0",
+    "@typescript-eslint/eslint-plugin": "^5.53.0",
+    "@typescript-eslint/parser": "^5.53.0",
+    "eslint": "^8.34.0",
+    "eslint-config-prettier": "^8.6.0",
     "ethers": "^5.7.2",
     "husky": "^8.0.2",
     "jest": "^29.4.2",
     "prettier": "^2.8.4",
     "size-limit": "^8.1.0",
     "ts-jest": "^29.0.5",
+    "ts-node": "^10.9.1",
     "typescript": "^4.9.5"
   },
   "dependencies": {
@@ -73,5 +81,6 @@
   },
   "peerDependencies": {
     "ethers": "^5.7.2"
-  }
+  },
+  "packageManager": "yarn@3.3.1"
 }