package octez-protocol-017-PtNairob-libs

You can search for identifiers within the package.

in-package search v0.2.0

octez-protocol-017-PtNairob-libs.baking
- Tezos_baking_017_PtNairob
octez-protocol-017-PtNairob-libs.baking-commands
- Tezos_baking_017_PtNairob_commands
  - Baking_commands
octez-protocol-017-PtNairob-libs.baking-commands.registration
- Tezos_baking_017_PtNairob_commands_registration
  - Baking_commands_registration
octez-protocol-017-PtNairob-libs.baking.tenderbrute
- Tenderbrute_017_PtNairob
  - Tenderbrute
octez-protocol-017-PtNairob-libs.bakings.mockup-simulator
- Tezos_017_PtNairob_mockup_simulator
octez-protocol-017-PtNairob-libs.client
- Tezos_client_017_PtNairob
octez-protocol-017-PtNairob-libs.client.commands
- Tezos_client_017_PtNairob_commands
octez-protocol-017-PtNairob-libs.client.commands-registration
- Tezos_client_017_PtNairob_commands_registration
  - Alpha_commands_registration
octez-protocol-017-PtNairob-libs.client.sapling
- Tezos_client_sapling_017_PtNairob
octez-protocol-017-PtNairob-libs.dac
- Tezos_dac_017_PtNairob
  - Dac_plugin_registration
    
    Make
    
    Mapper
    
    Proto
    
    Mempool
octez-protocol-017-PtNairob-libs.dal
- Tezos_dal_017_PtNairob
  - Dal_plugin_registration
    
    Plugin
  - Dal_slot_frame_encoding
    
    Rollups_map
    
    Slot_version
    
    V0
    
    Internal
octez-protocol-017-PtNairob-libs.layer2-utils
- Tezos_layer2_utils_017_PtNairob
  - Layer1_services
octez-protocol-017-PtNairob-libs.plugin
- Tezos_protocol_plugin_017_PtNairob
  - Mempool
    
    Conflict_map
    
    Internal_for_tests
  - Metrics_plugin
  - Plugin
  - Plugin_errors
  - RPC
    
    Attestation_rights
    
    S
    
    Baking_rights
    
    S
    
    Big_map
    
    S
    
    Contract
    
    S
    
    Dal
    
    S
    
    Forge
    
    Manager
    
    S
    
    Tx_rollup
    
    Commitment
    
    Inbox
    
    Withdraw
    
    Parse
    
    S
    
    Registration
    
    S
    
    Sc_rollup
    
    S
    
    Scripts
    
    Normalize_stack
    
    S
    
    Traced_interpreter
    
    Unparsing_mode
    
    UNPARSING_MODE
    
    Unparse_types
    
    Tx_rollup
    
    S
    
    Validators
    
    S
  - Script_interpreter_logging
    
    Logger_base
  - View_helpers
octez-protocol-017-PtNairob-libs.plugin-registerer
- Tezos_protocol_plugin_017_PtNairob_registerer
  - Plugin_registerer
    
    Metrics
    
    RPC
    
    Validation
octez-protocol-017-PtNairob-libs.smart-rollup
- Tezos_smart_rollup_017_PtNairob
  - Context_helpers
    
    In_memory
    
    Tree
    
    P
    
    Tree
  - Game_helpers
    
    Wasm
  - Proof_helpers
  - Pvm_in_memory
    
    Arith
    
    Internal_for_tests
    
    S
    
    Internal_for_tests
    
    Wasm
    
    Internal_for_tests
octez-protocol-017-PtNairob-libs.smart-rollup-layer2
- Tezos_smart_rollup_layer2_017_PtNairob
  - Sc_rollup_proto_types
    
    Address
    
    Commitment
    
    Commitment_hash
    
    Dal
    
    Page_index
    
    Slot_header
    
    Slot_history
    
    Slot_history_cache
    
    Slot_index
    
    Game
    
    Inbox
    
    Inbox_hash
    
    Kind
    
    Merkelized_payload_hashes_hash
    
    State_hash
  - Sc_rollup_services
    
    Block
    
    Helpers
    
    Encodings
    
    Query
octez-protocol-017-PtNairob-libs.test-helpers
- Tezos_017_PtNairob_test_helpers
  - Account
  - Assert
    
    Int32
    
    Int64
  - Big_map_helpers
  - Block
    
    Forge
  - Consensus_helpers
  - Context
    
    Contract
    
    Delegate
    
    Sc_rollup
    
    Vote
  - Contract_helpers
  - Cpmm_logic
    
    Simulate
    
    Simulate_raw
  - Cpmm_repr
    
    Parameter
    
    Storage
  - Dal_helpers
    
    Make
    
    P
  - Dummy_zk_rollup
    
    Bound
    
    Bounded
    
    Encoding
    
    L
    
    Anemoi
    
    Bool
    
    Internal
    
    Bytes
    
    Ecc
    
    Encodings
    
    Enum
    
    N
    
    Input
    
    Limb
    
    N
    
    Limbs
    
    N
    
    Mod_arith
    
    Num
    
    Poseidon
    
    VL
    
    P
    
    V
    
    L
    
    Anemoi
    
    Bool
    
    Internal
    
    Bytes
    
    Ecc
    
    Encodings
    
    Enum
    
    N
    
    Input
    
    Limb
    
    N
    
    Limbs
    
    N
    
    Mod_arith
    
    Num
    
    Poseidon
    
    Operator
    
    Internal_for_tests
    
    Params
    
    Types
    
    Encodings
    
    Bounded_e
    
    VL
    
    L
    
    Anemoi
    
    Bool
    
    Internal
    
    Bytes
    
    Ecc
    
    Encodings
    
    Enum
    
    N
    
    Input
    
    Limb
    
    N
    
    Limbs
    
    N
    
    Mod_arith
    
    Num
    
    Poseidon
    
    P
    
    Dummy
    
    V
    
    Bounded_u
    
    L
    
    Anemoi
    
    Bool
    
    Internal
    
    Bytes
    
    Ecc
    
    Encodings
    
    Enum
    
    N
    
    Input
    
    Limb
    
    N
    
    Limbs
    
    N
    
    Mod_arith
    
    Num
    
    Poseidon
    
    V
    
    E
    
    Bounded_e
    
    VL
    
    L
    
    Anemoi
    
    Bool
    
    Internal
    
    Bytes
    
    Ecc
    
    Encodings
    
    Enum
    
    N
    
    Input
    
    Limb
    
    N
    
    Limbs
    
    N
    
    Mod_arith
    
    Num
    
    Poseidon
  - Error_monad_operators
  - Expr
  - Expr_common
  - Incremental
  - Liquidity_baking_generator
  - Liquidity_baking_machine
    
    ConcreteMachine
    
    SymbolicMachine
    
    ValidationMachine
    
    Concrete
    
    Symbolic
  - Lqt_fa12_repr
    
    Parameter
    
    Storage
  - Lwt_result_wrap_syntax
  - Merkle_list_helper
    
    Hash
    
    Map
    
    Set
    
    ML
    
    Internal_for_tests
  - Nonce
  - Op
  - Operation_generator
    
    Gen_hash
    
    H
  - Rewards
  - Sapling_helpers
    
    Alpha_context_helpers
    
    Common
    
    Interpreter_helpers
  - Sc_rollup_helpers
    
    Arith_pvm
    
    Internal_for_tests
    
    In_memory_context
    
    Tree
    
    Make_in_memory_context
    
    Context
    
    Proof
    
    Tree
    
    Tree
    
    Node_inbox
    
    Payloads_histories
    
    Protocol_inbox
    
    Protocol_inbox_with_ctxt
    
    Wasm_pvm
    
    Internal_for_tests
    
    Wrong_arith_pvm
    
    Internal_for_tests
    
    Wrong_in_memory_context
    
    Tree
  - Script_big_map
  - Script_map
  - Script_set
  - Test_global_constants
    
    Generators
  - Test_tez
  - Testable
  - Ticket_helpers
  - Transfers
  - Zk_rollup_l2_helpers

Legend:
Library
Module
Module type
Parameter
Class
Class type

This module allows the creation of Sapling transactions: shield, unshield and transfer. Because Sapling uses an UTXO model, it is necessary for the client to maintain locally the set of unspent outputs for each viewing key, for each smart contract. This operation is called scanning. This local cache is updated downloading from the node only the difference from the last scanned state.

module Tez : 
  module type of Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Tez

module Shielded_tez : sig ... end

This module is used to represent any shielded token to avoid confusing it with Tez.

val sapling_transaction_as_arg : 
  Tezos_sapling.Core.Client.UTXO.transaction ->
  string

Convert a Sapling transaction to a suitable argument for the Smart Contract.

module Account : sig ... end

Account corresponding to a contract and a viewing key

module Contract_state : sig ... end

State of a contract, potentially involving several viewing keys

module Client_state : sig ... end

val shield : 
  Tezos_client_base.Client_context.full ->
  dst:Tezos_sapling.Core.Client.Viewing_key.address ->
  ?message:bytes ->
  Tez.t ->
  Contract_state.t ->
  string ->
  Tezos_sapling.Core.Client.UTXO.transaction Tezos_base.TzPervasives.tzresult
    Lwt.t

shield ~message ~dst tez cstate anti-replay returns a transaction shielding tez tez to a sapling address dst using a sapling storage cstate and the anti-replay string.

val unshield : 
  src:Tezos_sapling.Core.Client.Spending_key.t ->
  bound_data:string ->
  backdst:Tezos_sapling.Core.Client.Viewing_key.address ->
  Shielded_tez.t ->
  Contract_state.t ->
  string ->
  Tezos_sapling.Core.Client.UTXO.transaction Tezos_base.TzPervasives.tzresult

unshield ~src_name ~src ~dst ~backdst stez cstate storage returns a transaction unshielding stez shielded tokens from a sapling wallet src to a transparent tezos address dst, sending the change back to backdst and using a Sapling storage cstate and a anti-replay string. The transaction is refused if there is an insufficient amount of shielded tez in the wallet src, the error is raised with src_name.

val transfer : 
  Tezos_client_base.Client_context.full ->
  src:Tezos_sapling.Core.Client.Spending_key.t ->
  dst:Tezos_sapling.Core.Client.Viewing_key.address ->
  backdst:Tezos_sapling.Core.Client.Viewing_key.address ->
  ?message:bytes ->
  Shielded_tez.t ->
  Contract_state.t ->
  string ->
  Tezos_sapling.Core.Client.UTXO.transaction Tezos_base.TzPervasives.tzresult
    Lwt.t

transfer ~message ~src ~dst ~backdst amount cstate anti-replay creates a Sapling transaction of amount shielded tez from Sapling wallet src to Sapling address dst, sending the change to backdst, using a Sapling storage cstate and a anti-replay string. ~message is a message that will be uploaded encrypted on chain.