package octez-protocol-alpha-libs

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type

Calls Raw_contract_alias.add.

Calls Michelson_v1_parser.parse_expressionarg.

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.

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;
}

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;
}

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

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

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

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 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.

OCaml

Innovation. Community. Security.