npm package: @sabaaa1/common
Description: Hinkal is 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 platforms such as Uniswap, Pendle, Lido,
Author: Hinkal Protocol
Latest version: 0.1.14

# Hinkal SDK

Hinkal is 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 platforms such as Uniswap, Pendle, Lido, Curve, and others.

This SDK enables users to perform arbitrary smart contract interactions privately.

## Installation

Using npm:

```sh
npm install @hinkal/common
```

Or, yarn:

```sh
yarn add @hinkal/common
```

### Usage

#### Initialization

To get started with Hinkal, initialize it based on the Web3 connection library you’re using:

**ethers.js:**

```typescript
import { prepareEthersHinkal } from '@hinkal/common/providers/prepareEthersHinkal';
// signer: ethers.Signer
const hinkal = await prepareEthersHinkal(signer);
```

**wagmi:**

```typescript
import { prepareWagmiHinkal } from '@hinkal/common/providers/prepareWagmiHinkal';
// connector: wagmi.Connector
// config: wagmi.Config
const hinkal = await prepareWagmiHinkal(connector, config);
```

#### Shielded balance

Once the Hinkal object is initialized, shielded balances become accessible and can be calculated as needed:

```typescript
const balances = await hinkal.getBalances();
```

#### Depositing funds to the shielded balance

A user can deposit funds to their shielded address using:

```typescript
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.

#### Interacting with smart contracts privately

After a user’s shielded balance is updated, they can perform any smart contract interaction privately using:

```typescript
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 contains encoded user operations.

##### User operations

To generate user operations (`ops`) you will need the `emporiumOp` function.
```typescript
import {emporiumOp} from "@hinkal/common";
```

The function accepts the following arguments:
  1. `endpoint` *(required)* - target address or contract instance (with address). The contract instance will be used to properly encode the call function, if any, in the custom operation.
  2. `func` *(optional)* - the name of the function to be called on the target address.
  3. `args` *(optional)* - arguments of the function to be called on the target address.
  4. `invokeWallet` *(optional)* - bool flag that determines the type of transaction. There are two types: stateful and stateless interaction. The default is false (stateless).
  5. `value` *(optional)* - the amount of native currency to transfer to the target address.

The `emporiumOp` function will generate data for subsequent calls, supporting both stateful interaction (with state preservation) and stateless interaction (without state preservation). This is determined by the `invokeWallet` flag.

To execute on a smart contract, the user operation will be received in the following format:
```solidity
(address endpoint, bool invokeWallet, uint256 value, bytes data)
```

This will make it possible to make that kind of call:
```solidity
(bool success, bytes memory err) = endpoint.call{value: value}(data);
```

##### Stateless and stateful

The best way to demonstrate how this works is with an example.

**Stateless interaction**

Let's say we need to exchange USDC for ETH using DEX. 

```typescript
const operations = [
  emporiumOp(usdcContractInstance, 'approve', [swapRouterAddress, amountIn]),
  emporiumOp(swapRouterContractInstance, 'exactInputSingle', [swapSingleParams]),
  emporiumOp(wethContractInstance, 'withdraw', [amountOut]),
];
```

To perform a DEX swap, DEX does not need to know historical data about the calling party (e.g. when and what swaps have been performed from this account in the past). It only needs the current token balance for the exchange.

In this case it will be **stateless interaction**, so there is no need to change the default value of the `invokeWallet` flag.

**Stateful interaction**

Another example is when the protocol with which an account interacts needs to know what actions this account has done before, for example, to gain rewards. In this case, some account state will be required.

Let's imagine that you already have Curve LP tokens and need to make a stake.

```solidity
const operations = [
  emporiumOp(lpTokenInstance, 'approve', [gaugeAddressInstance, amount]), // without flag, because is's stateless interaction
  emporiumOp(gaugeAddressInstance, 'deposit', [amount, invokeWalletAddress], true), // with flag, because it's stateful interaction
];
```

As you can see, in this case `approve` is a stateless interaction, but `deposit` is a stateful interaction, because under the hood Curve will record this address and timestamp in order to calculate the checkpoint correctly in the future.

### Access Tokens

Before interacting with Hinkal smart contracts, users need to mint an access token after passing compliance checks.

To check whether a user already has an access token, use the checkAccessToken function:

```typescript
function checkAccessToken(): Promise<boolean>;
```

If the user does not have an access token, they must use one of the compliance providers to pass the check. To view the available providers:

```typescript
function getSupportedPassportLinks(): string[];
```

After passing the compliance check, the user can mint an access token using:

```typescript
const { signatureData } = await hinkal.getAPI().getAccessTokenSignature(chainId, ethereumAddress, accessKey);
await mintAccessToken(this, signatureData);
```

### References

Application: [Hinkal](https://app.hinkal.pro)
Docs: [Hinkal Documentation](https://hinkal-team.gitbook.io/hinkal)