gossip: fix vote encoder (#7174)

Author: ravyu-jump

src/flamenco/gossip/Local.mk

@@ -17,6 +17,9 @@ $(call run-unit-test,test_ping_tracker)
 $(call make-unit-test,test_gossip,test_gossip,fd_flamenco fd_ballet fd_util)
 $(call run-unit-test,test_gossip)
 
+$(call make-unit-test,test_gossip_ser,test_gossip_ser,fd_flamenco fd_ballet fd_util)
+$(call run-unit-test,test_gossip_ser)
+
 ifdef FD_HAS_HOSTED
 $(call make-fuzz-test,fuzz_gossip_msg_parse,fuzz_gossip_msg_parse,fd_flamenco fd_ballet fd_util)
 endif

src/flamenco/gossip/fd_gossip.c

@@ -720,42 +720,33 @@ fd_gossip_push_vote( fd_gossip_t *       gossip,
                      long                now ) {
   /* TODO: we can avoid addt'l memcpy if we pass a propely laid out
      crds buffer instead */
-  uchar crds_val[ FD_GOSSIP_CRDS_MAX_SZ ];
-  ulong crds_val_sz;
+  uchar                       crds_val[ FD_GOSSIP_CRDS_MAX_SZ ];
+  fd_gossip_view_crds_value_t view[1];
+
   fd_gossip_crds_vote_encode( crds_val,
                               FD_GOSSIP_CRDS_MAX_SZ,
                               txn,
                               txn_sz,
                               gossip->identity_pubkey,
                               now,
-                              &crds_val_sz );
-  fd_gossip_view_crds_value_t value[1];
+                              0UL, /* vote_index TODO */
+                              view );
 
   gossip->sign_fn( gossip->sign_ctx,
                    crds_val+64UL,
-                   crds_val_sz-64UL,
+                   view->length-64UL,
                    FD_KEYGUARD_SIGN_TYPE_ED25519,
                    crds_val );
 
-  value->tag                   = FD_GOSSIP_VALUE_VOTE;
-  value->value_off             = 0UL;
-  value->length                = (ushort)crds_val_sz;
-  value->pubkey_off            = 64UL+1UL; /* Signature + vote index */
-  value->wallclock_nanos       = now;
-  fd_gossip_view_vote_t * vote = value->vote;
-  vote->index                  = 0UL; /* TODO */
-  vote->txn_sz                 = (ushort)txn_sz;
-  vote->txn_off                = 64UL+1UL+32UL; /* Signature + vote index + pubkey */
-
-  int res = fd_crds_checks_fast( gossip->crds, value, crds_val, 0 );
+  int res = fd_crds_checks_fast( gossip->crds, view, crds_val, 0 );
   if( FD_UNLIKELY( res ) ) return -1;
 
-  fd_crds_entry_t const * entry = fd_crds_insert( gossip->crds, value, crds_val, gossip->identity_stake, 1, /* is_me */ now, stem );
+  fd_crds_entry_t const * entry = fd_crds_insert( gossip->crds, view, crds_val, gossip->identity_stake, 1, /* is_me */ now, stem );
   if( FD_UNLIKELY( !entry ) ) return -1;
 
   active_push_set_insert( gossip,
                           crds_val,
-                          crds_val_sz,
+                          view->length,
                           gossip->identity_pubkey,
                           gossip->identity_stake,
                           stem,

src/flamenco/gossip/fd_gossip_msg_ser.c

@@ -279,24 +279,26 @@ fd_gossip_contact_info_encode( fd_contact_info_t const * contact_info,
 }
 
 int
-fd_gossip_crds_vote_encode( uchar *       out_buf,
-                            ulong         out_buf_sz,
-                            uchar const * txn,
-                            ulong         txn_sz,
-                            uchar const * identity_pubkey,
-                            long          now,
-                            ulong *       opt_encoded_sz ) {
+fd_gossip_crds_vote_encode( uchar *                       out_buf,
+                            ulong                         out_buf_sz,
+                            uchar const *                 txn,
+                            ulong                         txn_sz,
+                            uchar const *                 identity_pubkey,
+                            long                          now,
+                            uchar                         vote_index,
+                            fd_gossip_view_crds_value_t * out_view ) {
+  fd_gossip_view_vote_t * vote = out_view->vote;
+
   SER_INIT( out_buf, out_buf_sz, 0U );
-  INC( 64U ); /* Reserve space for signature */
+  out_view->signature_off = CUR_OFFSET          ; /* Reserve space for signature */              ; INC( 64U );
+  out_view->tag           = FD_GOSSIP_VALUE_VOTE; FD_STORE( uint,  CURSOR, FD_GOSSIP_VALUE_VOTE ); INC(  4U );
 
-  FD_STORE( uint,  CURSOR, FD_GOSSIP_VALUE_VOTE )             ; INC( 4U );
-  FD_STORE( uchar, CURSOR, 0U )                               ; INC( 1U ); /* TODO: vote tower index, unused for now */
-  fd_memcpy( CURSOR, identity_pubkey, 32UL )                  ; INC( 32U );
-  fd_memcpy( CURSOR, txn,             txn_sz )                ; INC( (ushort)txn_sz );
-  FD_STORE( ulong, CURSOR, (ulong)FD_NANOSEC_TO_MILLI( now ) ); INC( 8U );
+  vote->index               = vote_index; FD_STORE ( uchar, CURSOR, vote_index )                       ; INC(  1U );
+  out_view->pubkey_off      = CUR_OFFSET; fd_memcpy( CURSOR, identity_pubkey, 32UL )                   ; INC( 32U );
+  vote->txn_off             = CUR_OFFSET; fd_memcpy( CURSOR, txn, txn_sz )                             ; INC( (ushort)txn_sz );
+  out_view->wallclock_nanos = now       ; FD_STORE ( ulong, CURSOR, (ulong)FD_NANOSEC_TO_MILLI( now ) ); INC(  8U );
 
-  if( opt_encoded_sz ) {
-    *opt_encoded_sz = BYTES_CONSUMED; /* Return the size of the encoded vote */
-  }
+  vote->txn_sz     = (ushort)txn_sz;
+  out_view->length = (ushort)BYTES_CONSUMED;
   return 0;
 }

src/flamenco/gossip/fd_gossip_private.h

@@ -375,11 +375,12 @@ fd_gossip_contact_info_encode( fd_contact_info_t const * contact_info,
                                ulong *                   opt_encoded_sz );
 
 int
-fd_gossip_crds_vote_encode( uchar *       out_buf,
-                            ulong         out_buf_sz,
-                            uchar const * txn,
-                            ulong         txn_sz,
-                            uchar const * identity_pubkey,
-                            long          now,
-                            ulong *       opt_encoded_sz );
+fd_gossip_crds_vote_encode( uchar *                       out_buf,
+                            ulong                         out_buf_sz,
+                            uchar const *                 txn,
+                            ulong                         txn_sz,
+                            uchar const *                 identity_pubkey,
+                            long                          now,
+                            uchar                         vote_index,
+                            fd_gossip_view_crds_value_t * out_view );
 #endif /* HEADER_fd_src_flamenco_gossip_fd_gossip_private_h */

src/flamenco/gossip/test_gossip_ser.c

@@ -0,0 +1,70 @@
+#include "../../util/fd_util.h"
+#include "fd_gossip_private.h"
+#include "fd_gossip_txbuild.h"
+
+FD_IMPORT_BINARY( fd_gossip_test_vote_txn, "src/flamenco/gossip/test_vote_txn.bin" );
+
+void
+gen_pubkey( fd_rng_t * rng, uchar * pubkey ) {
+  for( ulong i=0UL; i<32UL; i++ ) pubkey[i] = fd_rng_uchar( rng );
+}
+
+void
+test_gossip_vote_enc( void ) {
+  fd_rng_t _rng[1]; fd_rng_t * rng = fd_rng_join( fd_rng_new( _rng, 0U, 0UL ) );
+  uchar pubkey[32UL];
+  gen_pubkey( rng, pubkey );
+
+  fd_gossip_txbuild_t txbuild[1];
+  fd_gossip_txbuild_init( txbuild, pubkey, FD_GOSSIP_MESSAGE_PUSH );
+
+  uchar crds_val[ FD_GOSSIP_CRDS_MAX_SZ ];
+  fd_gossip_view_crds_value_t ser_view[1];
+
+  long now = 1234L*1000L*1000L;
+
+  fd_gossip_crds_vote_encode( crds_val,
+                              FD_GOSSIP_CRDS_MAX_SZ,
+                              fd_gossip_test_vote_txn,
+                              fd_gossip_test_vote_txn_sz,
+                              pubkey,
+                              now,
+                              0UL, /* vote_index */
+                              ser_view );
+  FD_TEST( ser_view->tag==FD_GOSSIP_VALUE_VOTE );
+  FD_TEST( fd_memeq( crds_val+ser_view->pubkey_off, pubkey, 32UL ) );
+  FD_TEST( ser_view->vote->index==0UL );
+  FD_TEST( ser_view->vote->txn_sz==fd_gossip_test_vote_txn_sz );
+  FD_TEST( fd_memeq( crds_val+ser_view->vote->txn_off, fd_gossip_test_vote_txn, fd_gossip_test_vote_txn_sz ) );
+  FD_TEST( ser_view->wallclock_nanos==now );
+
+  ulong crds_val_sz = ser_view->length;
+
+  FD_TEST( !!fd_gossip_txbuild_can_fit( txbuild, crds_val_sz ) );
+  fd_gossip_txbuild_append( txbuild, crds_val_sz, crds_val );
+
+
+  /* Simple parse test */
+  fd_gossip_view_t parse_view[1];
+  ulong sz = fd_gossip_msg_parse( parse_view, txbuild->bytes, txbuild->bytes_len );
+  FD_TEST( sz==txbuild->bytes_len );
+
+  fd_gossip_view_crds_value_t * parsed_vote = &parse_view->push->crds_values[0];
+  FD_TEST( parsed_vote->tag==FD_GOSSIP_VALUE_VOTE );
+  FD_TEST( fd_memeq( txbuild->bytes+parsed_vote->pubkey_off, pubkey, 32UL ) );
+  FD_TEST( parsed_vote->vote->index==0UL );
+  FD_TEST( parsed_vote->length==crds_val_sz );
+  FD_TEST( parsed_vote->vote->txn_sz==fd_gossip_test_vote_txn_sz );
+  FD_TEST( fd_memeq( txbuild->bytes+parsed_vote->vote->txn_off, fd_gossip_test_vote_txn, parsed_vote->vote->txn_sz ) );
+  FD_TEST( parsed_vote->wallclock_nanos==now );
+}
+
+int
+main( int     argc,
+      char ** argv ) {
+  fd_boot( &argc, &argv );
+  test_gossip_vote_enc();
+  FD_LOG_NOTICE(( "gossip vote encode test passed" ));
+  FD_LOG_NOTICE(( "All tests passed!" ));
+  return 0;
+}