package octez-shell-libs
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=dbc3b675aee59c2c574e5d0a771193a2ecfca31e7a5bc5aed66598080596ce1c
sha512=b97ed762b9d24744305c358af0d20f394376b64bfdd758dd4a81775326caf445caa57c4f6445da3dd6468ff492de18e4c14af6f374dfcbb7e4d64b7b720e5e2a
doc/tezos_signer_backends_unix/Tezos_signer_backends_unix/Remote/Make/index.html
Module Remote.Make
Source
Parameters
module S : sig ... end
Signature
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
type pk_uri = Tezos_client_base.Client_keys.pk_uri
type sk_uri = Tezos_client_base.Client_keys.sk_uri
scheme
is the name of the scheme implemented by this signer module.
title
is a one-line human readable description of the signer.
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
.
val import_secret_key :
io:Tezos_client_base.Client_context.io_wallet ->
pk_uri ->
(public_key_hash * public_key option) Tezos_base.TzPervasives.tzresult Lwt.t
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.
val 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
.
val deterministic_nonce :
sk_uri ->
Tezos_base.TzPervasives.Bytes.t ->
Tezos_base.TzPervasives.Bytes.t Tezos_base.TzPervasives.tzresult Lwt.t
deterministic_nonce sk data
is a nonce obtained deterministically from data
and sk
.
val deterministic_nonce_hash :
sk_uri ->
Tezos_base.TzPervasives.Bytes.t ->
Tezos_base.TzPervasives.Bytes.t Tezos_base.TzPervasives.tzresult Lwt.t
deterministic_nonce_hash sk data
is a nonce hash obtained deterministically from data
and sk
.
supports_deterministic_nonces
indicates whether the deterministic_nonce
functionality is supported.