tezos-client-base 10.2 · OCaml Package

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 +=

| Unregistered_key_scheme of string

type Tezos_base__TzPervasives.error +=

| Invalid_uri of Uri.t

module Public_key_hash : 
  Client_aliases.Alias with type t = Tezos_crypto.Signature.Public_key_hash.t

module Public_key : 
  Client_aliases.Alias
    with type t = pk_uri * Tezos_crypto.Signature.Public_key.t option

module Secret_key : Client_aliases.Alias with type t = sk_uri

type sapling_key = {

sk : sapling_uri;
path : int32 list;
address_index : Tezos_sapling.Core.Client.Viewing_key.index;

}

module Sapling_key : Client_aliases.Alias with type t = sapling_key

module PVSS_public_key : 
  Client_aliases.Alias with type t = Tezos_crypto.Pvss_secp256k1.Public_key.t

module PVSS_secret_key : Client_aliases.Alias with type t = pvss_sk_uri

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 import_secret_key : 
  io:Client_context.io_wallet ->
  pk_uri ->
  (Tezos_crypto.Signature.Public_key_hash.t
   * Tezos_crypto.Signature.Public_key.t option,
    Tezos_error_monad.TzCore.error list)
    result
    Lwt.t

val public_key : 
  pk_uri ->
  (Tezos_crypto.Signature.Public_key.t, Tezos_error_monad.TzCore.error list)
    result
    Lwt.t

val public_key_hash : 
  pk_uri ->
  (Tezos_crypto.Signature.Public_key_hash.t
   * Tezos_crypto.Signature.Public_key.t option,
    Tezos_error_monad.TzCore.error list)
    result
    Lwt.t

val neuterize : 
  sk_uri ->
  (pk_uri, Tezos_error_monad.TzCore.error list) result Lwt.t

val sign : 
  Client_context.wallet ->
  ?watermark:Tezos_crypto.Signature.watermark ->
  sk_uri ->
  Bytes.t ->
  (Tezos_crypto.Signature.t, Tezos_error_monad.TzCore.error list) result Lwt.t

val append : 
  Client_context.wallet ->
  ?watermark:Tezos_crypto.Signature.watermark ->
  sk_uri ->
  Bytes.t ->
  (Bytes.t, Tezos_error_monad.TzCore.error list) result Lwt.t

val check : 
  ?watermark:Tezos_crypto.Signature.watermark ->
  pk_uri ->
  Tezos_crypto.Signature.t ->
  Bytes.t ->
  (bool, Tezos_error_monad.TzCore.error list) result Lwt.t

val deterministic_nonce : 
  sk_uri ->
  Bytes.t ->
  (Bytes.t, Tezos_error_monad.TzCore.error list) result Lwt.t

val deterministic_nonce_hash : 
  sk_uri ->
  Bytes.t ->
  (Bytes.t, Tezos_error_monad.TzCore.error list) result Lwt.t

val supports_deterministic_nonces : 
  sk_uri ->
  (bool, Tezos_error_monad.TzCore.error list) 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) 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)
    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)
    result
    Lwt.t

val get_key : 
  Client_context.wallet ->
  Public_key_hash.t ->
  (string * Tezos_crypto.Signature.Public_key.t * sk_uri,
    Tezos_error_monad.TzCore.error list)
    result
    Lwt.t

val get_public_key : 
  Client_context.wallet ->
  Public_key_hash.t ->
  (string * Tezos_crypto.Signature.Public_key.t,
    Tezos_error_monad.TzCore.error list)
    result
    Lwt.t

val get_keys : 
  Client_context.wallet ->
  ((string * Public_key_hash.t * Tezos_crypto.Signature.Public_key.t * sk_uri)
     list,
    Tezos_error_monad.TzCore.error list)
    result
    Lwt.t

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

package tezos-client-base

Cryptographic keys tables

Interface for external signing modules.