Module Mavryk_client_base.Client_keys_v0

Module to use keys over Mavryk_crypto.Signature.V0

include module type of struct include Client_keys end

Cryptographic keys tables

type pk_uri = private Uri.t
module Pk_uri_hashtbl = Client_keys.Pk_uri_hashtbl
type sk_uri = private Uri.t
type sapling_uri = private Uri.t
type aggregate_pk_uri = private Uri.t
type aggregate_sk_uri = private Uri.t
val pk_uri_parameter : unit -> (pk_uri, 'a) Mavryk_clic.parameter
val pk_uri_param : ?name:string -> ?desc:string -> ('a, 'b) Mavryk_clic.params -> (pk_uri -> 'a, 'b) Mavryk_clic.params
val sk_uri_parameter : unit -> (sk_uri, 'a) Mavryk_clic.parameter
val sk_uri_param : ?name:string -> ?desc:string -> ('a, 'b) Mavryk_clic.params -> (sk_uri -> 'a, 'b) Mavryk_clic.params
val aggregate_sk_uri_parameter : unit -> (aggregate_sk_uri, 'a) Mavryk_clic.parameter
val aggregate_sk_uri_param : ?name:string -> ?desc:string -> ('a, 'b) Mavryk_clic.params -> (aggregate_sk_uri -> 'a, 'b) Mavryk_clic.params
type Mavryk_base.TzPervasives.error +=
  1. | Unregistered_key_scheme of string
type Mavryk_base.TzPervasives.error +=
  1. | Invalid_uri of Uri.t
type sapling_key = Client_keys.sapling_key = {
  1. sk : sapling_uri;
  2. path : int32 list;
  3. address_index : Mavryk_sapling.Core.Client.Viewing_key.index;
}
module Sapling_key = Client_keys.Sapling_key
module Aggregate_alias = Client_keys.Aggregate_alias

Aggregate_alias contains the implementation needed for the wallet to have the correspondence between aliases and keys. It has three sub-module Public_key Public_key_hash Secret_key. The reason of a sub-module inside a sub-module is not confuse them with the alias module for the standard signature (i.e. Public_key, Public_key_hash, and Secret_key).

module Aggregate_type = Client_keys.Aggregate_type
module Logging = Client_keys.Logging

Interface for external signing modules.

module type COMMON_SIGNER = Client_keys.COMMON_SIGNER
module type AGGREGATE_SIGNER = Client_keys.AGGREGATE_SIGNER
module type SIGNER = Client_keys.SIGNER
type signer = Client_keys.signer =
  1. | Simple of (module SIGNER)
  2. | Aggregate of (module AGGREGATE_SIGNER)
val register_signer : (module SIGNER) -> unit

register_signer signer registers first-class module signer as signer for keys with scheme (val signer : SIGNER).scheme.

val registered_signers : unit -> (string * signer) list
val register_aggregate_signer : (module AGGREGATE_SIGNER) -> unit

register_aggregate_signer signer registers first-class module signer as signer for keys with scheme (val signer : AGGREGATE_SIGNER).scheme.

module type S = Client_keys.S
module V0 = Client_keys.V0
module V1 = Client_keys.V1
module V_latest = Client_keys.V_latest
include module type of V_latest
include module type of struct include Client_keys.V0 end
module Signature_type = Client_keys.V0.Signature_type

Signature_type is a small module to be included in signer to conform to the module type SIGNER instead of rewriting all type.

module Public_key_hash = Client_keys.V0.Public_key_hash
module Public_key = Client_keys.V0.Public_key
module Secret_key = Client_keys.V0.Secret_key
val supports_deterministic_nonces : Client_keys.sk_uri -> bool Mavryk_base.TzPervasives.tzresult Lwt.t

Similar to repeated calls to register_key, but is more efficient. Always forces addition of new elements.

val force_switch : unit -> (bool, 'ctx) Mavryk_clic.arg