@hinkal/common 0.0.98 → 0.0.100

package/README.md

@@ -1,48 +1,65 @@
 # Hinkal SDK
-SDK allows to call hinkal functions. You will be able to do arbitrary Smart Contract interactions using SDK. 
+
+Hinkal is a middleware and set of smart contracts on EVM chains that uses ZK-proofs and stealth addresses to enable compliant and private transactions on major dApps. Users can privately store assets and transact on major dApps such as Uniswap, Pendle, Lido, Curve, and others.
+
+This SDK allows to do arbitrary Smart Contract interactions privately.
+
 ### Installation
+
 Using npm:
+
 ```sh
 npm install @hinkal/common
 ```
+
 Or, yarn:
+
 ```sh
 yarn add @hinkal/common
 ```
+
 ### Usage
 
 1. Step: import hinkal from @hinkal/common package and initiate a Hinkal instance:
- ```sh
-    import {Hinkal} from '@hinkal/common';
 
-    const hinkal = new Hinkal<Connector>();
+```sh
+   import {Hinkal} from '@hinkal/common';
+
+   const hinkal = new Hinkal<Connector>();
 ```
 
 2. Initiate ProviderAdapter object, where connector should be 'wagmi' Connector instance
- ```typescript  
-    const providerAdapter = new ProviderAdapter(connector);
-    await hinkal.initProviderAdapter(connector, providerAdapter);
+
+```typescript
+const providerAdapter = new ProviderAdapter(connector);
+await hinkal.initProviderAdapter(connector, providerAdapter);
 ```
 
 3. Ask user to generate his shielded address and fetch state from smart contract
- ```typescript
-    await hinkal.initUserKeys();
-    await hinkal.resetMerkle();
+
+```typescript
+await hinkal.initUserKeys();
+await hinkal.resetMerkle();
 ```
 
-4. Once user generated shielded address, shielded balances are available that can be displayed in front-end: 
+4. Once user generated shielded address, shielded balances are available that can be displayed in front-end:
+
 ```typescript
-    const balances = await hinkal.getBalances();
+const balances = await hinkal.getBalances();
 ```
 
 5. A user can deposit to his shielded account using:
+
 ```typescript
     hinkal.deposit(erc20addresses:string[],amountChanges:bigint[]);
 ```
+
 where erc20Addresses is array of token addresses and amountChanges - token amounts for the deposit.
 
 6. A user, once his balance is updated, can do any smart contract interaction:
+
 ```typescript
     hinkal.actionPrivateWallet( erc20Addresses:string[], amountChanges:bigint[], onChainCreation:boolean[], ops:string[]);
 ```
-where onChainCreation indicates amounts of tokens which are uncertain before the transaction is executed onchain. And, ops array is encoded array of user ops.
+
+where onChainCreation indicates amounts of tokens which are uncertain before the transaction is executed onchain. And, ops array is encoded array of user ops.

package/package.json

@@ -1,8 +1,16 @@
 {
   "name": "@hinkal/common",
-  "version": "0.0.98",
+  "version": "0.0.100",
   "homepage": "hinkal.pro",
-  "author": "Hinkal Protocol",
+  "author": {
+    "name": "Hinkal Protocol"
+  },
+  "keywords": [
+    "blockchain",
+    "privacy",
+    "zero-knowledge",
+    "stealth addresses"
+  ],
   "type": "module",
   "main": "index.mjs",
   "module": "index.mjs",