@inco/js 0.2.16 → 0.3.0

package/dist/types/generated/es/inco/kms/lite/v1/kms_service_pb.d.ts

@@ -0,0 +1,526 @@
+import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
+import type { TypedCiphertext } from "../../../fhe/v1/types_pb";
+import type { ECIESKeyset, HandleWithProof } from "./types_pb";
+import type { Message } from "@bufbuild/protobuf";
+/**
+ * Describes the file inco/kms/lite/v1/kms_service.proto.
+ */
+export declare const file_inco_kms_lite_v1_kms_service: GenFile;
+/**
+ * KeyRequest is the request type for the KmsService/Keys RPC method.
+ *
+ * @generated from message inco.kms.lite.v1.KeyRequest
+ */
+export type KeyRequest = Message<"inco.kms.lite.v1.KeyRequest"> & {};
+/**
+ * Describes the message inco.kms.lite.v1.KeyRequest.
+ * Use `create(KeyRequestSchema)` to create a new message.
+ */
+export declare const KeyRequestSchema: GenMessage<KeyRequest>;
+/**
+ * KeyResponse is the response type for the KmsService/Keys RPC method.
+ *
+ * @generated from message inco.kms.lite.v1.KeyResponse
+ */
+export type KeyResponse = Message<"inco.kms.lite.v1.KeyResponse"> & {
+    /**
+     * keyset is the keyset for the IncoLite KMS.
+     *
+     * @generated from field: inco.kms.lite.v1.ECIESKeyset keyset = 1;
+     */
+    keyset?: ECIESKeyset;
+    /**
+     * signing_address is the Ethereum EOA signing address of the KMS, encoded
+     * as a 0x-prefixed hex string.
+     * TODO scalar annotation.
+     *
+     * @generated from field: string signing_address = 2;
+     */
+    signingAddress: string;
+};
+/**
+ * Describes the message inco.kms.lite.v1.KeyResponse.
+ * Use `create(KeyResponseSchema)` to create a new message.
+ */
+export declare const KeyResponseSchema: GenMessage<KeyResponse>;
+/**
+ * ReencryptRequest is the request type for the KmsService/Reencrypt RPC method.
+ *
+ * @generated from message inco.kms.lite.v1.ReencryptRequest
+ */
+export type ReencryptRequest = Message<"inco.kms.lite.v1.ReencryptRequest"> & {
+    /**
+     * user_address is the Ethereum address of the user who requested the
+     * reencryption, prefixed with 0x.
+     *
+     * @generated from field: string user_address = 1;
+     */
+    userAddress: string;
+    /**
+     * ephemeral_pub_key is the encoding of the user's public ephemeral
+     * encryption key (secp256k1), generated by the user for this reencryption
+     * request. It is encoded in its 33-byte compressed format.
+     *
+     * @generated from field: bytes ephemeral_pub_key = 2;
+     */
+    ephemeralPubKey: Uint8Array;
+    /**
+     * eip712_signature is an EIP-712 signature of the following EIP-712 typed data by
+     * `user_address` (note that we only give a JSON representation for the sake of
+     * readability, but the actual signed data is defined in the EIP-712 spec):
+     *
+     * ```json
+     * {
+     *   "types": {
+     *     "EIP712Domain": [
+     *       { "name": "name", "type": "string" },
+     *       { "name": "version", "type": "string" },
+     *       { "name": "chainId", "type": "uint256" }
+     *     ],
+     *     "ReencryptionRequest": [
+     *       { "name": "publicKey", "type": "bytes" }
+     *     ]
+     *   },
+     *   "primaryType": "ReencryptionRequest",
+     *   "domain": {
+     *     "name": "IncoReencryption",
+     *     "version": "0.1.0",
+     *     "chainId": "<host_chain_id>",
+     *     "verifyingContract": "<acl_address>",
+     *     "salt": "0x0000000000000000000000000000000000000000000000000000000000000000"
+     *   },
+     *   "message": {
+     *     "publicKey": "<ephemeral_pub_key>"
+     *   }
+     * }
+     * ```
+     *
+     * @generated from field: bytes eip712_signature = 3;
+     */
+    eip712Signature: Uint8Array;
+    /**
+     * handles_with_proofs is the list of handles of the ciphertexts to reencrypt,
+     * along with the ACL proof that the user has access to the ciphertext.
+     *
+     * @generated from field: repeated inco.kms.lite.v1.HandleWithProof handles_with_proofs = 4;
+     */
+    handlesWithProofs: HandleWithProof[];
+};
+/**
+ * Describes the message inco.kms.lite.v1.ReencryptRequest.
+ * Use `create(ReencryptRequestSchema)` to create a new message.
+ */
+export declare const ReencryptRequestSchema: GenMessage<ReencryptRequest>;
+/**
+ * ReencryptResponse is the response type for the KmsService/Reencrypt RPC method.
+ *
+ * @generated from message inco.kms.lite.v1.ReencryptResponse
+ */
+export type ReencryptResponse = Message<"inco.kms.lite.v1.ReencryptResponse"> & {
+    /**
+     * payload is the reencryption response payload.
+     *
+     * @generated from field: inco.kms.lite.v1.ReencryptionResponsePayload payload = 1;
+     */
+    payload?: ReencryptionResponsePayload;
+};
+/**
+ * Describes the message inco.kms.lite.v1.ReencryptResponse.
+ * Use `create(ReencryptResponseSchema)` to create a new message.
+ */
+export declare const ReencryptResponseSchema: GenMessage<ReencryptResponse>;
+/**
+ * ReencryptionResponsePayload is the payload of the ReencryptResponse,
+ * separated out because it is signed by the KMS using its signing key.
+ *
+ * @generated from message inco.kms.lite.v1.ReencryptionResponsePayload
+ */
+export type ReencryptionResponsePayload = Message<"inco.kms.lite.v1.ReencryptionResponsePayload"> & {
+    /**
+     * user_ciphertexts is the list of ciphertexts that were reencrypted to the
+     * user's public key. Each ciphertext at index `i` corresponds to the ciphertext
+     * at index `i` in the `ReencryptRequest`.
+     *
+     * @generated from field: repeated inco.fhe.v1.TypedCiphertext user_ciphertexts = 1;
+     */
+    userCiphertexts: TypedCiphertext[];
+};
+/**
+ * Describes the message inco.kms.lite.v1.ReencryptionResponsePayload.
+ * Use `create(ReencryptionResponsePayloadSchema)` to create a new message.
+ */
+export declare const ReencryptionResponsePayloadSchema: GenMessage<ReencryptionResponsePayload>;
+/**
+ * AttestedDecryptRequest is the request type for the KmsService/AttestedDecrypt RPC method.
+ *
+ * @generated from message inco.kms.lite.v1.AttestedDecryptRequest
+ */
+export type AttestedDecryptRequest = Message<"inco.kms.lite.v1.AttestedDecryptRequest"> & {
+    /**
+     * user_address is the Ethereum address of the user who requested the
+     * decryption, prefixed with 0x.
+     *
+     * @generated from field: string user_address = 1;
+     */
+    userAddress: string;
+    /**
+     * eip712_signature is an EIP-712 signature of the following EIP-712 typed data by
+     * `user_address` (note that we only give a JSON representation for the sake of
+     * readability, but the actual signed data is defined in the EIP-712 spec):
+     *
+     * ```json
+     * {
+     *   "types": {
+     *     "EIP712Domain": [
+     *       { "name": "name", "type": "string" },
+     *       { "name": "version", "type": "string" },
+     *       { "name": "chainId", "type": "uint256" }
+     *     ],
+     *     "AttestedDecryptRequest": [
+     *       { "name": "handles", "type": "bytes32[]" }
+     *     ]
+     *   },
+     *   "primaryType": "AttestedDecryptRequest",
+     *   "domain": {
+     *     "name": "IncoAttestedDecrypt",
+     *     "version": "0.1.0",
+     *     "chainId": "<host_chain_id>",
+     *   },
+     *   "message": {
+     *     "handles": ["<handle1>", "<handle2>", ...]
+     *   }
+     * }
+     * ```
+     *
+     * @generated from field: bytes eip712_signature = 2;
+     */
+    eip712Signature: Uint8Array;
+    /**
+     * handles is the list of handles of the ciphertexts to decrypt.
+     * The user_address must have ACL access to the handles for the attested
+     * decryption to succeed.
+     *
+     * @generated from field: repeated string handles = 3;
+     */
+    handles: string[];
+};
+/**
+ * Describes the message inco.kms.lite.v1.AttestedDecryptRequest.
+ * Use `create(AttestedDecryptRequestSchema)` to create a new message.
+ */
+export declare const AttestedDecryptRequestSchema: GenMessage<AttestedDecryptRequest>;
+/**
+ * AttestedComputeRequest is the request type for the KmsService/AttestedDecrypt RPC method.
+ *
+ * @generated from message inco.kms.lite.v1.AttestedComputeRequest
+ */
+export type AttestedComputeRequest = Message<"inco.kms.lite.v1.AttestedComputeRequest"> & {
+    /**
+     * user_address is the Ethereum address of the user who requested the
+     * decryption, prefixed with 0x.
+     *
+     * @generated from field: string user_address = 1;
+     */
+    userAddress: string;
+    /**
+     * eip712_signature is an EIP-712 signature of the following EIP-712 typed data by
+     * `user_address` (note that we only give a JSON representation for the sake of
+     * readability, but the actual signed data is defined in the EIP-712 spec):
+     *
+     * ```json
+     * {
+     *   "types": {
+     *     "EIP712Domain": [
+     *       { "name": "name", "type": "string" },
+     *       { "name": "version", "type": "string" },
+     *       { "name": "chainId", "type": "uint256" }
+     *     ],
+     *     "AttestedComputeRequest": [
+     *       { "name": "op", "type" "uint8"},
+     *       { "name": "lhs", "type" "bytes32"},
+     *       { "name": "rhs", "type" "bytes32"}
+     *     ]
+     *   },
+     *   "primaryType": "AttestedComputeRequest",
+     *   "domain": {
+     *     "name": "IncoAttestedCompute",
+     *     "version": "0.1.0",
+     *     "chainId": "<host_chain_id>",
+     *   },
+     *   "message": {
+     *     "op": <operation>,
+     *     "lhs": "<handle1>",
+     *     "rhs": <plaintextBytes> // Also add a comment on length & encoding
+     *   }
+     * }
+     * ```
+     *
+     * @generated from field: bytes eip712_signature = 2;
+     */
+    eip712Signature: Uint8Array;
+    /**
+     * Subset of supported binary operations that can be performed on a handle.
+     *
+     * @generated from field: inco.kms.lite.v1.SupportedScalarBinaryOp op = 3;
+     */
+    op: SupportedScalarBinaryOp;
+    /**
+     * handle of the ciphertext encoded as a hex string (with or without 0x prefix) to perform computation on.
+     * The user_address must have ACL access to the handle for the attested
+     * compute to succeed.
+     *
+     * @generated from field: string lhs_handle = 4;
+     */
+    lhsHandle: string;
+    /**
+     * Second plaintext scalar operand encoded as a hex string (with or without 0x prefix)
+     *
+     * @generated from field: string rhs_plaintext = 5;
+     */
+    rhsPlaintext: string;
+};
+/**
+ * Describes the message inco.kms.lite.v1.AttestedComputeRequest.
+ * Use `create(AttestedComputeRequestSchema)` to create a new message.
+ */
+export declare const AttestedComputeRequestSchema: GenMessage<AttestedComputeRequest>;
+/**
+ * AttestedDecryptResponse is the response type for the KmsService/AttestedDecrypt RPC method.
+ *
+ * @generated from message inco.kms.lite.v1.AttestedDecryptResponse
+ */
+export type AttestedDecryptResponse = Message<"inco.kms.lite.v1.AttestedDecryptResponse"> & {
+    /**
+     * decryption_attestations is the list of decryption attestations. The item at index `i`
+     * corresponds to the handle at index `i` in the `AttestedDecryptRequest`.
+     *
+     * @generated from field: repeated inco.kms.lite.v1.DecryptionAttestation decryption_attestations = 1;
+     */
+    decryptionAttestations: DecryptionAttestation[];
+};
+/**
+ * Describes the message inco.kms.lite.v1.AttestedDecryptResponse.
+ * Use `create(AttestedDecryptResponseSchema)` to create a new message.
+ */
+export declare const AttestedDecryptResponseSchema: GenMessage<AttestedDecryptResponse>;
+/**
+ * AttestedComputeResponse is the response type for the KmsService/AttestedCompute RPC method.
+ *
+ * @generated from message inco.kms.lite.v1.AttestedComputeResponse
+ */
+export type AttestedComputeResponse = Message<"inco.kms.lite.v1.AttestedComputeResponse"> & {
+    /**
+     * decryption_attestation is the signed decryption of the result of the computation.
+     *
+     * @generated from field: inco.kms.lite.v1.DecryptionAttestation decryption_attestation = 1;
+     */
+    decryptionAttestation?: DecryptionAttestation;
+};
+/**
+ * Describes the message inco.kms.lite.v1.AttestedComputeResponse.
+ * Use `create(AttestedComputeResponseSchema)` to create a new message.
+ */
+export declare const AttestedComputeResponseSchema: GenMessage<AttestedComputeResponse>;
+/**
+ * DecryptionAttestation contains the attestation for the decryption of a single handle.
+ *
+ * @generated from message inco.kms.lite.v1.DecryptionAttestation
+ */
+export type DecryptionAttestation = Message<"inco.kms.lite.v1.DecryptionAttestation"> & {
+    /**
+     * handle is the handle that was decrypted, encoded as a 0x-prefixed hex string.
+     *
+     * @generated from field: string handle = 1;
+     */
+    handle: string;
+    /**
+     * plaintext is the decrypted plaintext value as a 32-byte word.
+     *
+     * @generated from field: bytes plaintext = 2;
+     */
+    plaintext: Uint8Array;
+    /**
+     * signature is the attestation from the covalidator for the (handle,plaintext) pair.
+     * This signature will be verified on the host chain.
+     *
+     * It is an EIP-712 signature of the following EIP-712 typed data by
+     * `user_address` (note that we only give a JSON representation for the sake of
+     * readability, but the actual signed data is defined in the EIP-712 spec):
+     *
+     * ```json
+     * {
+     *   "types": {
+     *     "EIP712Domain": [
+     *       { "name": "name", "type": "string" },
+     *       { "name": "version", "type": "string" },
+     *       { "name": "chainId", "type": "uint256" },
+     *       { "name": "verifyingContract", "type": "address" }
+     *     ],
+     *     "DecryptionRequest": [
+     *       { "name": "handle", "type": "bytes32" },
+     *       { "name": "value", "type": "bytes32" }
+     *     ]
+     *   },
+     *   "primaryType": "DecryptionRequest",
+     *   "domain": {
+     *     "name": "<Inco contract name, e.g. IncoLite>",
+     *     "version": "<Inco contract version>",
+     *     "chainId": "<host_chain_id>",
+     *     "verifyingContract": "<Inco contract address>",
+     *   },
+     *   "message": {
+     *     "handle": "<handle>",
+     *     "value": "<value>"
+     *   }
+     * }
+     * ```
+     *
+     * @generated from field: bytes signature = 3;
+     */
+    signature: Uint8Array;
+};
+/**
+ * Describes the message inco.kms.lite.v1.DecryptionAttestation.
+ * Use `create(DecryptionAttestationSchema)` to create a new message.
+ */
+export declare const DecryptionAttestationSchema: GenMessage<DecryptionAttestation>;
+/**
+ * @generated from enum inco.kms.lite.v1.SupportedScalarBinaryOp
+ */
+export declare enum SupportedScalarBinaryOp {
+    /**
+     * @generated from enum value: FHE_ADD = 0;
+     */
+    FHE_ADD = 0,
+    /**
+     * @generated from enum value: FHE_SUB = 1;
+     */
+    FHE_SUB = 1,
+    /**
+     * @generated from enum value: FHE_MUL = 2;
+     */
+    FHE_MUL = 2,
+    /**
+     * @generated from enum value: FHE_DIV = 3;
+     */
+    FHE_DIV = 3,
+    /**
+     * @generated from enum value: FHE_REM = 4;
+     */
+    FHE_REM = 4,
+    /**
+     * @generated from enum value: FHE_BIT_AND = 5;
+     */
+    FHE_BIT_AND = 5,
+    /**
+     * @generated from enum value: FHE_BIT_OR = 6;
+     */
+    FHE_BIT_OR = 6,
+    /**
+     * @generated from enum value: FHE_BIT_XOR = 7;
+     */
+    FHE_BIT_XOR = 7,
+    /**
+     * @generated from enum value: FHE_SHL = 8;
+     */
+    FHE_SHL = 8,
+    /**
+     * @generated from enum value: FHE_SHR = 9;
+     */
+    FHE_SHR = 9,
+    /**
+     * @generated from enum value: FHE_ROTL = 10;
+     */
+    FHE_ROTL = 10,
+    /**
+     * @generated from enum value: FHE_ROTR = 11;
+     */
+    FHE_ROTR = 11,
+    /**
+     * @generated from enum value: FHE_EQ = 12;
+     */
+    FHE_EQ = 12,
+    /**
+     * @generated from enum value: FHE_NE = 13;
+     */
+    FHE_NE = 13,
+    /**
+     * @generated from enum value: FHE_GE = 14;
+     */
+    FHE_GE = 14,
+    /**
+     * @generated from enum value: FHE_GT = 15;
+     */
+    FHE_GT = 15,
+    /**
+     * @generated from enum value: FHE_LE = 16;
+     */
+    FHE_LE = 16,
+    /**
+     * @generated from enum value: FHE_LT = 17;
+     */
+    FHE_LT = 17,
+    /**
+     * @generated from enum value: FHE_MIN = 18;
+     */
+    FHE_MIN = 18,
+    /**
+     * @generated from enum value: FHE_MAX = 19;
+     */
+    FHE_MAX = 19
+}
+/**
+ * Describes the enum inco.kms.lite.v1.SupportedScalarBinaryOp.
+ */
+export declare const SupportedScalarBinaryOpSchema: GenEnum<SupportedScalarBinaryOp>;
+/**
+ * KmsService is the service for the IncoLite KMS, which will run
+ * inside the TEE.
+ *
+ * @generated from service inco.kms.lite.v1.KmsService
+ */
+export declare const KmsService: GenService<{
+    /**
+     * Key returns the public keys exposed by the KMS.
+     *
+     * @generated from rpc inco.kms.lite.v1.KmsService.Key
+     */
+    key: {
+        methodKind: "unary";
+        input: typeof KeyRequestSchema;
+        output: typeof KeyResponseSchema;
+    };
+    /**
+     * Reencrypt reencrypts a ciphertext using the ephemeral public key of the
+     * user.
+     *
+     * @generated from rpc inco.kms.lite.v1.KmsService.Reencrypt
+     */
+    reencrypt: {
+        methodKind: "unary";
+        input: typeof ReencryptRequestSchema;
+        output: typeof ReencryptResponseSchema;
+    };
+    /**
+     * AttestedDecrypt decrypts multiple ciphertexts and provides an attestation
+     * that the decryption was performed correctly.
+     *
+     * @generated from rpc inco.kms.lite.v1.KmsService.AttestedDecrypt
+     */
+    attestedDecrypt: {
+        methodKind: "unary";
+        input: typeof AttestedDecryptRequestSchema;
+        output: typeof AttestedDecryptResponseSchema;
+    };
+    /**
+     * AttestedCompute decrypts the result of a scalar binary operation on a handle and privides an attestation
+     * that the computation and decryption were performed correctly.
+     *
+     * @generated from rpc inco.kms.lite.v1.KmsService.AttestedCompute
+     */
+    attestedCompute: {
+        methodKind: "unary";
+        input: typeof AttestedComputeRequestSchema;
+        output: typeof AttestedComputeResponseSchema;
+    };
+}>;