tezos-protocol-alpha 12.3 · OCaml Package

tezos-protocol-alpha

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

module type BASIC_DATA = sig ... end

type t

type context = t

type public_key = Tezos_crypto.Signature.public_key

type public_key_hash = Tezos_crypto.Signature.public_key_hash

type signature = Tezos_crypto.Signature.t

module Slot : sig ... end

module Tez : sig ... end

module Period : sig ... end

module Timestamp : sig ... end

module Raw_level : sig ... end

module Cycle : sig ... end

module Round : sig ... end

module Gas : sig ... end

This module implements the gas subsystem of the context.

module Script_string : module type of Script_string_repr

Strings of printable characters

module Script_int : module type of Script_int_repr

module Script_timestamp : sig ... end

module Script : sig ... end

module Constants : sig ... end

module Global_constants_storage : sig ... end

module Cache : sig ... end

module Level : sig ... end

module Fitness : sig ... end

module Nonce : sig ... end

module Seed : sig ... end

module Big_map : sig ... end

module Sapling : sig ... end

module Lazy_storage : sig ... end

module Origination_nonce : sig ... end

module Contract : sig ... end

module Receipt : sig ... end

module Tx_rollup : sig ... end

This simply re-exports Tx_rollup_repr and tx_rollup_storage. See tx_rollup_repr and tx_rollup_storage for additional documentation of this module

module Delegate : sig ... end

module Voting_period : sig ... end

module Vote : sig ... end

module Block_payload : sig ... end

module Block_header : sig ... end

module Kind : sig ... end

type 'a consensus_operation_type =

| Endorsement : Kind.endorsement consensus_operation_type
| Preendorsement : Kind.preendorsement consensus_operation_type

val pp_operation_kind : 
  Format.formatter ->
  'kind consensus_operation_type ->
  unit

type consensus_content = {

slot : Slot.t;
level : Raw_level.t;
round : Round.t;
block_payload_hash : Block_payload_hash.t;

}

val consensus_content_encoding : consensus_content Data_encoding.t

val pp_consensus_content : Format.formatter -> consensus_content -> unit

type 'kind operation = {

shell : Tezos_base.Operation.shell_header;
protocol_data : 'kind protocol_data;

}

and 'kind protocol_data = {

contents : 'kind contents_list;
signature : Tezos_crypto.Signature.t option;

}

and _ contents_list =

| Single : 'kind contents -> 'kind contents_list
| Cons : 'kind Kind.manager contents * 'rest Kind.manager contents_list -> ('kind * 'rest) Kind.manager contents_list

and _ contents =

| Preendorsement : consensus_content -> Kind.preendorsement contents
| Endorsement : consensus_content -> Kind.endorsement contents
| Seed_nonce_revelation : {
1. level : Raw_level.t;
2. nonce : Nonce.t;
} -> Kind.seed_nonce_revelation contents
| Double_preendorsement_evidence : {
1. op1 : Kind.preendorsement operation;
2. op2 : Kind.preendorsement operation;
} -> Kind.double_preendorsement_evidence contents
| Double_endorsement_evidence : {
1. op1 : Kind.endorsement operation;
2. op2 : Kind.endorsement operation;
} -> Kind.double_endorsement_evidence contents
| Double_baking_evidence : {
1. bh1 : Block_header.t;
2. bh2 : Block_header.t;
} -> Kind.double_baking_evidence contents
| Activate_account : {
1. id : Tezos_crypto.Ed25519.Public_key_hash.t;
2. activation_code : Blinded_public_key_hash.activation_code;
} -> Kind.activate_account contents
| Proposals : {
1. source : Tezos_crypto.Signature.public_key_hash;
2. period : int32;
3. proposals : Tezos_crypto.Protocol_hash.t list;
} -> Kind.proposals contents
| Ballot : {
1. source : Tezos_crypto.Signature.public_key_hash;
2. period : int32;
3. proposal : Tezos_crypto.Protocol_hash.t;
4. ballot : Vote.ballot;
} -> Kind.ballot contents
| Failing_noop : string -> Kind.failing_noop contents
| Manager_operation : {
1. source : Tezos_crypto.Signature.public_key_hash;
2. fee : Tez.tez;
3. counter : counter;
4. operation : 'kind manager_operation;
5. gas_limit : Gas.Arith.integral;
6. storage_limit : Z.t;
} -> 'kind Kind.manager contents

and _ manager_operation =

| Reveal : Tezos_crypto.Signature.public_key -> Kind.reveal manager_operation
| Transaction : {
1. amount : Tez.tez;
2. parameters : Script.lazy_expr;
3. entrypoint : string;
4. destination : Contract.contract;
} -> Kind.transaction manager_operation
| Origination : {
1. delegate : Tezos_crypto.Signature.public_key_hash option;
2. script : Script.t;
3. credit : Tez.tez;
4. preorigination : Contract.t option;
} -> Kind.origination manager_operation
| Delegation : Tezos_crypto.Signature.public_key_hash option -> Kind.delegation manager_operation
| Register_global_constant : {
1. value : Script.lazy_expr;
} -> Kind.register_global_constant manager_operation
| Set_deposits_limit : Tez.t option -> Kind.set_deposits_limit manager_operation
| Tx_rollup_origination : Kind.tx_rollup_origination manager_operation

and counter = Z.t

type 'kind internal_operation = {

source : Contract.contract;
operation : 'kind manager_operation;
nonce : int;

}

type packed_manager_operation =

| Manager : 'kind manager_operation -> packed_manager_operation

type packed_contents =

| Contents : 'kind contents -> packed_contents

type packed_contents_list =

| Contents_list : 'kind contents_list -> packed_contents_list

type packed_protocol_data =

| Operation_data : 'kind protocol_data -> packed_protocol_data

type packed_operation = {

shell : Tezos_base.Operation.shell_header;
protocol_data : packed_protocol_data;

}

type packed_internal_operation =

| Internal_operation : 'kind internal_operation -> packed_internal_operation

val manager_kind : 'kind manager_operation -> 'kind Kind.manager

module Operation : sig ... end

module Stake_distribution : sig ... end

module Commitment : sig ... end

module Bootstrap : sig ... end

module Migration : sig ... end

val prepare_first_block : 
  Environment_context.Context.t ->
  typecheck:
    (context ->
      Script.t ->
      ((Script.t * Lazy_storage.diffs option) * context,
        Tezos_protocol_environment_alpha__Environment.Error_monad.error
          Tezos_protocol_environment_alpha__Environment.Error_monad.trace)
        result
        Lwt.t) ->
  level:int32 ->
  timestamp:Tezos_base.Time.Protocol.t ->
  (context,
    Tezos_protocol_environment_alpha__Environment.Error_monad.error
      Tezos_protocol_environment_alpha__Environment.Error_monad.trace)
    result
    Lwt.t

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

val prepare : 
  Environment_context.Context.t ->
  level:int32 ->
  predecessor_timestamp:Tezos_base.Time.Protocol.t ->
  timestamp:Tezos_base.Time.Protocol.t ->
  (context * Receipt.balance_updates * Migration.origination_result list,
    Tezos_protocol_environment_alpha__Environment.Error_monad.error
      Tezos_protocol_environment_alpha__Environment.Error_monad.trace)
    result
    Lwt.t

Create an Alpha_context.t from an untyped context.

val activate : context -> Tezos_crypto.Protocol_hash.t -> context Lwt.t

val reset_internal_nonce : context -> context

val fresh_internal_nonce : 
  context ->
  (context * int,
    Tezos_protocol_environment_alpha__Environment.Error_monad.error
      Tezos_protocol_environment_alpha__Environment.Error_monad.trace)
    result

val record_internal_nonce : context -> int -> context

val internal_nonce_already_recorded : context -> int -> bool

val description : context Storage_description.t

val finalize : 
  ?commit_message:string ->
  context ->
  Fitness.raw ->
  Environment_context.validation_result

Finalize an Alpha_context.t, producing a validation_result.

val current_context : context -> Environment_context.Context.t

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

val record_non_consensus_operation_hash : 
  context ->
  Tezos_crypto.Operation_hash.t ->
  context

val non_consensus_operations : context -> Tezos_crypto.Operation_hash.t list

module Parameters : sig ... end

module Liquidity_baking : sig ... end

module Ticket_balance : sig ... end

This module re-exports functions from Ticket_storage. See documentation of the functions there.

module First_level_of_tenderbake : sig ... end

module Consensus : sig ... end

module Token : sig ... end

See 'token.mli' for more explanation.

module Fees : sig ... end

package tezos-protocol-alpha

Implementation

Lifetime of an Alpha_context