Class FhenixClientSync

The FhenixClientSync class provides functionalities to interact with a FHE (Fully Homomorphic Encryption) system. It includes methods for encryption, unsealing, and managing permits.

The Sync FhenixClient allows the client.encrypt_<xxxx>() functions to be performed synchronously

Note

The Sync FhenixClient must be created using await FhenixClientSync.create({provider}) instead of new FhenixClient({provider})

Hierarchy

FhenixClientBase
- FhenixClientSync

Constructors

constructor

new FhenixClientSync(params): FhenixClientSync
Parameters
- params: InstanceParamsWithFhePublicKeys
Returns FhenixClientSync
Overrides FhenixClientBase.constructor
- Defined in sdk/index.ts:597

Properties

fhePublicKeys

fhePublicKeys: (undefined | TfheCompactPublicKey)[] = []

Methods

encrypt

encrypt(value, type?, securityZone?): EncryptedNumber
Parameters
- value: number
- Optional type: EncryptionTypes
- securityZone: number = 0
Returns EncryptedNumber
Overrides FhenixClientBase.encrypt
- Defined in sdk/index.ts:726

encrypt_address

encrypt_address(value, securityZone?): EncryptedAddress
Parameters
- value: string | bigint
- securityZone: number = 0
Returns EncryptedAddress
Overrides FhenixClientBase.encrypt_address
- Defined in sdk/index.ts:714

encrypt_bool

encrypt_bool(value, securityZone?): EncryptedBool
Parameters
- value: boolean
- securityZone: number = 0
Returns EncryptedBool
Overrides FhenixClientBase.encrypt_bool
- Defined in sdk/index.ts:647

encrypt_uint128

encrypt_uint128(value, securityZone?): EncryptedUint128
Parameters
- value: string | bigint
- securityZone: number = 0
Returns EncryptedUint128
Overrides FhenixClientBase.encrypt_uint128
- Defined in sdk/index.ts:690

encrypt_uint16

encrypt_uint16(value, securityZone?): EncryptedUint16
Parameters
- value: number
- securityZone: number = 0
Returns EncryptedUint16
Overrides FhenixClientBase.encrypt_uint16
- Defined in sdk/index.ts:661

encrypt_uint256

encrypt_uint256(value, securityZone?): EncryptedUint256
Parameters
- value: string | bigint
- securityZone: number = 0
Returns EncryptedUint256
Overrides FhenixClientBase.encrypt_uint256
- Defined in sdk/index.ts:702

encrypt_uint32

encrypt_uint32(value, securityZone?): EncryptedUint32
Parameters
- value: number
- securityZone: number = 0
Returns EncryptedUint32
Overrides FhenixClientBase.encrypt_uint32
- Defined in sdk/index.ts:669

encrypt_uint64

encrypt_uint64(value, securityZone?): EncryptedUint64
Parameters
- value: string | bigint
- securityZone: number = 0
Returns EncryptedUint64
Overrides FhenixClientBase.encrypt_uint64
- Defined in sdk/index.ts:678

encrypt_uint8

encrypt_uint8(value, securityZone?): EncryptedUint8
Parameters
- value: number
- securityZone: number = 0
Returns EncryptedUint8
Overrides FhenixClientBase.encrypt_uint8
- Defined in sdk/index.ts:652

exportPermits

exportPermits(): ContractPermits
Exports all stored permits.

Returns ContractPermits
- All stored permits.
Inherited from FhenixClientBase.exportPermits
- Defined in sdk/index.ts:325

extractPermitPermission

extractPermitPermission(permit): Permission
Parameters
- permit: Permit
Returns Permission
Inherited from FhenixClientBase.extractPermitPermission
- Defined in sdk/index.ts:329

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
Inherited from FhenixClientBase.generatePermit
- Defined in sdk/index.ts:214

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.
Inherited from FhenixClientBase.getPermit
- Defined in sdk/index.ts:258

hasPermit

hasPermit(contractAddress, account): boolean
Checks if a permit exists for a specific contract address.
Parameters
- contractAddress: string
  The address of the contract.
- account: string
  The account address attached to the stored permits
Returns boolean
- True if a permit exists, false otherwise.
Inherited from FhenixClientBase.hasPermit
- Defined in sdk/index.ts:311

loadAllPermitsFromLocalStorage

loadAllPermitsFromLocalStorage(account): Record<string, Permit>
Retrieves all stored permits for a specific account.
Parameters
- account: string
  The address of the user account.
Returns Record<string, Permit>
- The permits associated with each contract address.
Inherited from FhenixClientBase.loadAllPermitsFromLocalStorage
- Defined in sdk/index.ts:273

removePermit

removePermit(contractAddress, account): void
Removes a stored permit for a specific contract address.
Parameters
- contractAddress: string
  The address of the contract.
- account: string
  The account address of the permit.
Returns void
Inherited from FhenixClientBase.removePermit
- Defined in sdk/index.ts:298

storePermit

storePermit(permit, account): 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.
- account: string
Returns void
Inherited from FhenixClientBase.storePermit
- Defined in sdk/index.ts:288

unseal

unseal(contractAddress, ciphertext, account): 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.
- account: string
  The account attached to existing permits.
Returns bigint
bigint - The unsealed message.
Inherited from FhenixClientBase.unseal
- Defined in sdk/index.ts:191

`Static` create

create(params): Promise<FhenixClientSync>
Parameters
- params: InstanceParams & {
  securityZones?: number[];
  }
Returns Promise<FhenixClientSync>
- Defined in sdk/index.ts:603

`Static` getFheKeyFromProvider

getFheKeyFromProvider(provider, securityZone?): Promise<TfheCompactPublicKey>
Retrieves the FHE public key from the provider.
Parameters
- provider: SupportedProvider
  The provider from which to retrieve the key.
- securityZone: number = 0
  The security zone for which to retrieve the key (default 0).
Returns Promise<TfheCompactPublicKey>
- The retrieved public key.
Inherited from FhenixClientBase.getFheKeyFromProvider
- Defined in sdk/index.ts:344

Class FhenixClientSync

Note

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FhenixClientSync

Properties

fhePublicKeys

Methods

encrypt

Parameters

Returns EncryptedNumber

encrypt_address

Parameters

Returns EncryptedAddress

encrypt_bool

Parameters

Returns EncryptedBool

encrypt_uint128

Parameters

Returns EncryptedUint128

encrypt_uint16

Parameters

Returns EncryptedUint16

encrypt_uint256

Parameters

Returns EncryptedUint256

encrypt_uint32

Parameters

Returns EncryptedUint32

encrypt_uint64

Parameters

Returns EncryptedUint64

encrypt_uint8

Parameters

Returns EncryptedUint8

exportPermits

Returns ContractPermits

extractPermitPermission

Parameters

Returns Permission

generatePermit

Parameters

Returns Promise<Permit>

Throws

getPermit

Parameters

Returns undefined | Permit

hasPermit

Parameters

Returns boolean

loadAllPermitsFromLocalStorage

Parameters

Returns Record<string, Permit>

removePermit

Parameters

Returns void

storePermit

Parameters

Returns void

unseal

Parameters

Returns bigint

Static create

Parameters

Returns Promise<FhenixClientSync>

Static getFheKeyFromProvider

Parameters

Returns Promise<TfheCompactPublicKey>

Settings

Member Visibility

Theme

On This Page

`Static` create

`Static` getFheKeyFromProvider