node-tkms 0.13.0-rc.1 → 0.13.0-rc.3

package/kms_lib.d.ts

@@ -1,10 +1,324 @@
 /* tslint:disable */
 /* eslint-disable */
+
+export class CiphertextHandle {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+}
+
+/**
+ * Core Client
+ *
+ * Simple client to interact with the KMS servers. This can be seen as a proof-of-concept
+ * and reference code for validating the KMS. The logic supplied by the client will be
+ * distributed across the aggregator/proxy and smart contracts.
+ */
+export class Client {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+}
+
+/**
+ * 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;
+    [Symbol.dispose](): void;
+    chain_id: Uint8Array;
+    name: string;
+    get salt(): Uint8Array | undefined;
+    set salt(value: Uint8Array | null | undefined);
+    verifying_contract: string;
+    version: string;
+}
+
+/**
+ * Validity of this struct is not checked.
+ */
+export class ParsedUserDecryptionRequest {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+}
+
+export class PrivateEncKeyMlKem512 {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+}
+
+export class PrivateSigKey {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+}
+
+export class PublicEncKeyMlKem512 {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+}
+
+export class PublicSigKey {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+}
+
+/**
+ * / 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.
+ */
+export class RequestId {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    request_id: string;
+}
+
+export class ServerIdAddr {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+}
+
+export class TypedCiphertext {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * The ciphertext format, see CiphertextFormat documentation for details.
+     * CiphertextFormat::default() is used if unspecified.
+     */
+    ciphertext_format: number;
+    /**
+     * The actual ciphertext to decrypt, taken directly from fhevm.
+     */
+    ciphertext: Uint8Array;
+    /**
+     * The external handle of the ciphertext (the handle used in the copro).
+     */
+    external_handle: 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 TypedPlaintext {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * 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 TypedSigncryptedCiphertext {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * The external handles that were originally in the request.
+     */
+    external_handle: 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 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;
+    /**
+     * The signcrypted payload, using a hybrid encryption approach in
+     * sign-then-encrypt.
+     */
+    signcrypted_ciphertext: Uint8Array;
+}
+
+export class UserDecryptionRequest {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * The client's (blockchain wallet) address, encoded using EIP-55. I.e. including `0x`.
+     */
+    client_address: string;
+    /**
+     * MPC context ID which is used to identify the context to use for this request.
+     *
+     * NOTE: at the moment this can be None since we do not fully support multiple contexts.
+     * See <https://github.com/zama-ai/kms-internal/issues/2530>
+     */
+    get context_id(): RequestId | undefined;
+    /**
+     * MPC context ID which is used to identify the context to use for this request.
+     *
+     * NOTE: at the moment this can be None since we do not fully support multiple contexts.
+     * See <https://github.com/zama-ai/kms-internal/issues/2530>
+     */
+    set context_id(value: RequestId | null | undefined);
+    /**
+     * 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);
+    /**
+     * 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 epoch number placeholder (zama-ai/kms-internal#2743).
+     */
+    get epoch_id(): RequestId | undefined;
+    /**
+     * The epoch number placeholder (zama-ai/kms-internal#2743).
+     */
+    set epoch_id(value: RequestId | null | undefined);
+    /**
+     * Extra data from the gateway.
+     */
+    extra_data: Uint8Array;
+    /**
+     * 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 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[];
+}
+
+export class UserDecryptionResponse {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * 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; // serialization of payload
+     *      bytes extraData;
+     * }
+     */
+    external_signature: Uint8Array;
+    /**
+     * Extra data used in the EIP712 signature - external_signature.
+     */
+    extra_data: Uint8Array;
+    /**
+     * The actual \[UserDecryptionResponsePayload\].
+     */
+    get payload(): UserDecryptionResponsePayload | undefined;
+    /**
+     * The actual \[UserDecryptionResponsePayload\].
+     */
+    set payload(value: UserDecryptionResponsePayload | null | undefined);
+    signature: Uint8Array;
+}
+
+export class UserDecryptionResponsePayload {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * The degree of the sharing scheme used.
+     */
+    degree: number;
+    /**
+     * 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 ID of the MPC party doing the user decryption. Used for polynomial
+     * reconstruction.
+     */
+    party_id: number;
+    /**
+     * 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 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;
+}
+
+export function get_client_address(client: Client): string;
+
+export function get_client_secret_key(client: Client): PrivateSigKey | undefined;
+
+export function get_server_addrs(client: Client): ServerIdAddr[];
+
+/**
+ * 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 ml_kem_pke_decrypt(ct: Uint8Array, my_sk: PrivateEncKeyMlKem512): Uint8Array;
+
 /**
  * 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 ml_kem_pke_encrypt(msg: Uint8Array, their_pk: PublicEncKeyMlKem512): Uint8Array;
+
+export function ml_kem_pke_get_pk(sk: PrivateEncKeyMlKem512): PublicEncKeyMlKem512;
+
+export function ml_kem_pke_keygen(): PrivateEncKeyMlKem512;
+
+export function ml_kem_pke_pk_len(): number;
+
+export function ml_kem_pke_pk_to_u8vec(pk: PublicEncKeyMlKem512): Uint8Array;
+
+export function ml_kem_pke_sk_len(): number;
+
+export function ml_kem_pke_sk_to_u8vec(sk: PrivateEncKeyMlKem512): Uint8Array;
+
 /**
  * Instantiate a new client.
  *
@@ -18,20 +332,40 @@ export function ml_kem_pke_encrypt(msg: Uint8Array, their_pk: PublicEncKeyMlKem5
  * The "default" parameter choice is selected if no matching string is found.
  */
 export function new_client(server_addrs: ServerIdAddr[], client_address_hex: string, fhe_parameter: string): Client;
-export function ml_kem_pke_keygen(): PrivateEncKeyMlKem512;
-export function ml_kem_pke_get_pk(sk: PrivateEncKeyMlKem512): PublicEncKeyMlKem512;
-export function u8vec_to_private_sig_key(v: Uint8Array): PrivateSigKey;
-export function public_sig_key_to_u8vec(pk: PublicSigKey): Uint8Array;
+
 /**
- * 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.
+ * 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 ml_kem_pke_decrypt(ct: Uint8Array, my_sk: PrivateEncKeyMlKem512): Uint8Array;
-export function u8vec_to_public_sig_key(v: Uint8Array): PublicSigKey;
-export function u8vec_to_ml_kem_pke_pk(v: Uint8Array): PublicEncKeyMlKem512;
-export function ml_kem_pke_pk_len(): number;
-export function get_server_addrs(client: Client): ServerIdAddr[];
+export function new_server_id_addr(id: number, addr: string): ServerIdAddr;
+
+export function private_sig_key_to_u8vec(sk: PrivateSigKey): Uint8Array;
+
+/**
+ * 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 user_decryption.
+ *
+ * * `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 user_decryption responses.
+ *
+ * * `enc_pk` - The ephemeral public key.
+ *
+ * * `enc_sk` - The ephemeral secret key.
+ *
+ * * `verify` - Whether to perform signature verification for the response.
+ * It is insecure if `verify = false`!
+ */
+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[];
+
 /**
  * Process the user_decryption response from JavaScript objects.
  * The returned result is a byte array representing a plaintext of any length,
@@ -94,294 +428,13 @@ export function get_server_addrs(client: Client): ServerIdAddr[];
  * It is insecure if `verify = false`!
  */
 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[];
-/**
- * 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 new_server_id_addr(id: number, addr: string): ServerIdAddr;
-export function ml_kem_pke_sk_len(): number;
-export function private_sig_key_to_u8vec(sk: PrivateSigKey): Uint8Array;
+
+export function public_sig_key_to_u8vec(pk: PublicSigKey): Uint8Array;
+
+export function u8vec_to_ml_kem_pke_pk(v: Uint8Array): PublicEncKeyMlKem512;
+
 export function u8vec_to_ml_kem_pke_sk(v: Uint8Array): PrivateEncKeyMlKem512;
-export function get_client_address(client: Client): string;
-/**
- * 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 user_decryption.
- *
- * * `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 user_decryption responses.
- *
- * * `enc_pk` - The ephemeral public key.
- *
- * * `enc_sk` - The ephemeral secret key.
- *
- * * `verify` - Whether to perform signature verification for the response.
- * It is insecure if `verify = false`!
- */
-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 function get_client_secret_key(client: Client): PrivateSigKey | undefined;
-export function ml_kem_pke_pk_to_u8vec(pk: PublicEncKeyMlKem512): Uint8Array;
-export function ml_kem_pke_sk_to_u8vec(sk: PrivateEncKeyMlKem512): Uint8Array;
-export class CiphertextHandle {
-  private constructor();
-  free(): void;
-}
-/**
- * Core Client
- *
- * Simple client to interact with the KMS servers. This can be seen as a proof-of-concept
- * and reference code for validating the KMS. The logic supplied by the client will be
- * distributed across the aggregator/proxy and smart contracts.
- */
-export class Client {
-  private constructor();
-  free(): void;
-}
-/**
- * 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;
-  name: 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 ParsedUserDecryptionRequest {
-  private constructor();
-  free(): void;
-}
-export class PrivateEncKeyMlKem512 {
-  private constructor();
-  free(): void;
-}
-export class PrivateSigKey {
-  private constructor();
-  free(): void;
-}
-export class PublicEncKeyMlKem512 {
-  private constructor();
-  free(): void;
-}
-export class PublicSigKey {
-  private constructor();
-  free(): void;
-}
-/**
- * / 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.
- */
-export class RequestId {
-  private constructor();
-  free(): void;
-  request_id: string;
-}
-export class ServerIdAddr {
-  private constructor();
-  free(): void;
-}
-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 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 TypedPlaintext {
-  private constructor();
-  free(): void;
-  /**
-   * 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 TypedSigncryptedCiphertext {
-  private constructor();
-  free(): void;
-  /**
-   * 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 signcrypted payload, using a hybrid encryption approach in
-   * sign-then-encrypt.
-   */
-  signcrypted_ciphertext: Uint8Array;
-  /**
-   * 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;
-}
-export class UserDecryptionRequest {
-  private constructor();
-  free(): void;
-  /**
-   * 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);
-  /**
-   * Extra data from the gateway.
-   */
-  extra_data: Uint8Array;
-  /**
-   * MPC context ID which is used to identify the context to use for this request.
-   *
-   * NOTE: at the moment this can be None since we do not fully support multiple contexts.
-   * See <https://github.com/zama-ai/kms-internal/issues/2530>
-   */
-  get context_id(): RequestId | undefined;
-  /**
-   * MPC context ID which is used to identify the context to use for this request.
-   *
-   * NOTE: at the moment this can be None since we do not fully support multiple contexts.
-   * See <https://github.com/zama-ai/kms-internal/issues/2530>
-   */
-  set context_id(value: RequestId | null | undefined);
-  /**
-   * The epoch number placeholder (zama-ai/kms-internal#2743).
-   */
-  get epoch_id(): RequestId | undefined;
-  /**
-   * The epoch number placeholder (zama-ai/kms-internal#2743).
-   */
-  set epoch_id(value: RequestId | 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; // serialization of payload
-   *      bytes extraData;
-   * }
-   */
-  external_signature: Uint8Array;
-  /**
-   * The actual \[UserDecryptionResponsePayload\].
-   */
-  get payload(): UserDecryptionResponsePayload | undefined;
-  /**
-   * The actual \[UserDecryptionResponsePayload\].
-   */
-  set payload(value: UserDecryptionResponsePayload | null | undefined);
-  /**
-   * Extra data used in the EIP712 signature - external_signature.
-   */
-  extra_data: Uint8Array;
-}
-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;
-}
+
+export function u8vec_to_private_sig_key(v: Uint8Array): PrivateSigKey;
+
+export function u8vec_to_public_sig_key(v: Uint8Array): PublicSigKey;