package tezos-client-012-Psithaca

  1. Overview
  2. Docs
Tezos/Protocol: protocol specific library for `tezos-client`

Install 

dune-project
 Dependency

www.tezos.com Readme Edit opam file Versions (3)

Authors

  1. T
    Tezos devteam

Maintainers

  1. C
    contact@tezos.com

Sources

tezos-16.1.tar.gz
sha256=43723d096307603703a1a89ed1b2eb202b365f5e7824b96b0cbf813b343a6cf7
sha512=b2a637f2e965000d3d49ad85277ca24d6cb07a1a7cf2bc69d296d8b03ad78c3eaa8e21e94b9162e62c2e11649cd03bc845b2a3dafe623b91065df69d47dc8e4f

doc/tezos-client-012-Psithaca.commands/Tezos_client_012_Psithaca_commands/Client_proto_stresstest_commands/index.html

Module Tezos_client_012_Psithaca_commands.Client_proto_stresstest_commandsSource

Sourcetype transfer_strategy =
  1. | Fixed_amount of {
    1. mutez : Tezos_protocol_012_Psithaca.Protocol.Alpha_context.Tez.t;
    }
    (*

    Amount to transfer

    *)
  2. | Evaporation of {
    1. fraction : float;
    }
    (*

    Maximum fraction of current wealth to transfer. Minimum amount is 1 mutez regardless of total wealth.

    *)
Sourcetype limit =
  1. | Abs of int
    (*

    Absolute level at which we should stop

    *)
  2. | Rel of int
    (*

    Relative number of level before stopping

    *)
Sourcetype parameters = {
  1. seed : int;
  2. fresh_probability : float;
    (*

    Per-transfer probability that the destination will be fresh

    *)
  3. tps : float;
    (*

    Transaction per seconds target

    *)
  4. strategy : transfer_strategy;
  5. fee_mutez : Tezos_protocol_012_Psithaca.Protocol.Alpha_context.Tez.t;
    (*

    fees for each transfer, in mutez

    *)
  6. gas_limit : Tezos_protocol_012_Psithaca.Protocol.Alpha_context.Gas.Arith.integral;
    (*

    gas limit per operation

    *)
  7. storage_limit : Z.t;
    (*

    storage limit per operation

    *)
  8. account_creation_storage : Z.t;
    (*

    upper bound on bytes consumed when creating a tz1 account

    *)
  9. total_transfers : int option;
    (*

    total number of transfers to perform; unbounded if None

    *)
  10. single_op_per_pkh_per_block : bool;
    (*

    if true, a single operation will be injected by pkh by block to improve the chance for the injected operations to be included in the next block

    *)
  11. level_limit : limit option;
    (*

    total number of levels during which the stresstest is run; unbounded if None

    *)
}
Sourcetype origin =
  1. | Explicit
  2. | Wallet_pkh
  3. | Wallet_alias of string
Sourcetype source = {
  1. pkh : Tezos_protocol_012_Psithaca.Protocol.Alpha_context.public_key_hash;
  2. pk : Tezos_protocol_012_Psithaca.Protocol.Alpha_context.public_key;
  3. sk : Tezos_crypto.Signature.V0.secret_key;
}
Sourcetype input_source =
  1. | Explicit of source
  2. | Wallet_alias of string
  3. | Wallet_pkh of Tezos_protocol_012_Psithaca.Protocol.Alpha_context.public_key_hash
Sourcetype source_origin = {
  1. source : source;
  2. origin : origin;
}
Sourcetype transfer = {
  1. src : source;
  2. dst : Tezos_protocol_012_Psithaca.Protocol.Alpha_context.public_key_hash;
  3. fee : Tezos_protocol_012_Psithaca.Protocol.Alpha_context.Tez.t;
  4. amount : Tezos_protocol_012_Psithaca.Protocol.Alpha_context.Tez.t;
  5. counter : Z.t option;
  6. fresh_dst : bool;
}
Sourcetype state = {
  1. current_head_on_start : Tezos_base.TzPervasives.Block_hash.t;
  2. counters : (Tezos_base.TzPervasives.Block_hash.t * Z.t) Tezos_crypto.Signature.V0.Public_key_hash.Table.t;
  3. mutable pool : source_origin list;
  4. mutable pool_size : int;
    (*

    Some l if single_op_per_pkh_per_block is true

    *)
  5. mutable shuffled_pool : source list option;
  6. mutable revealed : Tezos_crypto.Signature.V0.Public_key_hash.Set.t;
  7. mutable last_block : Tezos_base.TzPervasives.Block_hash.t;
  8. mutable last_level : int;
  9. new_block_condition : unit Lwt_condition.t;
  10. injected_operations : Tezos_base.TzPervasives.Operation_hash.t list Tezos_base.TzPervasives.Block_hash.Table.t;
}
Sourceval verbose : bool ref
Sourceval debug : bool ref
Sourceval debug_msg : (unit -> unit Lwt.t) -> unit Lwt.t
Sourceval default_parameters : parameters
Sourceval input_source_encoding : input_source Tezos_base.TzPervasives.Data_encoding.encoding
Sourceval input_source_list_encoding : input_source list Tezos_base.TzPervasives.Data_encoding.encoding
Sourceval injected_operations_encoding : (Tezos_base.TzPervasives.Block_hash.t * Tezos_base.TzPervasives.Operation_hash.t list) list Tezos_base.TzPervasives.Data_encoding.encoding
Sourceval parse_strategy : string -> (transfer_strategy, string) result

This command uses two different data structures for sources:

  • The in-output files one,
  • The normalized one.

The data structure used for in-output files does not directly contain the data required to forge operations. For efficiency purposes, the sources are converted into a normalized data structure that contains all the required data to forge operations and the format originally used to be able to revert this conversion.

normalize_source cctxt src converts src from in-output data structure to normalized one. If the conversion fails, None is returned and a warning message is printed in cctxt.

Only unencrypted and encrypted sources from the wallet of cctxt are supported.

Sourceval unnormalize_source : source_origin -> input_source

unnormalize_source src_org converts src_org from normalized data structure to in-output one.

Sourceval sample_any_source_from_pool : state -> Random.State.t -> source Lwt.t

Samples from state.pool. Used to generate the destination of a transfer, and its source only when state.shuffled_pool is None meaning that --single-op-per-pkh-per-block is not set.

Generates the source of a transfer. If state.shuffled_pool has a value (meaning that --single-op-per-pkh-per-block is active) then it is sampled from there, otherwise from state.pool.

Sourceval random_seed : Random.State.t -> bytes
Sourceval generate_fresh_source : state -> Random.State.t -> source
Sourceval heads_iter : Tezos_client_012_Psithaca.Protocol_client_context.full -> ((Tezos_base.TzPervasives.Block_hash.t * Tezos_base.Block_header.t) -> unit Lwt.t) -> unit Tezos_base.TzPervasives.tzresult Lwt.t
Sourceval inject_contents : Tezos_client_012_Psithaca.Protocol_client_context.full -> Tezos_shell_services.Chain_services.chain -> Tezos_protocol_environment_012_Psithaca.Block_hash.t -> Tezos_crypto.Signature.V0.Secret_key.t -> 'a Tezos_protocol_012_Psithaca.Protocol.Alpha_context.contents_list -> Tezos_base.TzPervasives.Operation_hash.t Tezos_base.TzPervasives.tzresult Lwt.t
Sourceval manager_op_of_transfer : parameters -> transfer -> Tezos_protocol_012_Psithaca.Protocol.Alpha_context.Kind.transaction Tezos_protocol_012_Psithaca.Protocol.Alpha_context.Kind.manager Tezos_protocol_012_Psithaca.Protocol.Alpha_context.contents
Sourceval cost_of_manager_operation : Tezos_protocol_012_Psithaca.Protocol.Alpha_context.Gas.Arith.integral
Sourceval save_injected_operations : Tezos_client_012_Psithaca.Protocol_client_context.full -> state -> unit Lwt.t
Sourcetype pool_source =
  1. | From_string of {
    1. json : Ezjsonm.value;
    }
  2. | From_file of {
    1. path : string;
    2. json : Ezjsonm.value;
    }
Sourceval json_of_pool_source : pool_source -> Ezjsonm.value
Sourceval json_file_or_text_parameter : (pool_source, Tezos_client_012_Psithaca.Protocol_client_context.full) Tezos_clic.parameter
Sourceval gas_limit_arg : (Tezos_protocol_012_Psithaca.Protocol.Alpha_context.Gas.Arith.integral option, Tezos_client_012_Psithaca.Protocol_client_context.full) Tezos_clic.arg
Sourceval set_option : 'a option -> ('b -> 'a -> 'b) -> 'b -> 'b
Sourceval commands : [< `Mainnet | `Testnet ] option -> unit -> Tezos_client_012_Psithaca.Protocol_client_context.full Tezos_clic.command list