@hinkal/common 0.0.103 → 0.0.104

package/README.md

@@ -22,10 +22,10 @@ yarn add @hinkal/common
 
 1. Import hinkal from @hinkal/common package and initiate a Hinkal instance:
 
-```sh
-   import {Hinkal} from '@hinkal/common';
+```typescript
+import { Hinkal } from '@hinkal/common';
 
-   const hinkal = new Hinkal<Connector>();
+const hinkal = new Hinkal<Connector>();
 ```
 
 2. Initialize a ProviderAdapter object, where the connector should be an instance of the wagmi Connector.
@@ -51,16 +51,20 @@ const balances = await hinkal.getBalances();
 5. A user can deposit to their shielded account using:
 
 ```typescript
-    function deposit(erc20addresses:string[],amountChanges:bigint[]): Promise<TransactionObject>;
+function deposit(erc20addresses: string[], amountChanges: bigint[]): Promise<TransactionObject>;
 ```
 
 where erc20Addresses is an array of token addresses, and amountChanges represents the token amounts for the deposit.
 
 6. Once a user’s balance is updated, they can perform any smart contract interaction:
 
-
 ```typescript
-    function actionPrivateWallet( erc20Addresses:string[], amountChanges:bigint[], onChainCreation:boolean[], ops:string[]): Promise<TransactionObject>;
+function actionPrivateWallet(
+  erc20Addresses: string[],
+  amountChanges: bigint[],
+  onChainCreation: boolean[],
+  ops: string[],
+): Promise<TransactionObject>;
 ```
 
 where onChainCreation indicates the amounts of tokens that are uncertain before the transaction is executed on-chain. The ops array is an encoded array of user operations.
@@ -72,15 +76,18 @@ Before interacting with Hinkal smart contracts, a user needs to mint an access t
 To check whether the user already has an access token, one can use the checkAccessToken function:
 
 ```typescript
-    function checkAccessToken(): Promise<boolean>;
+function checkAccessToken(): Promise<boolean>;
 ```
+
 If the user does not have an access token, one of the compliance providers should be used to pass the check. To view the available providers:
+
 ```typescript
-    function getSupportedPassportLinks(): string[];
+function getSupportedPassportLinks(): string[];
 ```
 
 Once the user has passed the check, they can mint an access token using:
+
 ```typescript
-    const { signatureData } = await hinkal.getAPI().getAccessTokenSignature(chainId, ethereumAddress, accessKey);
-    await mintAccessToken(this, signatureData);
-```
+const { signatureData } = await hinkal.getAPI().getAccessTokenSignature(chainId, ethereumAddress, accessKey);
+await mintAccessToken(this, signatureData);
+```