-module(tc_fr).

-export([
    %% field API
    into/1,
    cmp/2,
    zero/0,
    add_assign/2,
    serialize/1,
    deserialize/1
]).

-type fr() :: reference().
-export_type([fr/0]).

-spec into(Num :: integer()) -> fr().
into(Num) ->
    erlang_tc:into_fr(Num).

-spec cmp(FR1 :: fr(), FR2 :: fr()) -> boolean().
cmp(FR1, FR2) ->
    erlang_tc:cmp_fr(FR1, FR2).

-spec zero() -> fr().
zero() ->
    erlang_tc:zero_fr().

-spec add_assign(FR1 :: fr(), FR2 :: fr()) -> fr().
add_assign(FR1, FR2) ->
    erlang_tc:add_assign_fr(FR1, FR2).

-spec serialize(Fr :: fr()) -> binary().
serialize(Fr) ->
    erlang_tc:serialize_fr(Fr).

-spec deserialize(BinFr :: binary()) -> fr().
deserialize(BinFr) ->
    erlang_tc:deserialize_fr(BinFr).