package octez-proto-libs

You can search for identifiers within the package.

in-package search v0.2.0

Octez protocol libraries

Install

sha256=aa2f5bc99cc4ca2217c52a1af2a2cdfd3b383208cb859ca2e79ca0903396ca1d

sha512=d68bb3eb615e3dcccc845fddfc9901c95b3c6dc8e105e39522ce97637b1308a7fa7aa1d271351d5933febd7476b2819e1694f31198f1f0919681f1f9cc97cb3a

This module can be used to write compact encoding for complex types without relying on the existing combinators.

type tag = int

val join_tags : (tag * int) list -> tag

Combine multiple tags; will throw an error if the total length of the tags is more than 16.

module type S = sig ... end

val make : (module S with type input = 'a) -> 'a t

make (module M) is a compact encoding for the type of M.input.

The JSON representation is entirely determined by M.json_encoding.

The binary representation is determined as follows.

A value v : M.input is classified into a layout l by M.classify v.
A tag M.tag l is used (which may be combined with the tags of other compact encodings as described before).
The payload is the same bytes as can be found in the string returned by Data_encoding.Binary.to_string (M.partial_encoding l) v.

In other words, the tag of a value is M.(tag (layout v)) and the payload of a value is M.(partial_encoding (layout v) v).

It is the user's responsibility to ensure that all the values of M follow the invariants documented in S.