package tezos-protocol-alpha

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type

This module provides a typed API for the Rollup Management Protocol that defines the communication protocol for exchanging messages between Layer 1 and Layer 2 for smart-contract rollups.

The API exposes functions for constructing inbox messages. These are messages produced by the Layer 1 protocol and added to a smart-contract rollups inbox.

The Layer 2 node is responsible for decoding and interpreting the messages.

A type outbox_message representing messages from Layer 2 to Layer 1 is also provided. An outbox_message consists of a set of transactions to L1 accounts.

type Tezos_protocol_environment_alpha.Error_monad.error +=
  1. | Sc_rollup_invalid_destination
type transaction = private
  1. | Transaction : {
    1. destination : Contract_hash.t;
    2. entrypoint : Alpha_context.Entrypoint.t;
    3. parameters_ty : ('a, _) Script_typed_ir.ty;
    4. parameters : 'a;
    5. unparsed_parameters : Alpha_context.Script.expr;
    } -> transaction

A type representing a Layer 2 to Layer 1 transaction.

type atomic_transaction_batch = private {
  1. transactions : transaction list;
}

A type representing a batch of Layer 2 to Layer 1 transactions.

type outbox_message = private
  1. | Atomic_transaction_batch of atomic_transaction_batch
  2. | Whitelist_update of Alpha_context.Sc_rollup.Whitelist.t option

A typed representation of Sc_rollup.Outbox.Message.t.

make_internal_transfer ctxt ty ~payload ~sender ~source ~destination constructs a smart rollup's inbox message (an L1 to L2 message) with the given payload, sender, and source targeting destination.

outbox_message_of_outbox_message_repr ctxt msg returns a typed version of of the given outbox message msg.

Fails with an Sc_rollup_invalid_destination error in case the parameters don't match the type of the entrypoint and destination.

module Internal_for_tests : sig ... end

Function for constructing and encoding inbox_message and outbox_message values. Since Layer 1 only ever consumes outbox_message values and produces inbox_message values, these functions are used for testing only.

OCaml

Innovation. Community. Security.