package octez-shell-libs

  1. Overview
  2. Docs
package octez-shell-libs
Legend:
Library
Module
Module type
Parameter
Class
Class type

Cryptographic keys tables

type pk_uri = private Uri.t
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) Tezos_clic.parameter
val pk_uri_param : ?name:string -> ?desc:string -> ('a, 'b) Tezos_clic.params -> (pk_uri -> 'a, 'b) Tezos_clic.params
val sk_uri_parameter : unit -> (sk_uri, 'a) Tezos_clic.parameter
val sk_uri_param : ?name:string -> ?desc:string -> ('a, 'b) Tezos_clic.params -> (sk_uri -> 'a, 'b) Tezos_clic.params
val aggregate_sk_uri_parameter : unit -> (aggregate_sk_uri, 'a) Tezos_clic.parameter
val aggregate_sk_uri_param : ?name:string -> ?desc:string -> ('a, 'b) Tezos_clic.params -> (aggregate_sk_uri -> 'a, 'b) Tezos_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 Aggregate_alias : sig ... end

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 : sig ... end
module Logging : sig ... end

Interface for external signing modules.

module type COMMON_SIGNER = sig ... end
module type AGGREGATE_SIGNER = sig ... end
module type SIGNER = sig ... end
type 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 = sig ... end
include module type of V_latest
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.

val supports_deterministic_nonces : sk_uri -> bool Tezos_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) 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