package octez-shell-libs

  1. Overview
  2. Docs
Octez shell libraries

Install 

dune-project
 Dependency

www.tezos.com Readme Edit opam file Versions (5)

Authors

  1. T
    Tezos devteam

Maintainers

  1. C
    contact@tezos.com

Sources

octez-19.1.tar.gz
sha256=55ea1fb8bb3273a7fc270ca8f650d45c56449665619482aad9bc12f3ea736b7e
sha512=fec850fc2d17d7490bbabd5147d62aad13b3aaed8774270f8a38ab419670ed03e0fd30cf8642a97984eca5c2446726fe590ad99c015f7ec50919dc7652f25053

doc/octez-shell-libs.client-base/Tezos_client_base/Client_keys/V1/index.html

Module Client_keys.V1Source

Sourcemodule Signature_type : sig ... end

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

Sourcemodule Public_key_hash : Client_aliases.Alias with type t = Tezos_crypto.Signature.V1.Public_key_hash.t
Sourcemodule Public_key : Client_aliases.Alias with type t = pk_uri * Tezos_crypto.Signature.V1.Public_key.t option
Sourceval import_secret_key : io:Client_context.io_wallet -> pk_uri -> (Tezos_crypto.Signature.V1.Public_key_hash.t * Tezos_crypto.Signature.V1.Public_key.t option) Tezos_base.TzPervasives.tzresult Lwt.t
Sourceval public_key : pk_uri -> Tezos_crypto.Signature.V1.Public_key.t Tezos_base.TzPervasives.tzresult Lwt.t
Sourceval public_key_hash : pk_uri -> (Tezos_crypto.Signature.V1.Public_key_hash.t * Tezos_crypto.Signature.V1.Public_key.t option) Tezos_base.TzPervasives.tzresult Lwt.t
Sourceval sign : Client_context.wallet -> ?watermark:Tezos_crypto.Signature.V1.watermark -> sk_uri -> Tezos_base.TzPervasives.Bytes.t -> Tezos_crypto.Signature.V1.t Tezos_base.TzPervasives.tzresult Lwt.t
Sourceval check : ?watermark:Tezos_crypto.Signature.V1.watermark -> pk_uri -> Tezos_crypto.Signature.V1.t -> Tezos_base.TzPervasives.Bytes.t -> bool Tezos_base.TzPervasives.tzresult Lwt.t
Sourceval supports_deterministic_nonces : sk_uri -> bool Tezos_base.TzPervasives.tzresult Lwt.t
Sourceval register_key : Client_context.wallet -> ?force:bool -> (Tezos_crypto.Signature.V1.Public_key_hash.t * pk_uri * sk_uri) -> ?public_key:Tezos_crypto.Signature.V1.Public_key.t -> string -> unit Tezos_base.TzPervasives.tzresult Lwt.t
Sourceval register_keys : Client_context.wallet -> (string * Tezos_crypto.Signature.V1.Public_key_hash.t * Tezos_crypto.Signature.V1.Public_key.t * pk_uri * sk_uri) list -> unit Tezos_base.TzPervasives.tzresult Lwt.t

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

Sourceval list_keys : Client_context.wallet -> (string * Tezos_crypto.Signature.V1.Public_key_hash.t * Tezos_crypto.Signature.V1.Public_key.t option * sk_uri option) list Tezos_base.TzPervasives.tzresult Lwt.t
Sourceval alias_keys : Client_context.wallet -> string -> (Tezos_crypto.Signature.V1.Public_key_hash.t * Tezos_crypto.Signature.V1.Public_key.t option * sk_uri option) option Tezos_base.TzPervasives.tzresult Lwt.t
Sourceval get_key : Client_context.wallet -> Tezos_crypto.Signature.V1.Public_key_hash.t -> (string * Tezos_crypto.Signature.V1.Public_key.t * sk_uri) Tezos_base.TzPervasives.tzresult Lwt.t
Sourceval get_public_key : Client_context.wallet -> Tezos_crypto.Signature.V1.Public_key_hash.t -> (string * Tezos_crypto.Signature.V1.Public_key.t) Tezos_base.TzPervasives.tzresult Lwt.t
Sourceval get_keys : Client_context.wallet -> (string * Tezos_crypto.Signature.V1.Public_key_hash.t * Tezos_crypto.Signature.V1.Public_key.t * sk_uri) list Tezos_base.TzPervasives.tzresult Lwt.t
Sourceval force_switch : unit -> (bool, 'ctx) Tezos_clic.arg