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
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

val stake : 
  Raw_context.t ->
  for_next_cycle_use_only_after_slashing:bool ->
  amount:[ `At_most of Tez_repr.t | `Exactly of Tez_repr.t ] ->
  sender:Tezos_protocol_environment_alpha.Signature.Public_key_hash.t ->
  delegate:Tezos_protocol_environment_alpha.Signature.public_key_hash ->
  (Raw_context.t * Receipt_repr.balance_updates)
    Tezos_protocol_environment_alpha.Error_monad.tzresult
    Tezos_protocol_environment_alpha.Lwt.t

stake ctxt ~sender ~for_next_cycle_use_only_after_slashing ~delegate amount add amount as sender's stake to delegate.

If for_next_cycle_use_only_after_slashing is true, the implicit finalisation is done for the next cycle. It is meant to be used only at cycle end after the application of the slashing.

val request_unstake : 
  Raw_context.t ->
  for_next_cycle_use_only_after_slashing:bool ->
  sender_contract:Contract_repr.t ->
  delegate:Tezos_protocol_environment_alpha.Signature.public_key_hash ->
  Tez_repr.t ->
  (Raw_context.t * Receipt_repr.balance_updates)
    Tezos_protocol_environment_alpha.Error_monad.tzresult
    Tezos_protocol_environment_alpha.Lwt.t

request_unstake ctxt ~for_next_cycle_use_only_after_slashing ~sender_contract ~delegate amount records a request from sender_contract to unstake amount from delegate.

If for_next_cycle_use_only_after_slashing is true, the unstake request and the implicit finalisation is done for the next cycle. It is meant to be used only at cycle end after the application of the slashing.

val finalize_unstake : 
  Raw_context.t ->
  for_next_cycle_use_only_after_slashing:bool ->
  Contract_repr.t ->
  (Raw_context.t * Receipt_repr.balance_updates)
    Tezos_protocol_environment_alpha.Error_monad.tzresult
    Tezos_protocol_environment_alpha.Lwt.t

finalize_unstake ctxt ~for_next_cycle_use_only_after_slashing contract performs the finalization of all unstake requests from contract that can be finalized. An unstake request can be finalized if it is old enough, specifically the requested amount must not be at stake anymore and must not be slashable anymore, i.e. after preserved_cycles + max_slashing_period after the request. Amounts are transferred from the contract's delegate (at request time) unstaked frozen deposits to contract's spendable balance, minus slashing the requested stake undergone in between.

If for_next_cycle_use_only_after_slashing is true, the finalization is done for the next cycle. It is meant to be used only at cycle end after the application of the slashing.

type staking_automation =

| Auto_staking
| Manual_staking

Staking can be either automated or manual. If Adaptive Issuance is enabled, staking must be manual.

val staking_automation : Raw_context.t -> staking_automation

val check_manual_staking_allowed : 
  Raw_context.t ->
  unit Tezos_protocol_environment_alpha.Error_monad.tzresult