package tezt-tezos

  1. Overview
  2. Docs
package tezt-tezos
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Tezt_tezos.Dac_nodeSource

Spawn Data-availability-committee (DAC) nodes and control them.

Sourcetype t

DAC Node state.

Sourceval create_coordinator : ?path:string -> ?name:string -> ?color:Tezt.Log.Color.t -> ?data_dir:string -> ?event_pipe:string -> ?rpc_host:string -> ?rpc_port:int -> ?reveal_data_dir:string -> ?allow_v1_api:bool -> committee_members:string list -> node:Node.t -> client:Client.t -> unit -> t

Creates a DAC node to run in coordinator mode registered with the specified committee members.

Sourceval create_coordinator_with_endpoint : ?path:string -> ?name:string -> ?color:Tezt.Log.Color.t -> ?data_dir:string -> ?event_pipe:string -> ?rpc_host:string -> ?rpc_port:int -> ?reveal_data_dir:string -> ?allow_v1_api:bool -> committee_members:string list -> endpoint:Client.endpoint -> client:Client.t -> unit -> t

Same as create_coordinator, but do not assume the endpoint is a node.

Sourceval create_committee_member : ?path:string -> ?name:string -> ?color:Tezt.Log.Color.t -> ?data_dir:string -> ?event_pipe:string -> ?rpc_host:string -> ?rpc_port:int -> ?reveal_data_dir:string -> ?coordinator_rpc_host:string -> ?coordinator_rpc_port:int -> ?allow_v1_api:bool -> address:string -> node:Node.t -> client:Client.t -> unit -> t

Creates a DAC node to run in committee_member mode, using the specified address, coordinator rpc host and port.

Sourceval create_committee_member_with_endpoint : ?path:string -> ?name:string -> ?color:Tezt.Log.Color.t -> ?data_dir:string -> ?event_pipe:string -> ?rpc_host:string -> ?rpc_port:int -> ?reveal_data_dir:string -> ?coordinator_rpc_host:string -> ?coordinator_rpc_port:int -> ?allow_v1_api:bool -> address:string -> endpoint:Client.endpoint -> client:Client.t -> unit -> t

Same as create_committee_member, but do not assume the endpoint is a node.

Sourceval create_observer : ?path:string -> ?name:string -> ?color:Tezt.Log.Color.t -> ?data_dir:string -> ?event_pipe:string -> ?rpc_host:string -> ?rpc_port:int -> ?reveal_data_dir:string -> ?coordinator_rpc_host:string -> ?coordinator_rpc_port:int -> ?timeout:int -> ?allow_v1_api:bool -> committee_member_rpcs:(string * int) list -> node:Node.t -> client:Client.t -> unit -> t

Creates a DAC node to run in observer mode, using the specified coordinator rpc host and port and set the committee member endpoints to committee_member_rpcs.

Sourceval create_observer_with_endpoint : ?path:string -> ?name:string -> ?color:Tezt.Log.Color.t -> ?data_dir:string -> ?event_pipe:string -> ?rpc_host:string -> ?rpc_port:int -> ?reveal_data_dir:string -> ?coordinator_rpc_host:string -> ?coordinator_rpc_port:int -> ?timeout:int -> ?allow_v1_api:bool -> committee_member_rpcs:(string * int) list -> endpoint:Client.endpoint -> client:Client.t -> unit -> t

Same as create_obsever, but do not assume the endpoint is a node.

Sourceval name : t -> string

Get the name of an dac node.

Sourceval mode : t -> string

Get the mode in which a dac node is configured to run. Returned values can be either "Coordinator", "Commitee_member" or "Observer".

Sourceval rpc_host : t -> string

Get the RPC host given as --rpc-addr to an dac node.

Sourceval rpc_port : t -> int

Get the RPC port given as --rpc-addr to an dac node.

Sourceval endpoint : t -> string

Return the endpoint of the dac node, i.e., http://rpc_host:rpc_port.

Sourceval data_dir : t -> string

Get the data-dir of an dac node.

Sourceval reveal_data_dir : t -> string

Get the reveal-data-dir of an dac node.

Sourceval allow_v1_api : t -> bool

allow_v1_api dac_node is true if current node allows running V1 API.

Sourceval ls_reveal_data_dir : t -> string list Lwt.t

Calls ls on reveal data dir.

Sourceval run : ?wait_ready:bool -> ?env:string Tezt.Base.String_map.t -> t -> unit Lwt.t

run ?wait_ready ?env node launches the given dac node where env is a map of environment variable.

If wait_ready is true, the promise waits for the dac node to be ready. true by default.

Sourceval terminate : ?timeout:float -> t -> unit Lwt.t

Send SIGTERM and wait for the process to terminate.

Default timeout is 30 seconds, after which SIGKILL is sent.

Sourceval kill : t -> unit Lwt.t

Send SIGKILL and wait for the process to terminate.

Sourceval log_events : t -> unit

Shows in stdout every events sent by the node

Sourceval wait_for : ?where:string -> t -> string -> (Tezt.JSON.t -> 'a option) -> 'a Lwt.t

See Daemon.Make.wait_for.

Sourceval is_running_not_ready : t -> bool

is_running_not_ready dac_node returns true if the given node is running but its status is not ready

Sourceval wait : t -> Unix.process_status Lwt.t

Wait until a node terminates and return its status. If the node is not running, make the test fail.

Sourceval init_config : t -> string Lwt.t

Run octez-dac-node init-config. Returns the name of the resulting configuration file.

Sourcemodule Config_file : sig ... end

C node configuration files.

Sourceval with_sleeping_node : ?rpc_port:int -> ?rpc_address:string -> timeout:float -> ((string * int) -> unit Lwt.t) -> unit Lwt.t

with_sleeping_node creates and runs an embedded node that sleeps for timeout seconds upon receiving any request then returns "ok". It is used to test timeout capabilities of clients.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct