@inco/js 0.7.0 → 0.7.2

package/dist/cjs/lite/lightning.d.ts

@@ -1,11 +1,13 @@
-import { Account, Chain, PublicClient, Transport, WalletClient } from 'viem';
+import { Account, Chain, GetContractReturnType, PublicClient, Transport, WalletClient } from 'viem';
 import { AllowanceVoucherWithSig } from '../advancedacl/types.js';
 import { AttestedComputeOP } from '../attestedcompute/types.js';
 import { DecryptionAttestation, EncryptedDecryptionAttestation } from '../attesteddecrypt/index.js';
 import { Address, HexString } from '../binary.js';
-import { EciesScheme, Encryptor, SupportedFheType } from '../encryption/index.js';
+import { EciesScheme, SupportedFheType } from '../encryption/index.js';
+import { incoVerifierAbi } from '../generated/abis/verifier.js';
 import { lightningDeployments } from '../generated/lightning.js';
 import { localNodeLightningConfig } from '../generated/local-node.js';
+import { FheType } from '../handle.js';
 import { LocalNodeEnv } from '../local/index.js';
 import { BackoffConfig } from '../retry.js';
 import { Secp256k1Keypair } from './ecies.js';
@@ -22,6 +24,7 @@ export type SupportedNativeType = boolean | bigint | number;
 export type EncryptionContext = {
     accountAddress: string;
     dappAddress: string;
+    handleType: FheType;
 };
 export type DeploymentSlice = {
     executorAddress: string;
@@ -36,6 +39,11 @@ export type CustomConfig = {
     senderPrivateKey?: HexString;
 };
 export type CustomDeployment = DeploymentSlice & CustomConfig;
+export type IncoVerifierConfig = {
+    threshold: number;
+    signers: Address[];
+    eciesPubKey: HexString;
+};
 type LocalNodeEnvFileSource = {
     filePath: string;
 };
@@ -45,13 +53,15 @@ type LocalNodeEnvFileSource = {
  */
 export declare class Lightning<T extends DeploymentSlice = DeploymentSlice> {
     private readonly _deployment;
-    readonly covalidatorUrls: string[];
-    readonly signers: Address[];
-    readonly threshold: number;
+    private readonly covalidatorUrls;
+    private readonly signers;
+    private readonly threshold;
+    private readonly eciesPubKey;
     readonly executorAddress: Address;
     readonly chainId: bigint;
     private readonly ephemeralKeypair;
     private readonly kmsQuorumClient;
+    private readonly encryptor;
     private constructor();
     /**
      * Get a Lightning instance bound to the latest Lightning deployment for the Base Sepolia testnet.
@@ -92,7 +102,6 @@ export declare class Lightning<T extends DeploymentSlice = DeploymentSlice> {
      *    additional fields past will be made available as part of the `deployment` property.
      */
     static custom<T extends CustomConfig>(config: T): Promise<Lightning<DeploymentSlice & T>>;
-    static getEciesPublicKey(client: PublicClient, executorAddress: Address): Promise<HexString>;
     /**
      * Get the latest deployment for a given pepper, which usually denotes a family of deployments distinct from their
      * version such as 'devnet', 'testnet', 'mainnet', etc.
@@ -117,15 +126,13 @@ export declare class Lightning<T extends DeploymentSlice = DeploymentSlice> {
      * @param value a boolean or numeric value to encrypt
      * @param accountAddress the address of the account interacting with the dapp contract, normally an Externally Owned Account (EOA)
      * @param dappAddress the address of the dapp contract that interacts with the Inco Lightning contract or library
+     * @param handleType (optional) the handle type to be used for encrypting the value - this is required in case of non-default handle types
+     *                    default handle types:
+     *                      - boolean -> handleTypes.ebool
+     *                      - number | bigint -> handleTypes.euint256
+     * @returns a promise that resolves to the encrypted value as a HexString
      */
-    encrypt<T extends SupportedNativeType>(value: T, { accountAddress, dappAddress }: EncryptionContext, encryptor: Encryptor<EciesScheme>): Promise<HexString>;
-    /**
-     * Get the encryptor for a specific ECIES public key.
-     *
-     * @param eciesPubkey the ECIES public key to use for encryption
-     * @returns an Encryptor instance configured for the specified ECIES public key
-     */
-    getEncryptor(eciesPubkey: HexString): Encryptor<EciesScheme>;
+    encrypt<T extends SupportedNativeType>(value: T, { accountAddress, dappAddress, handleType }: EncryptionContext): Promise<HexString>;
     /**
      * Grants a session key allowance voucher for secure reencryption operations.
      *
@@ -198,6 +205,7 @@ export declare class Lightning<T extends DeploymentSlice = DeploymentSlice> {
      *
      * @param ephemeralKeypair Session keypair matching the voucher grantee.
      * @param allowanceVoucherWithSig Signed allowance voucher.
+     * @param ethClient - A public eth client or eth wallet client used for signing the attested decrypt request
      * @param handles Handles to decrypt.
      * @param options Optional reencryption/backoff configuration.
      *
@@ -206,6 +214,7 @@ export declare class Lightning<T extends DeploymentSlice = DeploymentSlice> {
      * const attestations = await lightning.attestedDecryptWithVoucher(
      *   ephemeralKeypair,
      *   voucher,
+     *   ethClient,
      *   [handle],
      * );
      * ```
@@ -215,14 +224,15 @@ export declare class Lightning<T extends DeploymentSlice = DeploymentSlice> {
      * const encrypted = await lightning.attestedDecryptWithVoucher(
      *   ephemeralKeypair,
      *   voucher,
+     *   ethClient,
      *   [handle],
      *   { reencryptPubKey: delegateKeypair.encodePublicKey() },
      * );
      * ```
      */
-    attestedDecryptWithVoucher(ephemeralKeypair: Secp256k1Keypair, allowanceVoucherWithSig: AllowanceVoucherWithSig, handles: HexString[], backoffConfig?: Partial<BackoffConfig>): Promise<Array<DecryptionAttestation<EciesScheme, SupportedFheType>>>;
-    attestedDecryptWithVoucher(ephemeralKeypair: Secp256k1Keypair, allowanceVoucherWithSig: AllowanceVoucherWithSig, handles: HexString[], reencryptPubKey: Uint8Array, backoffConfig?: Partial<BackoffConfig>): Promise<Array<EncryptedDecryptionAttestation<EciesScheme, SupportedFheType>>>;
-    attestedDecryptWithVoucher(ephemeralKeypair: Secp256k1Keypair, allowanceVoucherWithSig: AllowanceVoucherWithSig, handles: HexString[], reencryptPubKey: Uint8Array, reencryptKeypair: Secp256k1Keypair, backoffConfig?: Partial<BackoffConfig>): Promise<Array<DecryptionAttestation<EciesScheme, SupportedFheType>>>;
+    attestedDecryptWithVoucher(ephemeralKeypair: Secp256k1Keypair, allowanceVoucherWithSig: AllowanceVoucherWithSig, ethClient: PublicClient<Transport, Chain> | WalletClient<Transport, Chain, Account>, handles: HexString[], backoffConfig?: Partial<BackoffConfig>): Promise<Array<DecryptionAttestation<EciesScheme, SupportedFheType>>>;
+    attestedDecryptWithVoucher(ephemeralKeypair: Secp256k1Keypair, allowanceVoucherWithSig: AllowanceVoucherWithSig, ethClient: PublicClient<Transport, Chain> | WalletClient<Transport, Chain, Account>, handles: HexString[], reencryptPubKey: Uint8Array, backoffConfig?: Partial<BackoffConfig>): Promise<Array<EncryptedDecryptionAttestation<EciesScheme, SupportedFheType>>>;
+    attestedDecryptWithVoucher(ephemeralKeypair: Secp256k1Keypair, allowanceVoucherWithSig: AllowanceVoucherWithSig, ethClient: PublicClient<Transport, Chain> | WalletClient<Transport, Chain, Account>, handles: HexString[], reencryptPubKey: Uint8Array, reencryptKeypair: Secp256k1Keypair, backoffConfig?: Partial<BackoffConfig>): Promise<Array<DecryptionAttestation<EciesScheme, SupportedFheType>>>;
     /**
      * Get an attested compute for the given wallet client.
      *
@@ -233,7 +243,7 @@ export declare class Lightning<T extends DeploymentSlice = DeploymentSlice> {
      * @param backoffConfig - The backoff configuration for the attested compute request
      * @returns The decryption attestation
      *
-     * @example
+     * @example Plaintext result
      * ```typescript
      * import { AttestedComputeSupportedOps } from '../lite/attested-compute.js';
      * const lhsHandle = '0x...';
@@ -242,23 +252,80 @@ export declare class Lightning<T extends DeploymentSlice = DeploymentSlice> {
      * const response = await lightning.attestedCompute(walletClient, lhsHandle, op, rhsPlaintext);
      * const { plaintext, covalidatorSignature, handle } = response;
      * ```
+     *
+     * @example Reencrypt for a delegate
+     * ```ts
+     * const encrypted = await lightning.attestedCompute(
+     *   walletClient,
+     *   lhsHandle,
+     *   op,
+     *   rhsPlaintext,
+     *   delegatePubKey,
+     * );
+     * console.log(encrypted.encryptedPlaintext.ciphertext.value);
+     * ```
+     *
+     * @example Reencrypt and decrypt locally
+     * ```ts
+     * const decrypted = await lightning.attestedCompute(
+     *   walletClient,
+     *   lhsHandle,
+     *   op,
+     *   rhsPlaintext,
+     *   keypair.encodePublicKey(),
+     *   keypair,
+     * );
+     * console.log(decrypted.plaintext.value);
+     * ```
      */
     attestedCompute(walletClient: WalletClient<Transport, Chain, Account>, lhsHandle: HexString, op: AttestedComputeOP, rhsPlaintext: bigint | boolean, backoffConfig?: Partial<BackoffConfig>): Promise<DecryptionAttestation<EciesScheme, SupportedFheType>>;
+    attestedCompute(walletClient: WalletClient<Transport, Chain, Account>, lhsHandle: HexString, op: AttestedComputeOP, rhsPlaintext: bigint | boolean, reencryptPubKey: Uint8Array, backoffConfig?: Partial<BackoffConfig>): Promise<EncryptedDecryptionAttestation<EciesScheme, SupportedFheType>>;
+    attestedCompute(walletClient: WalletClient<Transport, Chain, Account>, lhsHandle: HexString, op: AttestedComputeOP, rhsPlaintext: bigint | boolean, reencryptPubKey: Uint8Array, reencryptKeypair: Secp256k1Keypair, backoffConfig?: Partial<BackoffConfig>): Promise<DecryptionAttestation<EciesScheme, SupportedFheType>>;
     /**
      * Performs attested compute via a voucher-backed session key.
      *
-     * @example
+     * @example Plaintext result
      * ```ts
      * const attestation = await lightning.attestedComputeWithVoucher(
      *   ephemeralKeypair,
      *   voucher,
+     *   ethClient,
      *   lhsHandle,
      *   AttestedComputeSupportedOps.Eq,
      *   true,
      * );
      * ```
+     *
+     * @example Reencrypt for a delegate
+     * ```ts
+     * const encrypted = await lightning.attestedComputeWithVoucher(
+     *   ephemeralKeypair,
+     *   voucher,
+     *   lhsHandle,
+     *   AttestedComputeSupportedOps.Eq,
+     *   true,
+     *   delegatePubKey,
+     * );
+     * console.log(encrypted.encryptedPlaintext.ciphertext.value);
+     * ```
+     *
+     * @example Reencrypt and decrypt locally
+     * ```ts
+     * const decrypted = await lightning.attestedComputeWithVoucher(
+     *   ephemeralKeypair,
+     *   voucher,
+     *   lhsHandle,
+     *   AttestedComputeSupportedOps.Eq,
+     *   true,
+     *   keypair.encodePublicKey(),
+     *   keypair,
+     * );
+     * console.log(decrypted.plaintext.value);
+     * ```
      */
-    attestedComputeWithVoucher(ephemeralKeypair: Secp256k1Keypair, allowanceVoucherWithSig: AllowanceVoucherWithSig, lhsHandle: HexString, op: AttestedComputeOP, rhsPlaintext: bigint | boolean, backoffConfig?: Partial<BackoffConfig>): Promise<DecryptionAttestation<EciesScheme, SupportedFheType>>;
+    attestedComputeWithVoucher(ephemeralKeypair: Secp256k1Keypair, allowanceVoucherWithSig: AllowanceVoucherWithSig, ethClient: PublicClient<Transport, Chain> | WalletClient<Transport, Chain, Account>, lhsHandle: HexString, op: AttestedComputeOP, rhsPlaintext: bigint | boolean, backoffConfig?: Partial<BackoffConfig>): Promise<DecryptionAttestation<EciesScheme, SupportedFheType>>;
+    attestedComputeWithVoucher(ephemeralKeypair: Secp256k1Keypair, allowanceVoucherWithSig: AllowanceVoucherWithSig, ethClient: PublicClient<Transport, Chain> | WalletClient<Transport, Chain, Account>, lhsHandle: HexString, op: AttestedComputeOP, rhsPlaintext: bigint | boolean, reencryptPubKey: Uint8Array, backoffConfig?: Partial<BackoffConfig>): Promise<EncryptedDecryptionAttestation<EciesScheme, SupportedFheType>>;
+    attestedComputeWithVoucher(ephemeralKeypair: Secp256k1Keypair, allowanceVoucherWithSig: AllowanceVoucherWithSig, ethClient: PublicClient<Transport, Chain> | WalletClient<Transport, Chain, Account>, lhsHandle: HexString, op: AttestedComputeOP, rhsPlaintext: bigint | boolean, reencryptPubKey: Uint8Array, reencryptKeypair: Secp256k1Keypair, backoffConfig?: Partial<BackoffConfig>): Promise<DecryptionAttestation<EciesScheme, SupportedFheType>>;
     /**
      * Get an decryption of publicly revealed handles.
      *
@@ -268,7 +335,7 @@ export declare class Lightning<T extends DeploymentSlice = DeploymentSlice> {
      *
      * @example
      * ```typescript
-     * const response = await lightning.attestedReveal([handle1, handle2]);
+     * const response = await lightning.attestedReveal([handle1, handle2], ethClient);
      * const { plaintext, covalidatorSignature } = response[0];
      * ```
      */
@@ -281,8 +348,17 @@ export declare class Lightning<T extends DeploymentSlice = DeploymentSlice> {
     }, threshold: number): string[];
     private static isIdByName;
     private static plaintextFromValue;
-    private static getContractThresholdAndSigners;
-    private static getThresholdAndSigners;
+    static getEciesPublicKey(client: PublicClient, executorAddress: Address): Promise<HexString>;
+    static getIncoVerifierContract(client: PublicClient, executorAddress: Address): Promise<GetContractReturnType<typeof incoVerifierAbi, PublicClient, Address>>;
+    /**
+     * Retrieves the verifier contract details including threshold, signers, and ECIES public key from the Inco Verifier contract.
+     *
+     * @param executorAddress The address of the Inco Lightning executor contract.
+     * @param client The public client to interact with the blockchain.
+     * @returns An object containing the threshold, signers, and ECIES public key.
+     */
+    private static getVerifierContractDetails;
+    private static getChainConfig;
     private static supportsThresholdRetrieval;
     private static getDefaultThresholdAndSigners;
 }