@inco/js 0.2.16 → 0.3.0

package/dist/esm/generated/ts/inco/fhe/v1/types.d.ts

@@ -0,0 +1,225 @@
+import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
+export declare const protobufPackage = "inco.fhe.v1";
+/**
+ * FheType represents the type of the plaintext encrypted in either in the FHE
+ * or the TEE ciphertext.
+ * For compatibility with Zama's FheType, we use the same values.
+ * ref: https://github.com/zama-ai/kms-core/blob/fcc54ba0933e6190d8e8091ef495bcf437c06f6a/core/grpc/proto/kms.v1.proto#L32
+ */
+export declare enum FheType {
+    FHE_TYPE_EBOOL = 0,
+    FHE_TYPE_EUINT4 = 1,
+    FHE_TYPE_EUINT8 = 2,
+    FHE_TYPE_EUINT16 = 3,
+    FHE_TYPE_EUINT32 = 4,
+    FHE_TYPE_EUINT64 = 5,
+    FHE_TYPE_EUINT128 = 6,
+    FHE_TYPE_EUINT160 = 7,
+    FHE_TYPE_EUINT256 = 8,
+    FHE_TYPE_EUINT512 = 9,
+    FHE_TYPE_EUINT1024 = 10,
+    FHE_TYPE_EUINT2048 = 11,
+    UNRECOGNIZED = -1
+}
+export declare function fheTypeFromJSON(object: any): FheType;
+export declare function fheTypeToJSON(object: FheType): string;
+/**
+ * TypedCiphertext represents a ciphertext with its type and handle.
+ * This type is inspired from Zama's TypedCiphertext:
+ * ref: https://github.com/zama-ai/kms-core/blob/fcc54ba0933e6190d8e8091ef495bcf437c06f6a/core/grpc/proto/kms.v1.proto#L180-L187
+ *
+ * The encryption and format of the encrypted plaintext must be specified at the site of its use.
+ */
+export interface TypedCiphertext {
+    /** The actual ciphertext to decrypt, taken directly from the fhevm. */
+    ciphertext: Uint8Array;
+    /** The type of plaintext encrypted. */
+    fheType: FheType;
+    /**
+     * The handle of the ciphertext.
+     * TODO scalar declaration.
+     */
+    handle: string;
+}
+/** Covalidator represents a covalidator that can vote on the CA Root. */
+export interface Covalidator {
+    /** inco_address is the Cosmos bech32 address of the covalidator. */
+    incoAddress: string;
+    /**
+     * grpc_url is the gRPC endpoint of the covalidator, in the format
+     * "host:port".
+     */
+    grpcUrl: string;
+}
+/** KeysetInfo represents information on how to retrieve the keyset from the KMS. */
+export interface KeysetInfo {
+    /**
+     * id is the unique identifier of the keyset. It is a 20-byte hash
+     * represented as a hex string with no prefix.
+     * More specification of the keyset ID can be found in Zama's
+     * documentation:
+     * https://github.com/zama-ai/kms-core/blob/v0.9.0-rc3/config/dev/README.md#kms-key-id
+     */
+    id: string;
+    /**
+     * kms_grpc_url is the gRPC endpoint of the KMS that manages the keyset, in
+     * the format "host:port". They keyset can be retrieved via the
+     * inco.kms.*.v1.KmsService#Key RPC method.
+     */
+    kmsGrpcUrl: string;
+}
+/**
+ * FheEnv represents the environment in which the FHE keys are used, which is
+ * composed of a host chain and a keyset.
+ */
+export interface FheEnv {
+    /**
+     * host_chain_id is the chain ID of the host chain. See the x/hostchain module
+     * for a specification of the chain ID.
+     */
+    hostChainId: string;
+    /** keyset_id is the unique identifier of the keyset. */
+    keysetId: string;
+    /** zama_access_control is the access control configuration for Zama's ACL. */
+    zamaAccessControl?: ZamaAccessControl | undefined;
+    /** inco_lite_access_control is the access control configuration for IncoLite. */
+    incoLiteAccessControl?: IncoLiteAccessControl | undefined;
+}
+/**
+ * ZamaAccessControl represents the access control configuration used by Zama.
+ * It is characterized by having separate storage slots for decryption,
+ * reencryption, and delegated reencryption.
+ */
+export interface ZamaAccessControl {
+    /**
+     * acl_address is the host chain address of the ACL contract to use for
+     * verifying the ACL proof. For EVM chains it's a non-prefixed hex string.
+     */
+    aclAddress: string;
+    /**
+     * decryption_storage_index is the storage slot of the ACL contract to use for
+     * verifying decyrption. It is usually called `allowedForDecryption` in the
+     * ACL.sol contract. It is encoded as a non-prefixed hex string.
+     *
+     * The Solidity type at this storage is expected to be:
+     * mapping(uint256 => bool)
+     */
+    decryptionStorageIndex: string;
+    /**
+     * reencryption_storage_index is the storage slot of the ACL contract to use
+     * for verifying reencryption. It is usually called `persistedAllowedPairs`
+     * in the ACL.sol contract. It is encoded as a non-prefixed hex string.
+     *
+     * The Solidity type at this storage is expected to be:
+     * mapping(uint256 handle => mapping(address account => bool isAllowed))
+     */
+    reencryptionStorageIndex: string;
+    /**
+     * delegations_storage slot is the storage slot of the ACL contract to use
+     * for verifying reencryptions using delegations. It is usually called
+     * `delegates` in the ACL.sol contract. It is encoded as a non-prefixed hex
+     * string.
+     *
+     * The Solidity type at this storage is expected to be:
+     * mapping(address account => mapping(address delegatee => mapping(address
+     * contractAddress => bool isDelegate)))
+     */
+    delegationsStorageIndex: string;
+}
+/**
+ * IncoLiteAccessControl represents the access control configuration used by
+ * IncoLite, which is empty.
+ */
+export interface IncoLiteAccessControl {
+}
+/** CARoot represents the CA Root that is voted on by the covalidators. */
+export interface CARoot {
+    /** hash is the CA Root hash that was voted on. */
+    hash: Uint8Array;
+}
+/** FheEnvBlock represents a specific host chain block in a specific FHE environment. */
+export interface FheEnvBlock {
+    /**
+     * host_chain_id is the chain ID of the host chain. See the x/hostchain module
+     * for a specification of the chain ID.
+     */
+    hostChainId: string;
+    /** keyset_id is the unique identifier of the keyset. */
+    keysetId: string;
+    /**
+     * block_hash is the block hash of the host chain.
+     * The hash is 0x-prefixed hex bytes.
+     * TODO scalar declaration.
+     */
+    blockHash: string;
+    /** block_height is the block height of the block. */
+    blockHeight: number;
+}
+/** BlockTopo represents the topology information for a host chain block. */
+export interface BlockTopo {
+    /**
+     * parent_hash is the block hash of this block's parent, or empty if unknown.
+     * If present, the parent block's height must be height-1.
+     * The hash is 0x-prefixed hex bytes.
+     * TODO scalar declaration.
+     */
+    parentHash: string;
+}
+/**
+ * BlockTopoStore represents the topology information for a host chain block,
+ * optimized for storage.
+ */
+export interface BlockTopoStore {
+    /**
+     * parent_hash is the block hash of this block's parent, or empty if unknown.
+     * If present, the parent block's height must be height-1.
+     */
+    parentHash: Uint8Array;
+}
+/** HandleBinding is the information bound to a ciphertext handle through covalidator consensus. */
+export interface HandleBinding {
+    /** ciphertext_hash is the TODO-Algorithm-TODO hash of the ciphertext. */
+    ciphertextHash: Uint8Array;
+}
+/** HandleBindingEntry is a handle together with its HandleBinding. */
+export interface HandleBindingEntry {
+    /**
+     * handle is the ciphertext handle for this entry.
+     * The handle is 0x-prefixed hex bytes.
+     * TODO scalar declaration.
+     */
+    handle: string;
+    /** binding is the HandleBinding for the handle. */
+    binding: HandleBinding | undefined;
+}
+export declare const TypedCiphertext: MessageFns<TypedCiphertext>;
+export declare const Covalidator: MessageFns<Covalidator>;
+export declare const KeysetInfo: MessageFns<KeysetInfo>;
+export declare const FheEnv: MessageFns<FheEnv>;
+export declare const ZamaAccessControl: MessageFns<ZamaAccessControl>;
+export declare const IncoLiteAccessControl: MessageFns<IncoLiteAccessControl>;
+export declare const CARoot: MessageFns<CARoot>;
+export declare const FheEnvBlock: MessageFns<FheEnvBlock>;
+export declare const BlockTopo: MessageFns<BlockTopo>;
+export declare const BlockTopoStore: MessageFns<BlockTopoStore>;
+export declare const HandleBinding: MessageFns<HandleBinding>;
+export declare const HandleBindingEntry: MessageFns<HandleBindingEntry>;
+type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
+export type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : Partial<T>;
+type KeysOfUnion<T> = T extends T ? keyof T : never;
+export type Exact<P, I extends P> = P extends Builtin ? P : P & {
+    [K in keyof P]: Exact<P[K], I[K]>;
+} & {
+    [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
+};
+export interface MessageFns<T> {
+    encode(message: T, writer?: BinaryWriter): BinaryWriter;
+    decode(input: BinaryReader | Uint8Array, length?: number): T;
+    fromJSON(object: any): T;
+    toJSON(message: T): unknown;
+    create<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
+    fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
+}
+export {};