package octez-protocol-015-PtLimaPt-libs

  1. Overview
  2. Docs
Octez protocol 015-PtLimaPt libraries

Install

Dune Dependency

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

Authors

  1. T
    Tezos devteam

Maintainers

  1. C
    contact@tezos.com

Sources

octez-19.1.tar.gz
sha256=55ea1fb8bb3273a7fc270ca8f650d45c56449665619482aad9bc12f3ea736b7e
sha512=fec850fc2d17d7490bbabd5147d62aad13b3aaed8774270f8a38ab419670ed03e0fd30cf8642a97984eca5c2446726fe590ad99c015f7ec50919dc7652f25053

doc/octez-protocol-015-PtLimaPt-libs.plugin/Tezos_protocol_plugin_015_PtLimaPt/RPC/Scripts/index.html

Module RPC.ScriptsSource

Sourcemodule S : sig ... end
Sourcemodule type UNPARSING_MODE = sig ... end
Sourcemodule Unparse_types : sig ... end
Sourceval pp_instr_name : 'a 'b 'c 'd. Tezos_protocol_015_PtLimaPt.Environment.Format.formatter -> ('a, 'b, 'c, 'd) Tezos_protocol_015_PtLimaPt.Protocol.Script_typed_ir.kinstr -> unit
Sourcetype Tezos_protocol_015_PtLimaPt.Environment.Error_monad.error +=
  1. | Run_operation_does_not_support_consensus_operations
Sourceval run_operation_service : Tezos_protocol_015_PtLimaPt.Protocol.Services_registration.rpc_context -> unit -> (Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.packed_operation * Tezos_protocol_environment_015_PtLimaPt.Chain_id.t) -> (Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.packed_protocol_data * Tezos_raw_protocol_015_PtLimaPt.Apply_results.packed_operation_metadata, Tezos_protocol_015_PtLimaPt.Environment.Error_monad.error Tezos_protocol_015_PtLimaPt.Environment.Error_monad.trace) Tezos_protocol_environment_015_PtLimaPt.Pervasives.result Tezos_protocol_environment_015_PtLimaPt.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_015_PtLimaPt.Protocol.Services_registration.rpc_context -> < successor_level : bool > -> (int32 option * Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.packed_operation * Tezos_protocol_environment_015_PtLimaPt.Chain_id.t * int) -> (Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.packed_protocol_data * Tezos_raw_protocol_015_PtLimaPt.Apply_results.packed_operation_metadata, Tezos_protocol_015_PtLimaPt.Environment.Error_monad.error Tezos_protocol_015_PtLimaPt.Environment.Error_monad.trace) Tezos_protocol_environment_015_PtLimaPt.Pervasives.result Tezos_protocol_environment_015_PtLimaPt.Lwt.t
Sourceval default_from_context : 'a -> ('a -> ('b, 'c) Tezos_protocol_environment_015_PtLimaPt.Pervasives.result Tezos_protocol_environment_015_PtLimaPt.Lwt.t) -> 'b option -> ('b, 'c) Tezos_protocol_environment_015_PtLimaPt.Pervasives.result Tezos_protocol_environment_015_PtLimaPt.Lwt.t
Sourcetype run_code_config = {
  1. balance : Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Tez.t;
  2. self : Tezos_protocol_015_PtLimaPt.Protocol.Contract_hash.t;
  3. payer : Tezos_protocol_015_PtLimaPt.Environment.Signature.public_key_hash;
  4. source : Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Contract.t;
}
Sourceval default_balance : Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Tez.t
Sourceval register : unit -> unit
Sourceval run_code : ?unparsing_mode: Tezos_protocol_015_PtLimaPt.Protocol.Script_ir_unparser.unparsing_mode -> ?gas:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Gas.Arith.integral -> ?entrypoint:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Entrypoint.t -> ?balance:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Tez.t -> script:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Script.expr -> storage:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Script.expr -> input:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Script.expr -> amount:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Tez.t -> chain_id:Tezos_protocol_015_PtLimaPt.Environment.Chain_id.t -> source:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Contract.t option -> payer:Tezos_raw_protocol_015_PtLimaPt__Alpha_context.public_key_hash option -> self:Tezos_raw_protocol_015_PtLimaPt.Contract_hash.t option -> now:Tezos_protocol_015_PtLimaPt.Protocol.Script_timestamp.t option -> level: Tezos_protocol_015_PtLimaPt.Protocol.Script_int.n Tezos_protocol_015_PtLimaPt.Protocol.Script_int.num option -> 'a Tezos_protocol_015_PtLimaPt.Environment.RPC_context.simple -> 'a -> (Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Script.expr * Tezos_protocol_015_PtLimaPt.Protocol.Apply_internal_results.packed_internal_operation list * Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Lazy_storage.diffs option) Tezos_protocol_environment_015_PtLimaPt.Error_monad.shell_tzresult Tezos_protocol_environment_015_PtLimaPt.Lwt.t
Sourceval trace_code : ?unparsing_mode: Tezos_protocol_015_PtLimaPt.Protocol.Script_ir_unparser.unparsing_mode -> ?gas:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Gas.Arith.integral -> ?entrypoint:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Entrypoint.t -> ?balance:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Tez.t -> script:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Script.expr -> storage:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Script.expr -> input:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Script.expr -> amount:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Tez.t -> chain_id:Tezos_protocol_015_PtLimaPt.Environment.Chain_id.t -> source:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Contract.t option -> payer:Tezos_raw_protocol_015_PtLimaPt__Alpha_context.public_key_hash option -> self:Tezos_raw_protocol_015_PtLimaPt.Contract_hash.t option -> now:Tezos_protocol_015_PtLimaPt.Protocol.Script_timestamp.t option -> level: Tezos_protocol_015_PtLimaPt.Protocol.Script_int.n Tezos_protocol_015_PtLimaPt.Protocol.Script_int.num option -> 'a Tezos_protocol_015_PtLimaPt.Environment.RPC_context.simple -> 'a -> (Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Script.expr * Tezos_protocol_015_PtLimaPt.Protocol.Apply_internal_results.packed_internal_operation list * (Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Script.location * Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Gas.t * Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Script.expr list) list * Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Lazy_storage.diffs option) Tezos_protocol_environment_015_PtLimaPt.Error_monad.shell_tzresult Tezos_protocol_environment_015_PtLimaPt.Lwt.t
Sourceval run_tzip4_view : ?gas:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Gas.Arith.integral -> contract:Tezos_raw_protocol_015_PtLimaPt.Contract_hash.t -> entrypoint:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Entrypoint.t -> input:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Script.expr -> chain_id:Tezos_protocol_015_PtLimaPt.Environment.Chain_id.t -> now:Tezos_protocol_015_PtLimaPt.Protocol.Script_timestamp.t option -> level: Tezos_protocol_015_PtLimaPt.Protocol.Script_int.n Tezos_protocol_015_PtLimaPt.Protocol.Script_int.num option -> ?source:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Contract.t -> ?payer:Tezos_raw_protocol_015_PtLimaPt__Alpha_context.public_key_hash -> unparsing_mode: Tezos_protocol_015_PtLimaPt.Protocol.Script_ir_unparser.unparsing_mode -> 'a Tezos_protocol_015_PtLimaPt.Environment.RPC_context.simple -> 'a -> Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Script.expr Tezos_protocol_environment_015_PtLimaPt.Error_monad.shell_tzresult Tezos_protocol_environment_015_PtLimaPt.Lwt.t
Sourceval run_script_view : ?gas:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Gas.Arith.integral -> contract:Tezos_raw_protocol_015_PtLimaPt.Contract_hash.t -> view:string -> input:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Script.expr -> ?unlimited_gas:bool -> chain_id:Tezos_protocol_015_PtLimaPt.Environment.Chain_id.t -> now:Tezos_protocol_015_PtLimaPt.Protocol.Script_timestamp.t option -> level: Tezos_protocol_015_PtLimaPt.Protocol.Script_int.n Tezos_protocol_015_PtLimaPt.Protocol.Script_int.num option -> ?source:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Contract.t -> ?payer:Tezos_raw_protocol_015_PtLimaPt__Alpha_context.public_key_hash -> unparsing_mode: Tezos_protocol_015_PtLimaPt.Protocol.Script_ir_unparser.unparsing_mode -> 'a Tezos_protocol_015_PtLimaPt.Environment.RPC_context.simple -> 'a -> Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Script.expr Tezos_protocol_environment_015_PtLimaPt.Error_monad.shell_tzresult Tezos_protocol_environment_015_PtLimaPt.Lwt.t

run_script_view is an helper function to call the corresponding RPC. unlimited_gas is set to false by default.

Sourceval typecheck_code : ?gas:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Gas.Arith.integral -> ?legacy:bool -> script:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Script.expr -> ?show_types:bool -> 'a Tezos_protocol_015_PtLimaPt.Environment.RPC_context.simple -> 'a -> ((Tezos_raw_protocol_015_PtLimaPt.Alpha_context.Script.location * (Tezos_raw_protocol_015_PtLimaPt.Alpha_context.Script.expr list * Tezos_raw_protocol_015_PtLimaPt.Alpha_context.Script.expr list)) list * Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Gas.t) Tezos_protocol_environment_015_PtLimaPt.Error_monad.shell_tzresult Tezos_protocol_environment_015_PtLimaPt.Lwt.t
Sourceval script_size : ?gas:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Gas.Arith.integral -> ?legacy:bool -> script:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Script.expr -> storage:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Script.expr -> 'a Tezos_protocol_015_PtLimaPt.Environment.RPC_context.simple -> 'a -> int Tezos_protocol_environment_015_PtLimaPt.Error_monad.shell_tzresult Tezos_protocol_environment_015_PtLimaPt.Lwt.t
Sourceval typecheck_data : ?gas:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Gas.Arith.integral -> ?legacy:bool -> data:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Script.expr -> ty:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Script.expr -> 'a Tezos_protocol_015_PtLimaPt.Environment.RPC_context.simple -> 'a -> Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Gas.t Tezos_protocol_environment_015_PtLimaPt.Error_monad.shell_tzresult Tezos_protocol_environment_015_PtLimaPt.Lwt.t
Sourceval pack_data : ?gas:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Gas.Arith.integral -> data:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Script.expr -> ty:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Script.expr -> 'a Tezos_protocol_015_PtLimaPt.Environment.RPC_context.simple -> 'a -> (Tezos_protocol_environment_015_PtLimaPt.Bytes.t * Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Gas.t) Tezos_protocol_environment_015_PtLimaPt.Error_monad.shell_tzresult Tezos_protocol_environment_015_PtLimaPt.Lwt.t
Sourceval normalize_data : ?legacy:bool -> data:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Script.expr -> ty:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Script.expr -> unparsing_mode: Tezos_protocol_015_PtLimaPt.Protocol.Script_ir_unparser.unparsing_mode -> 'a Tezos_protocol_015_PtLimaPt.Environment.RPC_context.simple -> 'a -> Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Script.expr Tezos_protocol_environment_015_PtLimaPt.Error_monad.shell_tzresult Tezos_protocol_environment_015_PtLimaPt.Lwt.t
Sourceval normalize_script : script:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Script.expr -> unparsing_mode: Tezos_protocol_015_PtLimaPt.Protocol.Script_ir_unparser.unparsing_mode -> 'a Tezos_protocol_015_PtLimaPt.Environment.RPC_context.simple -> 'a -> Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Script.expr Tezos_protocol_environment_015_PtLimaPt.Error_monad.shell_tzresult Tezos_protocol_environment_015_PtLimaPt.Lwt.t
Sourceval normalize_type : ty:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Script.expr -> 'a Tezos_protocol_015_PtLimaPt.Environment.RPC_context.simple -> 'a -> Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Script.expr Tezos_protocol_environment_015_PtLimaPt.Error_monad.shell_tzresult Tezos_protocol_environment_015_PtLimaPt.Lwt.t
Sourceval run_operation : op:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Operation.packed -> chain_id:Tezos_protocol_015_PtLimaPt.Environment.Chain_id.t -> 'a Tezos_protocol_015_PtLimaPt.Environment.RPC_context.simple -> 'a -> (Tezos_raw_protocol_015_PtLimaPt.Alpha_context.Operation.packed_protocol_data * Tezos_protocol_015_PtLimaPt.Protocol.Apply_results.packed_operation_metadata) Tezos_protocol_environment_015_PtLimaPt.Error_monad.shell_tzresult Tezos_protocol_environment_015_PtLimaPt.Lwt.t
Sourceval simulate_operation : op:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Operation.packed -> chain_id:Tezos_protocol_015_PtLimaPt.Environment.Chain_id.t -> latency:int -> ?successor_level:bool -> ?blocks_before_activation:int32 -> 'a Tezos_protocol_015_PtLimaPt.Environment.RPC_context.simple -> 'a -> (Tezos_raw_protocol_015_PtLimaPt.Alpha_context.Operation.packed_protocol_data * Tezos_protocol_015_PtLimaPt.Protocol.Apply_results.packed_operation_metadata) Tezos_protocol_environment_015_PtLimaPt.Error_monad.shell_tzresult Tezos_protocol_environment_015_PtLimaPt.Lwt.t
Sourceval entrypoint_type : script:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Script.expr -> entrypoint:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Entrypoint.t -> 'a Tezos_protocol_015_PtLimaPt.Environment.RPC_context.simple -> 'a -> Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Script.expr Tezos_protocol_environment_015_PtLimaPt.Error_monad.shell_tzresult Tezos_protocol_environment_015_PtLimaPt.Lwt.t
Sourceval list_entrypoints : 'a Tezos_protocol_015_PtLimaPt.Environment.RPC_context.simple -> 'a -> script:Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Script.expr -> (Tezos_protocol_015_PtLimaPt.Protocol.Michelson_v1_primitives.prim list list * (string * Tezos_protocol_015_PtLimaPt.Protocol.Alpha_context.Script.expr) list) Tezos_protocol_environment_015_PtLimaPt.Error_monad.shell_tzresult Tezos_protocol_environment_015_PtLimaPt.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