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.signer-backends/Tezos_signer_backends/Unencrypted/index.html

Module Tezos_signer_backends.UnencryptedSource

include Tezos_client_base.Client_keys.SIGNER
include Tezos_client_base.Client_keys.COMMON_SIGNER with type public_key_hash = Tezos_crypto.Signature.Public_key_hash.t and type public_key = Tezos_crypto.Signature.Public_key.t and type secret_key = Tezos_crypto.Signature.Secret_key.t and type signature = Tezos_crypto.Signature.t and type pk_uri = Tezos_client_base.Client_keys.pk_uri and type sk_uri = Tezos_client_base.Client_keys.sk_uri
Sourcetype public_key_hash = Tezos_crypto.Signature.Public_key_hash.t
Sourcetype public_key = Tezos_crypto.Signature.Public_key.t
Sourcetype secret_key = Tezos_crypto.Signature.Secret_key.t
Sourcetype signature = Tezos_crypto.Signature.t
Sourceval scheme : string

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

Sourceval title : string

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

Sourceval 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.

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.

Sourceval sign : ?watermark:Tezos_crypto.Signature.watermark -> sk_uri -> Tezos_base.TzPervasives.Bytes.t -> signature Tezos_base.TzPervasives.tzresult Lwt.t

sign ?watermark sk data is signature obtained by signing data with sk.

deterministic_nonce sk data is a nonce obtained deterministically from data and sk.

deterministic_nonce_hash sk data is a nonce hash obtained deterministically from data and sk.

Sourceval supports_deterministic_nonces : sk_uri -> bool Tezos_base.TzPervasives.tzresult Lwt.t

supports_deterministic_nonces indicates whether the deterministic_nonce functionality is supported.

Sourceval make_pk : Tezos_crypto.Signature.public_key -> Tezos_client_base.Client_keys.pk_uri Tezos_base.TzPervasives.tzresult
Sourceval make_sk : Tezos_crypto.Signature.secret_key -> Tezos_client_base.Client_keys.sk_uri Tezos_base.TzPervasives.tzresult
Sourceval make_sapling_key : Tezos_sapling.Core.Wallet.Spending_key.t -> Tezos_client_base.Client_keys.sapling_uri Tezos_base.TzPervasives.tzresult
Sourcemodule Aggregate : sig ... end