add support for encoding/decoding of subname id

.circleci/config.yml

@@ -3,7 +3,7 @@ version: 2.1
 executors:
   aebuilder:
     docker:
-      - image: aeternity/builder:bionic-otp23
+      - image: aeternity/builder
         user: builder
     working_directory: ~/src
 

rebar.config

@@ -1,4 +1,4 @@
 {erl_opts, [debug_info]}.
 {deps, [ {base58, {git, "https://github.com/aeternity/erl-base58.git", {ref, "60a3356"}}}
-       , {enacl, {git, "https://github.com/aeternity/enacl.git",       {ref, "67fceef"}}}
+       , {enacl, {git, "https://github.com/aeternity/enacl.git",       {ref, "26180f4"}}}
        ]}.

rebar.lock

@@ -1,8 +0,0 @@
-[{<<"base58">>,
-  {git,"https://github.com/aeternity/erl-base58.git",
-       {ref,"60a335668a60328a29f9731b67c4a0e9e3d50ab6"}},
-  0},
- {<<"enacl">>,
-  {git,"https://github.com/aeternity/enacl.git",
-       {ref,"67fceef42c0d055570f2e67b571f8d1f8de2f204"}},
-  0}].

src/aeser_api_encoder.erl

@@ -30,17 +30,15 @@
                     | oracle_query_id
                     | oracle_response
                     | account_pubkey
-                    | account_seckey
-                    | associate_chain
                     | signature
                     | name
+                    | subname
                     | commitment
                     | peer_pubkey
                     | state
                     | poi
                     | state_trees
                     | call_state_tree
-                    | mp_tree_hash
                     | bytearray.
 
 -type extended_type() :: known_type() | block_hash | {id_hash, [known_type()]}.
@@ -163,16 +161,14 @@ sha256_hash(Bin) ->
     crypto:hash(sha256, Bin).
 
 
-id2type(account)         -> account_pubkey;
-id2type(associate_chain) -> associate_chain;
-id2type(channel)         -> channel;
-id2type(commitment)      -> commitment;
-id2type(contract)        -> contract_pubkey;
-id2type(name)            -> name;
-id2type(oracle)          -> oracle_pubkey.
+id2type(account)    -> account_pubkey;
+id2type(channel)    -> channel;
+id2type(commitment) -> commitment;
+id2type(contract)   -> contract_pubkey;
+id2type(name)       -> name;
+id2type(oracle)     -> oracle_pubkey.
 
 type2id(account_pubkey)  -> account;
-type2id(associate_chain) -> associate_chain;
 type2id(channel)         -> channel;
 type2id(commitment)      -> commitment;
 type2id(contract_pubkey) -> contract;
@@ -196,18 +192,15 @@ type2enc(oracle_query)         -> ?BASE64;
 type2enc(oracle_query_id)      -> ?BASE58;
 type2enc(oracle_response)      -> ?BASE64;
 type2enc(account_pubkey)       -> ?BASE58;
-type2enc(account_seckey)       -> ?BASE58;
-type2enc(associate_chain)      -> ?BASE58;
 type2enc(signature)            -> ?BASE58;
 type2enc(commitment)           -> ?BASE58;
 type2enc(peer_pubkey)          -> ?BASE58;
 type2enc(name)                 -> ?BASE58;
+type2enc(subname)              -> ?BASE64;
 type2enc(state)                -> ?BASE64;
 type2enc(poi)                  -> ?BASE64;
 type2enc(state_trees)          -> ?BASE64;
 type2enc(call_state_tree)      -> ?BASE64;
-type2enc(mp_tree_hash)         -> ?BASE58;
-type2enc(hash)                 -> ?BASE58;
 type2enc(bytearray)            -> ?BASE64.
 
 
@@ -228,18 +221,15 @@ type2pfx(oracle_query)         -> <<"ov">>;
 type2pfx(oracle_query_id)      -> <<"oq">>;
 type2pfx(oracle_response)      -> <<"or">>;
 type2pfx(account_pubkey)       -> <<"ak">>;
-type2pfx(account_seckey)       -> <<"sk">>;
-type2pfx(associate_chain)      -> <<"ac">>;
 type2pfx(signature)            -> <<"sg">>;
 type2pfx(commitment)           -> <<"cm">>;
 type2pfx(peer_pubkey)          -> <<"pp">>;
 type2pfx(name)                 -> <<"nm">>;
+type2pfx(subname)              -> <<"sn">>;
 type2pfx(state)                -> <<"st">>;
 type2pfx(poi)                  -> <<"pi">>;
 type2pfx(state_trees)          -> <<"ss">>;
 type2pfx(call_state_tree)      -> <<"cs">>;
-type2pfx(mp_tree_hash)         -> <<"mt">>;
-type2pfx(hash)                 -> <<"hs">>;
 type2pfx(bytearray)            -> <<"ba">>.
 
 pfx2type(<<"kh">>) -> key_block_hash;
@@ -259,18 +249,15 @@ pfx2type(<<"ov">>) -> oracle_query;
 pfx2type(<<"oq">>) -> oracle_query_id;
 pfx2type(<<"or">>) -> oracle_response;
 pfx2type(<<"ak">>) -> account_pubkey;
-pfx2type(<<"sk">>) -> account_seckey;
-pfx2type(<<"ac">>) -> associate_chain;
 pfx2type(<<"sg">>) -> signature;
 pfx2type(<<"cm">>) -> commitment;
 pfx2type(<<"pp">>) -> peer_pubkey;
 pfx2type(<<"nm">>) -> name;
+pfx2type(<<"sn">>) -> subname;
 pfx2type(<<"st">>) -> state;
 pfx2type(<<"pi">>) -> poi;
 pfx2type(<<"ss">>) -> state_trees;
 pfx2type(<<"cs">>) -> call_state_tree;
-pfx2type(<<"mt">>) -> mp_tree_hash;
-pfx2type(<<"hs">>) -> hash;
 pfx2type(<<"ba">>) -> bytearray.
 
 -spec byte_size_for_type(known_type()) -> non_neg_integer() | not_applicable.
@@ -292,18 +279,15 @@ byte_size_for_type(oracle_query)         -> not_applicable;
 byte_size_for_type(oracle_query_id)      -> 32;
 byte_size_for_type(oracle_response)      -> not_applicable;
 byte_size_for_type(account_pubkey)       -> 32;
-byte_size_for_type(account_seckey)       -> 32;
-byte_size_for_type(associate_chain)      -> 32;
 byte_size_for_type(signature)            -> 64;
 byte_size_for_type(name)                 -> not_applicable;
+byte_size_for_type(subname)              -> not_applicable;
 byte_size_for_type(commitment)           -> 32;
 byte_size_for_type(peer_pubkey)          -> 32;
 byte_size_for_type(state)                -> 32;
 byte_size_for_type(poi)                  -> not_applicable;
 byte_size_for_type(state_trees)          -> not_applicable;
 byte_size_for_type(call_state_tree)      -> not_applicable;
-byte_size_for_type(mp_tree_hash)         -> 32;
-byte_size_for_type(hash)                 -> 32;
 byte_size_for_type(bytearray)            -> not_applicable.
 
 

src/aeser_chain_objects.erl

@@ -52,13 +52,13 @@ tag(name_preclaim_tx) -> 33;
 tag(name_update_tx) -> 34;
 tag(name_revoke_tx) -> 35;
 tag(name_transfer_tx) -> 36;
-tag(name_auction) -> 37;
+tag(subname) -> 38;
+tag(subname_tx) -> 39;
 tag(contract) -> 40;
 tag(contract_call) -> 41;
 tag(contract_create_tx) -> 42;
 tag(contract_call_tx) -> 43;
 tag(channel_create_tx) -> 50;
-tag(channel_set_delegates_tx) -> 501;
 tag(channel_deposit_tx) -> 51;
 tag(channel_withdraw_tx) -> 52;
 tag(channel_force_progress_tx) -> 521;
@@ -87,19 +87,9 @@ tag(channels_mtree) -> 623;
 tag(nameservice_mtree) -> 624;
 tag(oracles_mtree) -> 625;
 tag(accounts_mtree) -> 626;
-tag(acs_mtree) -> 627;
 tag(compiler_sophia) -> 70;
 tag(ga_attach_tx) -> 80;
 tag(ga_meta_tx) -> 81;
-tag(paying_for_tx) -> 82;
-tag(ga_meta_tx_auth_data) -> 810;
-tag(associate_chain) -> 90;
-tag(ac_state) -> 91;
-tag(ac_burn) -> 92;
-tag(ac_create_tx) -> 93;
-tag(ac_deposit_tx) -> 94;
-tag(ac_update_cops_tx) -> 95;
-tag(ac_rollup_tx) -> 96;
 tag(key_block) -> 100;
 tag(micro_block) -> 101;
 tag(light_micro_block) -> 102;
@@ -121,13 +111,13 @@ rev_tag(33) -> name_preclaim_tx;
 rev_tag(34) -> name_update_tx;
 rev_tag(35) -> name_revoke_tx;
 rev_tag(36) -> name_transfer_tx;
-rev_tag(37) -> name_auction;
+rev_tag(38) -> subname;
+rev_tag(39) -> subname_tx;
 rev_tag(40) -> contract;
 rev_tag(41) -> contract_call;
 rev_tag(42) -> contract_create_tx;
 rev_tag(43) -> contract_call_tx;
 rev_tag(50) -> channel_create_tx;
-rev_tag(501) -> channel_set_delegates_tx;
 rev_tag(51) -> channel_deposit_tx;
 rev_tag(52) -> channel_withdraw_tx;
 rev_tag(521) -> channel_force_progress_tx;
@@ -156,19 +146,9 @@ rev_tag(623) -> channels_mtree;
 rev_tag(624) -> nameservice_mtree;
 rev_tag(625) -> oracles_mtree;
 rev_tag(626) -> accounts_mtree;
-rev_tag(627) -> acs_mtree;
 rev_tag(70) -> compiler_sophia;
 rev_tag(80) -> ga_attach_tx;
 rev_tag(81) -> ga_meta_tx;
-rev_tag(82) -> paying_for_tx;
-rev_tag(810) -> ga_meta_tx_auth_data;
-rev_tag(90)  -> associate_chain;
-rev_tag(91)  -> ac_state;
-rev_tag(92)  -> ac_burn;
-rev_tag(93)  -> ac_create_tx;
-rev_tag(94)  -> ac_deposit_tx;
-rev_tag(95)  -> ac_update_cops_tx;
-rev_tag(96)  -> ac_rollup_tx;
 rev_tag(100) -> key_block;
 rev_tag(101) -> micro_block;
 rev_tag(102) -> light_micro_block;

src/aeser_contract_code.erl

@@ -23,7 +23,8 @@ serialize(CodeMap = #{ byte_code := ByteCode
     SourceHash = case CodeMap of
                      #{ source_hash := SHash } -> SHash;
                      #{ contract_source := SrcStr } ->
-                         enacl:generichash(32, list_to_binary(SrcStr))
+                         {ok, SHash} = enacl:generichash(32, list_to_binary(SrcStr)),
+                         SHash
                  end,
 
     %% Compiler version

src/aeser_delegation.erl

@@ -1,81 +0,0 @@
-%%%-------------------------------------------------------------------
-%%% @copyright (C) 2023, Aeternity Anstalt
-%%% @doc
-%%% Serialization of delegation signatures
-%%% @end
-%%%-------------------------------------------------------------------
--module(aeser_delegation).
-
--export([ aens_preclaim_sig/3
-        , aens_name_sig/4
-        , aens_sig/3
-
-        , oracle_sig/3
-        , oracle_response_sig/3
-        ]).
-
-%% Delegation signatures are prefixed with a unique tag, ensuring not to
-%% collide with serialized transactions.
--define(DELEGATION_TAG, 16#1a01).
-
--define(TYPE_AENS, 1).
--define(TYPE_AENS_NAME, 2).
--define(TYPE_AENS_PRECLAIM, 3).
--define(TYPE_ORACLE, 4).
--define(TYPE_ORACLE_RESPONSE, 5).
-
--define(VSN, 1).
-
--type sig_data() :: binary().
-
--spec aens_preclaim_sig(binary(), aeser_id:id(), aeser_id:id()) -> sig_data().
-aens_preclaim_sig(NetworkId, Account, Contract) ->
-    assert_id(account, Account),
-    assert_id(contract, Contract),
-    Template = [{account, id}, {contract, id}],
-    Fields   = [{account, Account}, {contract, Contract}],
-    serialize(?TYPE_AENS_PRECLAIM, NetworkId, Template, Fields).
-
--spec aens_name_sig(binary(), aeser_id:id(), aeser_id:id(), aeser_id:id()) -> sig_data().
-aens_name_sig(NetworkId, Account, Name, Contract) ->
-    assert_id(account, Account),
-    assert_id(name, Name),
-    assert_id(contract, Contract),
-    Template = [{account, id}, {name, id}, {contract, id}],
-    Fields   = [{account, Account}, {name, Name}, {contract, Contract}],
-    serialize(?TYPE_AENS_NAME, NetworkId, Template, Fields).
-
--spec aens_sig(binary(), aeser_id:id(), aeser_id:id()) -> sig_data().
-aens_sig(NetworkId, Account, Contract) ->
-    assert_id(account, Account),
-    assert_id(contract, Contract),
-    Template = [{account, id}, {contract, id}],
-    Fields   = [{account, Account}, {contract, Contract}],
-    serialize(?TYPE_AENS, NetworkId, Template, Fields).
-
--spec oracle_sig(binary(), aeser_id:id(), aeser_id:id()) -> sig_data().
-oracle_sig(NetworkId, Account, Contract) ->
-    assert_id(account, Account),
-    assert_id(contract, Contract),
-    Template = [{account, id}, {contract, id}],
-    Fields   = [{account, Account}, {contract, Contract}],
-    serialize(?TYPE_ORACLE, NetworkId, Template, Fields).
-
--spec oracle_response_sig(binary(), aeser_id:id(), aeser_id:id()) -> sig_data().
-oracle_response_sig(NetworkId, QueryId, Contract) ->
-    assert_id(oracle, QueryId),
-    assert_id(contract, Contract),
-    Template = [{query, id}, {contract, id}],
-    Fields   = [{query, QueryId}, {contract, Contract}],
-    serialize(?TYPE_ORACLE_RESPONSE, NetworkId, Template, Fields).
-
-%% ------------------------------------------------------------------------
-%% -- Internal functions
-%% ------------------------------------------------------------------------
-
-serialize(Type, NetworkId, Template, Fields) ->
-    Data = aeserialization:serialize(Type, ?VSN, Template, Fields),
-    <<?DELEGATION_TAG:16, NetworkId/binary, Data/binary>>.
-
-assert_id(Type, AeserId) ->
-    Type = aeser_id:specialize_type(AeserId).

src/aeser_id.erl

@@ -24,9 +24,8 @@
             , val
             }).
 
--type tag() :: 'account' | 'oracle' | 'name'
-             | 'commitment' | 'contract' | 'channel'
-             | 'associate_chain' .
+-type tag() :: 'account' | 'oracle' | 'name' | 'subname'
+             | 'commitment' | 'contract' | 'channel'.
 -type val() :: <<_:256>>.
 -opaque(id() :: #id{}).
 
@@ -38,14 +37,15 @@
 -define(PUB_SIZE, 32).
 -define(TAG_SIZE, 1).
 -define(SERIALIZED_SIZE, 33). %% ?TAG_SIZE + ?PUB_SIZE
+-define(SUBNAME_SERIALIZED_SIZE, 65). %% ?TAG_SIZE + ?PUB_SIZE + ?PUB_SIZE
 
 -define(IS_TAG(___TAG___), ___TAG___ =:= account;
                            ___TAG___ =:= oracle;
                            ___TAG___ =:= name;
+                           ___TAG___ =:= subname;
                            ___TAG___ =:= commitment;
                            ___TAG___ =:= contract;
-                           ___TAG___ =:= channel;
-                           ___TAG___ =:= associate_chain
+                           ___TAG___ =:= channel
        ).
 -define(IS_VAL(___VAL___), byte_size(___VAL___) =:= 32).
 
@@ -84,26 +84,34 @@ is_id(_) -> false.
 -spec encode(id()) -> binary().
 encode(#id{tag = Tag, val = Val}) ->
     Res = <<(encode_tag(Tag)):?TAG_SIZE/unit:8, Val/binary>>,
-    true = ?SERIALIZED_SIZE =:= byte_size(Res),
+    true = serialized_size(Tag) =:= byte_size(Res),
     Res.
 
 -spec decode(binary()) -> id().
 decode(<<Tag:?TAG_SIZE/unit:8, Val:?PUB_SIZE/binary>>) ->
     #id{ tag = decode_tag(Tag)
+       , val = Val};
+decode(<<SubnameTag:?TAG_SIZE/unit:8, Val:(?PUB_SIZE+?PUB_SIZE)/binary>>) ->
+    #id{ tag = subname = decode_tag(SubnameTag)
        , val = Val}.
 
+
 %%%===================================================================
 %%% Internal functions
 %%%===================================================================
 
-encode_tag(account)         -> 1;
-encode_tag(name)            -> 2;
-encode_tag(commitment)      -> 3;
-encode_tag(oracle)          -> 4;
-encode_tag(contract)        -> 5;
-encode_tag(channel)         -> 6;
-encode_tag(associate_chain) -> 7;
-encode_tag(Other)           -> error({illegal_id_tag_name, Other}).
+serialized_size(subname) -> ?SUBNAME_SERIALIZED_SIZE;
+serialized_size(_)       -> ?SERIALIZED_SIZE.
+
+
+encode_tag(account)    -> 1;
+encode_tag(name)       -> 2;
+encode_tag(commitment) -> 3;
+encode_tag(oracle)     -> 4;
+encode_tag(contract)   -> 5;
+encode_tag(channel)    -> 6;
+encode_tag(subname)    -> 7;
+encode_tag(Other)      -> error({illegal_id_tag_name, Other}).
 
 decode_tag(1) -> account;
 decode_tag(2) -> name;
@@ -111,5 +119,5 @@ decode_tag(3) -> commitment;
 decode_tag(4) -> oracle;
 decode_tag(5) -> contract;
 decode_tag(6) -> channel;
-decode_tag(7) -> associate_chain;
+decode_tag(7) -> subname;
 decode_tag(X) -> error({illegal_id_tag, X}).

src/aeserialization.erl

@@ -28,14 +28,12 @@
               | 'binary'
               | 'id'     %% As defined in aec_id.erl
               | [type()] %% Length one in the type. This means a list of any length.
-              | #{items := [{field_name(), type()}]} %% Record with named fields represented as a map. Encoded as a list in the given order.
               | tuple(). %% Any arity, containing type(). This means a static size array.
 
 -type encodable_term() :: non_neg_integer()
                         | binary()
                         | boolean()
                         | [encodable_term()] %% Of any length
-			| #{atom() => encodable_term()}
                         | tuple()  %% Any arity, containing encodable_term().
                         | aeser_id:id().
 
@@ -103,12 +101,6 @@ decode_fields(Template, Values) ->
 
 encode_field([Type], L) when is_list(L) ->
     [encode_field(Type, X) || X <- L];
-encode_field(#{items := Items}, Map) ->
-    lists:map(
-      fun({K, Type}) ->
-              V = maps:get(K, Map),
-              encode_field(Type, V)
-      end, Items);
 encode_field(Type, T) when tuple_size(Type) =:= tuple_size(T) ->
     Zipped = lists:zip(tuple_to_list(Type), tuple_to_list(T)),
     [encode_field(X, Y) || {X, Y} <- Zipped];
@@ -125,13 +117,6 @@ encode_field(Type, Val) -> error({illegal, Type, Val}).
 
 decode_field([Type], List) when is_list(List) ->
     [decode_field(Type, X) || X <- List];
-decode_field(#{items := Items}, List) when length(List) =:= length(Items) ->
-    Zipped = lists:zip(Items, List),
-    lists:foldl(
-      fun({{K, Type}, V}, Map) ->
-              maps:is_key(K, Map) andalso error(badarg, duplicate_field),
-              Map#{ K => decode_field(Type, V) }
-      end, #{}, Zipped);
 decode_field(Type, List) when length(List) =:= tuple_size(Type) ->
     Zipped = lists:zip(tuple_to_list(Type), List),
     list_to_tuple([decode_field(X, Y) || {X, Y} <- Zipped]);

test/aeser_delegation_tests.erl

@@ -1,67 +0,0 @@
-%%%-------------------------------------------------------------------
-%%% @copyright (C) 2023, Aeternity Anstalt
-%%%-------------------------------------------------------------------
-
--module(aeser_delegation_tests).
-
--include_lib("eunit/include/eunit.hrl").
-
--define(TEST_MODULE, aeser_delegation).
-
--define(ACCOUNT, aeser_id:create(account, <<1:256>>)).
--define(CONTRACT, aeser_id:create(contract, <<2:256>>)).
--define(NAME, aeser_id:create(name, <<3:256>>)).
--define(ORACLE, aeser_id:create(oracle, <<3:256>>)).
-
--define(NETWORK_ID, <<"my_fancy_network"/utf8>>).
-
-encode_correct_test_() ->
-    [{"Encode preclaim sig",
-      fun() ->
-          aeser_delegation:aens_preclaim_sig(?NETWORK_ID, ?ACCOUNT, ?CONTRACT)
-      end},
-     {"Encode name sig",
-      fun() ->
-          aeser_delegation:aens_name_sig(?NETWORK_ID, ?ACCOUNT, ?NAME, ?CONTRACT)
-      end},
-     {"Encode aens wildcard sig",
-      fun() ->
-          aeser_delegation:aens_sig(?NETWORK_ID, ?ACCOUNT, ?CONTRACT)
-      end},
-     {"Encode oracle sig",
-      fun() ->
-          aeser_delegation:oracle_sig(?NETWORK_ID, ?ACCOUNT, ?CONTRACT)
-      end},
-     {"Encode oracle response sig",
-      fun() ->
-          aeser_delegation:oracle_response_sig(?NETWORK_ID, ?ORACLE, ?CONTRACT)
-      end}
-    ].
-
-encode_fail_test_() ->
-    [{"Bad encoding preclaim sig",
-      fun() ->
-          ?assertError(_, aeser_delegation:aens_preclaim_sig(?NETWORK_ID, <<42:256>>, ?CONTRACT)),
-          ?assertError(_, aeser_delegation:aens_preclaim_sig(?NETWORK_ID, ?CONTRACT, ?ACCOUNT))
-      end},
-     {"Bad encoding name sig",
-      fun() ->
-          ?assertError(_, aeser_delegation:aens_name_sig(?NETWORK_ID, ?ACCOUNT, <<42:256>>, ?CONTRACT)),
-          ?assertError(_, aeser_delegation:aens_name_sig(?NETWORK_ID, ?NAME, ?ACCOUNT, ?CONTRACT))
-      end},
-     {"Bad encoding aens wildcard sig",
-      fun() ->
-          ?assertError(_, aeser_delegation:aens_sig(?NETWORK_ID, ?ACCOUNT, <<42:256>>)),
-          ?assertError(_, aeser_delegation:aens_sig(?NETWORK_ID, ?CONTRACT, ?CONTRACT))
-      end},
-     {"Bad encoding oracle sig",
-      fun() ->
-          ?assertError(_, aeser_delegation:oracle_sig(?NETWORK_ID, <<42:256>>, ?CONTRACT)),
-          ?assertError(_, aeser_delegation:oracle_sig(?NETWORK_ID, ?ACCOUNT, ?ACCOUNT))
-      end},
-     {"Bad encoding oracle response sig",
-      fun() ->
-          ?assertError(_, aeser_delegation:oracle_response_sig(?NETWORK_ID, <<42:256>>, ?CONTRACT)),
-          ?assertError(_, aeser_delegation:oracle_response_sig(?NETWORK_ID, ?ORACLE, ?ORACLE))
-      end}
-    ].