package octez-protocol-alpha-libs

  1. Overview
  2. Docs
Octez protocol alpha libraries

Install 

dune-project
 Dependency

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

Authors

  1. T
    Tezos devteam

Maintainers

  1. C
    contact@tezos.com

Sources

tezos-octez-v20.1.tag.bz2
sha256=ddfb5076eeb0b32ac21c1eed44e8fc86a6743ef18ab23fff02d36e365bb73d61
sha512=d22a827df5146e0aa274df48bc2150b098177ff7e5eab52c6109e867eb0a1f0ec63e6bfbb0e3645a6c2112de3877c91a17df32ccbff301891ce4ba630c997a65

doc/octez-protocol-alpha-libs.client/Tezos_client_alpha/Client_proto_programs/index.html

Module Tezos_client_alpha.Client_proto_programsSource

Sourcemodule Program : Tezos_client_base.Client_aliases.Alias with type t = Michelson_v1_parser.parsed Tezos_micheline.Micheline_parser.parsing_result
Sourcetype simulation_params = {
  1. input : Michelson_v1_parser.parsed;
  2. unparsing_mode : Tezos_protocol_alpha.Protocol.Script_ir_unparser.unparsing_mode;
  3. now : Tezos_protocol_alpha.Protocol.Script_timestamp.t option;
  4. level : Tezos_protocol_alpha.Protocol.Script_int.n Tezos_protocol_alpha.Protocol.Script_int.num option;
  5. sender : Tezos_protocol_alpha.Protocol.Alpha_context.Contract.t option;
  6. payer : Tezos_base.TzPervasives.Signature.public_key_hash option;
  7. gas : Tezos_protocol_alpha.Protocol.Alpha_context.Gas.Arith.integral option;
  8. other_contracts : Tezos_protocol_plugin_alpha.RPC.Scripts.S.other_contract_description list option;
  9. extra_big_maps : Tezos_protocol_plugin_alpha.RPC.Scripts.S.extra_big_map_description list option;
}
Sourcetype run_view_params = {
  1. shared_params : simulation_params;
  2. contract : Tezos_protocol_alpha.Protocol.Contract_hash.t;
  3. entrypoint : Tezos_protocol_alpha.Protocol.Alpha_context.Entrypoint.t;
}
Sourcetype run_script_view_params = {
  1. shared_params : simulation_params;
  2. contract : Tezos_protocol_alpha.Protocol.Contract_hash.t;
  3. view : string;
  4. unlimited_gas : bool;
}
Sourcetype run_params = {
  1. shared_params : simulation_params;
  2. amount : Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t option;
  3. balance : Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t option;
  4. program : Michelson_v1_parser.parsed;
  5. storage : Michelson_v1_parser.parsed;
  6. entrypoint : Tezos_protocol_alpha.Protocol.Alpha_context.Entrypoint.t option;
  7. self : Tezos_protocol_alpha.Protocol.Contract_hash.t option;
}
Sourcetype run_instr_params = {
  1. shared_params : simulation_params;
  2. amount : Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t;
  3. balance : Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t option;
  4. stack : (Tezos_protocol_alpha.Protocol.Alpha_context.Script.expr * Tezos_protocol_alpha.Protocol.Alpha_context.Script.expr) list;
  5. self : Tezos_protocol_alpha.Protocol.Contract_hash.t option;
  6. parameter : Tezos_protocol_alpha.Protocol.Alpha_context.Script.expr option;
  7. legacy : bool;
}

Calls Tezos_protocol_plugin_alpha.Plugin.RPC.Scripts.run_tzip4_view

run_script_view cctxt ~chain ~block params executes Tezos_protocol_plugin_alpha.Plugin.RPC.Scripts.run_script_view, the RPC to run a Michelson view offchain and returns its value.

Sourceval run : Protocol_client_context.rpc_context -> chain:Tezos_shell_services.Shell_services.chain -> block:Tezos_shell_services.Shell_services.block -> run_params -> (Tezos_protocol_alpha.Protocol.Alpha_context.Script.expr * Tezos_protocol_alpha.Protocol.Apply_internal_results.packed_internal_operation list * Tezos_protocol_alpha.Protocol.Alpha_context.Lazy_storage.diffs option) Tezos_base.TzPervasives.tzresult Lwt.t

Calls Tezos_protocol_plugin_alpha.Plugin.RPC.Scripts.run_code

Sourceval trace : Protocol_client_context.rpc_context -> chain:Tezos_shell_services.Shell_services.chain -> block:Tezos_shell_services.Shell_services.block -> run_params -> (Tezos_protocol_alpha.Protocol.Alpha_context.Script.expr * Tezos_protocol_alpha.Protocol.Apply_internal_results.packed_internal_operation list * Tezos_protocol_alpha.Protocol.Script_typed_ir.execution_trace * Tezos_protocol_alpha.Protocol.Alpha_context.Lazy_storage.diffs option) Tezos_base.TzPervasives.tzresult Lwt.t

Calls Tezos_protocol_plugin_alpha.Plugin.RPC.Scripts.trace_code

Sourceval run_instr : Protocol_client_context.rpc_context -> chain:Tezos_shell_services.Shell_services.chain -> block:Tezos_shell_services.Shell_services.block -> run_instr_params -> ((Tezos_protocol_alpha.Protocol.Alpha_context.Script.expr * Tezos_protocol_alpha.Protocol.Alpha_context.Script.expr) list * Tezos_protocol_alpha.Protocol.Alpha_context.Gas.t) Tezos_base.TzPervasives.tzresult Lwt.t

Calls Tezos_protocol_plugin_alpha.Plugin.RPC.Scripts.run_instr

Sourceval print_view_result : Protocol_client_context.full -> Tezos_protocol_alpha.Protocol.Script_repr.expr Tezos_base.TzPervasives.tzresult -> unit Tezos_base.TzPervasives.tzresult Lwt.t
Sourceval print_run_result : Protocol_client_context.full -> show_source:bool -> parsed:Michelson_v1_parser.parsed -> (Tezos_protocol_alpha.Protocol.Script_repr.expr * Tezos_protocol_alpha.Protocol.Apply_internal_results.packed_internal_operation list * Tezos_protocol_alpha.Protocol.Alpha_context.Lazy_storage.diffs option) Tezos_base.TzPervasives.tzresult -> unit Tezos_base.TzPervasives.tzresult Lwt.t
Sourceval print_trace_result : Protocol_client_context.full -> show_source:bool -> parsed:Michelson_v1_parser.parsed -> (Tezos_protocol_alpha.Protocol.Script_repr.expr * Tezos_protocol_alpha.Protocol.Apply_internal_results.packed_internal_operation list * Tezos_protocol_alpha.Protocol.Script_typed_ir.execution_trace * Tezos_protocol_alpha.Protocol.Alpha_context.Lazy_storage.diffs option) Tezos_base.TzPervasives.tzresult -> unit Tezos_base.TzPervasives.tzresult Lwt.t
Sourceval print_run_instr_result : Protocol_client_context.full -> show_source:bool -> parsed:Michelson_v1_parser.parsed -> ((Tezos_protocol_alpha.Protocol.Alpha_context.Script.expr * Tezos_protocol_alpha.Protocol.Alpha_context.Script.expr) list * Tezos_protocol_alpha.Protocol.Alpha_context.Gas.t) Tezos_base.TzPervasives.tzresult -> unit Tezos_base.TzPervasives.tzresult Lwt.t
Sourceval typecheck_data : Protocol_client_context.rpc_context -> chain:Tezos_shell_services.Shell_services.chain -> block:Tezos_shell_services.Shell_services.block -> gas:Tezos_protocol_alpha.Protocol.Alpha_context.Gas.Arith.integral option -> legacy:bool -> data:Michelson_v1_parser.parsed -> ty:Michelson_v1_parser.parsed -> unit -> Tezos_protocol_alpha.Protocol.Alpha_context.Gas.t Tezos_base.TzPervasives.tzresult Lwt.t

Calls Tezos_protocol_plugin_alpha.Plugin.RPC.Scripts.typecheck_data

Sourceval typecheck_program : Protocol_client_context.rpc_context -> chain:Tezos_shell_services.Shell_services.chain -> block:Tezos_shell_services.Shell_services.block -> gas:Tezos_protocol_alpha.Protocol.Alpha_context.Gas.Arith.integral option -> legacy:bool -> show_types:bool -> Michelson_v1_parser.parsed -> (Tezos_protocol_alpha.Protocol.Script_tc_errors.type_map * Tezos_protocol_alpha.Protocol.Alpha_context.Gas.t) Tezos_base.TzPervasives.tzresult Lwt.t

Calls Tezos_protocol_plugin_alpha.Plugin.RPC.Scripts.typecheck_code

Sourceval print_typecheck_result : emacs:bool -> show_types:bool -> print_source_on_error:bool -> display_names:bool -> name:string -> Michelson_v1_parser.parsed -> (Tezos_protocol_alpha.Protocol.Script_tc_errors.type_map * Tezos_protocol_alpha.Protocol.Alpha_context.Gas.t) Tezos_base.TzPervasives.tzresult -> Tezos_client_base.Client_context.printer -> unit Tezos_base.TzPervasives.tzresult Lwt.t
Sourceval script_size : Protocol_client_context.rpc_context -> chain:Tezos_shell_services.Shell_services.chain -> block:Tezos_shell_services.Shell_services.block -> gas:Tezos_protocol_alpha.Protocol.Alpha_context.Gas.Arith.integral option -> legacy:bool -> program:Michelson_v1_parser.parsed -> storage:Michelson_v1_parser.parsed -> unit -> int Tezos_base.TzPervasives.tzresult Lwt.t

Calls Tezos_protocol_plugin_alpha.Plugin.RPC.Scripts.script_size

Sourceval entrypoint_type : Protocol_client_context.rpc_context -> chain:Tezos_shell_services.Shell_services.chain -> block:Tezos_shell_services.Shell_services.block -> Michelson_v1_parser.parsed -> entrypoint:Tezos_protocol_alpha.Protocol.Alpha_context.Entrypoint.t -> Tezos_protocol_alpha.Protocol.Alpha_context.Script.expr option Tezos_base.TzPervasives.tzresult Lwt.t
Sourceval print_entrypoint_type : Protocol_client_context.full -> emacs:bool -> ?script_name:string -> show_source:bool -> parsed:Michelson_v1_parser.parsed -> entrypoint:Tezos_protocol_alpha.Protocol.Alpha_context.Entrypoint.t -> Tezos_protocol_alpha.Protocol.Script_repr.expr option Tezos_base.TzPervasives.tzresult -> unit Tezos_base.TzPervasives.tzresult Lwt.t
Sourceval list_entrypoints : Protocol_client_context.rpc_context -> chain:Tezos_shell_services.Shell_services.chain -> block:Tezos_shell_services.Shell_services.block -> Michelson_v1_parser.parsed -> (string * Tezos_protocol_alpha.Protocol.Alpha_context.Script.expr) list Tezos_base.TzPervasives.tzresult Lwt.t

Calls Michelson_v1_entrypoints.list_entrypoints

Sourceval print_entrypoints_list : Protocol_client_context.full -> emacs:bool -> ?script_name:string -> show_source:bool -> parsed:Michelson_v1_parser.parsed -> (string * Tezos_protocol_alpha.Protocol.Alpha_context.Script.expr) list Tezos_base.TzPervasives.tzresult -> unit Tezos_base.TzPervasives.tzresult Lwt.t
Sourceval list_unreachables : Protocol_client_context.rpc_context -> chain:Tezos_shell_services.Shell_services.chain -> block:Tezos_shell_services.Shell_services.block -> Michelson_v1_parser.parsed -> Tezos_protocol_alpha.Protocol.Michelson_v1_primitives.prim list list Tezos_base.TzPervasives.tzresult Lwt.t
Sourceval print_unreachables : Protocol_client_context.full -> emacs:bool -> ?script_name:string -> show_source:bool -> parsed:Michelson_v1_parser.parsed -> Tezos_protocol_alpha.Protocol.Michelson_v1_primitives.prim list list Tezos_base.TzPervasives.tzresult -> unit Tezos_base.TzPervasives.tzresult Lwt.t

Calls Michelson_v1_entrypoints.print_unreachables