@hinkal/common 0.0.97 → 0.0.99

package/README.md

@@ -1,6 +1,8 @@
 # Hinkal SDK
+
 SDK allows to call hinkal functions. You will be able to do arbitrary Smart Contract interactions using SDK. 
 ### Installation
+
 Using npm:
 ```sh
 npm install @hinkal/common
@@ -11,35 +13,39 @@ yarn add @hinkal/common
 ```
 ### Usage
 
+
 1. Step: import hinkal from @hinkal/common package and initiate a Hinkal instance:
  ```sh
-        import {Hinkal} from '@hinkal/common';
+    import {Hinkal} from '@hinkal/common';
 
-        const hinkal = new Hinkal<Connector>();
+    const hinkal = new Hinkal<Connector>();
 ```
 
 2. Initiate ProviderAdapter object, where connector should be 'wagmi' Connector instance
- ```sh
-        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
- ```sh
-        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: 
-```sh
-        const balances = await hinkal.getBalances();
+```typescript
+    const balances = await hinkal.getBalances();
 ```
+
 5. A user can deposit to his shielded account using:
-```sh
-        hinkal.deposit(erc20addresses:string[], amountChanges:bigint[]);
+```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:
-```sh
-        hinkal.actionPrivateWallet(erc20Addresses:string[], amountChanges:bigint[], 
-                                   onChainCreation:boolean[], ops:string[]);
+```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.