raw_context.ml
(*****************************************************************************)
(* *)
(* Open Source License *)
(* Copyright (c) 2018 Dynamic Ledger Solutions, Inc. <contact@tezos.com> *)
(* Copyright (c) 2021-2022 Trili Tech, <contact@trili.tech> *)
(* *)
(* Permission is hereby granted, free of charge, to any person obtaining a *)
(* copy of this software and associated documentation files (the "Software"),*)
(* to deal in the Software without restriction, including without limitation *)
(* the rights to use, copy, modify, merge, publish, distribute, sublicense, *)
(* and/or sell copies of the Software, and to permit persons to whom the *)
(* Software is furnished to do so, subject to the following conditions: *)
(* *)
(* The above copyright notice and this permission notice shall be included *)
(* in all copies or substantial portions of the Software. *)
(* *)
(* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR*)
(* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *)
(* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL *)
(* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER*)
(* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING *)
(* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER *)
(* DEALINGS IN THE SOFTWARE. *)
(* *)
(*****************************************************************************)
module Int_set = Set.Make (Compare.Int)
(*
Gas levels maintenance
=======================
The context maintains two levels of gas, one corresponds to the gas
available for the current operation while the other is the gas
available for the current block. Both levels are maintained
independently: [consume_gas] only decreases the operation level,
and block level should be updated with [consume_gas_limit_in_block].
A layered context
=================
Updating the context [remaining_operation_gas] is a critical routine
called very frequently by the operations performed by the protocol.
On the contrary, other fields are less frequently updated.
In a previous version of the context datatype definition, all
the fields were represented at the toplevel. To update the remaining
gas, we had to copy ~25 fields (that is 200 bytes).
With the following layered representation, we only have to
copy 2 fields (16 bytes) during [remaining_operation_gas] update.
This has a significant impact on the Michelson runtime efficiency.
Here are the fields on the [back] of the context:
*)
type consensus_pk = {
delegate : Signature.Public_key_hash.t;
consensus_pk : Signature.Public_key.t;
consensus_pkh : Signature.Public_key_hash.t;
}
let consensus_pk_encoding =
let open Data_encoding in
conv
(fun {delegate; consensus_pk; consensus_pkh} ->
if Signature.Public_key_hash.equal consensus_pkh delegate then
(consensus_pk, None)
else (consensus_pk, Some delegate))
(fun (consensus_pk, delegate) ->
let consensus_pkh = Signature.Public_key.hash consensus_pk in
let delegate =
match delegate with None -> consensus_pkh | Some del -> del
in
{delegate; consensus_pk; consensus_pkh})
(obj2
(req "consensus_pk" Signature.Public_key.encoding)
(opt "delegate" Signature.Public_key_hash.encoding))
module Raw_consensus = struct
(** Consensus operations are indexed by their [initial slots]. Given
a delegate, the [initial slot] is the lowest slot assigned to
this delegate. *)
type t = {
current_attestation_power : int;
(** Number of attestation slots recorded for the current block. *)
allowed_attestations : (consensus_pk * int) Slot_repr.Map.t option;
(** Attestations rights for the current block. Only an attestation
for the lowest slot in the block can be recorded. The map
associates to each initial slot the [pkh] associated to this
slot with its power. This is [None] only in mempool mode. *)
allowed_preattestations : (consensus_pk * int) Slot_repr.Map.t option;
(** Preattestations rights for the current block. Only a preattestation
for the lowest slot in the block can be recorded. The map
associates to each initial slot the [pkh] associated to this
slot with its power. This is [None] only in mempool mode, or in
application mode when there is no locked round (so the block
cannot contain any preattestations). *)
forbidden_delegates : Signature.Public_key_hash.Set.t;
(** Delegates that are not allowed to bake or attest blocks; i.e.,
delegates which have zero frozen deposit due to a previous
slashing. *)
attestations_seen : Slot_repr.Set.t;
(** Record the attestations already seen. Only initial slots are indexed. *)
preattestations_seen : Slot_repr.Set.t;
(** Record the preattestations already seen. Only initial slots
are indexed. *)
locked_round_evidence : (Round_repr.t * int) option;
(** Record the preattestation power for a locked round. *)
preattestations_quorum_round : Round_repr.t option;
(** in block construction mode, record the round of preattestations
included in a block. *)
attestation_branch : (Block_hash.t * Block_payload_hash.t) option;
}
(** Invariant:
- [slot \in attestations_seen => Int_map.mem slot allowed_attestations]
- [slot \in preattestations_seen => Int_map.mem slot allowed_preattestations]
- [ |attestations_seen| > 0 => |included attestations| > 0]
*)
let empty : t =
{
current_attestation_power = 0;
allowed_attestations = Some Slot_repr.Map.empty;
allowed_preattestations = Some Slot_repr.Map.empty;
forbidden_delegates = Signature.Public_key_hash.Set.empty;
attestations_seen = Slot_repr.Set.empty;
preattestations_seen = Slot_repr.Set.empty;
locked_round_evidence = None;
preattestations_quorum_round = None;
attestation_branch = None;
}
type error += Double_inclusion_of_consensus_operation
let () =
register_error_kind
`Branch
~id:"operation.double_inclusion_of_consensus_operation"
~title:"Double inclusion of consensus operation"
~description:"double inclusion of consensus operation"
~pp:(fun ppf () ->
Format.fprintf ppf "Double inclusion of consensus operation")
Data_encoding.empty
(function
| Double_inclusion_of_consensus_operation -> Some () | _ -> None)
(fun () -> Double_inclusion_of_consensus_operation)
let record_attestation t ~initial_slot ~power =
let open Result_syntax in
let+ () =
error_when
(Slot_repr.Set.mem initial_slot t.attestations_seen)
Double_inclusion_of_consensus_operation
in
{
t with
current_attestation_power = t.current_attestation_power + power;
attestations_seen = Slot_repr.Set.add initial_slot t.attestations_seen;
}
let record_preattestation ~initial_slot ~power round t =
let open Result_syntax in
let+ () =
error_when
(Slot_repr.Set.mem initial_slot t.preattestations_seen)
Double_inclusion_of_consensus_operation
in
let locked_round_evidence =
match t.locked_round_evidence with
| None -> Some (round, power)
| Some (_stored_round, evidences) ->
(* In mempool mode, round and stored_round can be different.
It doesn't matter in that case since quorum certificates
are not used in mempool.
For other cases [Apply.check_round] verifies it. *)
Some (round, evidences + power)
in
{
t with
locked_round_evidence;
preattestations_seen =
Slot_repr.Set.add initial_slot t.preattestations_seen;
}
let set_forbidden_delegates delegates t =
{t with forbidden_delegates = delegates}
let forbid_delegate delegate t =
{
t with
forbidden_delegates =
Signature.Public_key_hash.Set.add delegate t.forbidden_delegates;
}
let set_preattestations_quorum_round round t =
match t.preattestations_quorum_round with
| Some round' ->
(* If the rounds are different, an error should have already
been raised. *)
assert (Round_repr.equal round round') ;
t
| None -> {t with preattestations_quorum_round = Some round}
let initialize_with_attestations_and_preattestations ~allowed_attestations
~allowed_preattestations t =
{t with allowed_attestations; allowed_preattestations}
let locked_round_evidence t = t.locked_round_evidence
let attestation_branch t = t.attestation_branch
let set_attestation_branch t attestation_branch =
{t with attestation_branch = Some attestation_branch}
end
type dal_committee = {
pkh_to_shards :
(Dal_attestation_repr.shard_index * int) Signature.Public_key_hash.Map.t;
shard_to_pkh : Signature.Public_key_hash.t Dal_attestation_repr.Shard_map.t;
}
let empty_dal_committee =
{
pkh_to_shards = Signature.Public_key_hash.Map.empty;
shard_to_pkh = Dal_attestation_repr.Shard_map.empty;
}
type back = {
context : Context.t;
constants : Constants_parametric_repr.t;
round_durations : Round_repr.Durations.t;
cycle_eras : Level_repr.cycle_eras;
level : Level_repr.t;
predecessor_timestamp : Time.t;
timestamp : Time.t;
fees : Tez_repr.t;
origination_nonce : Origination_nonce.t option;
temporary_lazy_storage_ids : Lazy_storage_kind.Temp_ids.t;
internal_nonce : int;
internal_nonces_used : Int_set.t;
remaining_block_gas : Gas_limit_repr.Arith.fp;
unlimited_operation_gas : bool;
consensus : Raw_consensus.t;
non_consensus_operations_rev : Operation_hash.t list;
dictator_proposal_seen : bool;
sampler_state : (Seed_repr.seed * consensus_pk Sampler.t) Cycle_repr.Map.t;
stake_distribution_for_current_cycle :
Stake_repr.t Signature.Public_key_hash.Map.t option;
reward_coeff_for_current_cycle : Q.t;
sc_rollup_current_messages : Sc_rollup_inbox_merkelized_payload_hashes_repr.t;
dal_slot_fee_market : Dal_slot_repr.Slot_market.t;
(* DAL/FIXME https://gitlab.com/tezos/tezos/-/issues/3105
We associate to a slot header some fees. This enable the use
of a fee market for slot publication. However, this is not
resilient from the game theory point of view. Probably we can find
better incentives here. In any case, because we want the following
invariant:
- For each level and for each slot there is at most one slot
header.
- We need to provide an incentive to avoid byzantines to post
dummy slot headers. *)
dal_attestation_slot_accountability : Dal_attestation_repr.Accountability.t;
dal_committee : dal_committee;
dal_cryptobox : Dal.t option;
adaptive_issuance_enable : bool;
}
(*
The context is simply a record with two fields which
limits the cost of updating the [remaining_operation_gas].
*)
type t = {remaining_operation_gas : Gas_limit_repr.Arith.fp; back : back}
type root = t
(*
Context fields accessors
========================
To have the context related code more robust to evolutions,
we introduce accessors to get and to update the context
components.
*)
let[@inline] context ctxt = ctxt.back.context
let[@inline] current_level ctxt = ctxt.back.level
let[@inline] predecessor_timestamp ctxt = ctxt.back.predecessor_timestamp
let[@inline] current_timestamp ctxt = ctxt.back.timestamp
let[@inline] round_durations ctxt = ctxt.back.round_durations
let[@inline] cycle_eras ctxt = ctxt.back.cycle_eras
let[@inline] constants ctxt = ctxt.back.constants
let[@inline] sc_rollup ctxt = ctxt.back.constants.sc_rollup
let[@inline] zk_rollup ctxt = ctxt.back.constants.zk_rollup
let[@inline] recover ctxt = ctxt.back.context
let[@inline] fees ctxt = ctxt.back.fees
let[@inline] origination_nonce ctxt = ctxt.back.origination_nonce
let[@inline] internal_nonce ctxt = ctxt.back.internal_nonce
let[@inline] internal_nonces_used ctxt = ctxt.back.internal_nonces_used
let[@inline] remaining_block_gas ctxt = ctxt.back.remaining_block_gas
let[@inline] unlimited_operation_gas ctxt = ctxt.back.unlimited_operation_gas
let[@inline] temporary_lazy_storage_ids ctxt =
ctxt.back.temporary_lazy_storage_ids
let[@inline] remaining_operation_gas ctxt = ctxt.remaining_operation_gas
let[@inline] non_consensus_operations_rev ctxt =
ctxt.back.non_consensus_operations_rev
let[@inline] dictator_proposal_seen ctxt = ctxt.back.dictator_proposal_seen
let[@inline] sampler_state ctxt = ctxt.back.sampler_state
let[@inline] reward_coeff_for_current_cycle ctxt =
ctxt.back.reward_coeff_for_current_cycle
let[@inline] adaptive_issuance_enable ctxt = ctxt.back.adaptive_issuance_enable
let[@inline] update_back ctxt back = {ctxt with back}
let[@inline] update_remaining_block_gas ctxt remaining_block_gas =
update_back ctxt {ctxt.back with remaining_block_gas}
let[@inline] update_remaining_operation_gas ctxt remaining_operation_gas =
{ctxt with remaining_operation_gas}
let[@inline] update_unlimited_operation_gas ctxt unlimited_operation_gas =
update_back ctxt {ctxt.back with unlimited_operation_gas}
let[@inline] update_context ctxt context =
update_back ctxt {ctxt.back with context}
let[@inline] update_constants ctxt constants =
update_back ctxt {ctxt.back with constants}
let[@inline] update_origination_nonce ctxt origination_nonce =
update_back ctxt {ctxt.back with origination_nonce}
let[@inline] update_internal_nonce ctxt internal_nonce =
update_back ctxt {ctxt.back with internal_nonce}
let[@inline] update_internal_nonces_used ctxt internal_nonces_used =
update_back ctxt {ctxt.back with internal_nonces_used}
let[@inline] update_fees ctxt fees = update_back ctxt {ctxt.back with fees}
let[@inline] update_temporary_lazy_storage_ids ctxt temporary_lazy_storage_ids =
update_back ctxt {ctxt.back with temporary_lazy_storage_ids}
let[@inline] update_non_consensus_operations_rev ctxt
non_consensus_operations_rev =
update_back ctxt {ctxt.back with non_consensus_operations_rev}
let[@inline] update_dictator_proposal_seen ctxt dictator_proposal_seen =
update_back ctxt {ctxt.back with dictator_proposal_seen}
let[@inline] update_sampler_state ctxt sampler_state =
update_back ctxt {ctxt.back with sampler_state}
let[@inline] update_reward_coeff_for_current_cycle ctxt
reward_coeff_for_current_cycle =
update_back ctxt {ctxt.back with reward_coeff_for_current_cycle}
let[@inline] set_adaptive_issuance_enable ctxt =
update_back ctxt {ctxt.back with adaptive_issuance_enable = true}
type error += Too_many_internal_operations (* `Permanent *)
type error += Block_quota_exceeded (* `Temporary *)
type error += Operation_quota_exceeded (* `Temporary *)
type error += Stake_distribution_not_set (* `Branch *)
type error += Sampler_already_set of Cycle_repr.t (* `Permanent *)
let () =
let open Data_encoding in
register_error_kind
`Permanent
~id:"too_many_internal_operations"
~title:"Too many internal operations"
~description:
"A transaction exceeded the hard limit of internal operations it can emit"
empty
(function Too_many_internal_operations -> Some () | _ -> None)
(fun () -> Too_many_internal_operations) ;
register_error_kind
`Temporary
~id:"gas_exhausted.operation"
~title:"Gas quota exceeded for the operation"
~description:
"A script or one of its callee took more time than the operation said it \
would"
empty
(function Operation_quota_exceeded -> Some () | _ -> None)
(fun () -> Operation_quota_exceeded) ;
register_error_kind
`Temporary
~id:"gas_exhausted.block"
~title:"Gas quota exceeded for the block"
~description:
"The sum of gas consumed by all the operations in the block exceeds the \
hard gas limit per block"
empty
(function Block_quota_exceeded -> Some () | _ -> None)
(fun () -> Block_quota_exceeded) ;
register_error_kind
`Permanent
~id:"delegate.stake_distribution_not_set"
~title:"Stake distribution not set"
~description:"The stake distribution for the current cycle is not set."
~pp:(fun ppf () ->
Format.fprintf
ppf
"The stake distribution for the current cycle is not set.")
empty
(function Stake_distribution_not_set -> Some () | _ -> None)
(fun () -> Stake_distribution_not_set) ;
register_error_kind
`Permanent
~id:"sampler_already_set"
~title:"Sampler already set"
~description:
"Internal error: Raw_context.set_sampler_for_cycle was called twice for \
a given cycle"
~pp:(fun ppf c ->
Format.fprintf
ppf
"Internal error: sampler already set for cycle %a."
Cycle_repr.pp
c)
(obj1 (req "cycle" Cycle_repr.encoding))
(function Sampler_already_set c -> Some c | _ -> None)
(fun c -> Sampler_already_set c)
let fresh_internal_nonce ctxt =
let open Result_syntax in
if Compare.Int.(internal_nonce ctxt >= 65_535) then
tzfail Too_many_internal_operations
else
return
(update_internal_nonce ctxt (internal_nonce ctxt + 1), internal_nonce ctxt)
let reset_internal_nonce ctxt =
let ctxt = update_internal_nonce ctxt 0 in
update_internal_nonces_used ctxt Int_set.empty
let record_internal_nonce ctxt k =
update_internal_nonces_used ctxt (Int_set.add k (internal_nonces_used ctxt))
let internal_nonce_already_recorded ctxt k =
Int_set.mem k (internal_nonces_used ctxt)
let get_collected_fees ctxt = fees ctxt
let credit_collected_fees_only_call_from_token ctxt fees' =
let open Result_syntax in
let previous = get_collected_fees ctxt in
let+ fees = Tez_repr.(previous +? fees') in
update_fees ctxt fees
let spend_collected_fees_only_call_from_token ctxt fees' =
let open Result_syntax in
let previous = get_collected_fees ctxt in
let+ fees = Tez_repr.(previous -? fees') in
update_fees ctxt fees
type error += Undefined_operation_nonce (* `Permanent *)
let () =
let open Data_encoding in
register_error_kind
`Permanent
~id:"undefined_operation_nonce"
~title:"Ill timed access to the origination nonce"
~description:
"An origination was attempted out of the scope of a manager operation"
empty
(function Undefined_operation_nonce -> Some () | _ -> None)
(fun () -> Undefined_operation_nonce)
let init_origination_nonce ctxt operation_hash =
let origination_nonce = Some (Origination_nonce.initial operation_hash) in
update_origination_nonce ctxt origination_nonce
let increment_origination_nonce ctxt =
let open Result_syntax in
match origination_nonce ctxt with
| None -> tzfail Undefined_operation_nonce
| Some cur_origination_nonce ->
let origination_nonce =
Some (Origination_nonce.incr cur_origination_nonce)
in
let ctxt = update_origination_nonce ctxt origination_nonce in
return (ctxt, cur_origination_nonce)
let get_origination_nonce ctxt =
let open Result_syntax in
match origination_nonce ctxt with
| None -> tzfail Undefined_operation_nonce
| Some origination_nonce -> return origination_nonce
let unset_origination_nonce ctxt = update_origination_nonce ctxt None
let gas_level ctxt =
let open Gas_limit_repr in
if unlimited_operation_gas ctxt then Unaccounted
else Limited {remaining = remaining_operation_gas ctxt}
let block_gas_level = remaining_block_gas
let consume_gas_limit_in_block ctxt gas_limit =
let open Gas_limit_repr in
let open Result_syntax in
let* () =
check_gas_limit
~hard_gas_limit_per_operation:
(constants ctxt).hard_gas_limit_per_operation
~gas_limit
in
let block_gas = block_gas_level ctxt in
let limit = Arith.fp gas_limit in
if Arith.(limit > block_gas) then tzfail Block_quota_exceeded
else
let level = Arith.sub (block_gas_level ctxt) limit in
let ctxt = update_remaining_block_gas ctxt level in
Ok ctxt
let set_gas_limit ctxt (remaining : 'a Gas_limit_repr.Arith.t) =
let open Gas_limit_repr in
let remaining_operation_gas = Arith.fp remaining in
let ctxt = update_unlimited_operation_gas ctxt false in
{ctxt with remaining_operation_gas}
let set_gas_unlimited ctxt = update_unlimited_operation_gas ctxt true
let consume_gas ctxt cost =
let open Result_syntax in
match Gas_limit_repr.raw_consume (remaining_operation_gas ctxt) cost with
| Some gas_counter -> Ok (update_remaining_operation_gas ctxt gas_counter)
| None ->
if unlimited_operation_gas ctxt then return ctxt
else tzfail Operation_quota_exceeded
let check_enough_gas ctxt cost =
let open Result_syntax in
let* (_ : t) = consume_gas ctxt cost in
return_unit
let gas_consumed ~since ~until =
match (gas_level since, gas_level until) with
| Limited {remaining = before}, Limited {remaining = after} ->
Gas_limit_repr.Arith.sub before after
| _, _ -> Gas_limit_repr.Arith.zero
type missing_key_kind = Get | Set | Del | Copy
type storage_error =
| Incompatible_protocol_version of string
| Missing_key of string list * missing_key_kind
| Existing_key of string list
| Corrupted_data of string list
let storage_error_encoding =
let open Data_encoding in
union
[
case
(Tag 0)
~title:"Incompatible_protocol_version"
(obj1 (req "incompatible_protocol_version" @@ string Plain))
(function Incompatible_protocol_version arg -> Some arg | _ -> None)
(fun arg -> Incompatible_protocol_version arg);
case
(Tag 1)
~title:"Missing_key"
(obj2
(req "missing_key" (list @@ string Plain))
(req
"function"
(string_enum
[("get", Get); ("set", Set); ("del", Del); ("copy", Copy)])))
(function Missing_key (key, f) -> Some (key, f) | _ -> None)
(fun (key, f) -> Missing_key (key, f));
case
(Tag 2)
~title:"Existing_key"
(obj1 (req "existing_key" (list @@ string Plain)))
(function Existing_key key -> Some key | _ -> None)
(fun key -> Existing_key key);
case
(Tag 3)
~title:"Corrupted_data"
(obj1 (req "corrupted_data" (list @@ string Plain)))
(function Corrupted_data key -> Some key | _ -> None)
(fun key -> Corrupted_data key);
]
let pp_storage_error ppf = function
| Incompatible_protocol_version version ->
Format.fprintf
ppf
"Found a context with an unexpected version '%s'."
version
| Missing_key (key, Get) ->
Format.fprintf ppf "Missing key '%s'." (String.concat "/" key)
| Missing_key (key, Set) ->
Format.fprintf
ppf
"Cannot set undefined key '%s'."
(String.concat "/" key)
| Missing_key (key, Del) ->
Format.fprintf
ppf
"Cannot delete undefined key '%s'."
(String.concat "/" key)
| Missing_key (key, Copy) ->
Format.fprintf
ppf
"Cannot copy undefined key '%s'."
(String.concat "/" key)
| Existing_key key ->
Format.fprintf
ppf
"Cannot initialize defined key '%s'."
(String.concat "/" key)
| Corrupted_data key ->
Format.fprintf
ppf
"Failed to parse the data at '%s'."
(String.concat "/" key)
type error += Storage_error of storage_error
let () =
register_error_kind
`Permanent
~id:"context.storage_error"
~title:"Storage error (fatal internal error)"
~description:
"An error that should never happen unless something has been deleted or \
corrupted in the database."
~pp:(fun ppf err ->
Format.fprintf ppf "@[<v 2>Storage error:@ %a@]" pp_storage_error err)
storage_error_encoding
(function Storage_error err -> Some err | _ -> None)
(fun err -> Storage_error err)
let storage_error err = Result_syntax.tzfail (Storage_error err)
(* Initialization *********************************************************)
(* This key should always be populated for every version of the
protocol. It's absence meaning that the context is empty. *)
let version_key = ["version"]
(* This value is set by the snapshot_alpha.sh script, don't change it. *)
let protocol_migration_internal_message =
Sc_rollup_inbox_message_repr.Protocol_migration Constants_repr.version_value
let protocol_migration_serialized_message =
match
Sc_rollup_inbox_message_repr.serialize
(Internal protocol_migration_internal_message)
with
| Ok msg -> msg
| Error trace ->
Format.kasprintf
failwith
"%s: Could not serialize protocol message : %a"
__LOC__
pp_trace
trace
let cycle_eras_key = [Constants_repr.version; "cycle_eras"]
let constants_key = [Constants_repr.version; "constants"]
let protocol_param_key = ["protocol_parameters"]
let get_cycle_eras ctxt =
let open Lwt_syntax in
let+ bytes_opt = Context.find ctxt cycle_eras_key in
match bytes_opt with
| None -> storage_error (Missing_key (cycle_eras_key, Get))
| Some bytes -> (
match
Data_encoding.Binary.of_bytes_opt Level_repr.cycle_eras_encoding bytes
with
| None -> storage_error (Corrupted_data cycle_eras_key)
| Some cycle_eras -> Ok cycle_eras)
let set_cycle_eras ctxt cycle_eras =
let open Lwt_result_syntax in
let bytes =
Data_encoding.Binary.to_bytes_exn Level_repr.cycle_eras_encoding cycle_eras
in
let*! ctxt = Context.add ctxt cycle_eras_key bytes in
return ctxt
type error += Failed_to_parse_parameter of bytes
type error += Failed_to_decode_parameter of Data_encoding.json * string
let () =
register_error_kind
`Temporary
~id:"context.failed_to_parse_parameter"
~title:"Failed to parse parameter"
~description:"The protocol parameters are not valid JSON."
~pp:(fun ppf bytes ->
Format.fprintf
ppf
"@[<v 2>Cannot parse the protocol parameter:@ %s@]"
(Bytes.to_string bytes))
Data_encoding.(obj1 (req "contents" @@ bytes Hex))
(function Failed_to_parse_parameter data -> Some data | _ -> None)
(fun data -> Failed_to_parse_parameter data) ;
register_error_kind
`Temporary
~id:"context.failed_to_decode_parameter"
~title:"Failed to decode parameter"
~description:"Unexpected JSON object."
~pp:(fun ppf (json, msg) ->
Format.fprintf
ppf
"@[<v 2>Cannot decode the protocol parameter:@ %s@ %a@]"
msg
Data_encoding.Json.pp
json)
Data_encoding.(obj2 (req "contents" json) (req "error" @@ string Plain))
(function
| Failed_to_decode_parameter (json, msg) -> Some (json, msg) | _ -> None)
(fun (json, msg) -> Failed_to_decode_parameter (json, msg))
let get_proto_param ctxt =
let open Lwt_result_syntax in
let*! bytes_opt = Context.find ctxt protocol_param_key in
match bytes_opt with
| None -> failwith "Missing protocol parameters."
| Some bytes -> (
match Data_encoding.Binary.of_bytes_opt Data_encoding.json bytes with
| None -> tzfail (Failed_to_parse_parameter bytes)
| Some json -> (
let*! ctxt = Context.remove ctxt protocol_param_key in
match Data_encoding.Json.destruct Parameters_repr.encoding json with
| exception (Data_encoding.Json.Cannot_destruct _ as exn) ->
Format.kasprintf
failwith
"Invalid protocol_parameters: %a %a"
(fun ppf -> Data_encoding.Json.print_error ppf)
exn
Data_encoding.Json.pp
json
| param ->
let*? () = Parameters_repr.check_params param in
return (param, ctxt)))
let add_constants ctxt constants =
let bytes =
Data_encoding.Binary.to_bytes_exn
Constants_parametric_repr.encoding
constants
in
Context.add ctxt constants_key bytes
let get_constants ctxt =
let open Lwt_result_syntax in
let*! bytes_opt = Context.find ctxt constants_key in
match bytes_opt with
| None -> failwith "Internal error: cannot read constants in context."
| Some bytes -> (
match
Data_encoding.Binary.of_bytes_opt
Constants_parametric_repr.encoding
bytes
with
| None -> failwith "Internal error: cannot parse constants in context."
| Some constants -> return constants)
let patch_constants ctxt f =
let open Lwt_syntax in
let constants = f (constants ctxt) in
let+ context = add_constants (context ctxt) constants in
let ctxt = update_context ctxt context in
update_constants ctxt constants
let check_inited ctxt =
let open Lwt_syntax in
let+ bytes_opt = Context.find ctxt version_key in
match bytes_opt with
| None -> failwith "Internal error: un-initialized context."
| Some bytes ->
let s = Bytes.to_string bytes in
if Compare.String.(s = Constants_repr.version_value) then
Result.return_unit
else storage_error (Incompatible_protocol_version s)
let check_cycle_eras (cycle_eras : Level_repr.cycle_eras)
(constants : Constants_parametric_repr.t) =
let current_era = Level_repr.current_era cycle_eras in
assert (
Compare.Int32.(current_era.blocks_per_cycle = constants.blocks_per_cycle)) ;
assert (
Compare.Int32.(
current_era.blocks_per_commitment = constants.blocks_per_commitment))
let prepare ~level ~predecessor_timestamp ~timestamp ~adaptive_issuance_enable
ctxt =
let open Lwt_result_syntax in
let*? level = Raw_level_repr.of_int32 level in
let* () = check_inited ctxt in
let* constants = get_constants ctxt in
let*? round_durations =
Round_repr.Durations.create
~first_round_duration:constants.minimal_block_delay
~delay_increment_per_round:constants.delay_increment_per_round
in
let+ cycle_eras = get_cycle_eras ctxt in
check_cycle_eras cycle_eras constants ;
let level = Level_repr.level_from_raw ~cycle_eras level in
let sc_rollup_current_messages =
Sc_rollup_inbox_repr.init_witness_no_history
in
{
remaining_operation_gas = Gas_limit_repr.Arith.zero;
back =
{
context = ctxt;
constants;
level;
predecessor_timestamp;
timestamp;
round_durations;
cycle_eras;
fees = Tez_repr.zero;
origination_nonce = None;
temporary_lazy_storage_ids = Lazy_storage_kind.Temp_ids.init;
internal_nonce = 0;
internal_nonces_used = Int_set.empty;
remaining_block_gas =
Gas_limit_repr.Arith.fp
constants.Constants_parametric_repr.hard_gas_limit_per_block;
unlimited_operation_gas = true;
consensus = Raw_consensus.empty;
non_consensus_operations_rev = [];
dictator_proposal_seen = false;
sampler_state = Cycle_repr.Map.empty;
stake_distribution_for_current_cycle = None;
reward_coeff_for_current_cycle = Q.one;
sc_rollup_current_messages;
dal_slot_fee_market =
Dal_slot_repr.Slot_market.init
~length:constants.Constants_parametric_repr.dal.number_of_slots;
dal_attestation_slot_accountability =
Dal_attestation_repr.Accountability.init
~length:constants.Constants_parametric_repr.dal.number_of_slots;
dal_committee = empty_dal_committee;
dal_cryptobox = None;
adaptive_issuance_enable;
};
}
type previous_protocol = Genesis of Parameters_repr.t | Oxford_018
let check_and_update_protocol_version ctxt =
let open Lwt_result_syntax in
let* previous_proto, ctxt =
let*! bytes_opt = Context.find ctxt version_key in
match bytes_opt with
| None ->
failwith "Internal error: un-initialized context in check_first_block."
| Some bytes ->
let s = Bytes.to_string bytes in
if Compare.String.(s = Constants_repr.version_value) then
failwith "Internal error: previously initialized context."
else if Compare.String.(s = "genesis") then
let+ param, ctxt = get_proto_param ctxt in
(Genesis param, ctxt)
else if Compare.String.(s = "oxford_018") then return (Oxford_018, ctxt)
else Lwt.return @@ storage_error (Incompatible_protocol_version s)
in
let*! ctxt =
Context.add ctxt version_key (Bytes.of_string Constants_repr.version_value)
in
return (previous_proto, ctxt)
(* only for the migration *)
let[@warning "-32"] get_previous_protocol_constants ctxt =
let open Lwt_syntax in
let* bytes_opt = Context.find ctxt constants_key in
match bytes_opt with
| None ->
failwith
"Internal error: cannot read previous protocol constants in context."
| Some bytes -> (
match
Data_encoding.Binary.of_bytes_opt
Constants_parametric_previous_repr.encoding
bytes
with
| None ->
failwith
"Internal error: cannot parse previous protocol constants in \
context."
| Some constants -> return constants)
let update_block_time_related_constants (c : Constants_parametric_repr.t) =
let divide_period p =
Period_repr.of_seconds_exn
Int64.(div (mul (Period_repr.to_seconds p) 2L) 3L)
in
let minimal_block_delay = divide_period c.minimal_block_delay in
let delay_increment_per_round = divide_period c.delay_increment_per_round in
let hard_gas_limit_per_block =
let two = Z.(succ one) in
let three = Z.(succ two) in
Gas_limit_repr.Arith.(
integral_exn
(Z.div (Z.mul (integral_to_z c.hard_gas_limit_per_block) two) three))
in
let half_more x = Int32.(div (mul 3l x) 2l) in
let blocks_per_cycle = half_more c.blocks_per_cycle in
let blocks_per_commitment = half_more c.blocks_per_commitment in
let nonce_revelation_threshold = half_more c.nonce_revelation_threshold in
let max_operations_time_to_live = 3 * c.max_operations_time_to_live / 2 in
let block_time = Int64.to_int (Period_repr.to_seconds minimal_block_delay) in
let sc_rollup =
Constants_parametric_repr.update_sc_rollup_parameter c.sc_rollup ~block_time
in
{
c with
sc_rollup;
blocks_per_cycle;
blocks_per_commitment;
nonce_revelation_threshold;
max_operations_time_to_live;
minimal_block_delay;
delay_increment_per_round;
hard_gas_limit_per_block;
}
let update_cycle_eras ctxt level ~prev_blocks_per_cycle ~blocks_per_cycle
~blocks_per_commitment =
let open Lwt_result_syntax in
let* cycle_eras = get_cycle_eras ctxt in
let current_era = Level_repr.current_era cycle_eras in
let current_cycle =
let level_position =
Int32.sub level (Raw_level_repr.to_int32 current_era.first_level)
in
Cycle_repr.add
current_era.first_cycle
(Int32.to_int (Int32.div level_position prev_blocks_per_cycle))
in
let new_cycle_era =
Level_repr.
{
first_level = Raw_level_repr.of_int32_exn (Int32.succ level);
first_cycle = Cycle_repr.succ current_cycle;
blocks_per_cycle;
blocks_per_commitment;
}
in
let*? new_cycle_eras = Level_repr.add_cycle_era new_cycle_era cycle_eras in
set_cycle_eras ctxt new_cycle_eras
(* You should ensure that if the type `Constants_parametric_repr.t` is
different from `Constants_parametric_previous_repr.t` or the value of these
constants is modified, is changed from the previous protocol, then
you `propagate` these constants to the new protocol by writing them
onto the context via the function `add_constants` or
`patch_constants`.
This migration can be achieved also implicitly by modifying the
encoding directly in a way which is compatible with the previous
protocol. However, by doing so, you do not change the value of
these constants inside the context. *)
let prepare_first_block ~level ~timestamp _chain_id ctxt =
let open Lwt_result_syntax in
let* previous_proto, ctxt = check_and_update_protocol_version ctxt in
let* ctxt, previous_proto_constants =
match previous_proto with
| Genesis param ->
let*? first_level = Raw_level_repr.of_int32 level in
let cycle_era =
{
Level_repr.first_level;
first_cycle = Cycle_repr.root;
blocks_per_cycle = param.constants.blocks_per_cycle;
blocks_per_commitment = param.constants.blocks_per_commitment;
}
in
let*? cycle_eras = Level_repr.create_cycle_eras [cycle_era] in
let* ctxt = set_cycle_eras ctxt cycle_eras in
let*! result = add_constants ctxt param.constants in
return (result, None)
| Oxford_018 ->
let*! c = get_previous_protocol_constants ctxt in
(* When modifying the line below, be careful that the values are
compatible with the encodings exported by the environment did not
change. *)
let cryptobox_parameters =
{
Dal.page_size = 4096;
slot_size = 1 lsl 20;
redundancy_factor = 16;
number_of_shards = 2048;
}
in
let dal =
Constants_parametric_repr.
{
feature_enable = true;
incentives_enable = false;
number_of_slots = 256;
attestation_lag = 4;
attestation_threshold = 50;
cryptobox_parameters;
}
in
(* This test prevents the activation of the protocol if the
set of parameters given for the DAL is invalid. *)
let*? () =
match Dal.make cryptobox_parameters with
| Ok _cryptobox -> ok ()
| Error (`Fail explanation) ->
error (Dal_errors_repr.Dal_cryptobox_error {explanation})
in
let dal_activation_level =
if c.dal.feature_enable then
(* if dal was enable in previous protocol, do as if it were always
activated *)
Raw_level_repr.succ Raw_level_repr.root
else
(* dal activates at first level of the new protocol. *)
Raw_level_repr.of_int32_exn (Int32.succ level)
in
let dal_attested_slots_validity_lag =
(* A rollup node shouldn't import a page of an attested slot whose attested
level is too far in the past w.r.t. the current level. Importation window
is fixed to 241_920 levels below. It is the number of blocks produced
during 28 days (4 weeks) with a block time of 10 seconds. *)
241_920
in
let reveal_activation_level :
Constants_parametric_repr.sc_rollup_reveal_activation_level =
let ({
raw_data = {blake2B};
metadata;
dal_page = _;
dal_parameters = _;
}
: Constants_parametric_previous_repr
.sc_rollup_reveal_activation_level) =
c.sc_rollup.reveal_activation_level
in
{
raw_data = {blake2B};
metadata;
dal_page = dal_activation_level;
dal_parameters = dal_activation_level;
(* Warning: the semantics of valid slots needs to be adapted if the
value of this parameter is changed in the future.
- If it is increased, some attested slots that were outdated with
the old value will become valid again.
- If it is decreased, some attested slots that were valid with
the old value will become outdated.
In both cases, the status of slots before and after the value
change is different. So, the behaviour if a valid slot is
imported before the value upgrade but a refutation game
targetting a page of that slot is started after the upgrade is
not the correct/expected one. *)
dal_attested_slots_validity_lag;
}
in
let sc_rollup =
Constants_parametric_repr.
{
arith_pvm_enable = c.sc_rollup.arith_pvm_enable;
origination_size = c.sc_rollup.origination_size;
challenge_window_in_blocks =
c.sc_rollup.challenge_window_in_blocks;
stake_amount = c.sc_rollup.stake_amount;
commitment_period_in_blocks =
c.sc_rollup.commitment_period_in_blocks;
max_lookahead_in_blocks = c.sc_rollup.max_lookahead_in_blocks;
max_active_outbox_levels = c.sc_rollup.max_active_outbox_levels;
max_outbox_messages_per_level =
c.sc_rollup.max_outbox_messages_per_level;
number_of_sections_in_dissection =
c.sc_rollup.number_of_sections_in_dissection;
timeout_period_in_blocks = c.sc_rollup.timeout_period_in_blocks;
max_number_of_stored_cemented_commitments =
c.sc_rollup.max_number_of_stored_cemented_commitments;
max_number_of_parallel_games =
c.sc_rollup.max_number_of_parallel_games;
reveal_activation_level;
private_enable = c.sc_rollup.private_enable;
riscv_pvm_enable = c.sc_rollup.riscv_pvm_enable;
}
in
let zk_rollup =
Constants_parametric_repr.
{
enable = c.zk_rollup.enable;
origination_size = c.zk_rollup.origination_size;
min_pending_to_process = c.zk_rollup.min_pending_to_process;
max_ticket_payload_size = c.zk_rollup.max_ticket_payload_size;
}
in
let adaptive_rewards_params =
Constants_parametric_repr.
{
issuance_ratio_final_min = Q.(0_25 // 100_00);
(* 0.25% *)
issuance_ratio_final_max = Q.(10 // 100) (* 10% *);
issuance_ratio_initial_min = Q.(45 // 1000);
(* 4.5% *)
issuance_ratio_initial_max = Q.(55 // 1000);
(* 5.5% *)
initial_period = 10;
(* 1 month *)
transition_period = 50;
(* 5 months *)
max_bonus = c.adaptive_issuance.adaptive_rewards_params.max_bonus;
growth_rate =
c.adaptive_issuance.adaptive_rewards_params.growth_rate;
center_dz = c.adaptive_issuance.adaptive_rewards_params.center_dz;
radius_dz = c.adaptive_issuance.adaptive_rewards_params.radius_dz;
}
in
let adaptive_issuance =
Constants_parametric_repr.
{
global_limit_of_staking_over_baking =
c.adaptive_issuance.global_limit_of_staking_over_baking;
edge_of_staking_over_delegation =
c.adaptive_issuance.edge_of_staking_over_delegation;
launch_ema_threshold = c.adaptive_issuance.launch_ema_threshold;
adaptive_rewards_params;
activation_vote_enable = true;
autostaking_enable = c.adaptive_issuance.autostaking_enable;
force_activation = false;
ns_enable = false;
}
in
let liquidity_baking_subsidy = Tez_repr.(mul_exn one 5) in
let (issuance_weights : Constants_parametric_repr.issuance_weights) =
let ({
base_total_issued_per_minute;
baking_reward_fixed_portion_weight;
baking_reward_bonus_weight;
attesting_reward_weight;
liquidity_baking_subsidy_weight = _;
seed_nonce_revelation_tip_weight;
vdf_revelation_tip_weight;
}
: Constants_parametric_previous_repr.issuance_weights) =
c.issuance_weights
in
let base_total_issued_per_minute =
let x =
Tez_repr.(
sub_opt base_total_issued_per_minute liquidity_baking_subsidy)
in
match x with None -> assert false | Some x -> x
in
{
base_total_issued_per_minute;
baking_reward_fixed_portion_weight;
baking_reward_bonus_weight;
attesting_reward_weight;
seed_nonce_revelation_tip_weight;
vdf_revelation_tip_weight;
}
in
let direct_ticket_spending_enable = false in
let consensus_rights_delay =
(* We change the consensus_rights_delay value only for mainnet *)
if Compare.Int.(c.preserved_cycles = 5) then 2 else c.preserved_cycles
in
let Constants_repr.Generated.{max_slashing_threshold; _} =
Constants_repr.Generated.generate
~consensus_committee_size:c.consensus_committee_size
in
let constants =
Constants_parametric_repr.
{
consensus_rights_delay;
blocks_preservation_cycles = 1;
delegate_parameters_activation_delay = c.preserved_cycles;
blocks_per_cycle = c.blocks_per_cycle;
blocks_per_commitment = c.blocks_per_commitment;
nonce_revelation_threshold = c.nonce_revelation_threshold;
cycles_per_voting_period = c.cycles_per_voting_period;
hard_gas_limit_per_operation = c.hard_gas_limit_per_operation;
hard_gas_limit_per_block = c.hard_gas_limit_per_block;
proof_of_work_threshold = c.proof_of_work_threshold;
minimal_stake = c.minimal_stake;
minimal_frozen_stake = c.minimal_frozen_stake;
vdf_difficulty = c.vdf_difficulty;
origination_size = c.origination_size;
max_operations_time_to_live = c.max_operations_time_to_live;
issuance_weights;
cost_per_byte = c.cost_per_byte;
hard_storage_limit_per_operation =
c.hard_storage_limit_per_operation;
quorum_min = c.quorum_min;
quorum_max = c.quorum_max;
min_proposal_quorum = c.min_proposal_quorum;
liquidity_baking_subsidy;
liquidity_baking_toggle_ema_threshold =
c.liquidity_baking_toggle_ema_threshold;
minimal_block_delay = c.minimal_block_delay;
delay_increment_per_round = c.delay_increment_per_round;
consensus_committee_size = c.consensus_committee_size;
consensus_threshold = c.consensus_threshold;
minimal_participation_ratio = c.minimal_participation_ratio;
limit_of_delegation_over_baking =
c.limit_of_delegation_over_baking;
percentage_of_frozen_deposits_slashed_per_double_baking =
Percentage.convert_from_o_to_p
c.percentage_of_frozen_deposits_slashed_per_double_baking;
percentage_of_frozen_deposits_slashed_per_double_attestation =
Percentage.convert_from_o_to_p
c.percentage_of_frozen_deposits_slashed_per_double_attestation;
max_slashing_per_block = Percentage.p100;
max_slashing_threshold;
(* The `testnet_dictator` should absolutely be None on mainnet *)
testnet_dictator = c.testnet_dictator;
initial_seed = c.initial_seed;
cache_script_size = c.cache_script_size;
cache_stake_distribution_cycles =
c.cache_stake_distribution_cycles;
cache_sampler_state_cycles = c.cache_sampler_state_cycles;
dal;
sc_rollup;
zk_rollup;
adaptive_issuance;
direct_ticket_spending_enable;
}
in
let block_time_is_at_least_8s =
(* This check is used to trigger the constants changes at migration on
this protocol for network that have block time strictly greater
than 7s such as mainnet and ghostnet *)
Compare.Int64.(Period_repr.to_seconds c.minimal_block_delay >= 8L)
in
let* ctxt, constants =
if block_time_is_at_least_8s then
let new_constants : Constants_parametric_repr.t =
update_block_time_related_constants constants
in
let* ctxt =
update_cycle_eras
ctxt
level
~prev_blocks_per_cycle:constants.blocks_per_cycle
~blocks_per_cycle:new_constants.blocks_per_cycle
~blocks_per_commitment:new_constants.blocks_per_commitment
in
return (ctxt, new_constants)
else return (ctxt, constants)
in
let*! ctxt = add_constants ctxt constants in
return (ctxt, Some c)
in
let+ ctxt =
prepare
ctxt
~level
~predecessor_timestamp:timestamp
~timestamp
~adaptive_issuance_enable:false
in
(previous_proto, previous_proto_constants, ctxt)
let activate ctxt h =
let open Lwt_syntax in
let+ new_ctxt = Updater.activate (context ctxt) h in
update_context ctxt new_ctxt
(* Generic context ********************************************************)
type key = string list
type value = bytes
type tree = Context.tree
module type T =
Raw_context_intf.T
with type root := root
and type key := key
and type value := value
and type tree := tree
let mem ctxt k = Context.mem (context ctxt) k
let mem_tree ctxt k = Context.mem_tree (context ctxt) k
let get ctxt k =
let open Lwt_result_syntax in
let*! v_opt = Context.find (context ctxt) k in
match v_opt with
| None -> Lwt.return @@ storage_error (Missing_key (k, Get))
| Some v -> return v
let get_tree ctxt k =
let open Lwt_result_syntax in
let*! v_opt = Context.find_tree (context ctxt) k in
match v_opt with
| None -> Lwt.return @@ storage_error (Missing_key (k, Get))
| Some v -> return v
let find ctxt k = Context.find (context ctxt) k
let find_tree ctxt k = Context.find_tree (context ctxt) k
let add ctxt k v =
let open Lwt_syntax in
let+ new_ctxt = Context.add (context ctxt) k v in
update_context ctxt new_ctxt
let add_tree ctxt k v =
let open Lwt_syntax in
let+ new_ctxt = Context.add_tree (context ctxt) k v in
update_context ctxt new_ctxt
let init ctxt k v =
let open Lwt_result_syntax in
let*! result = Context.mem (context ctxt) k in
match result with
| true -> Lwt.return @@ storage_error (Existing_key k)
| _ ->
let*! context = Context.add (context ctxt) k v in
return (update_context ctxt context)
let init_tree ctxt k v : _ tzresult Lwt.t =
let open Lwt_result_syntax in
let*! result = Context.mem_tree (context ctxt) k in
match result with
| true -> Lwt.return @@ storage_error (Existing_key k)
| _ ->
let*! context = Context.add_tree (context ctxt) k v in
return (update_context ctxt context)
let update ctxt k v =
let open Lwt_result_syntax in
let*! result = Context.mem (context ctxt) k in
match result with
| false -> Lwt.return @@ storage_error (Missing_key (k, Set))
| _ ->
let*! context = Context.add (context ctxt) k v in
return (update_context ctxt context)
let update_tree ctxt k v =
let open Lwt_result_syntax in
let*! result = Context.mem_tree (context ctxt) k in
match result with
| false -> Lwt.return @@ storage_error (Missing_key (k, Set))
| _ ->
let*! context = Context.add_tree (context ctxt) k v in
return (update_context ctxt context)
(* Verify that the key is present before deleting *)
let remove_existing ctxt k =
let open Lwt_result_syntax in
let*! result = Context.mem (context ctxt) k in
match result with
| false -> Lwt.return @@ storage_error (Missing_key (k, Del))
| _ ->
let*! context = Context.remove (context ctxt) k in
return (update_context ctxt context)
(* Verify that the key is present before deleting *)
let remove_existing_tree ctxt k =
let open Lwt_result_syntax in
let*! result = Context.mem_tree (context ctxt) k in
match result with
| false -> Lwt.return @@ storage_error (Missing_key (k, Del))
| _ ->
let*! context = Context.remove (context ctxt) k in
return (update_context ctxt context)
(* Do not verify before deleting *)
let remove ctxt k =
let open Lwt_syntax in
let+ new_ctxt = Context.remove (context ctxt) k in
update_context ctxt new_ctxt
let add_or_remove ctxt k = function
| None -> remove ctxt k
| Some v -> add ctxt k v
let add_or_remove_tree ctxt k = function
| None -> remove ctxt k
| Some v -> add_tree ctxt k v
let list ctxt ?offset ?length k = Context.list (context ctxt) ?offset ?length k
let fold ?depth ctxt k ~order ~init ~f =
Context.fold ?depth (context ctxt) k ~order ~init ~f
let config ctxt = Context.config (context ctxt)
module Proof = Context.Proof
let length ctxt key = Context.length (context ctxt) key
module Tree :
Raw_context_intf.TREE
with type t := t
and type key := key
and type value := value
and type tree := tree = struct
include Context.Tree
let empty ctxt = Context.Tree.empty (context ctxt)
let get t k =
let open Lwt_result_syntax in
let*! result = find t k in
match result with
| None -> Lwt.return @@ storage_error (Missing_key (k, Get))
| Some v -> return v
let get_tree t k =
let open Lwt_result_syntax in
let*! result = find_tree t k in
match result with
| None -> Lwt.return @@ storage_error (Missing_key (k, Get))
| Some v -> return v
let init t k v =
let open Lwt_result_syntax in
let*! result = mem t k in
match result with
| true -> Lwt.return @@ storage_error (Existing_key k)
| _ ->
let*! tree = add t k v in
return tree
let init_tree t k v =
let open Lwt_result_syntax in
let*! result = mem_tree t k in
match result with
| true -> Lwt.return @@ storage_error (Existing_key k)
| _ ->
let*! tree = add_tree t k v in
return tree
let update t k v =
let open Lwt_result_syntax in
let*! result = mem t k in
match result with
| false -> Lwt.return @@ storage_error (Missing_key (k, Set))
| _ ->
let*! tree = add t k v in
return tree
let update_tree t k v =
let open Lwt_result_syntax in
let*! result = mem_tree t k in
match result with
| false -> Lwt.return @@ storage_error (Missing_key (k, Set))
| _ ->
let*! tree = add_tree t k v in
return tree
(* Verify that the key is present before deleting *)
let remove_existing t k =
let open Lwt_result_syntax in
let*! result = mem t k in
match result with
| false -> Lwt.return @@ storage_error (Missing_key (k, Del))
| _ ->
let*! tree = remove t k in
return tree
(* Verify that the key is present before deleting *)
let remove_existing_tree t k =
let open Lwt_result_syntax in
let*! result = mem_tree t k in
match result with
| false -> Lwt.return @@ storage_error (Missing_key (k, Del))
| _ ->
let*! tree = remove t k in
return tree
let add_or_remove t k = function None -> remove t k | Some v -> add t k v
let add_or_remove_tree t k = function
| None -> remove t k
| Some v -> add_tree t k v
end
let verify_tree_proof proof f = Context.verify_tree_proof proof f
let verify_stream_proof proof f = Context.verify_stream_proof proof f
let equal_config = Context.equal_config
let project x = x
let absolute_key _ k = k
let description = Storage_description.create ()
let fold_map_temporary_lazy_storage_ids ctxt f =
f (temporary_lazy_storage_ids ctxt) |> fun (temporary_lazy_storage_ids, x) ->
(update_temporary_lazy_storage_ids ctxt temporary_lazy_storage_ids, x)
let map_temporary_lazy_storage_ids_s ctxt f =
let open Lwt_syntax in
let+ ctxt, temporary_lazy_storage_ids = f (temporary_lazy_storage_ids ctxt) in
update_temporary_lazy_storage_ids ctxt temporary_lazy_storage_ids
module Cache = struct
type key = Context.Cache.key
type value = Context.Cache.value = ..
let key_of_identifier = Context.Cache.key_of_identifier
let identifier_of_key = Context.Cache.identifier_of_key
let pp fmt ctxt = Context.Cache.pp fmt (context ctxt)
let find c k = Context.Cache.find (context c) k
let set_cache_layout c layout =
let open Lwt_syntax in
let+ ctxt = Context.Cache.set_cache_layout (context c) layout in
update_context c ctxt
let update c k v = Context.Cache.update (context c) k v |> update_context c
let sync c cache_nonce =
let open Lwt_syntax in
let+ ctxt = Context.Cache.sync (context c) ~cache_nonce in
update_context c ctxt
let clear c = Context.Cache.clear (context c) |> update_context c
let list_keys c ~cache_index =
Context.Cache.list_keys (context c) ~cache_index
let key_rank c key = Context.Cache.key_rank (context c) key
let cache_size_limit c ~cache_index =
Context.Cache.cache_size_limit (context c) ~cache_index
let cache_size c ~cache_index =
Context.Cache.cache_size (context c) ~cache_index
let future_cache_expectation c ~time_in_blocks =
Context.Cache.future_cache_expectation (context c) ~time_in_blocks
|> update_context c
end
let record_non_consensus_operation_hash ctxt operation_hash =
update_non_consensus_operations_rev
ctxt
(operation_hash :: non_consensus_operations_rev ctxt)
let non_consensus_operations ctxt = List.rev (non_consensus_operations_rev ctxt)
let record_dictator_proposal_seen ctxt = update_dictator_proposal_seen ctxt true
let dictator_proposal_seen ctxt = dictator_proposal_seen ctxt
let init_sampler_for_cycle ctxt cycle seed state =
let open Result_syntax in
let map = sampler_state ctxt in
if Cycle_repr.Map.mem cycle map then tzfail (Sampler_already_set cycle)
else
let map = Cycle_repr.Map.add cycle (seed, state) map in
let ctxt = update_sampler_state ctxt map in
return ctxt
let sampler_for_cycle ~read ctxt cycle =
let open Lwt_result_syntax in
let map = sampler_state ctxt in
match Cycle_repr.Map.find cycle map with
| Some (seed, state) -> return (ctxt, seed, state)
| None ->
let* seed, state = read ctxt in
let map = Cycle_repr.Map.add cycle (seed, state) map in
let ctxt = update_sampler_state ctxt map in
return (ctxt, seed, state)
let find_stake_distribution_for_current_cycle ctxt =
ctxt.back.stake_distribution_for_current_cycle
let stake_distribution_for_current_cycle ctxt =
let open Result_syntax in
match ctxt.back.stake_distribution_for_current_cycle with
| None -> tzfail Stake_distribution_not_set
| Some s -> return s
let init_stake_distribution_for_current_cycle ctxt
stake_distribution_for_current_cycle =
update_back
ctxt
{
ctxt.back with
stake_distribution_for_current_cycle =
Some stake_distribution_for_current_cycle;
}
module Internal_for_tests = struct
let add_level ctxt l =
let new_level = Level_repr.Internal_for_tests.add_level ctxt.back.level l in
let new_back = {ctxt.back with level = new_level} in
{ctxt with back = new_back}
let add_cycles ctxt l =
let blocks_per_cycle = Int32.to_int (constants ctxt).blocks_per_cycle in
let new_level =
Level_repr.Internal_for_tests.add_cycles
~blocks_per_cycle
ctxt.back.level
l
in
let new_back = {ctxt.back with level = new_level} in
{ctxt with back = new_back}
end
module type CONSENSUS = sig
type t
type 'value slot_map
type slot_set
type slot
type round
type consensus_pk
val allowed_attestations : t -> (consensus_pk * int) slot_map option
val allowed_preattestations : t -> (consensus_pk * int) slot_map option
val forbidden_delegates : t -> Signature.Public_key_hash.Set.t
type error += Slot_map_not_found of {loc : string}
val current_attestation_power : t -> int
val initialize_consensus_operation :
t ->
allowed_attestations:(consensus_pk * int) slot_map option ->
allowed_preattestations:(consensus_pk * int) slot_map option ->
t
val record_attestation : t -> initial_slot:slot -> power:int -> t tzresult
val record_preattestation :
t -> initial_slot:slot -> power:int -> round -> t tzresult
val forbid_delegate : t -> Signature.Public_key_hash.t -> t
val set_forbidden_delegates : t -> Signature.Public_key_hash.Set.t -> t
val attestations_seen : t -> slot_set
val get_preattestations_quorum_round : t -> round option
val set_preattestations_quorum_round : t -> round -> t
val locked_round_evidence : t -> (round * int) option
val set_attestation_branch : t -> Block_hash.t * Block_payload_hash.t -> t
val attestation_branch : t -> (Block_hash.t * Block_payload_hash.t) option
end
module Consensus :
CONSENSUS
with type t := t
and type slot := Slot_repr.t
and type 'a slot_map := 'a Slot_repr.Map.t
and type slot_set := Slot_repr.Set.t
and type round := Round_repr.t
and type consensus_pk := consensus_pk = struct
let[@inline] update_consensus_with ctxt f =
{ctxt with back = {ctxt.back with consensus = f ctxt.back.consensus}}
let[@inline] update_consensus_with_tzresult ctxt f =
let open Result_syntax in
let+ consensus = f ctxt.back.consensus in
{ctxt with back = {ctxt.back with consensus}}
let[@inline] allowed_attestations ctxt =
ctxt.back.consensus.allowed_attestations
let[@inline] allowed_preattestations ctxt =
ctxt.back.consensus.allowed_preattestations
let[@inline] forbidden_delegates ctxt =
ctxt.back.consensus.forbidden_delegates
let[@inline] set_forbidden_delegates ctxt delegates =
update_consensus_with ctxt (Raw_consensus.set_forbidden_delegates delegates)
let[@inline] current_attestation_power ctxt =
ctxt.back.consensus.current_attestation_power
let[@inline] get_preattestations_quorum_round ctxt =
ctxt.back.consensus.preattestations_quorum_round
let[@inline] locked_round_evidence ctxt =
Raw_consensus.locked_round_evidence ctxt.back.consensus
let[@inline] initialize_consensus_operation ctxt ~allowed_attestations
~allowed_preattestations =
update_consensus_with
ctxt
(Raw_consensus.initialize_with_attestations_and_preattestations
~allowed_attestations
~allowed_preattestations)
let[@inline] record_preattestation ctxt ~initial_slot ~power round =
update_consensus_with_tzresult
ctxt
(Raw_consensus.record_preattestation ~initial_slot ~power round)
let[@inline] record_attestation ctxt ~initial_slot ~power =
update_consensus_with_tzresult
ctxt
(Raw_consensus.record_attestation ~initial_slot ~power)
let[@inline] forbid_delegate ctxt delegate =
update_consensus_with ctxt (Raw_consensus.forbid_delegate delegate)
let[@inline] attestations_seen ctxt = ctxt.back.consensus.attestations_seen
let[@inline] set_preattestations_quorum_round ctxt round =
update_consensus_with
ctxt
(Raw_consensus.set_preattestations_quorum_round round)
let[@inline] attestation_branch ctxt =
Raw_consensus.attestation_branch ctxt.back.consensus
let[@inline] set_attestation_branch ctxt branch =
update_consensus_with ctxt (fun ctxt ->
Raw_consensus.set_attestation_branch ctxt branch)
type error += Slot_map_not_found of {loc : string}
let () =
register_error_kind
`Permanent
~id:"raw_context.consensus.slot_map_not_found"
~title:"Slot map not found"
~description:"Pre-computed map by first slot not found."
Data_encoding.(obj1 (req "loc" (string Plain)))
(function Slot_map_not_found {loc} -> Some loc | _ -> None)
(fun loc -> Slot_map_not_found {loc})
end
(*
To optimize message insertion in smart contract rollup inboxes, we
maintain the sequence of current messages of each rollup used in
the block in a in-memory map.
*)
module Sc_rollup_in_memory_inbox = struct
let current_messages ctxt = ctxt.back.sc_rollup_current_messages
let set_current_messages ctxt witness =
{ctxt with back = {ctxt.back with sc_rollup_current_messages = witness}}
end
module Dal = struct
type cryptobox = Dal.t
let make ctxt =
let open Result_syntax in
(* Dal.make takes some time (on the order of 10ms) so we memoize
its result to avoid calling it more than once per block. *)
match ctxt.back.dal_cryptobox with
| Some cryptobox -> return (ctxt, cryptobox)
| None -> (
let Constants_parametric_repr.{dal = {cryptobox_parameters; _}; _} =
ctxt.back.constants
in
match Dal.make cryptobox_parameters with
| Ok cryptobox ->
let back = {ctxt.back with dal_cryptobox = Some cryptobox} in
return ({ctxt with back}, cryptobox)
| Error (`Fail explanation) ->
tzfail (Dal_errors_repr.Dal_cryptobox_error {explanation}))
let number_of_slots ctxt = ctxt.back.constants.dal.number_of_slots
let record_attested_shards ctxt attestation shards =
let dal_attestation_slot_accountability =
Dal_attestation_repr.Accountability.record_attested_shards
ctxt.back.dal_attestation_slot_accountability
attestation
shards
in
{ctxt with back = {ctxt.back with dal_attestation_slot_accountability}}
let register_slot_header ctxt slot_header =
let open Result_syntax in
match
Dal_slot_repr.Slot_market.register
ctxt.back.dal_slot_fee_market
slot_header
with
| None ->
let length =
Dal_slot_repr.Slot_market.length ctxt.back.dal_slot_fee_market
in
tzfail
(Dal_errors_repr.Dal_register_invalid_slot_header
{length; slot_header})
| Some (dal_slot_fee_market, updated) ->
if not updated then
tzfail
(Dal_errors_repr.Dal_publish_commitment_duplicate {slot_header})
else return {ctxt with back = {ctxt.back with dal_slot_fee_market}}
let candidates ctxt =
Dal_slot_repr.Slot_market.candidates ctxt.back.dal_slot_fee_market
let is_slot_index_attested ctxt =
let threshold =
ctxt.back.constants.Constants_parametric_repr.dal.attestation_threshold
in
let number_of_shards =
ctxt.back.constants.Constants_parametric_repr.dal.cryptobox_parameters
.number_of_shards
in
Dal_attestation_repr.Accountability.is_slot_attested
ctxt.back.dal_attestation_slot_accountability
~threshold
~number_of_shards
type committee = dal_committee = {
pkh_to_shards :
(Dal_attestation_repr.shard_index * int) Signature.Public_key_hash.Map.t;
shard_to_pkh : Signature.Public_key_hash.t Dal_attestation_repr.Shard_map.t;
}
(* DAL/FIXME https://gitlab.com/tezos/tezos/-/issues/3110
A committee is selected by the callback function
[pkh_from_tenderbake_slot]. We use a callback because of circular
dependencies. It is not clear whether it will be the final choice
for the DAL committee. The current solution is a bit hackish but
should work. If we decide to differ from the Tenderbake
committee, one could just draw a new committee.
The problem with drawing a new committee is that it is not
guaranteed that everyone in the DAL committee will be in the
Tenderbake committee. Consequently, either we decide to have a
new consensus operation which does not count for Tenderbake,
and/or we take into account for the model of DAL that at every
level, a percentage of DAL attestations cannot be received. *)
let compute_committee ctxt pkh_from_tenderbake_slot =
let open Lwt_result_syntax in
let Constants_parametric_repr.
{
dal = {cryptobox_parameters = {number_of_shards; _}; _};
consensus_committee_size;
_;
} =
ctxt.back.constants
in
(* We first draw a committee by drawing slots from the Tenderbake
committee. To have a compact representation of slots, we can
sort the Tenderbake slots by [pkh], so that a committee is
actually only an interval. This is done by recomputing a
committee from the first one. *)
let update_committee committee pkh ~slot_index ~power =
{
pkh_to_shards =
Signature.Public_key_hash.Map.update
pkh
(function
| None -> Some (slot_index, power)
| Some (initial_shard_index, old_power) ->
Some (initial_shard_index, old_power + power))
committee.pkh_to_shards;
shard_to_pkh =
List.fold_left
(fun shard_to_pkh slot ->
Dal_attestation_repr.Shard_map.add slot pkh shard_to_pkh)
committee.shard_to_pkh
Misc.(slot_index --> (slot_index + (power - 1)));
}
in
let rec compute_power index committee =
if Compare.Int.(index < 0) then return committee
else
let shard_index = index mod consensus_committee_size in
let*? slot = Slot_repr.of_int shard_index in
let* _ctxt, pkh = pkh_from_tenderbake_slot slot in
(* The [Slot_repr] module is related to the Tenderbake committee. *)
let slot_index = Slot_repr.to_int slot in
(* An optimisation could be to return only [pkh_to_shards] map
because the second one is not used. This can be done later
on, if it is a good optimisation. *)
let committee = update_committee committee pkh ~slot_index ~power:1 in
compute_power (index - 1) committee
in
(* This committee is an intermediate to compute the final DAL
committee. This one only projects the Tenderbake committee into
the DAL committee. The next one reorders the slots so that they
are grouped by public key hash. *)
let* unordered_committee =
compute_power (number_of_shards - 1) empty_dal_committee
in
let dal_committee =
Signature.Public_key_hash.Map.fold
(fun pkh (_, power) (total_power, committee) ->
let committee =
update_committee committee pkh ~slot_index:total_power ~power
in
let new_total_power = total_power + power in
(new_total_power, committee))
unordered_committee.pkh_to_shards
(0, empty_dal_committee)
|> snd
in
return dal_committee
let init_committee ctxt committee =
{ctxt with back = {ctxt.back with dal_committee = committee}}
let shards_of_attester ctxt ~attester:pkh =
let rec make acc (initial_shard_index, power) =
if Compare.Int.(power <= 0) then List.rev acc
else make (initial_shard_index :: acc) (initial_shard_index + 1, power - 1)
in
Signature.Public_key_hash.Map.find_opt
pkh
ctxt.back.dal_committee.pkh_to_shards
|> Option.map (fun pre_shards -> make [] pre_shards)
end
(* The type for relative context accesses instead from the root. In order for
the carbonated storage functions to consume the gas, this has gas infomation
*)
type local_context = {
tree : tree;
path : key;
remaining_operation_gas : Gas_limit_repr.Arith.fp;
unlimited_operation_gas : bool;
}
let with_local_context ctxt key f =
let open Lwt_result_syntax in
let*! tree_opt = find_tree ctxt key in
let tree =
match tree_opt with None -> Tree.empty ctxt | Some tree -> tree
in
let local_ctxt =
{
tree;
path = key;
remaining_operation_gas = remaining_operation_gas ctxt;
unlimited_operation_gas = unlimited_operation_gas ctxt;
}
in
let* local_ctxt, res = f local_ctxt in
let*! ctxt = add_tree ctxt key local_ctxt.tree in
update_remaining_operation_gas ctxt local_ctxt.remaining_operation_gas
|> fun ctxt ->
update_unlimited_operation_gas ctxt local_ctxt.unlimited_operation_gas
|> fun ctxt -> return (ctxt, res)
module Local_context : sig
include
Raw_context_intf.VIEW
with type t = local_context
and type key := key
and type value := value
and type tree := tree
val consume_gas :
local_context -> Gas_limit_repr.cost -> local_context tzresult
val absolute_key : local_context -> key -> key
end = struct
type t = local_context
let consume_gas local cost =
let open Result_syntax in
match Gas_limit_repr.raw_consume local.remaining_operation_gas cost with
| Some gas_counter -> Ok {local with remaining_operation_gas = gas_counter}
| None ->
if local.unlimited_operation_gas then return local
else tzfail Operation_quota_exceeded
let tree local = local.tree
let update_root_tree local tree = {local with tree}
let absolute_key local key = local.path @ key
let find local = Tree.find (tree local)
let find_tree local = Tree.find_tree (tree local)
let mem local = Tree.mem (tree local)
let mem_tree local = Tree.mem_tree (tree local)
let get local = Tree.get (tree local)
let get_tree local = Tree.get_tree (tree local)
let update local key b =
let open Lwt_result_syntax in
let+ tree = Tree.update (tree local) key b in
update_root_tree local tree
let update_tree local key b =
let open Lwt_result_syntax in
let+ tree = Tree.update_tree (tree local) key b in
update_root_tree local tree
let init local key b =
let open Lwt_result_syntax in
let+ tree = Tree.init (tree local) key b in
update_root_tree local tree
let init_tree local key t =
let open Lwt_result_syntax in
let+ tree = Tree.init_tree (tree local) key t in
update_root_tree local tree
let add local i b =
let open Lwt_syntax in
let+ tree = Tree.add (tree local) i b in
update_root_tree local tree
let add_tree local i t =
let open Lwt_syntax in
let+ tree = Tree.add_tree (tree local) i t in
update_root_tree local tree
let remove local i =
let open Lwt_syntax in
let+ tree = Tree.remove (tree local) i in
update_root_tree local tree
let remove_existing local key =
let open Lwt_result_syntax in
let+ tree = Tree.remove_existing (tree local) key in
update_root_tree local tree
let remove_existing_tree local key =
let open Lwt_result_syntax in
let+ tree = Tree.remove_existing_tree (tree local) key in
update_root_tree local tree
let add_or_remove local key vopt =
let open Lwt_syntax in
let+ tree = Tree.add_or_remove (tree local) key vopt in
update_root_tree local tree
let add_or_remove_tree local key topt =
let open Lwt_syntax in
let+ tree = Tree.add_or_remove_tree (tree local) key topt in
update_root_tree local tree
let fold ?depth local key ~order ~init ~f =
Tree.fold ?depth (tree local) key ~order ~init ~f
let list local ?offset ?length key =
Tree.list (tree local) ?offset ?length key
let config local = Tree.config (tree local)
let length local i = Tree.length (tree local) i
end