package octez-protocol-alpha-libs

  1. Overview
  2. Docs
package octez-protocol-alpha-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

Calls Tezos_protocol_alpha.Protocol.Contract_services.list.

Calls Tezos_protocol_plugin_alpha.Plugin.RPC.Contract.get_storage_normalized.

Calls Tezos_protocol_plugin_alpha.Plugin.RPC.Contract.get_used_storage_space.

Calls Tezos_protocol_plugin_alpha.Plugin.RPC.Contract.get_paid_storage_space.

Calls Tezos_protocol_alpha.Protocol.Contract_services.contract_big_map_get_opt.

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_alpha.Protocol.Alpha_context.Tez.t -> ?gas_limit:Tezos_protocol_alpha.Protocol.Alpha_context.Gas.Arith.integral -> ?storage_limit:Z.t -> ?counter:Tezos_protocol_alpha.Protocol.Alpha_context.Manager_counter.t -> source:Tezos_base.TzPervasives.Signature.public_key_hash -> src_pk:Tezos_base.TzPervasives.Signature.public_key -> src_sk:Tezos_client_base.Client_keys.sk_uri -> fee_parameter:Injection.fee_parameter -> constant:string -> unit -> (Tezos_protocol_alpha.Protocol.Alpha_context.Kind.register_global_constant Tezos_protocol_alpha.Protocol.Alpha_context.Kind.manager Injection.result, Tezos_base.TzPervasives.tztrace) result Lwt.t

Calls Injection.prepare_manager_operation with Register_global_constant constant as operation.

Calls Tezos_protocol_plugin_alpha.Plugin.RPC.Big_map.big_map_get_normalized.

Calls Tezos_protocol_plugin_alpha.Plugin.RPC.Contract.get_script_normalized.

Calls Tezos_protocol_alpha.Protocol.Contract_services.script_opt.

Calls Tezos_protocol_alpha.Protocol.Contract_services.balance.

Calls Tezos_protocol_alpha.Protocol.Contract_services.staked_balance.

Calls Tezos_protocol_alpha.Protocol.Contract_services.full_balance.

Calls Tezos_protocol_plugin_alpha.Plugin.RPC.Contract.get_ticket_balance.

Calls Tezos_protocol_plugin_alpha.Plugin.RPC.Contract.get_all_ticket_balances.

val ticket_balances_encoding : (Tezos_protocol_alpha.Protocol.Ticket_token.unparsed_token * Z.t) list Tezos_base.TzPervasives.Data_encoding.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.Public_key_hash.t -> Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t option Tezos_base.TzPervasives.tzresult Lwt.t

Calls Tezos_protocol_alpha.Protocol.Delegate_services.frozen_deposits_limit.

Calls Injection.prepare_manager_operation with Alpha_context.Delegation delegate_opt as operation.

Calls Injection.inject_manager_operation with Annotated_manager_operation.annotated_list.Single_manager build_delegate_operation ?fee opt_delegate as operation.

val update_consensus_key : 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_alpha.Protocol.Alpha_context.Tez.t -> consensus_pk:Tezos_base.TzPervasives.Signature.public_key -> manager_sk:Tezos_client_base.Client_keys.sk_uri -> fee_parameter:Injection.fee_parameter -> Tezos_base.TzPervasives.Signature.public_key -> Tezos_protocol_alpha.Protocol.Alpha_context.Kind.update_consensus_key Tezos_protocol_alpha.Protocol.Alpha_context.Kind.manager Injection.result Tezos_base.TzPervasives.tzresult Lwt.t
val drain_delegate : 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 -> consensus_sk:Tezos_client_base.Client_keys.sk_uri -> consensus_pkh:Tezos_base.TzPervasives.Signature.public_key_hash -> ?destination:Tezos_base.TzPervasives.Signature.public_key_hash -> delegate:Tezos_base.TzPervasives.Signature.public_key_hash -> unit -> Tezos_protocol_alpha.Protocol.Alpha_context.Kind.drain_delegate Injection.result Tezos_base.TzPervasives.tzresult Lwt.t

Calls Injection.inject_manager_operation with Annotated_manager_operation.annotated_list.Single_manager Alpha_context.Set_deposits_limit limit_opt as operation.

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

Same as set_delegate but the ~source argument of Injection.inject_manager_operation is Signature.Public_key.hash src_pk.

val save_contract : force:bool -> Protocol_client_context.full -> string -> Tezos_protocol_alpha.Protocol.Alpha_context.Contract.t -> unit Tezos_base.TzPervasives.tzresult Lwt.t

Calls Raw_contract_alias.add.

Injects the origination of a script into the context. See Injection.inject_manager_operation for the injection, and Protocol.Alpha_context.Origination for the origination parameters.

val parse_arg_transfer : string option -> Tezos_protocol_alpha.Protocol.Alpha_context.Script.lazy_expr Tezos_base.TzPervasives.tzresult Lwt.t

Calls Michelson_v1_parser.parse_expressionarg.

Calls Injection.prepare_manager_operation with Alpha_context.Transaction {amount;parameters;destinations;entrypoint} as operation.

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.

Calls Injection.inject_manager_operation with Annotated_manager_operation.annotated_list.Single_manager build_transaction_operation ~amount ~parameters ~entrypoint ?fee ?gas_limit ?storage_limit destination as contents.

Calls Injection.prepare_manager_operation with Reveal pk as operation

Calls Injection.inject_manager_operation with Annotated_manager_operation.annotated_list.Single_manager build_reveal_operation ?fee ~storage_limit:Z.zero src_pk as contents.

type activation_key = {
  1. pkh : Tezos_base.TzPervasives.Signature.Ed25519.Public_key_hash.t;
  2. amount : Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t;
  3. activation_code : Tezos_protocol_alpha.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_alpha.Protocol.Alpha_context.Gas.Arith.integral option;
  4. storage_limit : Z.t option;
  5. amount : string;
  6. arg : string option;
  7. entrypoint : Tezos_protocol_alpha.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_alpha.Protocol.Alpha_context.Kind.activate_account Injection.result Tezos_base.TzPervasives.tzresult Lwt.t

Activate an account, by calling Injection.inject_operation.

Activate an existing account, by calling Injection.inject_operation with activation code. It fails if the account is unknown or if the account is not Signature.Ed25519.

type period_info = {
  1. current_period_kind : Tezos_protocol_alpha.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_alpha.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

get_period_info ~successor cctx ~chain ~block returns the successor period_info if successor, it returns the current period_info otherwise. This function uses Tezos_protocol_alpha.Protocol.Voting_services.successor_period if successor, otherwise it calls Tezos_protocol_alpha.Protocol.Voting_services.current_period. In any case, it also uses Tezos_protocol_alpha.Protocol.Voting_services.current_proposal

get_ballots_info cctx ~chain ~block returns the ballots_info. It calls Tezos_protocol_alpha.Protocol.Voting_services.ballots, Tezos_protocol_alpha.Protocol.Voting_services.current_quorum and Tezos_protocol_alpha.Protocol.Voting_services.total_voting_power.

Calls Tezos_protocol_alpha.Protocol.Voting_services.proposals

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.sk_uri -> Tezos_protocol_alpha.Protocol.Alpha_context.public_key_hash -> Tezos_base.TzPervasives.Protocol_hash.t list -> Tezos_protocol_alpha.Protocol.Alpha_context.Kind.proposals Injection.result_list Tezos_base.TzPervasives.tzresult Lwt.t

Calls Injection.inject_operation where contents is Alpha_context.Single (Proposals {source; period = index; proposals}) with index the result of Alpha_services.Voting.successor_period

Calls Injection.inject_operation where contents is Alpha_context.Single (Ballot {source; period = index; proposals}) with index the result of Alpha_services.Voting.successor_period

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

Calls Tezos_protocol_alpha.Protocol.Alpha_services.Cache.cached_contracts

Calls Tezos_protocol_alpha.Protocol.Alpha_services.Cache.contract_rank

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

Calls Tezos_protocol_alpha.Protocol.Alpha_services.Cache.contract_cache_size

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

Calls Tezos_protocol_alpha.Protocol.Alpha_services.Cache.contract_cache_size_limit

Injects a smart-contract rollup origination operation using Injection.inject_operation.

Originates a smart rollup of kind with the boot_sector using paramaters_ty. Generates a unique smart rollup address returned in the operation's receipt.

This is the only entry-point to create a smart rollup.

Injects a smart-contract rollup add messages operation using Injection.inject_operation.

Adds external messages to the smart rollup inbox shared with all smart rollups.

Injects a smart-contract rollup cement commitment operation using Injection.inject_operation.

Cements a commitment for the smart rollup rollup. The commitment now becomes unrefutable and we can execute outbox messages for the committed PVM state (see sc_rollup_execute_outbox_message).

Injects a smart-contract rollup publish commitment operation using Injection.inject_operation.

Publishes a commitment to announces the PVM state at the end of a commitment period and the number of ticks executed. If it is the first time src_pk publishes a commitment, a bond is frozen.

Injects a smart-contract rollup execute outbox message operation using Injection.inject_operation.

Executes output_proof on the PVM commited state from the cemented_commitment. Allows to perform L2->L1 communication.

Injects a smart-contract rollup recover bond operation using Injection.inject_operation.

Allows to recover the bond frozen by the operation sc_rollup_publish of src_pk, if the commitment is no longer subject to refutations.

Injects a smart-contract rollup refutation operation using Injection.inject_operation.

Either start a refutation game between src_pk and oppononent or plays a move in an existing refutation game.

Injects a smart-contract rollup timeout operation using Injection.inject_operation.

Timeouts the absent player from the refutation game between alice and bob.

Injects a DAL publish commitment operation using Injection.inject_operation.

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