node-tkms 0.10.0-rc1 → 0.11.0-23

package/kms_lib.d.ts

@@ -1,117 +1,67 @@
 /* tslint:disable */
 /* eslint-disable */
-/**
- * @param {PublicSigKey} pk
- * @returns {Uint8Array}
- */
+export function ml_kem_pke_pk_len(): number;
+export function ml_kem_pke_sk_len(): number;
 export function public_sig_key_to_u8vec(pk: PublicSigKey): Uint8Array;
-/**
- * @param {Uint8Array} v
- * @returns {PublicSigKey}
- */
 export function u8vec_to_public_sig_key(v: Uint8Array): PublicSigKey;
-/**
- * @param {PrivateSigKey} sk
- * @returns {Uint8Array}
- */
 export function private_sig_key_to_u8vec(sk: PrivateSigKey): Uint8Array;
+export function u8vec_to_private_sig_key(v: Uint8Array): PrivateSigKey;
 /**
- * @param {Uint8Array} v
- * @returns {PrivateSigKey}
+ * Create a new [ServerIdAddr] structure that holds an ID and an address
+ * which must be a valid EIP-55 address, notably prefixed with "0x".
  */
-export function u8vec_to_private_sig_key(v: Uint8Array): PrivateSigKey;
+export function new_server_id_addr(id: number, addr: string): ServerIdAddr;
 /**
  * Instantiate a new client.
  *
- * * `server_addrs` - a list of KMS server EIP-55 addresses,
- * must be prefixed with "0x".
+ * * `server_addrs` - a list of KMS server ID with EIP-55 addresses,
+ * the elements in the list can be created using [new_server_id_addr].
  *
  * * `client_address_hex` - the client (wallet) address in hex,
  * must be prefixed with "0x".
  *
- * * `param_choice` - the parameter choice, which can be either `"test"` or `"default"`.
+ * * `fhe_parameter` - the parameter choice, which can be either `"test"` or `"default"`.
  * The "default" parameter choice is selected if no matching string is found.
- * @param {(string)[]} server_addrs
- * @param {string} client_address_hex
- * @param {string} param_choice
- * @returns {Client}
- */
-export function new_client(server_addrs: (string)[], client_address_hex: string, param_choice: string): Client;
-/**
- * @param {Client} client
- * @returns {(string)[]}
- */
-export function get_server_addrs(client: Client): (string)[];
-/**
- * @param {Client} client
- * @returns {PrivateSigKey | undefined}
  */
+export function new_client(server_addrs: ServerIdAddr[], client_address_hex: string, fhe_parameter: string): Client;
+export function get_server_addrs(client: Client): ServerIdAddr[];
 export function get_client_secret_key(client: Client): PrivateSigKey | undefined;
-/**
- * @param {Client} client
- * @returns {string}
- */
 export function get_client_address(client: Client): string;
+export function ml_kem_pke_keygen(): PrivateEncKeyMlKem512;
+export function ml_kem_pke_get_pk(sk: PrivateEncKeyMlKem512): PublicEncKeyMlKem512;
+export function ml_kem_pke_pk_to_u8vec(pk: PublicEncKeyMlKem512): Uint8Array;
+export function ml_kem_pke_sk_to_u8vec(sk: PrivateEncKeyMlKem512): Uint8Array;
+export function u8vec_to_ml_kem_pke_pk(v: Uint8Array): PublicEncKeyMlKem512;
+export function u8vec_to_ml_kem_pke_sk(v: Uint8Array): PrivateEncKeyMlKem512;
 /**
- * @returns {PrivateEncKey}
- */
-export function cryptobox_keygen(): PrivateEncKey;
-/**
- * @param {PrivateEncKey} sk
- * @returns {PublicEncKey}
- */
-export function cryptobox_get_pk(sk: PrivateEncKey): PublicEncKey;
-/**
- * @param {PublicEncKey} pk
- * @returns {Uint8Array}
- */
-export function cryptobox_pk_to_u8vec(pk: PublicEncKey): Uint8Array;
-/**
- * @param {PrivateEncKey} sk
- * @returns {Uint8Array}
- */
-export function cryptobox_sk_to_u8vec(sk: PrivateEncKey): Uint8Array;
-/**
- * @param {Uint8Array} v
- * @returns {PublicEncKey}
- */
-export function u8vec_to_cryptobox_pk(v: Uint8Array): PublicEncKey;
-/**
- * @param {Uint8Array} v
- * @returns {PrivateEncKey}
+ * This function is *not* used by relayer-sdk because the encryption
+ * happens on the KMS side. It's just here for completeness and tests.
  */
-export function u8vec_to_cryptobox_sk(v: Uint8Array): PrivateEncKey;
+export function ml_kem_pke_encrypt(msg: Uint8Array, their_pk: PublicEncKeyMlKem512): Uint8Array;
 /**
- * @param {Uint8Array} msg
- * @param {PublicEncKey} their_pk
- * @param {PrivateEncKey} my_sk
- * @returns {CryptoBoxCt}
+ * This function is *not* used by relayer-sdk because the decryption
+ * is handled by [process_user_decryption_resp].
+ * It's just here for completeness and tests.
  */
-export function cryptobox_encrypt(msg: Uint8Array, their_pk: PublicEncKey, my_sk: PrivateEncKey): CryptoBoxCt;
+export function ml_kem_pke_decrypt(ct: Uint8Array, my_sk: PrivateEncKeyMlKem512): Uint8Array;
 /**
- * @param {CryptoBoxCt} ct
- * @param {PrivateEncKey} my_sk
- * @param {PublicEncKey} their_pk
- * @returns {Uint8Array}
- */
-export function cryptobox_decrypt(ct: CryptoBoxCt, my_sk: PrivateEncKey, their_pk: PublicEncKey): Uint8Array;
-/**
- * Process the reencryption response from JavaScript objects.
+ * Process the user_decryption response from JavaScript objects.
  * The returned result is a byte array representing a plaintext of any length,
  * postprocessing is returned to turn it into an integer.
  *
- * * `client` - client that wants to perform reencryption.
+ * * `client` - client that wants to perform user_decryption.
  *
- * * `request` - the initial reencryption request JS object.
+ * * `request` - the initial user_decryption request JS object.
  * It can be set to null if `verify` is false.
  * Otherwise the caller needs to give the following JS object.
  * Note that `client_address` and `eip712_verifying_contract` follow EIP-55.
+ * The signature field is not needed.
  * ```
  * {
- *   signature: '15a4f9a8eb61459cfba7d103d8f911fb04ce91ecf841b34c49c0d56a70b896d20cbc31986188f91efc3842b7df215cee8acb40178daedb8b63d0ba5d199bce121c',
+ *   signature: undefined,
  *   client_address: '0x17853A630aAe15AED549B2B874de08B73C0F59c5',
  *   enc_key: '2000000000000000df2fcacb774f03187f3802a27259f45c06d33cefa68d9c53426b15ad531aa822',
- *   ciphertext_handle: '0748b542afe2353c86cb707e3d21044b0be1fd18efc7cbaa6a415af055bfb358',
+ *   ciphertext_handles: [ '0748b542afe2353c86cb707e3d21044b0be1fd18efc7cbaa6a415af055bfb358' ]
  *   eip712_verifying_contract: '0x66f9664f97F2b50F62D13eA064982f936dE76657'
  * }
  * ```
@@ -153,31 +103,23 @@ export function cryptobox_decrypt(ct: CryptoBoxCt, my_sk: PrivateEncKey, their_p
  *
  * * `verify` - Whether to perform signature verification for the response.
  * It is insecure if `verify = false`!
- * @param {Client} client
- * @param {any} request
- * @param {any} eip712_domain
- * @param {any} agg_resp
- * @param {PublicEncKey} enc_pk
- * @param {PrivateEncKey} enc_sk
- * @param {boolean} verify
- * @returns {Uint8Array}
  */
-export function process_reencryption_resp_from_js(client: Client, request: any, eip712_domain: any, agg_resp: any, enc_pk: PublicEncKey, enc_sk: PrivateEncKey, verify: boolean): Uint8Array;
+export function process_user_decryption_resp_from_js(client: Client, request: any, eip712_domain: any, agg_resp: any, enc_pk: PublicEncKeyMlKem512, enc_sk: PrivateEncKeyMlKem512, verify: boolean): TypedPlaintext[];
 /**
- * Process the reencryption response from Rust objects.
- * Consider using [process_reencryption_resp_from_js]
+ * Process the user_decryption response from Rust objects.
+ * Consider using [process_user_decryption_resp_from_js]
  * when using the JS API.
  * The result is a byte array representing a plaintext of any length.
  *
- * * `client` - client that wants to perform reencryption.
+ * * `client` - client that wants to perform user_decryption.
  *
- * * `request` - the initial reencryption request.
+ * * `request` - the initial user_decryption request.
  * Must be given if `verify` is true.
  *
  * * `eip712_domain` - the EIP-712 domain.
  * Must be given if `verify` is true.
  *
- * * `agg_resp` - the vector of reencryption responses.
+ * * `agg_resp` - the vector of user_decryption responses.
  *
  * * `enc_pk` - The ephemeral public key.
  *
@@ -185,32 +127,11 @@ export function process_reencryption_resp_from_js(client: Client, request: any,
  *
  * * `verify` - Whether to perform signature verification for the response.
  * It is insecure if `verify = false`!
- * @param {Client} client
- * @param {ParsedReencryptionRequest | undefined} request
- * @param {Eip712DomainMsg | undefined} eip712_domain
- * @param {(ReencryptionResponse)[]} agg_resp
- * @param {PublicEncKey} enc_pk
- * @param {PrivateEncKey} enc_sk
- * @param {boolean} verify
- * @returns {Uint8Array}
- */
-export function process_reencryption_resp(client: Client, request: ParsedReencryptionRequest | undefined, eip712_domain: Eip712DomainMsg | undefined, agg_resp: (ReencryptionResponse)[], enc_pk: PublicEncKey, enc_sk: PrivateEncKey, verify: boolean): Uint8Array;
-/**
- * The plaintext types that can be encrypted in a fhevm ciphertext.
  */
-export enum FheType {
-  Ebool = 0,
-  Euint4 = 1,
-  Euint8 = 2,
-  Euint16 = 3,
-  Euint32 = 4,
-  Euint64 = 5,
-  Euint128 = 6,
-  Euint160 = 7,
-  Euint256 = 8,
-  Euint512 = 9,
-  Euint1024 = 10,
-  Euint2048 = 11,
+export function process_user_decryption_resp(client: Client, request: ParsedUserDecryptionRequest | null | undefined, eip712_domain: Eip712DomainMsg | null | undefined, agg_resp: UserDecryptionResponse[], enc_pk: PublicEncKeyMlKem512, enc_sk: PrivateEncKeyMlKem512, verify: boolean): TypedPlaintext[];
+export class CiphertextHandle {
+  private constructor();
+  free(): void;
 }
 /**
  * Core Client
@@ -220,145 +141,215 @@ export enum FheType {
  * distributed across the aggregator/proxy and smart contracts.
  */
 export class Client {
-  free(): void;
-}
-export class CryptoBoxCt {
+  private constructor();
   free(): void;
 }
 /**
- * <https://eips.ethereum.org/EIPS/eip-712#definition-of-domainseparator>
- * eventually chain_id, verifying_contract and salt will be parsed in to
- * solidity types
+ * Eip712 domain information.
+ * Any constraints specified in the [standard](<https://eips.ethereum.org/EIPS/eip-712#definition-of-domainseparator>) _must_ be fulfilled.
+ * Furthermore, be aware that all parameters will eventually be parsed into Solidity types.
  */
 export class Eip712DomainMsg {
+  private constructor();
   free(): void;
-  chain_id: Uint8Array;
   name: string;
-  salt?: Uint8Array;
-  verifying_contract: string;
   version: string;
+  chain_id: Uint8Array;
+  verifying_contract: string;
+  get salt(): Uint8Array | undefined;
+  set salt(value: Uint8Array | null | undefined);
 }
 /**
  * Validity of this struct is not checked.
  */
-export class ParsedReencryptionRequest {
+export class ParsedUserDecryptionRequest {
+  private constructor();
   free(): void;
 }
-export class PrivateEncKey {
+export class PrivateEncKeyMlKem512 {
+  private constructor();
   free(): void;
 }
 export class PrivateSigKey {
+  private constructor();
   free(): void;
 }
-export class PublicEncKey {
+export class PublicEncKeyMlKem512 {
+  private constructor();
   free(): void;
 }
 export class PublicSigKey {
+  private constructor();
   free(): void;
 }
-export class ReencryptionRequest {
-  free(): void;
-  domain?: Eip712DomainMsg;
-  payload?: ReencryptionRequestPayload;
 /**
- * The ID that identifies this request.
- * Future queries for the result must use this request ID.
+ * / A unique 32 Byte / 256 Bit ID, to be used to identify a request and
+ * / for retrieving the computed result later on.
+ * / Must be encoded in lower-case hex. The string must NOT contain a `0x` prefix.
  */
-  request_id?: RequestId;
-/**
- * Signature of the serialization of \[ReencryptionRequestPayload\].
- */
-  signature: Uint8Array;
+export class RequestId {
+  private constructor();
+  free(): void;
+  request_id: string;
 }
-export class ReencryptionRequestPayload {
+export class ServerIdAddr {
+  private constructor();
   free(): void;
-/**
- * The actual ciphertext to decrypt, taken directly from the fhevm.
- * When creating the payload, this field may be empty,
- * it is the responsibility of the gateway to fetch the
- * ciphertext for the given digest below.
- */
-  ciphertext?: Uint8Array;
-/**
- * The SHA3 digest of the ciphertext above.
- */
-  ciphertext_digest: Uint8Array;
-/**
- * The client's (blockchain wallet) address,
- * encoded using EIP-55.
- */
-  client_address: string;
-/**
- * Encoding of the user's public encryption key for this request.
- * Encoding using the default encoding of libsodium, i.e. the 32 bytes of a
- * Montgomery point.
- */
-  enc_key: Uint8Array;
-/**
- * The type of plaintext encrypted.
- */
+}
+export class TypedCiphertext {
+  private constructor();
+  free(): void;
+  /**
+   * The actual ciphertext to decrypt, taken directly from fhevm.
+   */
+  ciphertext: Uint8Array;
+  /**
+   * The type of plaintext encrypted. The type should match FheType from tfhe-rs:
+   * <https://github.com/zama-ai/tfhe-rs/blob/main/tfhe/src/high_level_api/mod.rs>
+   */
   fhe_type: number;
-/**
- * The key id to use for decryption. Will be the request_id used during key
- * generation
- */
-  key_id?: RequestId;
-/**
- * Version of the request format.
- */
-  version: number;
+  /**
+   * The external handle of the ciphertext (the handle used in the copro).
+   */
+  external_handle: Uint8Array;
+  /**
+   * The ciphertext format, see CiphertextFormat documentation for details.
+   * CiphertextFormat::default() is used if unspecified.
+   */
+  ciphertext_format: number;
 }
-export class ReencryptionResponse {
+export class TypedPlaintext {
+  private constructor();
   free(): void;
-/**
- * Signature of the serialization of \[ReencryptionResponsePayload\].
- */
-  payload?: ReencryptionResponsePayload;
-  signature: Uint8Array;
+  /**
+   * The actual plaintext in bytes.
+   */
+  bytes: Uint8Array;
+  /**
+   * The type of plaintext encrypted. The type should match FheType from tfhe-rs:
+   * <https://github.com/zama-ai/tfhe-rs/blob/main/tfhe/src/high_level_api/mod.rs>
+   */
+  fhe_type: number;
 }
-export class ReencryptionResponsePayload {
+export class TypedSigncryptedCiphertext {
+  private constructor();
   free(): void;
-/**
- * The degree of the sharing scheme used.
- */
-  degree: number;
-/**
- * The concatenation of two digests:
- * (eip712_signing_hash(pk, domain) || ciphertext digest).
- * This is needed to ensure the response corresponds to the request.
- */
-  digest: Uint8Array;
-/**
- * The type of plaintext encrypted.
- */
+  /**
+   * The type of plaintext encrypted. The type should match FheType from tfhe-rs:
+   * <https://github.com/zama-ai/tfhe-rs/blob/main/tfhe/src/high_level_api/mod.rs>
+   */
   fhe_type: number;
-/**
- * The ID of the MPC party doing the reencryption. Used for polynomial
- * reconstruction.
- */
-  party_id: number;
-/**
- * The signcrypted payload, using a hybrid encryption approach in
- * sign-then-encrypt.
- */
+  /**
+   * The signcrypted payload, using a hybrid encryption approach in
+   * sign-then-encrypt.
+   */
   signcrypted_ciphertext: Uint8Array;
-/**
- * The server's signature verification key.
- * Encoded using SEC1.
- * Needed to validate the response, but MUST also be linked to a list of
- * trusted keys.
- */
-  verification_key: Uint8Array;
-/**
- * Version of the response format.
- */
-  version: number;
+  /**
+   * The external handles that were originally in the request.
+   */
+  external_handle: Uint8Array;
+  /**
+   * The packing factor determines whether the decrypted plaintext
+   * has a different way of packing compared to what is specified in the plaintext modulus.
+   */
+  packing_factor: number;
 }
-/**
- * Simple response to return an ID, to be used to retrieve the computed result
- * later on.
- */
-export class RequestId {
+export class UserDecryptionRequest {
+  private constructor();
   free(): void;
-  request_id: string;
+  /**
+   * The 32 Byte / 256 Bit ID of the user decryption request, without `0x`
+   * prefix. Future queries for the result must use this request ID.
+   */
+  get request_id(): RequestId | undefined;
+  /**
+   * The 32 Byte / 256 Bit ID of the user decryption request, without `0x`
+   * prefix. Future queries for the result must use this request ID.
+   */
+  set request_id(value: RequestId | null | undefined);
+  /**
+   * The list of ciphertexts to decrypt for the user.
+   */
+  typed_ciphertexts: TypedCiphertext[];
+  /**
+   * The 32 Byte / 256 Bit key id to use for decryption. This is the request_id
+   * used for key generation
+   */
+  get key_id(): RequestId | undefined;
+  /**
+   * The 32 Byte / 256 Bit key id to use for decryption. This is the request_id
+   * used for key generation
+   */
+  set key_id(value: RequestId | null | undefined);
+  /**
+   * The client's (blockchain wallet) address, encoded using EIP-55. I.e. including `0x`.
+   */
+  client_address: string;
+  /**
+   * Encoding of the user's public encryption key for this request.
+   * This must be a bincode (v.1) encoded ML-KEM 512 key.
+   */
+  enc_key: Uint8Array;
+  /**
+   * The user's EIP712 domain. This MUST be present. Furthermore, the `verifying_contract` MUST be set and be distinct from `client_address`.
+   */
+  get domain(): Eip712DomainMsg | undefined;
+  /**
+   * The user's EIP712 domain. This MUST be present. Furthermore, the `verifying_contract` MUST be set and be distinct from `client_address`.
+   */
+  set domain(value: Eip712DomainMsg | null | undefined);
+}
+export class UserDecryptionResponse {
+  private constructor();
+  free(): void;
+  signature: Uint8Array;
+  /**
+   * This is the external signature created from the Eip712 domain
+   * on the structure, where userDecryptedShare is bc2wrap::serialize(&payload)
+   * struct UserDecryptResponseVerification {
+   *      bytes publicKey;
+   *      uint256\[\] ctHandles;
+   *      bytes userDecryptedShare;
+   * }
+   */
+  external_signature: Uint8Array;
+  /**
+   * The actual \[UserDecryptionResponsePayload\].
+   */
+  get payload(): UserDecryptionResponsePayload | undefined;
+  /**
+   * The actual \[UserDecryptionResponsePayload\].
+   */
+  set payload(value: UserDecryptionResponsePayload | null | undefined);
+}
+export class UserDecryptionResponsePayload {
+  private constructor();
+  free(): void;
+  /**
+   * The server's signature verification key, Encoded using SEC1.
+   * Needed to validate the response, but MUST also be linked to a list of
+   * trusted keys.
+   */
+  verification_key: Uint8Array;
+  /**
+   * This is needed to ensure the response corresponds to the request.
+   * It is the digest of UserDecryptionLinker hashed using EIP712
+   * under the given domain in the request.
+   */
+  digest: Uint8Array;
+  /**
+   * The resulting signcrypted ciphertexts, each ciphertext
+   * must be decrypted and then reconstructed with the other shares
+   * to produce the final plaintext.
+   */
+  signcrypted_ciphertexts: TypedSigncryptedCiphertext[];
+  /**
+   * The ID of the MPC party doing the user decryption. Used for polynomial
+   * reconstruction.
+   */
+  party_id: number;
+  /**
+   * The degree of the sharing scheme used.
+   */
+  degree: number;
 }