package tezos-protocol-020-PsParisC

You can search for identifiers within the package.

in-package search v0.2.0

tezos-protocol-020-PsParisC.embedded-protocol
- Tezos_embedded_protocol_020_PsParisC
  - Registerer
    
    Registered
    
    Mempool
    
    Source
tezos-protocol-020-PsParisC.parameters
- Tezos_protocol_020_PsParisC_parameters
  - Default_parameters
    
    Internal_for_tests
tezos-protocol-020-PsParisC.protocol
- Tezos_protocol_020_PsParisC
  - Protocol
tezos-protocol-020-PsParisC.protocol.environment
- Tezos_protocol_environment_020_PsParisC
  - Array
    
    Floatarray
  - Base58
  - Bits
  - Blake2B
    
    Make
    
    Map
    
    Name
    
    Register
    
    Set
    
    Make_minimal
    
    Name
    
    Name
    
    PrefixedName
    
    Register
  - Block_hash
    
    Map
    
    Set
  - Block_header
  - Bls
    
    Primitive
    
    Fr
    
    G1
    
    Scalar
    
    G2
    
    Scalar
    
    Public_key
    
    Public_key_hash
    
    Map
    
    Set
  - Bounded
    
    BOUNDS
    
    Int16
    
    B
    
    Int31
    
    B
    
    Int32
    
    B
    
    Int64
    
    B
    
    Int8
    
    B
    
    Non_negative_int32
    
    S
    
    Uint16
    
    B
    
    Uint8
    
    B
  - Bytes
  - CamlinternalFormatBasics
  - Chain_id
    
    Map
    
    Set
  - Char
  - Compare
    
    Bool
    
    Bytes
    
    COMPARABLE
    
    Char
    
    Int
    
    Int32
    
    Int64
    
    List
    
    P
    
    List_length_with
    
    List_lengths
    
    Make
    
    P
    
    Option
    
    P
    
    Q
    
    Result
    
    Error
    
    Ok
    
    S
    
    String
    
    Uint32
    
    Uint64
    
    Z
  - Context
    
    CACHE
    
    Cache
    
    Kind
    
    PROOF_ENCODING
    
    Proof
    
    Internal_for_tests
    
    Stream
    
    Proof_encoding
    
    V1
    
    Tree2
    
    Tree32
    
    V2
    
    Tree2
    
    Tree32
    
    TREE
    
    Tree
    
    VIEW
  - Context_binary
    
    Tree
  - Context_hash
    
    Map
    
    Set
    
    Version
  - Dal
    
    Commitment
    
    Commitment_proof
  - Data_encoding
    
    Binary
    
    Bounded
    
    Compact
    
    Custom
    
    S
    
    Fixed
    
    Json
    
    Variable
    
    With_JSON_discriminant
    
    With_field_name_duplicate_checks
  - Ed25519
    
    Public_key
    
    Public_key_hash
    
    Map
    
    Set
  - Either
  - Equality_witness
  - Error_monad
    
    Lwt_option_syntax
    
    Lwt_result_syntax
    
    Lwt_syntax
    
    Option_syntax
    
    Result_syntax
  - FallbackArray
  - Fitness
  - Format
  - Hex
  - Int32
  - Int64
  - Lift
    
    Mempool
    
    P
    
    Mempool
  - List
  - Logging
  - Lwt
  - Map
    
    Make
    
    Ord
    
    S
  - Micheline
  - Name
  - Operation
  - Operation_hash
    
    Map
    
    Set
  - Operation_list_hash
    
    Map
    
    Set
  - Operation_list_list_hash
    
    Map
    
    Set
  - Option
  - P256
    
    Public_key
    
    Public_key_hash
    
    Map
    
    Set
  - Pervasives
  - Plonk
  - Protocol_hash
    
    Map
    
    Set
  - Q
  - RPC_answer
  - RPC_arg
  - RPC_context
    
    simple
  - RPC_directory
  - RPC_path
  - RPC_query
  - RPC_service
  - Raw_hashes
  - Result
  - S
    
    AGGREGATE_SIGNATURE
    
    Public_key
    
    Public_key_hash
    
    Map
    
    Set
    
    B58_DATA
    
    CURVE
    
    Scalar
    
    ENCODER
    
    FIELD
    
    HASH
    
    Map
    
    Set
    
    HASHABLE
    
    INDEXES
    
    Map
    
    Set
    
    INDEXES_MAP
    
    INDEXES_SET
    
    MERKLE_TREE
    
    Map
    
    Set
    
    MINIMAL_HASH
    
    PRIME_FIELD
    
    RAW_DATA
    
    SIGNATURE
    
    Public_key
    
    Public_key_hash
    
    Map
    
    Set
    
    SIGNATURE_PUBLIC_KEY
    
    SIGNATURE_PUBLIC_KEY_HASH
    
    Map
    
    Set
    
    SPLIT_SIGNATURE
    
    Public_key
    
    Public_key_hash
    
    Map
    
    Set
    
    T
  - Sapling
    
    CV
    
    Ciphertext
    
    Commitment
    
    Hash
    
    Nullifier
    
    UTXO
    
    Legacy
    
    Verification
  - Secp256k1
    
    Public_key
    
    Public_key_hash
    
    Map
    
    Set
  - Seq
  - Set
    
    Make
    
    Ord
    
    S
  - Signature
    
    Public_key
    
    Public_key_hash
    
    Map
    
    Set
  - Skip_list
    
    MONAD
    
    Make
    
    Arg
    
    Lwt
    
    MONADIC
    
    Make_monadic
    
    M
    
    S
    
    Lwt
    
    MONADIC
    
    Make_monadic
    
    M
  - Smart_rollup
    
    Address
    
    Map
    
    Set
    
    Commitment_hash
    
    Map
    
    Set
    
    Inbox_hash
    
    Map
    
    Set
    
    Merkelized_payload_hashes_hash
    
    Map
    
    Set
    
    State_hash
    
    Map
    
    Set
  - String
  - Time
  - Timelock
  - TzEndian
  - Updater
    
    PROTOCOL
    
    Mempool
  - Vdf
  - Wasm_2_0_0
    
    Make
    
    Tree
  - Z
  - proto_rpc_context
  - proto_rpc_context_of_directory
tezos-protocol-020-PsParisC.protocol.lifted
- Tezos_protocol_020_PsParisC_lifted
  - Lifted_protocol
    
    Mempool
tezos-protocol-020-PsParisC.protocol.raw
- Tezos_raw_protocol_020_PsParisC

Legend:
Library
Module
Module type
Parameter
Class
Class type

val originate : 
  ?whitelist:Sc_rollup_whitelist_repr.t ->
  Raw_context.t ->
  kind:Sc_rollups.Kind.t ->
  parameters_ty:Script_repr.lazy_expr ->
  genesis_commitment:Sc_rollup_commitment_repr.t ->
  (Sc_rollup_repr.Address.t
   * Tezos_protocol_environment_020_PsParisC.Z.t
   * Sc_rollup_commitment_repr.Hash.t
   * Raw_context.t)
    Tezos_protocol_environment_020_PsParisC.Error_monad.tzresult
    Tezos_protocol_environment_020_PsParisC.Lwt.t

originate ?whitelist context ~kind ~parameters_ty ~genesis_commitment produces an address a for a smart contract rollup using the origination nonce found in context. This function also initializes the storage with a new entry indexed by a to remember the kind of the rollup at address a.

Also returns the number of allocated bytes.

val raw_originate : 
  ?whitelist:Sc_rollup_whitelist_repr.t ->
  Raw_context.t ->
  kind:Sc_rollups.Kind.t ->
  parameters_ty:Script_repr.lazy_expr ->
  genesis_commitment:Sc_rollup_commitment_repr.t ->
  address:Sc_rollup_repr.Address.t ->
  (Tezos_protocol_environment_020_PsParisC.Z.t
   * Sc_rollup_commitment_repr.Hash.t
   * Raw_context.t)
    Tezos_protocol_environment_020_PsParisC.Error_monad.tzresult
    Tezos_protocol_environment_020_PsParisC.Lwt.t

raw_originate ?whitelist context ~kind ~parameters_ty ~genesis_commitment ~address is exactly originate but provides the rollup's address (address) instead of randomly generating it.

This should not be used by apply.ml, this is needed for bootstrap smart rollups only.

val kind : 
  Raw_context.t ->
  Sc_rollup_repr.t ->
  (Raw_context.t * Sc_rollups.Kind.t)
    Tezos_protocol_environment_020_PsParisC.Error_monad.tzresult
    Tezos_protocol_environment_020_PsParisC.Lwt.t

kind context address returns the kind of the given rollup address iff address is an existing rollup. Fails with an Sc_rollup_does_not_exist error in case the rollup does not exist.

val list_unaccounted : 
  Raw_context.t ->
  Sc_rollup_repr.t list
    Tezos_protocol_environment_020_PsParisC.Error_monad.tzresult
    Tezos_protocol_environment_020_PsParisC.Lwt.t

val genesis_info : 
  Raw_context.t ->
  Sc_rollup_repr.t ->
  (Raw_context.t * Sc_rollup_commitment_repr.genesis_info)
    Tezos_protocol_environment_020_PsParisC.Error_monad.tzresult
    Tezos_protocol_environment_020_PsParisC.Lwt.t

genesis_info ctxt sc_rollup returns the level at which a sc_rollup was originated, and its genesis commitment hash.

val get_metadata : 
  Raw_context.t ->
  Sc_rollup_repr.t ->
  (Raw_context.t * Sc_rollup_metadata_repr.t)
    Tezos_protocol_environment_020_PsParisC.Error_monad.tzresult
    Tezos_protocol_environment_020_PsParisC.Lwt.t

get_metadata ctxt rollup retrieves the origination level of the rollup using Sc_rollup_commitment_repr.genesis_info and creates a Sc_rollup_metadata_repr.t. Fails with Sc_rollup_does_not_exist {rollup} if the genesis info is missing.

val parameters_type : 
  Raw_context.t ->
  Sc_rollup_repr.t ->
  (Script_repr.lazy_expr option * Raw_context.t)
    Tezos_protocol_environment_020_PsParisC.Error_monad.tzresult
    Tezos_protocol_environment_020_PsParisC.Lwt.t

parameters_type ctxt rollup returns the registered type of a rollup. Returns None in case there is no registered type for the rollup.

val must_exist : 
  Raw_context.t ->
  Sc_rollup_repr.t ->
  Raw_context.t Tezos_protocol_environment_020_PsParisC.Error_monad.tzresult
    Tezos_protocol_environment_020_PsParisC.Lwt.t

must_exist ctxt rollup checks whether the given rollup exists in ctxt. If rollup exists, a new context is returned with gas consumed for the lookup cost. If it does not exist, an error is returned.

val set_previous_commitment_period : 
  Raw_context.t ->
  int ->
  Raw_context.t Tezos_protocol_environment_020_PsParisC.Lwt.t

set_previous_commitment_period ctxt previous_period is expected to be called during the protocol stitching, to ensure the previous commitment period length remains available in the next protocol, in order to deal with the commitments posted during the previous protocol but not yet cemented.

val previous_protocol_constants : 
  Raw_context.t ->
  (Raw_level_repr.t * int)
    Tezos_protocol_environment_020_PsParisC.Error_monad.tzresult
    Tezos_protocol_environment_020_PsParisC.Lwt.t

previous_protocol_constants ctxt fetches from ctxt the first level of the current protocol and the previous commitment period.

Both values are bounded in size and small, so we don’t carbonate the call.

Warning: b This function requires that the previous commitment period has been correctly set with set_previous_commitment_period during the latest stitching.