package octez-shell-libs

  1. Overview
  2. Docs
package octez-shell-libs
Legend:
Library
Module
Module type
Parameter
Class
Class type
type public_key_hash
type public_key
type secret_key
type watermark
type signature
module 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.

module Public_key : Client_aliases.Alias with type t = pk_uri * public_key option
val import_secret_key : io:Client_context.io_wallet -> pk_uri -> (public_key_hash * public_key option) Tezos_base.TzPervasives.tzresult Lwt.t
val public_key : pk_uri -> public_key Tezos_base.TzPervasives.tzresult Lwt.t
val public_key_hash : pk_uri -> (public_key_hash * public_key option) Tezos_base.TzPervasives.tzresult Lwt.t
val neuterize : sk_uri -> pk_uri Tezos_base.TzPervasives.tzresult Lwt.t
val sign : Client_context.wallet -> ?watermark:watermark -> sk_uri -> Tezos_base.TzPervasives.Bytes.t -> signature Tezos_base.TzPervasives.tzresult Lwt.t
val append : Client_context.wallet -> ?watermark:watermark -> sk_uri -> Tezos_base.TzPervasives.Bytes.t -> Tezos_base.TzPervasives.Bytes.t Tezos_base.TzPervasives.tzresult Lwt.t
val check : ?watermark:watermark -> pk_uri -> signature -> Tezos_base.TzPervasives.Bytes.t -> bool Tezos_base.TzPervasives.tzresult Lwt.t
val deterministic_nonce : sk_uri -> Tezos_base.TzPervasives.Bytes.t -> Tezos_base.TzPervasives.Bytes.t Tezos_base.TzPervasives.tzresult Lwt.t
val deterministic_nonce_hash : sk_uri -> Tezos_base.TzPervasives.Bytes.t -> Tezos_base.TzPervasives.Bytes.t Tezos_base.TzPervasives.tzresult Lwt.t
val supports_deterministic_nonces : sk_uri -> bool Tezos_base.TzPervasives.tzresult Lwt.t
val register_key : Client_context.wallet -> ?force:bool -> (public_key_hash * pk_uri * sk_uri) -> ?public_key:public_key -> string -> unit Tezos_base.TzPervasives.tzresult Lwt.t
val register_keys : Client_context.wallet -> (string * public_key_hash * public_key * 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.

val list_keys : Client_context.wallet -> (string * public_key_hash * public_key option * sk_uri option) list Tezos_base.TzPervasives.tzresult Lwt.t
val alias_keys : Client_context.wallet -> string -> (public_key_hash * public_key option * sk_uri option) option Tezos_base.TzPervasives.tzresult Lwt.t
val get_key : Client_context.wallet -> public_key_hash -> (string * public_key * sk_uri) Tezos_base.TzPervasives.tzresult Lwt.t
val get_public_key : Client_context.wallet -> public_key_hash -> (string * public_key) Tezos_base.TzPervasives.tzresult Lwt.t
val get_keys : Client_context.wallet -> (string * public_key_hash * public_key * sk_uri) list Tezos_base.TzPervasives.tzresult Lwt.t
val force_switch : unit -> (bool, 'ctx) Tezos_clic.arg
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct