@verified-network/verified-custody 0.1.4 → 0.1.6

package/README.md

@@ -1,32 +1,44 @@
-# Verified Wallet
+# Verified Custody
 
-# Verified Custody Module.
+This react module allows users to create a vault using Mobile/ E-mail as their vault id and gives you a private Key which the users can use to sign all transactions further.
 
-This module allows users to create a vault using Mobile/ E-mail as their vault address and gives you a private Key which the users can use to sign all transactions further.
-
-Usage:
+### Build:
 - All the components of the module is compiled and available under the dist/ directory.
 
 
-Install: 
-- npm install verified-wallet
+###  Install: 
+``` npm install @verified-network/verified-custody```
+
+ 
+The react module exports some constants and helper functions which will be useful when changing UI based on a user's state or any business logic
+
+ **IS_CUSTODY_SET - (bool)** - Returns true when the user's pk is stored in the device and is validated by the users pin.
+
+ **useCustody() - (hook)** - contains vaultInfo and IS_CUSTODY_SET.
+
+ **initializeMessaging() - (void)** - Should be called to initialise the fcm which will get the device token. Should be called at the earliest.
 
-The Module exports some constants and functions which will be useful when changing UI based on a user state or any Business Logic
+**getPermissionStatus - (bool** - Returns the status whether the user has allowed Push notification permissions. 
 
-- IS_CUSTODY_SET - (bool) - Returns true when the user's pk is stored in the device and is validated by the users pin.
-- useCustody() - hook - contains vaultInfo and IS_CUSTODY_SET.
+**getFcmToken - ( string)** - Returns the FCM token of the device.
 
-- initializeMessaging() - (void) - Should be called to initialise the fcm which will get the device token. Should be called at the earliest.
 
-- getPermissionStatus - (bool) - Returns the status whether the user has allowed Push notification permissions. 
 
-- getFcmToken - ( string) - Returns the FCM token of the device.
 
 
+****< StartCustody />**** component is the entry component, which starts from asking the user to enter their phone/email and follows. 
+
+This **< StartCustody />** component, can be used for multiple use case like to Sign Transactions and Retrieve Private Key by passing props.
+
+- Create a new vault
+- To Accept and Decline Cosigner Request
+- To Sign Transactions
 
-**< StartCustody />** component is the entry component, which starts from asking the user to enter their phone/email and follows. 
+**creator, txId, transactionType, user(id), etc.,** will be obtained from the notification params and as the query params.
 
+## Usage:
 
+### Creating a vault:
 
     return (
         <>
@@ -41,19 +53,10 @@ The Module exports some constants and functions which will be useful when changi
               ) }
             </>
           ) :  permissionStatus === 'denied' ? (
-            <div style={{
-                position: "absolute",
-                left: "50%",
-                top: "50%",
-                transform: "translate(-50%, -50%)",
-                textAlign: "center",
-              }}
-            >
               <p>
                 Notifications are blocked. Please enable them from your browser
                 settings.
               </p>
-            </div>
           ) : (
             <div>Requesting notification permissions...</div>
           )}
@@ -61,20 +64,30 @@ The Module exports some constants and functions which will be useful when changi
       )
 
 
-This **< StartCustody />** component, can be used for multiple use case like to Sign Transactions and Retrieve Private Key by passing props.
-
-- To Accept and Decline Cosigner Request
-- To Sign Transactions
-- To Retrieve Private Key
-
+### Handling cosigner requests:
 
-         <StartCustody
-              startPoint={{
+        <StartCustody
+            startPoint={{
                 component: "StartCosigner",  // currently supports all forms of signing
                 args: { creator, txId, transactionType, id },
-              }}
+            }}
+        />
     
+*transactionType* determines the type of signing request. 
 
 
-- **creator, txId, transactionType** will be obtained from the notification params and as the query params.
+
+### Recovering a private key:
+
+This **< GetPrivateKey  />** component, will let you to retreive the private key once all your cosigners signoff your recovery code request.
+
+    return (
+    <GetPrivateKey
+      setupProps={{
+        chainId: 84532,
+      }}
+      signingInfo={{ creator, txId, transactionType, user }}
+     />
+    )
+