Class FhenixClient

constructor

• new FhenixClient(params): FhenixClient

• Creates an instance of FhenixClient. Initializes the fhevm library if needed and retrieves the public key for encryption from the provider.

  Parameters

  • params: InstanceParams

    Parameters to initialize the client.

  Returns FhenixClient

fhePublicKey

encrypt

• encrypt(value, type?): Promise<EncryptedNumber>

• Encrypts a numeric value according to the specified encryption type or the most efficient one based on the value.

  Parameters

  • value: number

    The numeric value to encrypt.

  • Optional type: EncryptionTypes

    Optional. The encryption type (uint8, uint16, uint32).

  Returns Promise<EncryptedNumber>

  • The encrypted value serialized as Uint8Array. Use the .data property to access the Uint8Array.

encrypt_address

• encrypt_address(value): Promise<EncryptedAddress>

• Encrypts an Address (Uint160) value using the stored public key.

  Parameters

  • value: string | bigint

    The Address (Uint160) value to encrypt.

  Returns Promise<EncryptedAddress>

  • The encrypted value serialized as EncryptedAddress. Use the .data property to access the Uint8Array.

encrypt_bool

• encrypt_bool(value): Promise<EncryptedBool>

• Encrypts a Uint8 value using the stored public key.

  Parameters

  • value: boolean

    The Uint8 value to encrypt.

  Returns Promise<EncryptedBool>

  • The encrypted value serialized as EncryptedUint8. Use the .data property to access the Uint8Array.

encrypt_uint128

• encrypt_uint128(value): Promise<EncryptedUint128>

• Encrypts a Uint128 value using the stored public key.

  Parameters

  • value: string | bigint

    The Uint128 value to encrypt.

  Returns Promise<EncryptedUint128>

  • The encrypted value serialized as EncryptedUint128. Use the .data property to access the Uint8Array.

encrypt_uint16

• encrypt_uint16(value): Promise<EncryptedUint16>

• Encrypts a Uint16 value using the stored public key.

  Parameters

  • value: number

    The Uint16 value to encrypt.

  Returns Promise<EncryptedUint16>

  • The encrypted value serialized as EncryptedUint16. Use the .data property to access the Uint8Array.

encrypt_uint256

• encrypt_uint256(value): Promise<EncryptedUint256>

• Encrypts a Uint256 value using the stored public key.

  Parameters

  • value: string | bigint

    The Uint256 value to encrypt.

  Returns Promise<EncryptedUint256>

  • The encrypted value serialized as EncryptedUint256. Use the .data property to access the Uint8Array.

encrypt_uint32

• encrypt_uint32(value): Promise<EncryptedUint32>

• Encrypts a Uint32 value using the stored public key.

  Parameters

  • value: number

    The Uint32 value to encrypt.

  Returns Promise<EncryptedUint32>

  • The encrypted value serialized as EncryptedUint32. Use the .data property to access the Uint8Array.

encrypt_uint64

• encrypt_uint64(value): Promise<EncryptedUint64>

• Encrypts a Uint64 value using the stored public key.

  Parameters

  • value: string | bigint

    The Uint32 value to encrypt.

  Returns Promise<EncryptedUint64>

  • The encrypted value serialized as EncryptedUint64. Use the .data property to access the Uint8Array.

encrypt_uint8

• encrypt_uint8(value): Promise<EncryptedUint8>

• Encrypts a Uint8 value using the stored public key.

  Parameters

  • value: number

    The Uint8 value to encrypt.

  Returns Promise<EncryptedUint8>

  • The encrypted value serialized as EncryptedUint8. Use the .data property to access the Uint8Array.

exportPermits

• exportPermits(): ContractPermits

• Exports all stored permits.

  Returns ContractPermits

  • All stored permits.

extractPermitPermission

• extractPermitPermission(permit): Permission

• Parameters

  • permit: Permit

  Returns Permission

generatePermit

• generatePermit(contractAddress, provider?, signer?): Promise<Permit>

• Creates a new permit for a specific contract address. Also saves the permit to localstorage (if available)

  Parameters

  • contractAddress: string

    The address of the contract.

  • Optional provider: SupportedProvider

    The provider from which to sign the permit - must container a signer.

  • Optional signer: PermitSigner

    the signer to use to sign the permit if provider does not support signing (e.g. hardhat)

  Returns Promise<Permit>

  Permit - The permit associated with the contract address.

  Throws

  • If the provider does not contain a signer, or if a provider is not set

getPermit

• getPermit(contractAddress, account): undefined | Permit

• Retrieves the stored permit for a specific contract address.

  Parameters

  • contractAddress: string

    The address of the contract.

  • account: string

    The address of the user account.

  Returns undefined | Permit

  • The permit associated with the contract address.

hasPermit

• hasPermit(contractAddress): boolean

• Checks if a permit exists for a specific contract address.

  Parameters

  • contractAddress: string

    The address of the contract.

  Returns boolean

  • True if a permit exists, false otherwise.

removePermit

• removePermit(contractAddress): void

• Removes a stored permit for a specific contract address.

  Parameters

  • contractAddress: string

    The address of the contract.

  Returns void

storePermit

• storePermit(permit): void

• Stores a permit for a specific contract address. Will overwrite any existing permit for the same contract address. Does not store the permit in localstorage (should it?)

  Parameters

  • permit: Permit

    The permit to store.

  Returns void

unseal

• unseal(contractAddress, ciphertext): bigint

• Unseals an encrypted message using the stored permit for a specific contract address.

  Parameters

  • contractAddress: string

    The address of the contract.

  • ciphertext: string

    The encrypted message to unseal.

  Returns bigint

  bigint - The unsealed message.