package octez-shell-libs

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

Parameters

module C : sig ... end

Signature

include Tezos_client_base.Client_keys.COMMON_SIGNER with type public_key_hash = Tezos_crypto.Aggregate_signature.Public_key_hash.t and type public_key = Tezos_crypto.Aggregate_signature.Public_key.t and type secret_key = Tezos_crypto.Aggregate_signature.Secret_key.t and type pk_uri = Tezos_client_base.Client_keys.aggregate_pk_uri and type sk_uri = Tezos_client_base.Client_keys.aggregate_sk_uri
type signature
val scheme : string

scheme is the name of the scheme implemented by this signer module.

val title : string

title is a one-line human readable description of the signer.

val description : string

description is a multi-line human readable description of the signer, that should include the format of key specifications.

neuterize sk is the corresponding pk.

import_secret_key ~io pk is the function to be called when interactively importing a key-pair and returning the public key and its hash.

Some signer implementations improve long-term security by requiring human/manual validation while importing keys, the ~io argument can be used to prompt the user in such case.

public_key pk is the Ed25519 version of pk.

val public_key_hash : pk_uri -> (public_key_hash * public_key option) Tezos_base.TzPervasives.tzresult Lwt.t

public_key_hash pk is the hash of pk. As some signers will query the full public key to obtain the hash, it can be optionally returned to reduce the amount of queries.

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