%%% plop data structures. Heavily based on RFC 6962. Some are for
%%% database storage, some for interfacing with consumers and some are
%%% for serialisation.

-type signature_type() :: certificate_timestamp | tree_hash | test. % uint8
-type entry_type() :: x509 | precert | test.    % uint16
-type leaf_type() :: timestamped_entry | test.  % uint8

%% @doc Merkle Tree Leaf -- what's sent as 'leaf_input' in response to
%% get-entries requests and also the input to the hash function for
%% leaf hashes in the tree. RFC 6962 sect 3.4.
-record(mtl, {
          version = 1 :: pos_integer(),
          leaf_type = timestamped_entry :: leaf_type(),
          entry :: timestamped_entry()
         }).
-type mtl() :: #mtl{}.

-record(spt, {
          version :: pos_integer(),             % uint8
          logid :: binary(),                    % SHA-256 over DER encoded public log key
          timestamp :: integer(),               % uint64
          signature :: binary()
         }).
-type spt() :: #spt{}.

%% A plop entry with timestamp. Part of the Merkle Tree Leaf
%% structure.
-record(timestamped_entry, {
          timestamp = now :: now | integer(),
          entry :: plop_entry()
         }).
-type timestamped_entry() :: #timestamped_entry{}.

%% An entry, without the timestamp. This is what we hash over and
%% store in the the database for finding duplicated submissions.
-record(plop_entry, {
          type :: entry_type(),
          data :: binary()
         }).
-type plop_entry() :: #plop_entry{}.

-export_type([timestamped_entry/0, mtl/0, entry_type/0]).