Module Tezt_tezos.Signatory

This module is a Tezt wrapper around the Tezos remote signer "Signatory".

It allows to run a signatory signer and to interact with it.

type generic = [
  1. | `Activate_account
  2. | `Attestation
  3. | `Attestation_with_dal
  4. | `Ballot
  5. | `Dal_publish_commitment
  6. | `Delegation
  7. | `Double_attestation_evidence
  8. | `Double_baking_evidence
  9. | `Double_preattestation_evidence
  10. | `Drain_delegate
  11. | `Failing_noop
  12. | `Finalize_unstake
  13. | `Increase_paid_storage
  14. | `Origination
  15. | `Preattestation
  16. | `Proposals
  17. | `Register_global_constant
  18. | `Reveal
  19. | `Seed_nonce_revelation
  20. | `Set_delegate_parameters
  21. | `Set_deposits_limit
  22. | `Signature_prefix
  23. | `Smart_rollup_add_messages
  24. | `Smart_rollup_cement
  25. | `Smart_rollup_execute_outbox_message
  26. | `Smart_rollup_originate
  27. | `Smart_rollup_publish
  28. | `Smart_rollup_recover_bond
  29. | `Smart_rollup_refute
  30. | `Smart_rollup_timeout
  31. | `Stake
  32. | `Transaction
  33. | `Transfer_ticket
  34. | `Unstake
  35. | `Update_consensus_key
  36. | `Vdf_revelation
  37. | `Zk_rollup_origination
  38. | `Zk_rollup_publish
  39. | `Zk_rollup_update
]

The type of a generic operation that can be signed by the signatory.

type restriction = [
  1. | `Block
  2. | `Endorsement
  3. | `Failing_noop
  4. | `Generic of generic list
  5. | `Preendorsement
]

The type of a restriction on the operations that can be signed by the signatory.

type key = {
  1. account : Account.key;
    (*

    The account associated with the key.

    *)
  2. active : bool;
    (*

    Whether the key is active.

    *)
  3. log_payloads : bool;
    (*

    Whether to log the payloads of the operations.

    *)
  4. restrictions : restriction list;
    (*

    The restrictions on the operations that can be signed by the key.

    *)
}

The type of a key that can be used by the signatory.

type t

The type for a signatory signer.

val port : t -> int

port signatory returns the port on which the signatory signer is listening.

val create : ?name:string -> ?color:Tezt_wrapper.Log.Color.t -> ?base_dir:string -> ?port:int -> ?runner:Tezt_wrapper.Runner.t -> ?config_file:string -> ?vault_name:string -> key list -> t Lwt.t

create ?name ?color ?base_dir ?port ?runner ?config_file ?vault_name keys creates a new signatory signer instance.

val wait_for_ready : t -> unit Lwt.t

wait_for_ready signatory waits for the signatory signer to be ready to accept requests.

val run : t -> unit Lwt.t

run signatory runs the signatory signer.

val terminate : ?timeout:float -> t -> unit

terminate ?timeout signatory terminates the signatory signer.

val restart : t -> unit Lwt.t

restart signatory restarts the signatory signer.