useEncryptedBalance

The useEncryptedBalance hook provides developers with an interface to manage encrypted token balances within the eERC protocol. This includes accessing decrypted and encrypted balances, as well as performing key actions such as minting, burning, transferring tokens, and fetching updated balance data. The hook is designed to simplify balance management while leveraging the protocol's encryption and privacy features.

Usage

const { useEncryptedBalance } = useEERC(...);
const {
	decryptedBalance,
	parsedDecryptedBalance,
	encryptedBalance,
	auditorPublicKey,
	decimals,
	
	// actions
	privateMint,
	privateBurn,
	privateTransfer,
	withdraw,
	deposit,
	refetchBalance
} = useEncryptedBalance(tokenAddress?:string)

Parameters

• tokenAddress (optional) : `0x${string}` The address of the underlying ERC20 token. This parameter is only required in converter mode.

Returns

• decryptedBalance: bigint The user's decrypted token balance

• parsedDecryptedBalance: string The user's decrypted token balance as a string.

• auditorPublicKey: bigint[] Auditor Public key

• encryptedBalance: bigint[] Encrypted balance of the user as an array

• decimals: bigint Encrypted token decimals

Methods

• privateMint(recipient: string, amount: bigint): Promise<{ transactionHash: string }> Mints encrypted tokens for a specified recipient address. This action can only be performed by the contract owner.

• privateBurn(amount: bigint): Promise<{ transactionHash: string }> Burns a specified amount of encrypted tokens from the user's balance.

• privateTransfer(to: string, amount: bigint): Promise<{ transactionHash: string, receiverEncryptedAmount: string[], senderEncryptedAmount: string[] }> Transfers encrypted tokens to another user.

• withdraw(amount: bigint): Promise<{ transactionHash: string }> Withdraws a specified amount of tokens from the user's balance to underlying ERC20 token address. Only available in converter mode.

• deposit(amount: bigint): Promise<{ transactionHash: string }> Convers a specified amount of ERC20 tokens to private Encrypted ERC tokens. Only available in converter mode.

• refetchBalance(): void Refetches and updates the user's encrypted and decrypted balances from the contract.