package tezos-protocol-alpha

  1. Overview
  2. Docs
Tezos protocol alpha package

Install 

dune-project
 Dependency

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

Authors

  1. T
    Tezos devteam

Maintainers

  1. C
    contact@tezos.com

Sources

tezos-18.1.tar.gz
sha256=aa2f5bc99cc4ca2217c52a1af2a2cdfd3b383208cb859ca2e79ca0903396ca1d
sha512=d68bb3eb615e3dcccc845fddfc9901c95b3c6dc8e105e39522ce97637b1308a7fa7aa1d271351d5933febd7476b2819e1694f31198f1f0919681f1f9cc97cb3a

doc/tezos_raw_protocol_alpha/Tezos_raw_protocol_alpha/Alpha_context/index.html

Module Tezos_raw_protocol_alpha.Alpha_contextSource

An Alpha_context.t is an immutable snapshot of the ledger state at some block height, preserving type-safety and invariants of the ledger state.

Implementation

Alpha_context.t is a wrapper over Raw_context.t, which in turn is a wrapper around Context.t from the Protocol Environment.

Lifetime of an Alpha_context

  • Creation, using prepare or prepare_first_block
  • Modification, using the operations defined in this signature
  • Finalization, using finalize
Sourcemodule type BASIC_DATA = sig ... end
Sourcetype t
Sourcetype context = t
Sourcemodule Slot : sig ... end

This module re-exports definitions from Slot_repr.

Sourcemodule Tez : sig ... end

This module re-exports definitions from Tez_repr.

Sourcemodule Period : sig ... end

This module re-exports definitions from Period_repr.

Sourcemodule Timestamp : sig ... end

This module re-exports definitions from Time_repr.

Sourcemodule Ratio : sig ... end

This module re-exports definitions from Ratio_repr.

Sourcemodule Raw_level : sig ... end

This module re-exports definitions from Raw_level_repr.

Sourcemodule Cycle : sig ... end

This module re-exports definitions from Cycle_repr.

Sourcemodule Round : sig ... end

This module re-exports definitions from Round_repr.

Sourcemodule Gas : sig ... end

This module implements the gas subsystem of the context.

Sourcemodule Entrypoint : module type of Entrypoint_repr
Sourcemodule Script : sig ... end

This module re-exports definitions from Script_repr and Michelson_v1_primitives.

Sourcemodule Constants : sig ... end

This module re-exports definitions from Constants_repr and Constants_storage.

Sourcemodule Global_constants_storage : sig ... end

See the definitions inside the module.

Sourcemodule Internal_for_tests : sig ... end

This module discloses definitions that are only useful for tests and must not be used otherwise.

Sourcemodule Level : sig ... end

This module re-exports definitions from Level_repr and Level_storage.

Sourcemodule Fitness : sig ... end

This module re-exports definitions from Fitness_repr.

Sourcemodule Nonce : sig ... end

This module re-exports definitions from Nonce_storage.

Sourcemodule Seed : sig ... end

This module re-exports definitions from Seed_repr and Seed_storage.

Sourcemodule Big_map : sig ... end

Big maps are a data structure storing key-value associations, just like regular maps, but here the whole content of the structure is not loaded in memory when interacting with it. They are thus suitable for a Michelson contract, for instance, when there are a lot of bindings, but only a few items are accessed at each contract call.

Sourcemodule Sapling : sig ... end

This module re-exports definitions from Sapling_repr, Sapling_storage and Sapling_validator.

Sourcemodule Lazy_storage : sig ... end

This module re-exports definitions from Lazy_storage_diff.

Sourcemodule Origination_nonce : sig ... end

See the definitions inside the module.

Sourcemodule Ticket_hash : sig ... end

This module re-exports definitions from Ticket_hash_repr.

Sourcemodule Manager_counter : sig ... end

This module re-exports definitions from Manager_counter_repr.

Sourcemodule Contract : sig ... end

This module re-exports definitions from Contract_repr and Contract_storage.

Sourcemodule Bond_id : sig ... end

This module re-exports definitions from Bond_id_repr.

Sourcemodule Zk_rollup : sig ... end

This module re-exports definitions from Zk_rollup_repr and Zk_rollup_storage.

Sourcemodule Receipt : sig ... end

This module re-exports definitions from Receipt_repr.

Sourcemodule Consensus_key : sig ... end

This module re-exports definitions from Delegate_consensus_key.

Sourcemodule Delegate : sig ... end

This module re-exports definitions from Deposits_repr, Delegate_storage, Delegate_consensus_key, Delegate_missed_attestations_storage, Delegate_slashed_deposits_storage, Delegate_cycles, Delegate_rewards.

Sourcemodule Voting_period : sig ... end

This module re-exports definitions from Voting_period_repr and Voting_period_storage.

Sourcemodule Vote : sig ... end

This module re-exports definitions from Vote_repr and Vote_storage.

Sourcemodule Dal : sig ... end

This module exposes definitions for the data-availability layer.

Sourcemodule Dal_errors : sig ... end

This module re-exports definitions from Dal_errors_repr.

Sourcemodule Sc_rollup : sig ... end

This module re-exports definitions from Sc_rollup_storage and Sc_rollup_repr.

Sourcemodule Destination : sig ... end

This module re-exports definitions from Destination_repr.

Sourcemodule Block_payload : sig ... end

See Block_payload_repr.

Sourcemodule Block_header : sig ... end

This module re-exports definitions from Block_header_repr.

Sourcemodule Cache : sig ... end

This module re-exports definitions from Cache_repr.

Sourcemodule Kind : sig ... end

This module re-exports definitions from Operation_repr.Kind.

All the definitions below are re-exported from Operation_repr.

Sourcetype 'a consensus_operation_type =
  1. | Attestation : Kind.attestation consensus_operation_type
  2. | Preattestation : Kind.preattestation consensus_operation_type
Sourcetype consensus_content = {
  1. slot : Slot.t;
  2. level : Raw_level.t;
  3. round : Round.t;
  4. block_payload_hash : Block_payload_hash.t;
}
Sourceval consensus_content_encoding : consensus_content Tezos_protocol_environment_alpha.Data_encoding.t
Sourceval pp_consensus_content : Tezos_protocol_environment_alpha.Format.formatter -> consensus_content -> unit
Sourcetype 'kind operation = {
  1. shell : Tezos_protocol_environment_alpha.Operation.shell_header;
  2. protocol_data : 'kind protocol_data;
}
Sourceand 'kind protocol_data = {
  1. contents : 'kind contents_list;
  2. signature : signature option;
}
Sourceand _ contents_list =
  1. | Single : 'kind contents -> 'kind contents_list
  2. | Cons : 'kind Kind.manager contents * 'rest Kind.manager contents_list -> ('kind * 'rest) Kind.manager contents_list
Sourceand _ contents =
  1. | Preattestation : consensus_content -> Kind.preattestation contents
  2. | Attestation : consensus_content -> Kind.attestation contents
  3. | Dal_attestation : Dal.Attestation.operation -> Kind.dal_attestation contents
  4. | Seed_nonce_revelation : {
    1. level : Raw_level.t;
    2. nonce : Nonce.t;
    } -> Kind.seed_nonce_revelation contents
  5. | Vdf_revelation : {
    1. solution : Seed.vdf_solution;
    } -> Kind.vdf_revelation contents
  6. | Double_preattestation_evidence : {
    1. op1 : Kind.preattestation operation;
    2. op2 : Kind.preattestation operation;
    } -> Kind.double_preattestation_evidence contents
  7. | Double_attestation_evidence : {
    1. op1 : Kind.attestation operation;
    2. op2 : Kind.attestation operation;
    } -> Kind.double_attestation_evidence contents
  8. | Double_baking_evidence : {
    1. bh1 : Block_header.t;
    2. bh2 : Block_header.t;
    } -> Kind.double_baking_evidence contents
  9. | Activate_account : {
    1. id : Tezos_protocol_environment_alpha.Ed25519.Public_key_hash.t;
    2. activation_code : Blinded_public_key_hash.activation_code;
    } -> Kind.activate_account contents
  10. | Proposals : {
    1. source : public_key_hash;
    2. period : int32;
    3. proposals : Tezos_protocol_environment_alpha.Protocol_hash.t list;
    } -> Kind.proposals contents
  11. | Ballot : {
    1. source : public_key_hash;
    2. period : int32;
    3. proposal : Tezos_protocol_environment_alpha.Protocol_hash.t;
    4. ballot : Vote.ballot;
    } -> Kind.ballot contents
  12. | Drain_delegate : {
    1. consensus_key : Tezos_protocol_environment_alpha.Signature.Public_key_hash.t;
    2. delegate : Tezos_protocol_environment_alpha.Signature.Public_key_hash.t;
    3. destination : Tezos_protocol_environment_alpha.Signature.Public_key_hash.t;
    } -> Kind.drain_delegate contents
  13. | Failing_noop : string -> Kind.failing_noop contents
  14. | Manager_operation : {
    1. source : public_key_hash;
    2. fee : Tez.tez;
    3. counter : Manager_counter.t;
    4. operation : 'kind manager_operation;
    5. gas_limit : Gas.Arith.integral;
    6. storage_limit : Tezos_protocol_environment_alpha.Z.t;
    } -> 'kind Kind.manager contents
Sourceand _ manager_operation =
  1. | Reveal : public_key -> Kind.reveal manager_operation
  2. | Transaction : {
    1. amount : Tez.tez;
    2. parameters : Script.lazy_expr;
    3. entrypoint : Entrypoint.t;
    4. destination : Contract.t;
    } -> Kind.transaction manager_operation
  3. | Origination : {
    1. delegate : public_key_hash option;
    2. script : Script.t;
    3. credit : Tez.tez;
    } -> Kind.origination manager_operation
  4. | Delegation : public_key_hash option -> Kind.delegation manager_operation
  5. | Register_global_constant : {
    1. value : Script.lazy_expr;
    } -> Kind.register_global_constant manager_operation
  6. | Increase_paid_storage : {
    1. amount_in_bytes : Tezos_protocol_environment_alpha.Z.t;
    2. destination : Contract_hash.t;
    } -> Kind.increase_paid_storage manager_operation
  7. | Update_consensus_key : Tezos_protocol_environment_alpha.Signature.Public_key.t -> Kind.update_consensus_key manager_operation
  8. | Transfer_ticket : {
    1. contents : Script.lazy_expr;
    2. ty : Script.lazy_expr;
    3. ticketer : Contract.t;
    4. amount : Ticket_amount.t;
    5. destination : Contract.t;
    6. entrypoint : Entrypoint.t;
    } -> Kind.transfer_ticket manager_operation
  9. | Dal_publish_slot_header : Dal.Operations.Publish_slot_header.t -> Kind.dal_publish_slot_header manager_operation
  10. | Sc_rollup_originate : {
    1. kind : Sc_rollup.Kind.t;
    2. boot_sector : string;
    3. parameters_ty : Script.lazy_expr;
    4. whitelist : Sc_rollup.Whitelist.t option;
    } -> Kind.sc_rollup_originate manager_operation
  11. | Sc_rollup_add_messages : {
    1. messages : string list;
    } -> Kind.sc_rollup_add_messages manager_operation
  12. | Sc_rollup_cement : {
    1. rollup : Sc_rollup.t;
    } -> Kind.sc_rollup_cement manager_operation
  13. | Sc_rollup_publish : {
    1. rollup : Sc_rollup.t;
    2. commitment : Sc_rollup.Commitment.t;
    } -> Kind.sc_rollup_publish manager_operation
  14. | Sc_rollup_refute : {
    1. rollup : Sc_rollup.t;
    2. opponent : Sc_rollup.Staker.t;
    3. refutation : Sc_rollup.Game.refutation;
    } -> Kind.sc_rollup_refute manager_operation
  15. | Sc_rollup_timeout : {
    1. rollup : Sc_rollup.t;
    2. stakers : Sc_rollup.Game.Index.t;
    } -> Kind.sc_rollup_timeout manager_operation
  16. | Sc_rollup_execute_outbox_message : {
    1. rollup : Sc_rollup.t;
    2. cemented_commitment : Sc_rollup.Commitment.Hash.t;
    3. output_proof : string;
    } -> Kind.sc_rollup_execute_outbox_message manager_operation
  17. | Sc_rollup_recover_bond : {
    1. sc_rollup : Sc_rollup.t;
    2. staker : Tezos_protocol_environment_alpha.Signature.Public_key_hash.t;
    } -> Kind.sc_rollup_recover_bond manager_operation
  18. | Zk_rollup_origination : {
    1. public_parameters : Tezos_protocol_environment_alpha.Plonk.public_parameters;
    2. circuits_info : [ `Public | `Private | `Fee ] Zk_rollup.Account.SMap.t;
    3. init_state : Zk_rollup.State.t;
    4. nb_ops : int;
    } -> Kind.zk_rollup_origination manager_operation
  19. | Zk_rollup_publish : {
    1. zk_rollup : Zk_rollup.t;
    2. ops : (Zk_rollup.Operation.t * Zk_rollup.Ticket.t option) list;
    } -> Kind.zk_rollup_publish manager_operation
  20. | Zk_rollup_update : {
    1. zk_rollup : Zk_rollup.t;
    2. update : Zk_rollup.Update.t;
    } -> Kind.zk_rollup_update manager_operation
Sourcetype packed_manager_operation =
  1. | Manager : 'kind manager_operation -> packed_manager_operation
Sourcetype packed_contents =
  1. | Contents : 'kind contents -> packed_contents
Sourcetype packed_contents_list =
  1. | Contents_list : 'kind contents_list -> packed_contents_list
Sourcetype packed_protocol_data =
  1. | Operation_data : 'kind protocol_data -> packed_protocol_data
Sourceval manager_kind : 'kind manager_operation -> 'kind Kind.manager
Sourcemodule Operation : sig ... end

This module re-exports definitions from Operation_repr.

Sourcemodule Stake_distribution : sig ... end

This module re-exports definitions from Stake_storage, Delegate_storage and Delegate.

Sourcemodule Commitment : sig ... end

This module re-exports definitions from Commitment_repr and, Commitment_storage.

Sourcemodule Bootstrap : sig ... end

This module re-exports definitions from Bootstrap_storage.

Sourcemodule Migration : sig ... end

This module re-exports definitions from Migration_repr.

Create an Alpha_context.t from an untyped context (first block in the chain only).

Create an Alpha_context.t from an untyped context.

All the definitions below are re-exported from Raw_context.

Sourceval reset_internal_nonce : context -> context
Sourceval record_internal_nonce : context -> int -> context
Sourceval internal_nonce_already_recorded : context -> int -> bool
Sourceval record_non_consensus_operation_hash : context -> Tezos_protocol_environment_alpha.Operation_hash.t -> context
Sourceval record_dictator_proposal_seen : t -> t
Sourceval dictator_proposal_seen : t -> bool

Finalize an Alpha_context.t, producing a validation_result.

Should only be used by Main.current_context to return a context usable for RPCs

Sourcemodule Parameters : sig ... end

This module re-exports definitions from Parameters_repr.

Sourcemodule Votes_EMA : sig ... end

This module re-exports definitions from Votes_EMA_repr

Sourcemodule Per_block_votes : sig ... end

This module re-exports definitions from Per_block_votes_repr.

Sourcemodule Liquidity_baking : sig ... end

This module re-exports definitions from Liquidity_baking_storage.

Sourcemodule Adaptive_issuance : sig ... end

This module re-exports definitions from Adaptive_issuance_storage.

Sourcemodule Ticket_balance : sig ... end

This module re-exports definitions from Ticket_storage.

Sourcemodule First_level_of_protocol : sig ... end
Sourcemodule Consensus : sig ... end

This module re-exports definitions from Raw_context.Consensus.

Sourcemodule Token : sig ... end

This module re-exports definitions from Token.

Sourcemodule Unstake_requests : sig ... end

This module re-exports definitions from Unstake_requests_storage.

Sourcemodule Unstaked_frozen_deposits : sig ... end
Sourcemodule Staking_pseudotokens : sig ... end

This module re-exports definitions from Staking_pseudotokens_storage.

Sourcemodule Fees : sig ... end

This module re-exports definitions from Fees_storage.