package tezos-protocol-alpha

You can search for identifiers within the package.

in-package search v0.2.0

tezos-protocol-alpha.embedded-protocol
- Tezos_embedded_protocol_alpha
  - Registerer
    
    Registered
    
    Mempool
    
    Source
tezos-protocol-alpha.parameters
- Tezos_protocol_alpha_parameters
  - Default_parameters
    
    Internal_for_tests
tezos-protocol-alpha.protocol
- Tezos_protocol_alpha
  - Protocol
tezos-protocol-alpha.protocol.environment
- Tezos_protocol_environment_alpha
  - 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-alpha.protocol.lifted
- Tezos_protocol_alpha_lifted
  - Lifted_protocol
    
    Mempool
tezos-protocol-alpha.protocol.raw
- Tezos_raw_protocol_alpha

Legend:
Library
Module
Module type
Parameter
Class
Class type

Functions for RPC service registration, using Updater.rpc_context and RPC_service.t from the Protocol Environment.

This module is a frontend to a mutable service directory. The various register functions update the directory as a side-effect.

The get_rpc_services function returns the resulting RPC_context. It is parameterized by Updater.rpc_context which acts as the service prefix (in practice meaning this type will be passed to each handler). Hence, Protocol RPC services provide a read-only view of the Ledger state.

type rpc_context = {

block_hash : Tezos_protocol_environment_alpha.Block_hash.t;
block_header : Alpha_context.Block_header.shell_header;
context : Alpha_context.t;

}

val rpc_init : 
  Tezos_protocol_environment_alpha.Updater.rpc_context ->
  [ `Head_level | `Successor_level ] ->
  rpc_context Tezos_protocol_environment_alpha.Error_monad.tzresult
    Tezos_protocol_environment_alpha.Lwt.t

rpc_init rpc_context mode allows to instantiate an rpc_context using the Alpha_context representation from a raw context representation (the one the shell knows).

If mode = `Head_level, the Alpha_context uses the same level as the head of the chain (given by rpc_context.block_header).

If mode= `Successor_level, the Alpha_context uses the successor level of the head.

This function aims to be used by RPCs, in particular by RPCs which simulate an operation to determine the fees/gas of an operation. Using the `Head_level can be dangerous if some storage paths depend on the level. Using the successor level allows to ensure that the simulation is done on a fresh level.

val register0 : 
  chunked:bool ->
  ([< Tezos_protocol_environment_alpha.RPC_service.meth ],
    Tezos_protocol_environment_alpha.Updater.rpc_context,
    Tezos_protocol_environment_alpha.Updater.rpc_context,
    'a,
    'b,
    'c)
    Tezos_protocol_environment_alpha.RPC_service.t ->
  (Alpha_context.t ->
    'a ->
    'b ->
    'c Tezos_protocol_environment_alpha.Error_monad.tzresult
      Tezos_protocol_environment_alpha.Lwt.t) ->
  unit

val register0_noctxt : 
  chunked:bool ->
  ([< Tezos_protocol_environment_alpha.RPC_service.meth ],
    Tezos_protocol_environment_alpha.Updater.rpc_context,
    'a,
    'b,
    'c,
    'd)
    Tezos_protocol_environment_alpha.RPC_service.t ->
  ('b ->
    'c ->
    'd Tezos_protocol_environment_alpha.Error_monad.tzresult
      Tezos_protocol_environment_alpha.Lwt.t) ->
  unit

val register1 : 
  chunked:bool ->
  ([< Tezos_protocol_environment_alpha.RPC_service.meth ],
    Tezos_protocol_environment_alpha.Updater.rpc_context,
    Tezos_protocol_environment_alpha.Updater.rpc_context * 'a,
    'b,
    'c,
    'd)
    Tezos_protocol_environment_alpha.RPC_service.t ->
  (Alpha_context.t ->
    'a ->
    'b ->
    'c ->
    'd Tezos_protocol_environment_alpha.Error_monad.tzresult
      Tezos_protocol_environment_alpha.Lwt.t) ->
  unit

val register2 : 
  chunked:bool ->
  ([< Tezos_protocol_environment_alpha.RPC_service.meth ],
    Tezos_protocol_environment_alpha.Updater.rpc_context,
    (Tezos_protocol_environment_alpha.Updater.rpc_context * 'a) * 'b,
    'c,
    'd,
    'e)
    Tezos_protocol_environment_alpha.RPC_service.t ->
  (Alpha_context.t ->
    'a ->
    'b ->
    'c ->
    'd ->
    'e Tezos_protocol_environment_alpha.Error_monad.tzresult
      Tezos_protocol_environment_alpha.Lwt.t) ->
  unit

val opt_register0 : 
  chunked:bool ->
  ([< Tezos_protocol_environment_alpha.RPC_service.meth ],
    Tezos_protocol_environment_alpha.Updater.rpc_context,
    Tezos_protocol_environment_alpha.Updater.rpc_context,
    'a,
    'b,
    'c)
    Tezos_protocol_environment_alpha.RPC_service.t ->
  (Alpha_context.t ->
    'a ->
    'b ->
    'c option Tezos_protocol_environment_alpha.Error_monad.tzresult
      Tezos_protocol_environment_alpha.Lwt.t) ->
  unit

val opt_register1 : 
  chunked:bool ->
  ([< Tezos_protocol_environment_alpha.RPC_service.meth ],
    Tezos_protocol_environment_alpha.Updater.rpc_context,
    Tezos_protocol_environment_alpha.Updater.rpc_context * 'a,
    'b,
    'c,
    'd)
    Tezos_protocol_environment_alpha.RPC_service.t ->
  (Alpha_context.t ->
    'a ->
    'b ->
    'c ->
    'd option Tezos_protocol_environment_alpha.Error_monad.tzresult
      Tezos_protocol_environment_alpha.Lwt.t) ->
  unit

val opt_register2 : 
  chunked:bool ->
  ([< Tezos_protocol_environment_alpha.RPC_service.meth ],
    Tezos_protocol_environment_alpha.Updater.rpc_context,
    (Tezos_protocol_environment_alpha.Updater.rpc_context * 'a) * 'b,
    'c,
    'd,
    'e)
    Tezos_protocol_environment_alpha.RPC_service.t ->
  (Alpha_context.t ->
    'a ->
    'b ->
    'c ->
    'd ->
    'e option Tezos_protocol_environment_alpha.Error_monad.tzresult
      Tezos_protocol_environment_alpha.Lwt.t) ->
  unit

val get_rpc_services : 
  unit ->
  Tezos_protocol_environment_alpha.Updater.rpc_context
    Tezos_protocol_environment_alpha.RPC_directory.directory