package tezos-signer-backends

You can search for identifiers within the package.

in-package search v0.2.0

tezos-signer-backends
- Tezos_signer_backends
  - Encrypted
    
    Make
    
    C
  - Http
    
    Make
    
    P
    
    RPC_client
    
    LOGGER
    
    http_ctxt
  - Http_gen
    
    Make
    
    Make
    
    P
    
    RPC_client
    
    LOGGER
    
    http_ctxt
    
    N
  - Https
    
    Make
    
    P
    
    RPC_client
    
    LOGGER
    
    http_ctxt
  - Signer_events
  - Unencrypted
tezos-signer-backends.unix
- Tezos_signer_backends_unix
  - Ledger
    
    Signer_implementation
  - Ledger_names
  - Remote
    
    Make
    
    RPC_client
    
    LOGGER
    
    http_ctxt
    
    S
  - Socket
    
    Make
    
    P
    
    Tcp
    
    Unix

Legend:
Library
Module
Module type
Parameter
Class
Class type

include Tezos_client_base.Client_keys.SIGNER

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.

val neuterize : 
  Tezos_client_base.Client_keys.sk_uri ->
  (Tezos_client_base.Client_keys.pk_uri, Tezos_error_monad.TzCore.error list)
    Stdlib.result
    Lwt.t

neuterize sk is the corresponding pk.

val import_secret_key : 
  io:Tezos_client_base.Client_context.io_wallet ->
  Tezos_client_base.Client_keys.pk_uri ->
  (Tezos_crypto.Signature.Public_key_hash.t
   * Tezos_crypto.Signature.Public_key.t option,
    Tezos_error_monad.TzCore.error list)
    Stdlib.result
    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.

val public_key : 
  Tezos_client_base.Client_keys.pk_uri ->
  (Tezos_crypto.Signature.Public_key.t, Tezos_error_monad.TzCore.error list)
    Stdlib.result
    Lwt.t

public_key pk is the Ed25519 version of pk.

val public_key_hash : 
  Tezos_client_base.Client_keys.pk_uri ->
  (Tezos_crypto.Signature.Public_key_hash.t
   * Tezos_crypto.Signature.Public_key.t option,
    Tezos_error_monad.TzCore.error list)
    Stdlib.result
    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 ->
  Tezos_client_base.Client_keys.sk_uri ->
  Stdlib.Bytes.t ->
  (Tezos_crypto.Signature.t, Tezos_error_monad.TzCore.error list) Stdlib.result
    Lwt.t

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

val deterministic_nonce : 
  Tezos_client_base.Client_keys.sk_uri ->
  Stdlib.Bytes.t ->
  (Stdlib.Bytes.t, Tezos_error_monad.TzCore.error list) Stdlib.result Lwt.t

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

val deterministic_nonce_hash : 
  Tezos_client_base.Client_keys.sk_uri ->
  Stdlib.Bytes.t ->
  (Stdlib.Bytes.t, Tezos_error_monad.TzCore.error list) Stdlib.result Lwt.t

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

val supports_deterministic_nonces : 
  Tezos_client_base.Client_keys.sk_uri ->
  (bool, Tezos_error_monad.TzCore.error list) Stdlib.result Lwt.t

supports_deterministic_nonces indicates whether the deterministic_nonce functionality is supported.

val make_pk : 
  Tezos_crypto.Signature.public_key ->
  (Tezos_client_base.Client_keys.pk_uri, Tezos_error_monad.TzCore.error list)
    Stdlib.result
    Lwt.t

val make_sk : 
  Tezos_crypto.Signature.secret_key ->
  (Tezos_client_base.Client_keys.sk_uri, Tezos_error_monad.TzCore.error list)
    Stdlib.result
    Lwt.t

val make_sapling_key : 
  Tezos_sapling.Core.Wallet.Spending_key.t ->
  Tezos_client_base.Client_keys.sapling_uri