package tezos-client-base

  1. Overview
  2. Docs

Cryptographic keys tables

type pk_uri = private Uri.t
module Pk_uri_hashtbl : sig ... end
type sk_uri = private Uri.t
type sapling_uri = private Uri.t
type pvss_sk_uri = private Uri.t
val pk_uri_parameter : unit -> (pk_uri, 'a) Tezos_clic.Clic.parameter
val pk_uri_param : ?name:string -> ?desc:string -> ('a, 'b) Tezos_clic.Clic.params -> (pk_uri -> 'a, 'b) Tezos_clic.Clic.params
val sk_uri_parameter : unit -> (sk_uri, 'a) Tezos_clic.Clic.parameter
val sk_uri_param : ?name:string -> ?desc:string -> ('a, 'b) Tezos_clic.Clic.params -> (sk_uri -> 'a, 'b) Tezos_clic.Clic.params
type Tezos_base__TzPervasives.error +=
  1. | Unregistered_key_scheme of string
type Tezos_base__TzPervasives.error +=
  1. | Invalid_uri of Uri.t
type sapling_key = {
  1. sk : sapling_uri;
  2. path : int32 list;
  3. address_index : Tezos_sapling.Core.Client.Viewing_key.index;
}
module Logging : sig ... end

Interface for external signing modules.

module type SIGNER = sig ... end
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 * (module SIGNER)) list
val neuterize : sk_uri -> (pk_uri, Tezos_error_monad.TzCore.error list) Stdlib.result Lwt.t
val append : Client_context.wallet -> ?watermark:Tezos_crypto.Signature.watermark -> sk_uri -> Stdlib.Bytes.t -> (Stdlib.Bytes.t, Tezos_error_monad.TzCore.error list) Stdlib.result Lwt.t
val check : ?watermark:Tezos_crypto.Signature.watermark -> pk_uri -> Tezos_crypto.Signature.t -> Stdlib.Bytes.t -> (bool, Tezos_error_monad.TzCore.error list) Stdlib.result Lwt.t
val deterministic_nonce : sk_uri -> Stdlib.Bytes.t -> (Stdlib.Bytes.t, Tezos_error_monad.TzCore.error list) Stdlib.result Lwt.t
val deterministic_nonce_hash : sk_uri -> Stdlib.Bytes.t -> (Stdlib.Bytes.t, Tezos_error_monad.TzCore.error list) Stdlib.result Lwt.t
val supports_deterministic_nonces : sk_uri -> (bool, Tezos_error_monad.TzCore.error list) Stdlib.result Lwt.t
val register_key : Client_context.wallet -> ?force:bool -> (Tezos_crypto.Signature.Public_key_hash.t * pk_uri * sk_uri) -> ?public_key:Tezos_crypto.Signature.Public_key.t -> string -> (unit, Tezos_error_monad.TzCore.error list) Stdlib.result Lwt.t
val list_keys : Client_context.wallet -> ((string * Public_key_hash.t * Tezos_crypto.Signature.public_key option * sk_uri option) list, Tezos_error_monad.TzCore.error list) Stdlib.result Lwt.t
val alias_keys : Client_context.wallet -> string -> ((Public_key_hash.t * Tezos_crypto.Signature.public_key option * sk_uri option) option, Tezos_error_monad.TzCore.error list) Stdlib.result Lwt.t
val force_switch : unit -> (bool, 'ctx) Tezos_clic.Clic.arg
OCaml

Innovation. Community. Security.