Eval: Prefetching for heartbeat transactions (#6182)

Author: jannotti

daemon/algod/api/algod.oas2.json

@@ -245,7 +245,7 @@
     },
     "/v2/accounts/{address}": {
       "get": {
-        "description": "Given a specific account public key, this call returns the accounts status, balance and spendable amounts",
+        "description": "Given a specific account public key, this call returns the account's status, balance and spendable amounts",
         "tags": [
           "public",
           "nonparticipating"

daemon/algod/api/algod.oas3.yml

@@ -2978,7 +2978,7 @@
     },
     "/v2/accounts/{address}": {
       "get": {
-        "description": "Given a specific account public key, this call returns the accounts status, balance and spendable amounts",
+        "description": "Given a specific account public key, this call returns the account's status, balance and spendable amounts",
         "operationId": "AccountInformation",
         "parameters": [
           {

daemon/algod/api/server/v2/generated/nonparticipating/public/routes.go

@@ -3218,7 +3218,21 @@ func TestIllegalOp(t *testing.T) {
 	}
 }
 
-func TestShortProgram(t *testing.T) {
+func TestShortSimple(t *testing.T) {
+	partitiontest.PartitionTest(t)
+
+	t.Parallel()
+	for v := uint64(1); v <= AssemblerMaxVersion; v++ {
+		t.Run(fmt.Sprintf("v=%d", v), func(t *testing.T) {
+			ops := testProg(t, `int 8; store 7`, v)
+			testLogicBytes(t, ops.Program[:len(ops.Program)-1], nil,
+				"program ends short of immediate values",
+				"program ends short of immediate values")
+		})
+	}
+}
+
+func TestShortBranch(t *testing.T) {
 	partitiontest.PartitionTest(t)
 
 	t.Parallel()

data/transactions/logic/eval_test.go

@@ -325,7 +325,7 @@ func (tx Header) Alive(tc TxnContext) error {
 
 // MatchAddress checks if the transaction touches a given address.
 func (tx Transaction) MatchAddress(addr basics.Address, spec SpecialAddresses) bool {
-	return slices.Contains(tx.RelevantAddrs(spec), addr)
+	return slices.Contains(tx.relevantAddrs(spec), addr)
 }
 
 var errKeyregTxnFirstVotingRoundGreaterThanLastVotingRound = errors.New("transaction first voting round need to be less than its last voting round")
@@ -714,9 +714,8 @@ func (tx Header) Last() basics.Round {
 	return tx.LastValid
 }
 
-// RelevantAddrs returns the addresses whose balance records this transaction will need to access.
-// The header's default is to return just the sender and the fee sink.
-func (tx Transaction) RelevantAddrs(spec SpecialAddresses) []basics.Address {
+// relevantAddrs returns the addresses whose balance records this transaction will need to access.
+func (tx Transaction) relevantAddrs(spec SpecialAddresses) []basics.Address {
 	addrs := []basics.Address{tx.Sender, spec.FeeSink}
 
 	switch tx.Type {
@@ -733,6 +732,8 @@ func (tx Transaction) RelevantAddrs(spec SpecialAddresses) []basics.Address {
 		if !tx.AssetTransferTxnFields.AssetSender.IsZero() {
 			addrs = append(addrs, tx.AssetTransferTxnFields.AssetSender)
 		}
+	case protocol.HeartbeatTx:
+		addrs = append(addrs, tx.HeartbeatTxnFields.HbAddress)
 	}
 
 	return addrs

data/transactions/transaction.go

@@ -1612,6 +1612,10 @@ func (eval *BlockEvaluator) recordProposal() error {
 	return nil
 }
 
+// proposerPayout determines how much the proposer should be paid, assuming it
+// gets paid at all.  It may not examine the actual proposer because it is
+// called before the proposer is known.  Agreement might zero out this value
+// when the actual proposer is decided, if that proposer is ineligible.
 func (eval *BlockEvaluator) proposerPayout() (basics.MicroAlgos, error) {
 	incentive, _ := basics.NewPercent(eval.proto.Payouts.Percent).DivvyAlgos(eval.block.FeesCollected)
 	total, o := basics.OAddA(incentive, eval.block.Bonus)

ledger/eval/eval.go

@@ -343,7 +343,9 @@ func (p *accountPrefetcher) prefetch(ctx context.Context) {
 				// since they might be non-used arbitrary values
 
 			case protocol.StateProofTx:
-			case protocol.KeyRegistrationTx:
+			case protocol.KeyRegistrationTx: // No extra accounts besides the sender
+			case protocol.HeartbeatTx:
+				loadAccountsAddAccountTask(&stxn.Txn.HbAddress, task, accountTasks, queue)
 			}
 
 			// If you add new addresses here, also add them in getTxnAddresses().

ledger/eval/prefetcher/prefetcher.go

@@ -30,6 +30,7 @@ import (
 	"github.com/algorand/go-algorand/crypto/stateproof"
 	"github.com/algorand/go-algorand/data/basics"
 	"github.com/algorand/go-algorand/data/bookkeeping"
+	"github.com/algorand/go-algorand/data/committee"
 	"github.com/algorand/go-algorand/data/stateproofmsg"
 	"github.com/algorand/go-algorand/data/transactions"
 	"github.com/algorand/go-algorand/ledger/eval"
@@ -1422,3 +1423,54 @@ func TestEvaluatorPrefetcherAlignmentStateProof(t *testing.T) {
 	prefetched.pretend(rewardsPool())
 	require.Equal(t, requested, prefetched)
 }
+
+func TestEvaluatorPrefetcherAlignmentHeartbeat(t *testing.T) {
+	partitiontest.PartitionTest(t)
+
+	// We need valid part keys to evaluate the Heartbeat.
+	const kd = 10
+	firstID := basics.OneTimeIDForRound(0, kd)
+	otss := crypto.GenerateOneTimeSignatureSecrets(firstID.Batch, 5)
+
+	l := &prefetcherAlignmentTestLedger{
+		balances: map[basics.Address]ledgercore.AccountData{
+			rewardsPool(): {
+				AccountBaseData: ledgercore.AccountBaseData{
+					MicroAlgos: basics.MicroAlgos{Raw: 1234567890},
+				},
+			},
+			makeAddress(1): {
+				AccountBaseData: ledgercore.AccountBaseData{
+					MicroAlgos: basics.MicroAlgos{Raw: 1000001},
+				},
+			},
+			makeAddress(2): {
+				AccountBaseData: ledgercore.AccountBaseData{
+					MicroAlgos: basics.MicroAlgos{Raw: 100_000},
+				},
+				VotingData: basics.VotingData{
+					VoteID: otss.OneTimeSignatureVerifier,
+				},
+			},
+		},
+	}
+
+	txn := transactions.Transaction{
+		Type: protocol.HeartbeatTx,
+		Header: transactions.Header{
+			Sender:      makeAddress(1),
+			GenesisHash: genesisHash(),
+			Fee:         basics.Algos(1), // Heartbeat txn is unusual in that it checks fees a bit.
+		},
+		HeartbeatTxnFields: transactions.HeartbeatTxnFields{
+			HbAddress: makeAddress(2),
+			HbProof:   otss.Sign(firstID, committee.Seed(genesisHash())).ToHeartbeatProof(),
+			HbSeed:    committee.Seed(genesisHash()),
+		},
+	}
+
+	requested, prefetched := run(t, l, txn)
+
+	prefetched.pretend(rewardsPool())
+	require.Equal(t, requested, prefetched)
+}