package octez-protocol-020-PsParisC-libs

  1. Overview
  2. Docs
Octez protocol 020-PsParisC libraries

Install

Dune Dependency

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

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-020-PsParisC-libs.plugin/Tezos_protocol_plugin_020_PsParisC/RPC/Scripts/index.html

Module RPC.ScriptsSource

Sourcemodule S : sig ... end
Sourcemodule type UNPARSING_MODE = sig ... end
Sourcemodule Unparse_types : sig ... end
Sourcemodule Normalize_stack : sig ... end
Sourceval pp_instr_name : 'a 'b 'c 'd. Tezos_protocol_020_PsParisC.Environment.Format.formatter -> ('a, 'b, 'c, 'd) Tezos_protocol_020_PsParisC.Protocol.Script_typed_ir.kinstr -> unit
Sourcetype Tezos_protocol_020_PsParisC.Environment.Error_monad.error +=
  1. | Run_operation_does_not_support_consensus_operations
Sourceval run_operation_service : Tezos_protocol_020_PsParisC.Protocol.Services_registration.rpc_context -> < version : 'a.. > -> (Tezos_protocol_020_PsParisC.Protocol.Alpha_context.packed_operation * Tezos_protocol_environment_020_PsParisC.Chain_id.t) -> ('a * (Tezos_protocol_020_PsParisC.Protocol.Alpha_context.packed_protocol_data * Tezos_raw_protocol_020_PsParisC.Apply_results.packed_operation_metadata), Tezos_protocol_020_PsParisC.Environment.Error_monad.error Tezos_protocol_environment_020_PsParisC.Error_monad.trace) result Lwt.t

Validate and apply the operation but skip signature checks; do not support consensus operations.

Return the unchanged operation protocol data, and the operation receipt ie. metadata containing balance updates, consumed gas, application success or failure, etc.

Sourceval simulate_operation_service : Tezos_protocol_020_PsParisC.Protocol.Services_registration.rpc_context -> < version : 'a.. > -> (int32 option * Tezos_protocol_020_PsParisC.Protocol.Alpha_context.packed_operation * Tezos_protocol_environment_020_PsParisC.Chain_id.t * int) -> ('a * (Tezos_protocol_020_PsParisC.Protocol.Alpha_context.packed_protocol_data * Tezos_raw_protocol_020_PsParisC.Apply_results.packed_operation_metadata), Tezos_protocol_020_PsParisC.Environment.Error_monad.error Tezos_protocol_environment_020_PsParisC.Error_monad.trace) result Lwt.t
Sourceval default_from_context : 'a -> ('a -> ('b, 'c) result Lwt.t) -> 'b option -> ('b, 'c) result Lwt.t
Sourcetype run_code_config = {
  1. balance : Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Tez.t;
  2. self : Tezos_protocol_020_PsParisC.Protocol.Contract_hash.t;
  3. payer : Tezos_protocol_020_PsParisC.Environment.Signature.public_key_hash;
  4. sender : Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Contract.t;
}
Sourceval default_balance : Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Tez.t
Sourceval register : unit -> unit
Sourceval run_code : unparsing_mode: Tezos_protocol_020_PsParisC.Protocol.Script_ir_unparser.unparsing_mode option -> gas: Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Gas.Arith.integral option -> entrypoint:Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Entrypoint.t -> balance:Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Tez.t option -> other_contracts:S.other_contract_description list option -> extra_big_maps:S.extra_big_map_description list option -> script:Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Script.expr -> storage:Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Script.expr -> input:Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Script.expr -> amount:Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Tez.t -> chain_id:Tezos_protocol_020_PsParisC.Environment.Chain_id.t -> sender:Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Contract.t option -> payer:Tezos_raw_protocol_020_PsParisC__Alpha_context.public_key_hash option -> self:Tezos_raw_protocol_020_PsParisC.Contract_hash.t option -> now:Tezos_protocol_020_PsParisC.Protocol.Script_timestamp.t option -> level: Tezos_protocol_020_PsParisC.Protocol.Script_int.n Tezos_protocol_020_PsParisC.Protocol.Script_int.num option -> 'a Tezos_protocol_020_PsParisC.Environment.RPC_context.simple -> 'a -> (Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Script.expr * Tezos_protocol_020_PsParisC.Protocol.Apply_internal_results.packed_internal_operation list * Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Lazy_storage.diffs option) Tezos_protocol_environment_020_PsParisC.Error_monad.shell_tzresult Tezos_protocol_environment_020_PsParisC.Lwt.t
Sourceval trace_code : unparsing_mode: Tezos_protocol_020_PsParisC.Protocol.Script_ir_unparser.unparsing_mode option -> gas: Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Gas.Arith.integral option -> entrypoint:Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Entrypoint.t -> balance:Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Tez.t option -> other_contracts:S.other_contract_description list option -> extra_big_maps:S.extra_big_map_description list option -> script:Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Script.expr -> storage:Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Script.expr -> input:Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Script.expr -> amount:Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Tez.t -> chain_id:Tezos_protocol_020_PsParisC.Environment.Chain_id.t -> sender:Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Contract.t option -> payer:Tezos_raw_protocol_020_PsParisC__Alpha_context.public_key_hash option -> self:Tezos_raw_protocol_020_PsParisC.Contract_hash.t option -> now:Tezos_protocol_020_PsParisC.Protocol.Script_timestamp.t option -> level: Tezos_protocol_020_PsParisC.Protocol.Script_int.n Tezos_protocol_020_PsParisC.Protocol.Script_int.num option -> 'a Tezos_protocol_020_PsParisC.Environment.RPC_context.simple -> 'a -> (Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Script.expr * Tezos_protocol_020_PsParisC.Protocol.Apply_internal_results.packed_internal_operation list * Tezos_protocol_020_PsParisC.Protocol.Script_typed_ir.execution_trace * Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Lazy_storage.diffs option) Tezos_protocol_environment_020_PsParisC.Error_monad.shell_tzresult Tezos_protocol_environment_020_PsParisC.Lwt.t
Sourceval run_tzip4_view : gas: Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Gas.Arith.integral option -> other_contracts:S.other_contract_description list option -> extra_big_maps:S.extra_big_map_description list option -> contract:Tezos_raw_protocol_020_PsParisC.Contract_hash.t -> entrypoint:Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Entrypoint.t -> input:Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Script.expr -> chain_id:Tezos_protocol_020_PsParisC.Environment.Chain_id.t -> now:Tezos_protocol_020_PsParisC.Protocol.Script_timestamp.t option -> level: Tezos_protocol_020_PsParisC.Protocol.Script_int.n Tezos_protocol_020_PsParisC.Protocol.Script_int.num option -> sender:Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Contract.t option -> payer:Tezos_raw_protocol_020_PsParisC__Alpha_context.public_key_hash option -> unparsing_mode: Tezos_protocol_020_PsParisC.Protocol.Script_ir_unparser.unparsing_mode -> 'a Tezos_protocol_020_PsParisC.Environment.RPC_context.simple -> 'a -> Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Script.expr Tezos_protocol_environment_020_PsParisC.Error_monad.shell_tzresult Tezos_protocol_environment_020_PsParisC.Lwt.t
Sourceval run_script_view : gas: Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Gas.Arith.integral option -> other_contracts:S.other_contract_description list option -> extra_big_maps:S.extra_big_map_description list option -> contract:Tezos_raw_protocol_020_PsParisC.Contract_hash.t -> view:string -> input:Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Script.expr -> unlimited_gas:bool -> chain_id:Tezos_protocol_020_PsParisC.Environment.Chain_id.t -> now:Tezos_protocol_020_PsParisC.Protocol.Script_timestamp.t option -> level: Tezos_protocol_020_PsParisC.Protocol.Script_int.n Tezos_protocol_020_PsParisC.Protocol.Script_int.num option -> sender:Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Contract.t option -> payer:Tezos_raw_protocol_020_PsParisC__Alpha_context.public_key_hash option -> unparsing_mode: Tezos_protocol_020_PsParisC.Protocol.Script_ir_unparser.unparsing_mode -> 'a Tezos_protocol_020_PsParisC.Environment.RPC_context.simple -> 'a -> Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Script.expr Tezos_protocol_environment_020_PsParisC.Error_monad.shell_tzresult Tezos_protocol_environment_020_PsParisC.Lwt.t

run_script_view is an helper function to call the corresponding RPC.

Sourceval run_instr : gas: Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Gas.Arith.integral option -> legacy:bool -> input: (Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Script.expr * Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Script.expr) list -> code:Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Script.expr -> chain_id:Tezos_protocol_020_PsParisC.Environment.Chain_id.t -> now:Tezos_protocol_020_PsParisC.Protocol.Script_timestamp.t option -> level: Tezos_protocol_020_PsParisC.Protocol.Script_int.n Tezos_protocol_020_PsParisC.Protocol.Script_int.num option -> unparsing_mode: Tezos_protocol_020_PsParisC.Protocol.Script_ir_unparser.unparsing_mode option -> source:Tezos_raw_protocol_020_PsParisC__Alpha_context.public_key_hash option -> sender:Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Contract.t option -> self:Tezos_raw_protocol_020_PsParisC.Contract_hash.t option -> parameter: Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Script.expr option -> amount:Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Tez.t -> balance:Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Tez.t option -> other_contracts:S.other_contract_description list option -> extra_big_maps:S.extra_big_map_description list option -> 'a Tezos_protocol_020_PsParisC.Environment.RPC_context.simple -> 'a -> ((Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Script.expr * Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Script.expr) list * Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Gas.t) Tezos_protocol_environment_020_PsParisC.Error_monad.shell_tzresult Tezos_protocol_environment_020_PsParisC.Lwt.t
Sourceval typecheck_code : gas: Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Gas.Arith.integral option -> legacy:bool -> script:Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Script.expr -> show_types:bool -> 'a Tezos_protocol_020_PsParisC.Environment.RPC_context.simple -> 'a -> ((Tezos_raw_protocol_020_PsParisC.Alpha_context.Script.location * (Tezos_raw_protocol_020_PsParisC.Alpha_context.Script.expr list * Tezos_raw_protocol_020_PsParisC.Alpha_context.Script.expr list)) list * Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Gas.t) Tezos_protocol_environment_020_PsParisC.Error_monad.shell_tzresult Tezos_protocol_environment_020_PsParisC.Lwt.t
Sourceval script_size : gas: Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Gas.Arith.integral option -> legacy:bool -> script:Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Script.expr -> storage:Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Script.expr -> 'a Tezos_protocol_020_PsParisC.Environment.RPC_context.simple -> 'a -> int Tezos_protocol_environment_020_PsParisC.Error_monad.shell_tzresult Tezos_protocol_environment_020_PsParisC.Lwt.t
Sourceval typecheck_data : gas: Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Gas.Arith.integral option -> legacy:bool -> data:Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Script.expr -> ty:Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Script.expr -> 'a Tezos_protocol_020_PsParisC.Environment.RPC_context.simple -> 'a -> Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Gas.t Tezos_protocol_environment_020_PsParisC.Error_monad.shell_tzresult Tezos_protocol_environment_020_PsParisC.Lwt.t
Sourceval pack_data : gas: Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Gas.Arith.integral option -> data:Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Script.expr -> ty:Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Script.expr -> 'a Tezos_protocol_020_PsParisC.Environment.RPC_context.simple -> 'a -> (Tezos_protocol_environment_020_PsParisC.Bytes.t * Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Gas.t) Tezos_protocol_environment_020_PsParisC.Error_monad.shell_tzresult Tezos_protocol_environment_020_PsParisC.Lwt.t
Sourceval normalize_data : legacy:bool -> other_contracts:S.other_contract_description list option -> extra_big_maps:S.extra_big_map_description list option -> data:Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Script.expr -> ty:Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Script.expr -> unparsing_mode: Tezos_protocol_020_PsParisC.Protocol.Script_ir_unparser.unparsing_mode -> 'a Tezos_protocol_020_PsParisC.Environment.RPC_context.simple -> 'a -> Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Script.expr Tezos_protocol_environment_020_PsParisC.Error_monad.shell_tzresult Tezos_protocol_environment_020_PsParisC.Lwt.t
Sourceval normalize_stack : legacy:bool -> other_contracts:S.other_contract_description list option -> extra_big_maps:S.extra_big_map_description list option -> stack: (Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Script.expr * Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Script.expr) list -> unparsing_mode: Tezos_protocol_020_PsParisC.Protocol.Script_ir_unparser.unparsing_mode -> 'a Tezos_protocol_020_PsParisC.Environment.RPC_context.simple -> 'a -> (Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Script.expr * Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Script.expr) list Tezos_protocol_environment_020_PsParisC.Error_monad.shell_tzresult Tezos_protocol_environment_020_PsParisC.Lwt.t
Sourceval normalize_script : script:Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Script.expr -> unparsing_mode: Tezos_protocol_020_PsParisC.Protocol.Script_ir_unparser.unparsing_mode -> 'a Tezos_protocol_020_PsParisC.Environment.RPC_context.simple -> 'a -> Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Script.expr Tezos_protocol_environment_020_PsParisC.Error_monad.shell_tzresult Tezos_protocol_environment_020_PsParisC.Lwt.t
Sourceval normalize_type : ty:Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Script.expr -> 'a Tezos_protocol_020_PsParisC.Environment.RPC_context.simple -> 'a -> Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Script.expr Tezos_protocol_environment_020_PsParisC.Error_monad.shell_tzresult Tezos_protocol_environment_020_PsParisC.Lwt.t
Sourceval run_operation : op:Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Operation.packed -> chain_id:Tezos_protocol_020_PsParisC.Environment.Chain_id.t -> ?version:version -> 'a Tezos_protocol_020_PsParisC.Environment.RPC_context.simple -> 'a -> (Tezos_raw_protocol_020_PsParisC.Alpha_context.Operation.packed_protocol_data * Tezos_protocol_020_PsParisC.Protocol.Apply_results.packed_operation_metadata, Tezos_base.TzPervasives.Error_monad.tztrace) result Lwt.t
Sourceval simulate_operation : op:Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Operation.packed -> chain_id:Tezos_protocol_020_PsParisC.Environment.Chain_id.t -> latency:int -> ?version:version -> ?successor_level:bool -> ?blocks_before_activation:int32 -> 'a Tezos_protocol_020_PsParisC.Environment.RPC_context.simple -> 'a -> (Tezos_raw_protocol_020_PsParisC.Alpha_context.Operation.packed_protocol_data * Tezos_protocol_020_PsParisC.Protocol.Apply_results.packed_operation_metadata, Tezos_base.TzPervasives.Error_monad.tztrace) result Lwt.t
Sourceval entrypoint_type : script:Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Script.expr -> entrypoint:Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Entrypoint.t -> 'a Tezos_protocol_020_PsParisC.Environment.RPC_context.simple -> 'a -> Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Script.expr Tezos_protocol_environment_020_PsParisC.Error_monad.shell_tzresult Tezos_protocol_environment_020_PsParisC.Lwt.t
Sourceval list_entrypoints : 'a Tezos_protocol_020_PsParisC.Environment.RPC_context.simple -> 'a -> script:Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Script.expr -> (Tezos_protocol_020_PsParisC.Protocol.Michelson_v1_primitives.prim list list * (string * Tezos_protocol_020_PsParisC.Protocol.Alpha_context.Script.expr) list) Tezos_protocol_environment_020_PsParisC.Error_monad.shell_tzresult Tezos_protocol_environment_020_PsParisC.Lwt.t
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