package octez-protocol-017-PtNairob-libs

  1. Overview
  2. Docs
package octez-protocol-017-PtNairob-libs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

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_017_PtNairob.Environment.Format.formatter -> ('a, 'b, 'c, 'd) Tezos_protocol_017_PtNairob.Protocol.Script_typed_ir.kinstr -> unit
Sourcetype Tezos_protocol_017_PtNairob.Environment.Error_monad.error +=
  1. | Run_operation_does_not_support_consensus_operations
Sourceval run_operation_service : Tezos_protocol_017_PtNairob.Protocol.Services_registration.rpc_context -> unit -> (Tezos_protocol_017_PtNairob.Protocol.Alpha_context.packed_operation * Tezos_protocol_environment_017_PtNairob.Chain_id.t) -> (Tezos_protocol_017_PtNairob.Protocol.Alpha_context.packed_protocol_data * Tezos_raw_protocol_017_PtNairob.Apply_results.packed_operation_metadata, Tezos_protocol_017_PtNairob.Environment.Error_monad.error Tezos_protocol_017_PtNairob.Environment.Error_monad.trace) Tezos_protocol_environment_017_PtNairob.Pervasives.result Tezos_protocol_environment_017_PtNairob.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_017_PtNairob.Protocol.Services_registration.rpc_context -> < successor_level : bool > -> (int32 option * Tezos_protocol_017_PtNairob.Protocol.Alpha_context.packed_operation * Tezos_protocol_environment_017_PtNairob.Chain_id.t * int) -> (Tezos_protocol_017_PtNairob.Protocol.Alpha_context.packed_protocol_data * Tezos_raw_protocol_017_PtNairob.Apply_results.packed_operation_metadata, Tezos_protocol_017_PtNairob.Environment.Error_monad.error Tezos_protocol_017_PtNairob.Environment.Error_monad.trace) Tezos_protocol_environment_017_PtNairob.Pervasives.result Tezos_protocol_environment_017_PtNairob.Lwt.t
Sourceval default_from_context : 'a -> ('a -> ('b, 'c) Tezos_protocol_environment_017_PtNairob.Pervasives.result Tezos_protocol_environment_017_PtNairob.Lwt.t) -> 'b option -> ('b, 'c) Tezos_protocol_environment_017_PtNairob.Pervasives.result Tezos_protocol_environment_017_PtNairob.Lwt.t
Sourcetype run_code_config = {
  1. balance : Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Tez.t;
  2. self : Tezos_protocol_017_PtNairob.Protocol.Contract_hash.t;
  3. payer : Tezos_protocol_017_PtNairob.Environment.Signature.public_key_hash;
  4. source : Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Contract.t;
}
Sourceval default_balance : Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Tez.t
Sourceval register : unit -> unit
Sourceval run_code : ?unparsing_mode: Tezos_protocol_017_PtNairob.Protocol.Script_ir_unparser.unparsing_mode -> ?gas:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Gas.Arith.integral -> ?entrypoint:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Entrypoint.t -> ?balance:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Tez.t -> script:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Script.expr -> storage:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Script.expr -> input:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Script.expr -> amount:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Tez.t -> chain_id:Tezos_protocol_017_PtNairob.Environment.Chain_id.t -> source:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Contract.t option -> payer:Tezos_raw_protocol_017_PtNairob__Alpha_context.public_key_hash option -> self:Tezos_raw_protocol_017_PtNairob.Contract_hash.t option -> now:Tezos_protocol_017_PtNairob.Protocol.Script_timestamp.t option -> level: Tezos_protocol_017_PtNairob.Protocol.Script_int.n Tezos_protocol_017_PtNairob.Protocol.Script_int.num option -> 'a Tezos_protocol_017_PtNairob.Environment.RPC_context.simple -> 'a -> (Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Script.expr * Tezos_protocol_017_PtNairob.Protocol.Apply_internal_results.packed_internal_operation list * Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Lazy_storage.diffs option) Tezos_protocol_environment_017_PtNairob.Error_monad.shell_tzresult Tezos_protocol_environment_017_PtNairob.Lwt.t
Sourceval trace_code : ?unparsing_mode: Tezos_protocol_017_PtNairob.Protocol.Script_ir_unparser.unparsing_mode -> ?gas:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Gas.Arith.integral -> ?entrypoint:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Entrypoint.t -> ?balance:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Tez.t -> script:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Script.expr -> storage:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Script.expr -> input:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Script.expr -> amount:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Tez.t -> chain_id:Tezos_protocol_017_PtNairob.Environment.Chain_id.t -> source:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Contract.t option -> payer:Tezos_raw_protocol_017_PtNairob__Alpha_context.public_key_hash option -> self:Tezos_raw_protocol_017_PtNairob.Contract_hash.t option -> now:Tezos_protocol_017_PtNairob.Protocol.Script_timestamp.t option -> level: Tezos_protocol_017_PtNairob.Protocol.Script_int.n Tezos_protocol_017_PtNairob.Protocol.Script_int.num option -> 'a Tezos_protocol_017_PtNairob.Environment.RPC_context.simple -> 'a -> (Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Script.expr * Tezos_protocol_017_PtNairob.Protocol.Apply_internal_results.packed_internal_operation list * Tezos_protocol_017_PtNairob.Protocol.Script_typed_ir.execution_trace * Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Lazy_storage.diffs option) Tezos_protocol_environment_017_PtNairob.Error_monad.shell_tzresult Tezos_protocol_environment_017_PtNairob.Lwt.t
Sourceval run_tzip4_view : ?gas:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Gas.Arith.integral -> contract:Tezos_raw_protocol_017_PtNairob.Contract_hash.t -> entrypoint:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Entrypoint.t -> input:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Script.expr -> chain_id:Tezos_protocol_017_PtNairob.Environment.Chain_id.t -> now:Tezos_protocol_017_PtNairob.Protocol.Script_timestamp.t option -> level: Tezos_protocol_017_PtNairob.Protocol.Script_int.n Tezos_protocol_017_PtNairob.Protocol.Script_int.num option -> ?source:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Contract.t -> ?payer:Tezos_raw_protocol_017_PtNairob__Alpha_context.public_key_hash -> unparsing_mode: Tezos_protocol_017_PtNairob.Protocol.Script_ir_unparser.unparsing_mode -> 'a Tezos_protocol_017_PtNairob.Environment.RPC_context.simple -> 'a -> Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Script.expr Tezos_protocol_environment_017_PtNairob.Error_monad.shell_tzresult Tezos_protocol_environment_017_PtNairob.Lwt.t
Sourceval run_script_view : ?gas:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Gas.Arith.integral -> contract:Tezos_raw_protocol_017_PtNairob.Contract_hash.t -> view:string -> input:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Script.expr -> ?unlimited_gas:bool -> chain_id:Tezos_protocol_017_PtNairob.Environment.Chain_id.t -> now:Tezos_protocol_017_PtNairob.Protocol.Script_timestamp.t option -> level: Tezos_protocol_017_PtNairob.Protocol.Script_int.n Tezos_protocol_017_PtNairob.Protocol.Script_int.num option -> ?source:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Contract.t -> ?payer:Tezos_raw_protocol_017_PtNairob__Alpha_context.public_key_hash -> unparsing_mode: Tezos_protocol_017_PtNairob.Protocol.Script_ir_unparser.unparsing_mode -> 'a Tezos_protocol_017_PtNairob.Environment.RPC_context.simple -> 'a -> Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Script.expr Tezos_protocol_environment_017_PtNairob.Error_monad.shell_tzresult Tezos_protocol_environment_017_PtNairob.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_017_PtNairob.Protocol.Alpha_context.Gas.Arith.integral -> ?legacy:bool -> script:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Script.expr -> ?show_types:bool -> 'a Tezos_protocol_017_PtNairob.Environment.RPC_context.simple -> 'a -> ((Tezos_raw_protocol_017_PtNairob.Alpha_context.Script.location * (Tezos_raw_protocol_017_PtNairob.Alpha_context.Script.expr list * Tezos_raw_protocol_017_PtNairob.Alpha_context.Script.expr list)) list * Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Gas.t) Tezos_protocol_environment_017_PtNairob.Error_monad.shell_tzresult Tezos_protocol_environment_017_PtNairob.Lwt.t
Sourceval script_size : ?gas:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Gas.Arith.integral -> ?legacy:bool -> script:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Script.expr -> storage:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Script.expr -> 'a Tezos_protocol_017_PtNairob.Environment.RPC_context.simple -> 'a -> int Tezos_protocol_environment_017_PtNairob.Error_monad.shell_tzresult Tezos_protocol_environment_017_PtNairob.Lwt.t
Sourceval typecheck_data : ?gas:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Gas.Arith.integral -> ?legacy:bool -> data:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Script.expr -> ty:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Script.expr -> 'a Tezos_protocol_017_PtNairob.Environment.RPC_context.simple -> 'a -> Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Gas.t Tezos_protocol_environment_017_PtNairob.Error_monad.shell_tzresult Tezos_protocol_environment_017_PtNairob.Lwt.t
Sourceval pack_data : ?gas:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Gas.Arith.integral -> data:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Script.expr -> ty:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Script.expr -> 'a Tezos_protocol_017_PtNairob.Environment.RPC_context.simple -> 'a -> (Tezos_protocol_environment_017_PtNairob.Bytes.t * Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Gas.t) Tezos_protocol_environment_017_PtNairob.Error_monad.shell_tzresult Tezos_protocol_environment_017_PtNairob.Lwt.t
Sourceval normalize_data : ?legacy:bool -> data:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Script.expr -> ty:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Script.expr -> unparsing_mode: Tezos_protocol_017_PtNairob.Protocol.Script_ir_unparser.unparsing_mode -> 'a Tezos_protocol_017_PtNairob.Environment.RPC_context.simple -> 'a -> Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Script.expr Tezos_protocol_environment_017_PtNairob.Error_monad.shell_tzresult Tezos_protocol_environment_017_PtNairob.Lwt.t
Sourceval normalize_stack : ?legacy:bool -> stack: (Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Script.expr * Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Script.expr) list -> unparsing_mode: Tezos_protocol_017_PtNairob.Protocol.Script_ir_unparser.unparsing_mode -> 'a Tezos_protocol_017_PtNairob.Environment.RPC_context.simple -> 'a -> (Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Script.expr * Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Script.expr) list Tezos_protocol_environment_017_PtNairob.Error_monad.shell_tzresult Tezos_protocol_environment_017_PtNairob.Lwt.t
Sourceval normalize_script : script:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Script.expr -> unparsing_mode: Tezos_protocol_017_PtNairob.Protocol.Script_ir_unparser.unparsing_mode -> 'a Tezos_protocol_017_PtNairob.Environment.RPC_context.simple -> 'a -> Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Script.expr Tezos_protocol_environment_017_PtNairob.Error_monad.shell_tzresult Tezos_protocol_environment_017_PtNairob.Lwt.t
Sourceval normalize_type : ty:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Script.expr -> 'a Tezos_protocol_017_PtNairob.Environment.RPC_context.simple -> 'a -> Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Script.expr Tezos_protocol_environment_017_PtNairob.Error_monad.shell_tzresult Tezos_protocol_environment_017_PtNairob.Lwt.t
Sourceval run_operation : op:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Operation.packed -> chain_id:Tezos_protocol_017_PtNairob.Environment.Chain_id.t -> 'a Tezos_protocol_017_PtNairob.Environment.RPC_context.simple -> 'a -> (Tezos_raw_protocol_017_PtNairob.Alpha_context.Operation.packed_protocol_data * Tezos_protocol_017_PtNairob.Protocol.Apply_results.packed_operation_metadata) Tezos_protocol_environment_017_PtNairob.Error_monad.shell_tzresult Tezos_protocol_environment_017_PtNairob.Lwt.t
Sourceval simulate_operation : op:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Operation.packed -> chain_id:Tezos_protocol_017_PtNairob.Environment.Chain_id.t -> latency:int -> ?successor_level:bool -> ?blocks_before_activation:int32 -> 'a Tezos_protocol_017_PtNairob.Environment.RPC_context.simple -> 'a -> (Tezos_raw_protocol_017_PtNairob.Alpha_context.Operation.packed_protocol_data * Tezos_protocol_017_PtNairob.Protocol.Apply_results.packed_operation_metadata) Tezos_protocol_environment_017_PtNairob.Error_monad.shell_tzresult Tezos_protocol_environment_017_PtNairob.Lwt.t
Sourceval entrypoint_type : script:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Script.expr -> entrypoint:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Entrypoint.t -> 'a Tezos_protocol_017_PtNairob.Environment.RPC_context.simple -> 'a -> Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Script.expr Tezos_protocol_environment_017_PtNairob.Error_monad.shell_tzresult Tezos_protocol_environment_017_PtNairob.Lwt.t
Sourceval list_entrypoints : 'a Tezos_protocol_017_PtNairob.Environment.RPC_context.simple -> 'a -> script:Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Script.expr -> (Tezos_protocol_017_PtNairob.Protocol.Michelson_v1_primitives.prim list list * (string * Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Script.expr) list) Tezos_protocol_environment_017_PtNairob.Error_monad.shell_tzresult Tezos_protocol_environment_017_PtNairob.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