@inco/js 0.1.21 → 0.1.23

package/dist/lite/lightning.d.ts

@@ -0,0 +1,99 @@
+import { Account, Chain, Transport, WalletClient } from 'viem';
+import { HexString } from '../binary';
+import { EciesScheme } from '../encryption';
+import { lightningDeployments } from '../generated/lightning';
+import { LocalNodeEnv } from '../local';
+import type { Reencryptor } from '../reencryption';
+type TupleToUnion<T> = T extends readonly unknown[] ? T[number] : never;
+type ToBigInt<T extends string> = T extends `${infer N extends bigint}` ? N : never;
+type ValuesToBigInt<T> = {
+    [K in keyof T]: T[K] extends string ? ToBigInt<T[K]> : never;
+};
+type DistributedToBigInt<T, K> = T extends infer U ? K extends keyof U ? Omit<U, K> & (ValuesToBigInt<Pick<U, K>> | Pick<U, K>) : never : never;
+type Deployment = TupleToUnion<typeof lightningDeployments>;
+type DeploymentWithBigIntChainId = DistributedToBigInt<Deployment, 'chainId'>;
+type DistributedPick<T, K> = T extends any ? Pick<T, Extract<keyof T, K>> : never;
+export type DeploymentByName = DistributedPick<DeploymentWithBigIntChainId, 'name' | 'chainId'>;
+export type DeploymentByExecutor = DistributedPick<DeploymentWithBigIntChainId, 'executorAddress' | 'chainId'>;
+export type DeploymentId = DeploymentByName | DeploymentByExecutor;
+export type Pepper = Deployment['pepper'];
+export type ChainId = ToBigInt<Deployment['chainId']>;
+export type SupportedNativeType = boolean | bigint | number;
+export type EncryptionContext = {
+    accountAddress: string;
+    dappAddress: string;
+};
+export type DeploymentSlice = {
+    executorAddress: string;
+    eciesPublicKey: string;
+    chainId: string;
+};
+/**
+ * The Lightning class provides a convenient way to interact with the Inco Lightning contract by binding to a specific
+ * deployment.
+ */
+export declare class Lightning<T extends DeploymentSlice> {
+    private readonly _deployment;
+    readonly covalidatorUrl: string;
+    private readonly encryptor;
+    private readonly ephemeralKeypair;
+    private readonly kmsClient;
+    constructor(_deployment: T, covalidatorUrl: string);
+    /**
+     * Get a Lightning deployment by name or executor address on a particular chain.
+     *
+     * @param id this is an object containing either the pair of name and chainId or the executorAddress and chainId
+     */
+    static at(id: DeploymentId): Lightning<Deployment>;
+    static local({ EXECUTOR_ADDRESS, ECIES_PUBLIC_KEY }: LocalNodeEnv, { chainId, covalidatorUrl }: {
+        chainId: bigint;
+        covalidatorUrl: string;
+    }): Lightning<DeploymentSlice>;
+    /**
+     * 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.
+     *
+     * @param pepper the pepper to use to filter the deployments
+     * @param chainId the chainId to use to filter the deployments
+     */
+    static latestDeployment<P extends Pepper>(pepper: P, chainId: ChainId): Deployment;
+    /**
+     * Get the latest Lightning deployment for a given pepper amd chainId unconditionally.
+     * Note that if you upgrade the library the latest deployment may change and contracts deployed to a previous version
+     * will not be compatible with the new version.
+     *
+     * @param pepper the pepper to use to filter the deployments
+     * @param chainId the chainId to use to filter the deployments
+     */
+    static latest<P extends Pepper>(pepper: P, chainId: ChainId): Lightning<Deployment>;
+    get deployment(): T;
+    /**
+     * Get the chainId of the deployment to which this Lightning instance is bound.
+     */
+    get chainId(): bigint;
+    /**
+     * Encrypt a value using the public ECIES key of the Lightning deployment.
+     *
+     * @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
+     */
+    encrypt<T extends SupportedNativeType>(value: T, { accountAddress, dappAddress }: EncryptionContext): Promise<HexString>;
+    /**
+     * Obtain a reencryptor for a particular Externally Owned Account (EOA) to request decrypted values.
+     * The account associated with the walletClient must have permissions to decrypt the handle or ciphertext passed
+     * to the reencryptor function.
+     *
+     * @param walletClient the wallet client to use for signing the reencrypt request.
+     */
+    getReencryptor(walletClient: WalletClient<Transport, Chain, Account>): Promise<Reencryptor<EciesScheme>>;
+    /**
+     * Get the GRPC endpoint for the covalidator that services this deployment.
+     */
+    static getCovalidatorUrl(deployment: DeploymentSlice & {
+        pepper: string;
+    }): string;
+    private static isIdByName;
+    private static plaintextFromValue;
+}
+export {};