package octez-protocol-014-PtKathma-libs

  1. Overview
  2. Docs
package octez-protocol-014-PtKathma-libs
Legend:
Library
Module
Module type
Parameter
Class
Class type
val list_contract_labels : Protocol_client_context.full -> chain:Tezos_shell_services.Shell_services.chain -> block:Tezos_shell_services.Shell_services.block -> (string * string * string) list Tezos_base.TzPervasives.tzresult Lwt.t
val register_global_constant : Protocol_client_context.full -> chain:Tezos_shell_services.Shell_services.chain -> block:Tezos_shell_services.Shell_services.block -> ?confirmations:int -> ?dry_run:bool -> ?verbose_signing:bool -> ?simulation:bool -> ?fee:Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Tez.tez -> ?gas_limit: Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Gas.Arith.integral -> ?storage_limit:Z.t -> ?counter:Z.t -> source:Tezos_base.TzPervasives.Signature.V0.public_key_hash -> src_pk:Tezos_base.TzPervasives.Signature.V0.public_key -> src_sk:Tezos_client_base.Client_keys_v0.sk_uri -> fee_parameter:Injection.fee_parameter -> constant:string -> unit -> (Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Kind.register_global_constant Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Kind.manager Injection.result, Tezos_base.TzPervasives.tztrace) result Lwt.t
val get_frozen_deposits_limit : Protocol_client_context.rpc_context -> chain:Tezos_shell_services.Shell_services.chain -> block:Tezos_shell_services.Shell_services.block -> Tezos_base.TzPervasives.Signature.V0.Public_key_hash.t -> Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Tez.t option Tezos_base.TzPervasives.tzresult Lwt.t

Calls Injection.inject_manager_operation with Annotated_manager_operation.annotated_list.Single_manager Alpha_context.Increase_paid_storage {amount_in_bytes; destination} as operation.

val save_contract : force:bool -> Protocol_client_context.full -> string -> Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Contract.t -> unit Tezos_base.TzPervasives.tzresult Lwt.t
val parse_arg_transfer : string option -> Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Script.lazy_expr Tezos_base.TzPervasives.tzresult Lwt.t

Same as transfer, but takes parameters as Script.lazy_expr instead of a raw string. This can be useful for commands that elaborate Micheline parameters, such as Multisigs or FA1.2 operations.

type activation_key = {
  1. pkh : Tezos_base.TzPervasives.Signature.Ed25519.Public_key_hash.t;
  2. amount : Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Tez.t;
  3. activation_code : Tezos_protocol_014_PtKathma.Protocol.Blinded_public_key_hash.activation_code;
  4. mnemonic : string list;
  5. password : string;
  6. email : string;
}
val activation_key_encoding : activation_key Tezos_base.TzPervasives.Data_encoding.t
type batch_transfer_operation = {
  1. destination : string;
  2. fee : string option;
  3. gas_limit : Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Gas.Arith.integral option;
  4. storage_limit : Z.t option;
  5. amount : string;
  6. arg : string option;
  7. entrypoint : Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Entrypoint.t option;
}
val batch_transfer_operation_encoding : batch_transfer_operation Tezos_base.TzPervasives.Data_encoding.t
val activate_account : Protocol_client_context.full -> chain:Tezos_shell_services.Shell_services.chain -> block:Tezos_shell_services.Shell_services.block -> ?confirmations:int -> ?dry_run:bool -> ?encrypted:bool -> ?force:bool -> activation_key -> string -> Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Kind.activate_account Injection.result Tezos_base.TzPervasives.tzresult Lwt.t
type period_info = {
  1. current_period_kind : Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Voting_period.kind;
  2. position : Int32.t;
  3. remaining : Int32.t;
  4. current_proposal : Tezos_base.TzPervasives.Protocol_hash.t option;
}
type ballots_info = {
  1. current_quorum : Int32.t;
  2. participation : Int32.t;
  3. supermajority : Int64.t;
  4. ballots : Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Vote.ballots;
}
val get_period_info : ?successor:bool -> Protocol_client_context.full -> chain:Tezos_shell_services.Shell_services.chain -> block:Tezos_shell_services.Shell_services.block -> period_info Tezos_base.TzPervasives.tzresult Lwt.t
val submit_proposals : ?dry_run:bool -> ?verbose_signing:bool -> Protocol_client_context.full -> chain:Tezos_shell_services.Shell_services.chain -> block:Tezos_shell_services.Shell_services.block -> ?confirmations:int -> src_sk:Tezos_client_base.Client_keys_v0.sk_uri -> Tezos_protocol_014_PtKathma.Protocol.Alpha_context.public_key_hash -> Tezos_base.TzPervasives.Protocol_hash.t list -> Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Kind.proposals Injection.result_list Tezos_base.TzPervasives.tzresult Lwt.t
val display_receipt_for_operation : Protocol_client_context.full -> chain:Tezos_shell_services.Block_services.chain -> ?predecessors:int -> Tezos_base.TzPervasives.Operation_list_hash.elt -> unit Tezos_base.TzPervasives.tzresult Lwt.t

lookup an operation in predecessors previous blocks, and print the receipt if found

val contract_cache_size : Protocol_client_context.full -> chain:Tezos_shell_services.Shell_services.chain -> block:Tezos_shell_services.Shell_services.block -> int Tezos_base.TzPervasives.tzresult Lwt.t
val contract_cache_size_limit : Protocol_client_context.full -> chain:Tezos_shell_services.Shell_services.chain -> block:Tezos_shell_services.Shell_services.block -> int Tezos_base.TzPervasives.tzresult Lwt.t
val submit_tx_rollup_commitment : Protocol_client_context.full -> chain:Tezos_shell_services.Shell_services.chain -> block:Tezos_shell_services.Shell_services.block -> ?confirmations:int -> ?dry_run:bool -> ?verbose_signing:bool -> ?simulation:bool -> ?fee:Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Tez.tez -> ?gas_limit: Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Gas.Arith.integral -> ?storage_limit:Z.t -> ?counter:Z.t -> source:Tezos_base.TzPervasives.Signature.V0.public_key_hash -> src_pk:Tezos_base.TzPervasives.Signature.V0.public_key -> src_sk:Tezos_client_base.Client_keys_v0.sk_uri -> fee_parameter:Injection.fee_parameter -> level:Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Tx_rollup_level.t -> inbox_merkle_root: Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Tx_rollup_inbox.Merkle.root -> messages: Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Tx_rollup_message_result_hash.t list -> predecessor: Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Tx_rollup_commitment_hash.t option -> tx_rollup:Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Tx_rollup.t -> unit -> (Tezos_base.TzPervasives.Operation_hash.t * Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Kind.tx_rollup_commit Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Kind.manager Tezos_protocol_014_PtKathma.Protocol.Alpha_context.contents * Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Kind.tx_rollup_commit Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Kind.manager Tezos_protocol_014_PtKathma.Protocol.Apply_results.contents_result) Tezos_base.TzPervasives.tzresult Lwt.t
val submit_tx_rollup_rejection : Protocol_client_context.full -> chain:Tezos_shell_services.Shell_services.chain -> block:Tezos_shell_services.Shell_services.block -> ?confirmations:int -> ?dry_run:bool -> ?verbose_signing:bool -> ?simulation:bool -> ?fee:Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Tez.tez -> ?gas_limit: Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Gas.Arith.integral -> ?storage_limit:Z.t -> ?counter:Z.t -> source:Tezos_base.TzPervasives.Signature.V0.public_key_hash -> src_pk:Tezos_base.TzPervasives.Signature.V0.public_key -> src_sk:Tezos_client_base.Client_keys_v0.sk_uri -> fee_parameter:Injection.fee_parameter -> level:Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Tx_rollup_level.t -> tx_rollup:Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Tx_rollup.t -> message: Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Tx_rollup_message.t -> message_position:int -> message_path: Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Tx_rollup_inbox.Merkle.path -> message_result_hash: Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Tx_rollup_message_result_hash.t -> message_result_path: Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Tx_rollup_commitment.Merkle.path -> previous_context_hash:Tezos_base.TzPervasives.Context_hash.t -> previous_withdraw_list_hash: Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Tx_rollup_withdraw_list_hash.t -> previous_message_result_path: Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Tx_rollup_commitment.Merkle.path -> proof:Tezos_protocol_014_PtKathma.Protocol.Tx_rollup_l2_proof.t -> unit -> (Tezos_base.TzPervasives.Operation_hash.t * Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Kind.tx_rollup_rejection Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Kind.manager Tezos_protocol_014_PtKathma.Protocol.Alpha_context.contents * Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Kind.tx_rollup_rejection Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Kind.manager Tezos_protocol_014_PtKathma.Protocol.Apply_results.contents_result) Tezos_base.TzPervasives.tzresult Lwt.t
val tx_rollup_dispatch_tickets : Protocol_client_context.full -> chain:Tezos_shell_services.Shell_services.chain -> block:Tezos_shell_services.Shell_services.block -> ?confirmations:int -> ?dry_run:bool -> ?verbose_signing:bool -> ?simulation:bool -> ?fee:Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Tez.tez -> ?gas_limit: Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Gas.Arith.integral -> ?storage_limit:Z.t -> ?counter:Z.t -> source:Tezos_base.TzPervasives.Signature.V0.public_key_hash -> src_pk:Tezos_base.TzPervasives.Signature.V0.public_key -> src_sk:Tezos_client_base.Client_keys_v0.sk_uri -> fee_parameter:Injection.fee_parameter -> level:Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Tx_rollup_level.t -> context_hash:Tezos_base.TzPervasives.Context_hash.t -> message_position:int -> message_result_path: Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Tx_rollup_commitment.Merkle.path -> tickets_info: Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Tx_rollup_reveal.t list -> tx_rollup:Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Tx_rollup.t -> unit -> (Tezos_base.TzPervasives.Operation_hash.t * Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Kind.tx_rollup_dispatch_tickets Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Kind.manager Tezos_protocol_014_PtKathma.Protocol.Alpha_context.contents * Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Kind.tx_rollup_dispatch_tickets Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Kind.manager Tezos_protocol_014_PtKathma.Protocol.Apply_results.contents_result) Tezos_base.TzPervasives.tzresult Lwt.t
val sc_rollup_execute_outbox_message : Protocol_client_context.full -> chain:Tezos_shell_services.Chain_services.chain -> block:Tezos_shell_services.Block_services.block -> ?confirmations:int -> ?dry_run:bool -> ?verbose_signing:bool -> ?simulation:bool -> ?fee:Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Tez.t -> ?gas_limit: Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Gas.Arith.integral -> ?storage_limit:Tezos_protocol_014_PtKathma.Protocol.Alpha_context.counter -> ?counter:Tezos_protocol_014_PtKathma.Protocol.Alpha_context.counter -> source:Tezos_protocol_014_PtKathma.Protocol.Alpha_context.public_key_hash -> rollup:Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Sc_rollup.t -> cemented_commitment: Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Sc_rollup.Commitment.Hash.t -> outbox_level:Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Raw_level.t -> message_index:int -> inclusion_proof:string -> message:string -> src_pk:Tezos_protocol_014_PtKathma.Protocol.Alpha_context.public_key -> src_sk:Tezos_client_base.Client_keys_v0.sk_uri -> fee_parameter:Injection.fee_parameter -> unit -> (Tezos_base.TzPervasives.Operation_hash.t * Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Kind.sc_rollup_execute_outbox_message Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Kind.manager Tezos_protocol_014_PtKathma.Protocol.Alpha_context.contents * Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Kind.sc_rollup_execute_outbox_message Tezos_protocol_014_PtKathma.Protocol.Alpha_context.Kind.manager Tezos_protocol_014_PtKathma.Protocol.Apply_results.contents_result, Tezos_base.TzPervasives.tztrace) result 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