@hinkal/common 0.0.100 → 0.0.102

package/README.md

@@ -1,8 +1,8 @@
 # Hinkal 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.
+Hinkal is a middleware and a set of smart contracts on EVM chains that use 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.
+This SDK allows users to perform arbitrary smart contract interactions privately.
 
 ### Installation
 
@@ -20,7 +20,7 @@ yarn add @hinkal/common
 
 ### Usage
 
-1. Step: import hinkal from @hinkal/common package and initiate a Hinkal instance:
+1. Import hinkal from @hinkal/common package and initiate a Hinkal instance:
 
 ```sh
    import {Hinkal} from '@hinkal/common';
@@ -28,38 +28,59 @@ yarn add @hinkal/common
    const hinkal = new Hinkal<Connector>();
 ```
 
-2. Initiate ProviderAdapter object, where connector should be 'wagmi' Connector instance
+2. Initialize a ProviderAdapter object, where the connector should be an instance of the wagmi Connector.
 
 ```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
+3. Prompt a user to generate their shielded address and fetch the state from the smart contract.
 
 ```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 a user has generated a shielded address, the shielded balances become available and can be displayed on the front end:
 
 ```typescript
 const balances = await hinkal.getBalances();
 ```
 
-5. A user can deposit to his shielded account using:
+5. A user can deposit to their shielded account using:
 
 ```typescript
-    hinkal.deposit(erc20addresses:string[],amountChanges:bigint[]);
+    hinkal.deposit(erc20addresses:string[],amountChanges:bigint[]): Promise<TransactionObject>;
 ```
 
-where erc20Addresses is array of token addresses and amountChanges - token amounts for the deposit.
+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:
 
-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[]);
+    hinkal.actionPrivateWallet( erc20Addresses:string[], amountChanges:bigint[], onChainCreation:boolean[], ops:string[]): Promise<TransactionObject>;
 ```
 
-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 the amounts of tokens that are uncertain before the transaction is executed on-chain. The ops array is an encoded array of user operations.
+
+### Access Tokens
+
+Before interacting with Hinkal smart contracts, a user needs to mint an access token after passing compliance checks.
+
+To check whether the user already has an access token, one can use the checkAccessToken function:
+
+```typescript
+    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[];
+```
+
+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);
+```

package/assets/{snarkjsWorkerLogic-D1WyqRQr.js → snarkjsWorkerLogic-CatB8Hso.js}

@@ -1,5 +1,5 @@
-import { a as Qi } from "./zkProofWorkerLogic-Doz4ARB3.js";
-import "./zkProofWorkerLauncher-D86Xs1_B.js";
+import { a as Qi } from "./zkProofWorkerLogic-CLpRqNRx.js";
+import "./zkProofWorkerLauncher-C-pvCm0b.js";
 const Pi = [0, 1, 2, 2, 3, 3, 3, 3, 4, 4, 4, 4, 4, 4, 4, 4];
 function Xn(c, t) {
   if (!t || t == 10)

package/assets/{utxoWorkerLogic-BUjkvmsS.js → utxoWorkerLogic-DDqTe7hT.js}

@@ -1,5 +1,5 @@
-import { U as l, d as p, a as T, b as f, c as I, e as y, l as h, p as m } from "./zkProofWorkerLogic-Doz4ARB3.js";
-import "./zkProofWorkerLauncher-D86Xs1_B.js";
+import { U as l, d as p, a as T, b as f, c as I, e as y, l as h, p as m } from "./zkProofWorkerLogic-CLpRqNRx.js";
+import "./zkProofWorkerLauncher-C-pvCm0b.js";
 const U = (e) => {
   const t = p.decode(
     ["uint256", "address", "tuple(uint256, uint256, uint256, uint256)", "uint256", "uint256"],

package/assets/{viteWorkerURL.constant-TBsXLMNi.js → viteWorkerURL.constant-DrIQXA2B.js}

@@ -1,5 +1,5 @@
-import { W as r } from "./zkProofWorkerLogic-Doz4ARB3.js";
-import "./zkProofWorkerLauncher-D86Xs1_B.js";
+import { W as r } from "./zkProofWorkerLogic-CLpRqNRx.js";
+import "./zkProofWorkerLauncher-C-pvCm0b.js";
 var o = self.location.href, e = "" + new URL("snarkjsWorkerLauncher-fuD5h_j0.js", import.meta.url).href, a = "" + new URL("utxoWorkerLauncher-TRT6Cdzd.js", import.meta.url).href;
 const n = {
   [r.ZKProof]: o,

package/assets/{zkProofWorkerLauncher-D86Xs1_B.js → zkProofWorkerLauncher-C-pvCm0b.js}

@@ -1190,7 +1190,7 @@ const et = () => {
 };
 globalThis.process = tt;
 globalThis.Buffer = xr.Buffer;
-const nt = import("./zkProofWorkerLogic-Doz4ARB3.js").then(function(f) {
+const nt = import("./zkProofWorkerLogic-CLpRqNRx.js").then(function(f) {
   return f.z;
 });
 addEventListener("message", async (f) => {