Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
include 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 = aggregate_pk_uri
and type sk_uri = aggregate_sk_uri
type pk_uri = aggregate_pk_uritype sk_uri = aggregate_sk_uritype public_key_hash = Tezos_crypto.Aggregate_signature.Public_key_hash.ttype public_key = Tezos_crypto.Aggregate_signature.Public_key.ttype secret_key = Tezos_crypto.Aggregate_signature.Secret_key.tdescription is a multi-line human readable description of the signer, that should include the format of key specifications.
val neuterize : sk_uri -> pk_uri Tezos_base.TzPervasives.tzresult Lwt.tneuterize sk is the corresponding pk.
val import_secret_key :
io:Client_context.io_wallet ->
pk_uri ->
(public_key_hash * public_key option) Tezos_base.TzPervasives.tzresult Lwt.timport_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.
val public_key : pk_uri -> public_key Tezos_base.TzPervasives.tzresult Lwt.tpublic_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.tpublic_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 :
aggregate_sk_uri ->
Bytes.t ->
Tezos_crypto.Aggregate_signature.t Tezos_base.TzPervasives.tzresult Lwt.tsign sk data is signature obtained by signing data with sk.