@verified-network/verified-custody 0.4.2 → 0.4.4

package/README.md

@@ -350,6 +350,204 @@ function App() {
 }
 ```
 
+# 🔄 React(Create React App) Setup and Fixes
+✅ 1. Initialize the Project
+```jsx
+npx create-react-app my-app
+cd my-app
+```
+
+✅ 2. Install react-app-rewired
+```jsx
+npm install react-app-rewired --save-dev
+OR
+yarn add --dev react-app-rewired
+```
+✅ 3. Install other dependencies for node polyfils
+```jsx
+npm install --save-dev crypto-browserify stream-browserify assert stream-http https-browserify os-browserify url path-browserify vm-browserify buffer process 
+OR
+yarn add crypto-browserify stream-browserify assert stream-http https-browserify os-browserify url path-browserify vm-browserify buffer process 
+```
+note: the above dependencies are needed dependencies to make node related packages work, more dependencies can be added to handle any other nodeJs polyfills error.
+
+✅ 4. Override create-react-app webpack configuration
+In the root folder of your project, create a new file named 'config-overrides.js', and add:
+```jsx
+//config-overrides.js
+
+const webpack = require("webpack");
+module.exports = function override(config) {
+  const fallback = config.resolve.fallback || {};
+  Object.assign(fallback, {
+    crypto: require.resolve("crypto-browserify"),
+    stream: require.resolve("stream-browserify"),
+    assert: require.resolve("assert"),
+    http: require.resolve("stream-http"),
+    https: require.resolve("https-browserify"),
+    os: require.resolve("os-browserify"),
+    url: require.resolve("url"),
+    path: require.resolve("path-browserify"),
+    vm: require.resolve("vm-browserify"),
+    fs: false,
+  });
+  config.plugins.push(
+    new webpack.IgnorePlugin({
+      resourceRegExp:
+        /^react-native$|^expo-font$|^@react-native-async-storage\/async-storage$/,
+    })
+  );
+
+  config.plugins = (config.plugins || []).concat([
+    new webpack.ProvidePlugin({
+      process: "process/browser",
+      Buffer: ["buffer", "Buffer"],
+    }),
+  ]);
+  config.module.rules = [
+    ...config.module.rules,
+    {
+      test: /\.m?js/,
+      resolve: {
+        fullySpecified: false,
+      },
+    },
+  ];
+  config.resolve.fallback = fallback;
+  config.ignoreWarnings = [/Failed to parse source map/];
+  return config;
+};
+```
+config-overrides.js' code snippet instructs webpack how to resolve node js related dependencies that may not be available on browser side but are required. It also instruct webpack to ignore react-native related dependencies that may breack our react app.
+
+✅ 5. Modify package.json Scripts
+In your package.json, replace this:
+```json
+"scripts": {
+  "start": "react-scripts start",
+  "build": "react-scripts build",
+  "test": "react-scripts test",
+  "eject": "react-scripts eject"
+}
+```
+With this:
+```json
+"scripts": {
+  "start": "react-app-rewired start",
+  "build": "react-app-rewired build",
+  "test": "react-app-rewired test"
+}
+
+```
+note: the above scripts changes ensure your app is handled by react-app-rewired scripts instead of react-scripts this way the webpack configuration will be acknowledged.
+
+✅ 6. Import and Initialize Verified-Custody-Module and Start the application
+Using the instruction on Verified Custody Module Usage initialize the module to suit your app logic,
+You can start the application using:
+```jsx
+npm start
+```
+# React(Create React App) Folder Structure
+```pgsql
+my-app/
+├── node_modules/
+├── public/
+├── src/
+│   ├── App.js
+│   └── index.js
+├── config-overrides.js
+├── package.json
+└── README.md
+```
+
+# 🔄 React Native(Using Expo) Setup and Fixes
+✅ 1. Initialize the Project
+```jsx
+npx create-expo-app my-rn-app
+cd my-rn-app
+```
+
+✅ 2. Install required dependencies
+```jsx
+npm react-native-get-random-values expo-font @react-native-async-storage/async-storage
+OR
+yarn add react-native-get-random-values expo-font @react-native-async-storage/async-storage
+```
+✅ 3. Install other dependencies for node polyfils
+```jsx
+npm install --save-dev crypto-browserify stream-browserify assert stream-http https-browserify os-browserify url path-browserify vm-browserify buffer process 
+OR
+yarn add crypto-browserify stream-browserify assert stream-http https-browserify os-browserify url path-browserify vm-browserify buffer process 
+```
+note: the above dependencies are required as external/peer dependencies for the module to work on react-native.
+ 
+
+✅ 4. Modify the (tabs) index.js or index.ts
+In the app/(tabs) folder, open the index.js or index.ts file and add:
+```jsx
+//index.js or index.ts
+
+import "react-native-get-random-values";
+OR
+require("react-native-get-random-values")
+};
+```
+note the react-native-get-random-values import needs to be on the first line of the file so this is import early before the custody module is used. The  react-native-get-random-values is very important for node packages like crypto and various hashing/encryption functions to work.
+
+✅ 6. Import and Initialize Verified-Custody-Module and Start the application
+Using the instruction on Verified Custody Module Usage initialize the module to suit your app logic,
+You can start the application using:
+```jsx
+npm start(if your script is setup)
+OR
+npx expo start
+OR
+npx expo run:android (to start the application on android)
+OR
+npx expo run:ios (to start the application on ios)
+```
+# React Native(With Expo) Folder Structure
+```pgsql
+my-rn-app/
+├── node_modules/
+├── public/
+├── app/
+│   ├── (tabs)
+│         └── index.ts or index.js
+├── package.json
+└── README.md
+```
+
+# 🔄 Web Extension Setup and Fixes
+Web Extension has various setup procedures, any of the setup you decide to use will work fine with Verify Custody Module.
+It is important to know that Web extension are to be built like react app and therefore during build react native related dependencies should be ignored or set as external.
+This can be done using plugin on webpack.
+For Example:
+```jsx
+plugins: [
+  {
+    name: "node-and-react-native-polyfills",
+    setup(build) {
+      // treat react-native as external don't build
+      build.onResolve({ filter: /^react-native$/ }, () => {
+        return { external: true };
+      });
+      build.onResolve({ filter: /^expo-font$/ }, () => {
+        return { external: true };
+      });
+      build.onResolve(
+        { filter: /^@react-native-async-storage\/async-storage$/ },
+        () => {
+          return { external: true };
+        }
+      );
+  
+      ...Other polyfills
+    },
+  }
+]
+```
+
 ## Summary
 
 - Secure blockchain wallet custody with private key sharding and on-chain encrypted storage.

package/dist/index.d.mts

@@ -52,12 +52,13 @@ interface VerifiedCustodyProps {
 }
 interface VerifiedCustodyHelpers {
     sendCoSignerInvitation: (channel: "sms" | "email", cosigerId: string, cretorId: string, hashedCretorPin: string) => Promise<boolean>;
-    sendCreatorConfirmation: (channel: "sms" | "email", cretorId: string, cosigersList: [], requiredSigners: number) => Promise<boolean>;
+    sendCreatorConfirmation: (channel: "sms" | "email", cretorId: string, cosigersList: [], requiredSigners: number, hashedCretorPin: string, isRemoved?: boolean) => Promise<boolean>;
     sendCreatorInitiation: (channel: "sms" | "email", cretorId: string, hashedCretorPin: string, txId: number, requiredSigners: number) => Promise<boolean>;
-    sendCreatorSigned: (channel: "sms" | "email", cretorId: string, coSignerId: string) => Promise<boolean>;
+    sendCreatorSigned: (channel: "sms" | "email", cretorId: string, coSignerId: string, vaultPinHashed: string) => Promise<boolean>;
     sendCreatorCompleted: (channel: "sms" | "email", cretorId: string, txId: number) => Promise<boolean>;
-    sendCreatorAcceptance: (channel: "sms" | "email", creatorId: string, coSignerId: string) => Promise<boolean>;
-    sendCreatorRejection: (channel: "sms" | "email", creatorId: string, coSignerId: string) => Promise<boolean>;
+    sendCreatorAuthChanged: (channel: "sms" | "email", cretorId: string, vaultPinHashed: string, oldVaultPinHashed: string, timestamp: number) => Promise<boolean>;
+    sendCreatorAcceptance: (channel: "sms" | "email", creatorId: string, coSignerId: string, vaultPinHashed: string) => Promise<boolean>;
+    sendCreatorRejection: (channel: "sms" | "email", creatorId: string, coSignerId: string, vaultPinHashed: string) => Promise<boolean>;
     sendOTPVerification: (creatorUniqueId: string, channel: "sms" | "email", creatorId: string) => Promise<boolean>;
     checkOTPVerification: (creatorUniqueId: string, creatorId: string, otp: string) => Promise<boolean>;
 }
@@ -102,6 +103,8 @@ declare const FTUPage: (props: {
     helperFunctions?: VerifiedCustodyHelpers;
     setIsLoading?: (isLoading: boolean) => void;
     setShowDashboard?: (showDashboard: boolean) => void;
+    setShowResetPin?: (showResetPin: boolean) => void;
+    setShowRemoveCosigner?: (showRemoveCosigner: boolean) => void;
     dashbordElement?: React$1.ComponentType<{
         setIsLoading: React$1.Dispatch<React$1.SetStateAction<boolean>>;
     }>;
@@ -144,6 +147,8 @@ declare const EnterPinPage: (props: {
     txToSign?: any;
     setIsLoading: (isLoading: boolean) => void;
     setShowDashboard?: (showDashboard: boolean) => void;
+    setShowResetPin?: (showResetPin: boolean) => void;
+    setShowRemoveCosigner?: (showRemoveCosigner: boolean) => void;
     setShowCompleteVault?: (showDashboard: boolean) => void;
     setUserEmail?: (userEmail: string) => void;
     setUserNumberFmt?: (userNumberFmt: string) => void;
@@ -154,6 +159,9 @@ declare const EnterPinPage: (props: {
     }) => void;
     helperFunctions?: VerifiedCustodyHelpers;
     enablePhone?: boolean;
+    dashbordElement?: React$1.ComponentType<{
+        setIsLoading: React$1.Dispatch<React$1.SetStateAction<boolean>>;
+    }>;
 }) => React$1.JSX.Element;
 
 declare const CreatePinPage: (props: {
@@ -306,6 +314,13 @@ declare const AddCosignersPage: (props: {
     };
     helperFunctions?: VerifiedCustodyHelpers;
     enablePhone?: boolean;
+    action?: string;
+    setShowDashboard?: (showDashboard: boolean) => void;
+    setShowResetPin?: (showResetPin: boolean) => void;
+    setShowRemoveCosigner?: (showRemoveCosigner: boolean) => void;
+    dashbordElement?: React$1.ComponentType<{
+        setIsLoading: React$1.Dispatch<React$1.SetStateAction<boolean>>;
+    }>;
 }) => React$1.JSX.Element;
 
 /**
@@ -319,6 +334,7 @@ declare const loadAllGoogleFonts: (document: Document) => boolean;
  */
 declare const loadAllGoogleFontsRN: (expoFont: any) => Promise<boolean>;
 declare const hashTheString: (text: string) => string;
+declare const hashTheBuffer: (buffer: ArrayBuffer | Uint8Array) => string;
 declare const encryptString: (text: string, secretKey: string) => string;
 declare const decryptString: (encryptedText: string, secretKey: string) => string;
 declare const publicKeyCredentialRequestOptions: () => any;
@@ -348,4 +364,4 @@ declare const VaultContextProvider: ({ children }: {
     children: any;
 }) => React$1.JSX.Element;
 
-export { AddCosignersPage as AddCoSignersPage, ContactPage, CreatePinPage, EnterPinPage, FTUPage, OTPPage, VaultContextProvider, VerifiedCustody, type VerifiedCustodyHelpers, type VerifiedCustodyProps, type VerifiedWalletAction, type VerifiedWalletTx, type VerifiedWalletVault, decryptString, decryptWithPasskey, encryptString, encryptWithPasskey, getPlatformComponents, hashTheString, initPlatform, loadAllGoogleFonts, loadAllGoogleFontsRN, publicKeyCredentialRequestOptions };
+export { AddCosignersPage as AddCoSignersPage, ContactPage, CreatePinPage, EnterPinPage, FTUPage, OTPPage, VaultContextProvider, VerifiedCustody, type VerifiedCustodyHelpers, type VerifiedCustodyProps, type VerifiedWalletAction, type VerifiedWalletTx, type VerifiedWalletVault, decryptString, decryptWithPasskey, encryptString, encryptWithPasskey, getPlatformComponents, hashTheBuffer, hashTheString, initPlatform, loadAllGoogleFonts, loadAllGoogleFontsRN, publicKeyCredentialRequestOptions };

package/dist/index.d.ts

@@ -52,12 +52,13 @@ interface VerifiedCustodyProps {
 }
 interface VerifiedCustodyHelpers {
     sendCoSignerInvitation: (channel: "sms" | "email", cosigerId: string, cretorId: string, hashedCretorPin: string) => Promise<boolean>;
-    sendCreatorConfirmation: (channel: "sms" | "email", cretorId: string, cosigersList: [], requiredSigners: number) => Promise<boolean>;
+    sendCreatorConfirmation: (channel: "sms" | "email", cretorId: string, cosigersList: [], requiredSigners: number, hashedCretorPin: string, isRemoved?: boolean) => Promise<boolean>;
     sendCreatorInitiation: (channel: "sms" | "email", cretorId: string, hashedCretorPin: string, txId: number, requiredSigners: number) => Promise<boolean>;
-    sendCreatorSigned: (channel: "sms" | "email", cretorId: string, coSignerId: string) => Promise<boolean>;
+    sendCreatorSigned: (channel: "sms" | "email", cretorId: string, coSignerId: string, vaultPinHashed: string) => Promise<boolean>;
     sendCreatorCompleted: (channel: "sms" | "email", cretorId: string, txId: number) => Promise<boolean>;
-    sendCreatorAcceptance: (channel: "sms" | "email", creatorId: string, coSignerId: string) => Promise<boolean>;
-    sendCreatorRejection: (channel: "sms" | "email", creatorId: string, coSignerId: string) => Promise<boolean>;
+    sendCreatorAuthChanged: (channel: "sms" | "email", cretorId: string, vaultPinHashed: string, oldVaultPinHashed: string, timestamp: number) => Promise<boolean>;
+    sendCreatorAcceptance: (channel: "sms" | "email", creatorId: string, coSignerId: string, vaultPinHashed: string) => Promise<boolean>;
+    sendCreatorRejection: (channel: "sms" | "email", creatorId: string, coSignerId: string, vaultPinHashed: string) => Promise<boolean>;
     sendOTPVerification: (creatorUniqueId: string, channel: "sms" | "email", creatorId: string) => Promise<boolean>;
     checkOTPVerification: (creatorUniqueId: string, creatorId: string, otp: string) => Promise<boolean>;
 }
@@ -102,6 +103,8 @@ declare const FTUPage: (props: {
     helperFunctions?: VerifiedCustodyHelpers;
     setIsLoading?: (isLoading: boolean) => void;
     setShowDashboard?: (showDashboard: boolean) => void;
+    setShowResetPin?: (showResetPin: boolean) => void;
+    setShowRemoveCosigner?: (showRemoveCosigner: boolean) => void;
     dashbordElement?: React$1.ComponentType<{
         setIsLoading: React$1.Dispatch<React$1.SetStateAction<boolean>>;
     }>;
@@ -144,6 +147,8 @@ declare const EnterPinPage: (props: {
     txToSign?: any;
     setIsLoading: (isLoading: boolean) => void;
     setShowDashboard?: (showDashboard: boolean) => void;
+    setShowResetPin?: (showResetPin: boolean) => void;
+    setShowRemoveCosigner?: (showRemoveCosigner: boolean) => void;
     setShowCompleteVault?: (showDashboard: boolean) => void;
     setUserEmail?: (userEmail: string) => void;
     setUserNumberFmt?: (userNumberFmt: string) => void;
@@ -154,6 +159,9 @@ declare const EnterPinPage: (props: {
     }) => void;
     helperFunctions?: VerifiedCustodyHelpers;
     enablePhone?: boolean;
+    dashbordElement?: React$1.ComponentType<{
+        setIsLoading: React$1.Dispatch<React$1.SetStateAction<boolean>>;
+    }>;
 }) => React$1.JSX.Element;
 
 declare const CreatePinPage: (props: {
@@ -306,6 +314,13 @@ declare const AddCosignersPage: (props: {
     };
     helperFunctions?: VerifiedCustodyHelpers;
     enablePhone?: boolean;
+    action?: string;
+    setShowDashboard?: (showDashboard: boolean) => void;
+    setShowResetPin?: (showResetPin: boolean) => void;
+    setShowRemoveCosigner?: (showRemoveCosigner: boolean) => void;
+    dashbordElement?: React$1.ComponentType<{
+        setIsLoading: React$1.Dispatch<React$1.SetStateAction<boolean>>;
+    }>;
 }) => React$1.JSX.Element;
 
 /**
@@ -319,6 +334,7 @@ declare const loadAllGoogleFonts: (document: Document) => boolean;
  */
 declare const loadAllGoogleFontsRN: (expoFont: any) => Promise<boolean>;
 declare const hashTheString: (text: string) => string;
+declare const hashTheBuffer: (buffer: ArrayBuffer | Uint8Array) => string;
 declare const encryptString: (text: string, secretKey: string) => string;
 declare const decryptString: (encryptedText: string, secretKey: string) => string;
 declare const publicKeyCredentialRequestOptions: () => any;
@@ -348,4 +364,4 @@ declare const VaultContextProvider: ({ children }: {
     children: any;
 }) => React$1.JSX.Element;
 
-export { AddCosignersPage as AddCoSignersPage, ContactPage, CreatePinPage, EnterPinPage, FTUPage, OTPPage, VaultContextProvider, VerifiedCustody, type VerifiedCustodyHelpers, type VerifiedCustodyProps, type VerifiedWalletAction, type VerifiedWalletTx, type VerifiedWalletVault, decryptString, decryptWithPasskey, encryptString, encryptWithPasskey, getPlatformComponents, hashTheString, initPlatform, loadAllGoogleFonts, loadAllGoogleFontsRN, publicKeyCredentialRequestOptions };
+export { AddCosignersPage as AddCoSignersPage, ContactPage, CreatePinPage, EnterPinPage, FTUPage, OTPPage, VaultContextProvider, VerifiedCustody, type VerifiedCustodyHelpers, type VerifiedCustodyProps, type VerifiedWalletAction, type VerifiedWalletTx, type VerifiedWalletVault, decryptString, decryptWithPasskey, encryptString, encryptWithPasskey, getPlatformComponents, hashTheBuffer, hashTheString, initPlatform, loadAllGoogleFonts, loadAllGoogleFontsRN, publicKeyCredentialRequestOptions };