package tezos-protocol-013-PtJakart

  1. Overview
  2. Docs
package tezos-protocol-013-PtJakart
Legend:
Library
Module
Module type
Parameter
Class
Class type

Parameters

Signature

type ctxt = Context.t

The operations are versioned (see Tx_rollup_l2_batch), so their interpretations are.

module Batch_V1 : sig ... end

apply_deposit ctxt deposit credits a quantity of tickets to a layer2 address in ctxt.

This function can fail if the deposit.amount is not strictly-positive.

If the deposit causes an error, then a withdrawal returning the funds to the deposit's sender is returned.

apply_message ctxt parameters message interprets the message in the ctxt.

That is,

  • Deposit tickets if the message is a deposit.
  • Decodes the batch and interprets it for the correct batch version.

The function can fail with Invalid_batch_encoding if it's not able to decode the batch.

The function can also return errors from subsequent functions, see apply_deposit and batch interpretations for various versions.

The list of withdrawals in the message result followed the ordering of the contents in the message.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct