renamed stateProofVerificationData to SPVerificationContext

algorand · algorandskiy · Mar 30, 2023 · Oct 23, 2022 · Oct 23, 2022 · Oct 23, 2022
commit 4e01f819dafaeaedd1cac038d4eebc5bb641928d
diff --git a/cmd/tealdbg/localLedger.go b/cmd/tealdbg/localLedger.go
@@ -285,8 +285,8 @@ func (l *localLedger) BlockHdrCached(basics.Round) (bookkeeping.BlockHeader, err
 	return bookkeeping.BlockHeader{}, nil
 }
 
-func (l *localLedger) StateProofVerificationData(_ basics.Round) (*ledgercore.StateProofVerificationData, error) {
-	return nil, fmt.Errorf("localLedger: StateProofVerificationData is not implemented")
+func (l *localLedger) StateProofVerificationData(_ basics.Round) (*ledgercore.SPVerificationContext, error) {
+	return nil, fmt.Errorf("localLedger: SPVerificationContext is not implemented")
 }
 
 func (l *localLedger) CheckDup(config.ConsensusParams, basics.Round, basics.Round, basics.Round, transactions.Txid, ledgercore.Txlease) error {

diff --git a/daemon/algod/api/server/v2/dryrun.go b/daemon/algod/api/server/v2/dryrun.go
@@ -251,8 +251,8 @@ func (dl *dryrunLedger) CheckDup(config.ConsensusParams, basics.Round, basics.Ro
 	return nil
 }
 
-func (dl *dryrunLedger) StateProofVerificationData(_ basics.Round) (*ledgercore.StateProofVerificationData, error) {
-	return nil, fmt.Errorf("dryrunLedger: StateProofVerificationData is not implemented")
+func (dl *dryrunLedger) StateProofVerificationData(_ basics.Round) (*ledgercore.SPVerificationContext, error) {
+	return nil, fmt.Errorf("dryrunLedger: SPVerificationContext is not implemented")
 }
 
 func (dl *dryrunLedger) lookup(rnd basics.Round, addr basics.Address) (basics.AccountData, basics.Round, error) {

diff --git a/ledger/accountdb.go b/ledger/accountdb.go
@@ -5364,8 +5364,8 @@ func stateProofVerificationInitDbQueries(r db.Queryable) (*stateProofVerificatio
 	return qs, nil
 }
 
-func (qs *stateProofVerificationDbQueries) lookupData(stateProofLastAttestedRound basics.Round) (*ledgercore.StateProofVerificationData, error) {
-	data := ledgercore.StateProofVerificationData{}
+func (qs *stateProofVerificationDbQueries) lookupData(stateProofLastAttestedRound basics.Round) (*ledgercore.SPVerificationContext, error) {
+	data := ledgercore.SPVerificationContext{}
 	queryFunc := func() error {
 		row := qs.lookupStateProofVerificationData.QueryRow(stateProofLastAttestedRound)
 		var buf []byte

diff --git a/ledger/acctupdates.go b/ledger/acctupdates.go
@@ -831,7 +831,7 @@ func (aul *accountUpdatesLedgerEvaluator) VotersForStateProof(rnd basics.Round)
 	return aul.ao.voters.getVoters(rnd)
 }
 
-func (aul *accountUpdatesLedgerEvaluator) StateProofVerificationData(_ basics.Round) (*ledgercore.StateProofVerificationData, error) {
+func (aul *accountUpdatesLedgerEvaluator) StateProofVerificationData(_ basics.Round) (*ledgercore.SPVerificationContext, error) {
 	// this function should not be used by accountUpdatesLedgerEvaluator
 	return nil, fmt.Errorf("accountUpdatesLedgerEvaluator: tried to get stateProofVerification data during accountUpdates initialization ")
 }

diff --git a/ledger/apply/apply.go b/ledger/apply/apply.go
@@ -30,7 +30,7 @@ type StateProofsApplier interface {
 	BlockHdr(r basics.Round) (bookkeeping.BlockHeader, error)
 	GetStateProofNextRound() basics.Round
 	SetStateProofNextRound(rnd basics.Round)
-	StateProofVerificationData(stateProofLastAttestedRound basics.Round) (*ledgercore.StateProofVerificationData, error)
+	StateProofVerificationData(stateProofLastAttestedRound basics.Round) (*ledgercore.SPVerificationContext, error)
 }
 
 // Balances allow to move MicroAlgos from one address to another and to update balance records, or to access and modify individual balance records

diff --git a/ledger/apply/stateproof.go b/ledger/apply/stateproof.go
@@ -53,7 +53,7 @@ func StateProof(tx transactions.StateProofTxnFields, atRound basics.Round, sp St
 		return err
 	}
 
-	var verificationData *ledgercore.StateProofVerificationData
+	var verificationData *ledgercore.SPVerificationContext
 	if config.Consensus[atRoundHdr.CurrentProtocol].StateProofUseTrackerVerification {
 		verificationData, err = sp.StateProofVerificationData(lastRoundInInterval)
 	} else {
@@ -73,7 +73,7 @@ func StateProof(tx transactions.StateProofTxnFields, atRound basics.Round, sp St
 	return nil
 }
 
-func gatherVerificationDataUsingBlockHeaders(sp StateProofsApplier, lastRoundInInterval basics.Round) (*ledgercore.StateProofVerificationData, error) {
+func gatherVerificationDataUsingBlockHeaders(sp StateProofsApplier, lastRoundInInterval basics.Round) (*ledgercore.SPVerificationContext, error) {
 	lastRoundHdr, err := sp.BlockHdr(lastRoundInInterval)
 	if err != nil {
 		return nil, err
@@ -85,7 +85,7 @@ func gatherVerificationDataUsingBlockHeaders(sp StateProofsApplier, lastRoundInI
 		return nil, err
 	}
 
-	verificationData := ledgercore.StateProofVerificationData{
+	verificationData := ledgercore.SPVerificationContext{
 		LastAttestedRound: lastRoundInInterval,
 		VotersCommitment:  votersHdr.StateProofTracking[protocol.StateProofBasic].StateProofVotersCommitment,
 		OnlineTotalWeight: votersHdr.StateProofTracking[protocol.StateProofBasic].StateProofOnlineTotalWeight,

diff --git a/ledger/evalindexer.go b/ledger/evalindexer.go
@@ -214,9 +214,9 @@ func (l indexerLedgerConnector) VotersForStateProof(_ basics.Round) (*ledgercore
 }
 
 // StateProofVerificationData is part of LedgerForEvaluator interface.
-func (l indexerLedgerConnector) StateProofVerificationData(_ basics.Round) (*ledgercore.StateProofVerificationData, error) {
+func (l indexerLedgerConnector) StateProofVerificationData(_ basics.Round) (*ledgercore.SPVerificationContext, error) {
 	// This function is not used by evaluator.
-	return nil, errors.New("StateProofVerificationData() not implemented")
+	return nil, errors.New("SPVerificationContext() not implemented")
 }
 
 func makeIndexerLedgerConnector(il indexerLedgerForEval, genesisHash crypto.Digest, genesisProto config.ConsensusParams, latestRound basics.Round, roundResources EvalForIndexerResources) indexerLedgerConnector {

diff --git a/ledger/internal/appcow_test.go b/ledger/internal/appcow_test.go
@@ -107,8 +107,8 @@ func (ml *emptyLedger) GetStateProofNextRound() basics.Round {
 	return basics.Round(0)
 }
 
-func (ml *emptyLedger) StateProofVerificationData(_ basics.Round) (*ledgercore.StateProofVerificationData, error) {
-	return nil, fmt.Errorf("emptyLedger does not implement StateProofVerificationData")
+func (ml *emptyLedger) StateProofVerificationData(_ basics.Round) (*ledgercore.SPVerificationContext, error) {
+	return nil, fmt.Errorf("emptyLedger does not implement SPVerificationContext")
 }
 
 type modsData struct {

diff --git a/ledger/internal/cow.go b/ledger/internal/cow.go
@@ -63,7 +63,7 @@ type roundCowParent interface {
 	allocated(addr basics.Address, aidx basics.AppIndex, global bool) (bool, error)
 	getKey(addr basics.Address, aidx basics.AppIndex, global bool, key string, accountIdx uint64) (basics.TealValue, bool, error)
 	kvGet(key string) ([]byte, bool, error)
-	StateProofVerificationData(stateProofLastAttestedRound basics.Round) (*ledgercore.StateProofVerificationData, error)
+	StateProofVerificationData(stateProofLastAttestedRound basics.Round) (*ledgercore.SPVerificationContext, error)
 }
 
 type roundCowState struct {
@@ -241,7 +241,7 @@ func (cb *roundCowState) BlockHdr(r basics.Round) (bookkeeping.BlockHeader, erro
 	return cb.lookupParent.BlockHdr(r)
 }
 
-func (cb *roundCowState) StateProofVerificationData(stateProofLastAttestedRound basics.Round) (*ledgercore.StateProofVerificationData, error) {
+func (cb *roundCowState) StateProofVerificationData(stateProofLastAttestedRound basics.Round) (*ledgercore.SPVerificationContext, error) {
 	return cb.lookupParent.StateProofVerificationData(stateProofLastAttestedRound)
 }
 

diff --git a/ledger/internal/cow_test.go b/ledger/internal/cow_test.go
@@ -36,7 +36,7 @@ type mockLedger struct {
 	balanceMap             map[basics.Address]basics.AccountData
 	blocks                 map[basics.Round]bookkeeping.BlockHeader
 	blockErr               map[basics.Round]error
-	stateProofVerification map[basics.Round]*ledgercore.StateProofVerificationData
+	stateProofVerification map[basics.Round]*ledgercore.SPVerificationContext
 }
 
 func (ml *mockLedger) lookup(addr basics.Address) (ledgercore.AccountData, error) {
@@ -112,7 +112,7 @@ func (ml *mockLedger) blockHdrCached(rnd basics.Round) (bookkeeping.BlockHeader,
 	return ml.blockHdrCached(rnd)
 }
 
-func (ml *mockLedger) StateProofVerificationData(rnd basics.Round) (*ledgercore.StateProofVerificationData, error) {
+func (ml *mockLedger) StateProofVerificationData(rnd basics.Round) (*ledgercore.SPVerificationContext, error) {
 	element, exists := ml.stateProofVerification[rnd]
 	if !exists {
 		return nil, fmt.Errorf("requested state proof verification data not found")

diff --git a/ledger/internal/eval.go b/ledger/internal/eval.go
@@ -47,7 +47,7 @@ type LedgerForCowBase interface {
 	LookupApplication(basics.Round, basics.Address, basics.AppIndex) (ledgercore.AppResource, error)
 	LookupKv(basics.Round, string) ([]byte, error)
 	GetCreatorForRound(basics.Round, basics.CreatableIndex, basics.CreatableType) (basics.Address, bool, error)
-	StateProofVerificationData(stateProofLastAttestedRound basics.Round) (*ledgercore.StateProofVerificationData, error)
+	StateProofVerificationData(stateProofLastAttestedRound basics.Round) (*ledgercore.SPVerificationContext, error)
 }
 
 // ErrRoundZero is self-explanatory
@@ -338,7 +338,7 @@ func (x *roundCowBase) BlockHdr(r basics.Round) (bookkeeping.BlockHeader, error)
 	return x.l.BlockHdr(r)
 }
 
-func (x *roundCowBase) StateProofVerificationData(stateProofLastAttestedRound basics.Round) (*ledgercore.StateProofVerificationData, error) {
+func (x *roundCowBase) StateProofVerificationData(stateProofLastAttestedRound basics.Round) (*ledgercore.SPVerificationContext, error) {
 	return x.l.StateProofVerificationData(stateProofLastAttestedRound)
 }
 

diff --git a/ledger/internal/eval_test.go b/ledger/internal/eval_test.go
@@ -327,7 +327,7 @@ func TestCowStateProof(t *testing.T) {
 	c0 := makeRoundCowState(
 		&ml, bookkeeping.BlockHeader{}, config.Consensus[protocol.ConsensusFuture],
 		0, ledgercore.AccountTotals{}, 0)
-	ml.stateProofVerification = make(map[basics.Round]*ledgercore.StateProofVerificationData)
+	ml.stateProofVerification = make(map[basics.Round]*ledgercore.SPVerificationContext)
 
 	spType = protocol.StateProofType(1234) // bad stateproof type
 	stateProofTx := transactions.StateProofTxnFields{
@@ -375,7 +375,7 @@ func TestCowStateProof(t *testing.T) {
 	blockErr[256] = noBlockErr
 	stateProofTx.Message.LastAttestedRound = 512
 	stateProofTx.StateProof.SignedWeight = 100
-	ml.stateProofVerification[basics.Round(stateProofTx.Message.LastAttestedRound)] = &ledgercore.StateProofVerificationData{
+	ml.stateProofVerification[basics.Round(stateProofTx.Message.LastAttestedRound)] = &ledgercore.SPVerificationContext{
 		LastAttestedRound: basics.Round(stateProofTx.Message.LastAttestedRound),
 		VotersCommitment:  []byte{0x1}[:],
 		OnlineTotalWeight: basics.MicroAlgos{Raw: 5},
@@ -719,8 +719,8 @@ func (ledger *evalTestLedger) Latest() basics.Round {
 	return basics.Round(len(ledger.blocks)).SubSaturate(1)
 }
 
-func (ledger *evalTestLedger) StateProofVerificationData(_ basics.Round) (*ledgercore.StateProofVerificationData, error) {
-	return nil, fmt.Errorf("evalTestLedger does not implement StateProofVerificationData")
+func (ledger *evalTestLedger) StateProofVerificationData(_ basics.Round) (*ledgercore.SPVerificationContext, error) {
+	return nil, fmt.Errorf("evalTestLedger does not implement SPVerificationContext")
 }
 
 // AddValidatedBlock adds a new block to the ledger, after the block has
@@ -898,8 +898,8 @@ func (l *testCowBaseLedger) LookupKv(rnd basics.Round, key string) ([]byte, erro
 	return nil, errors.New("not implemented")
 }
 
-func (l *testCowBaseLedger) StateProofVerificationData(_ basics.Round) (*ledgercore.StateProofVerificationData, error) {
-	return nil, fmt.Errorf("testCowBaseLedger does not implement StateProofVerificationData")
+func (l *testCowBaseLedger) StateProofVerificationData(_ basics.Round) (*ledgercore.SPVerificationContext, error) {
+	return nil, fmt.Errorf("testCowBaseLedger does not implement SPVerificationContext")
 }
 
 func (l *testCowBaseLedger) GetCreatorForRound(_ basics.Round, cindex basics.CreatableIndex, ctype basics.CreatableType) (basics.Address, bool, error) {

diff --git a/ledger/internal/prefetcher/prefetcher_alignment_test.go b/ledger/internal/prefetcher/prefetcher_alignment_test.go
@@ -103,8 +103,8 @@ func (l *prefetcherAlignmentTestLedger) CheckDup(config.ConsensusParams, basics.
 	return nil
 }
 
-func (l *prefetcherAlignmentTestLedger) StateProofVerificationData(_ basics.Round) (*ledgercore.StateProofVerificationData, error) {
-	return nil, fmt.Errorf("prefetcherAlignmentTestLedger does not implement StateProofVerificationData")
+func (l *prefetcherAlignmentTestLedger) StateProofVerificationData(_ basics.Round) (*ledgercore.SPVerificationContext, error) {
+	return nil, fmt.Errorf("prefetcherAlignmentTestLedger does not implement SPVerificationContext")
 }
 
 func (l *prefetcherAlignmentTestLedger) LookupWithoutRewards(_ basics.Round, addr basics.Address) (ledgercore.AccountData, basics.Round, error) {

diff --git a/ledger/ledger.go b/ledger/ledger.go
@@ -456,7 +456,7 @@ func (l *Ledger) VotersForStateProof(rnd basics.Round) (*ledgercore.VotersForRou
 
 // StateProofVerificationData returns the data required to verify the state proof whose last attested round is
 // stateProofLastAttestedRound.
-func (l *Ledger) StateProofVerificationData(stateProofLastAttestedRound basics.Round) (*ledgercore.StateProofVerificationData, error) {
+func (l *Ledger) StateProofVerificationData(stateProofLastAttestedRound basics.Round) (*ledgercore.SPVerificationContext, error) {
 	l.trackerMu.RLock()
 	defer l.trackerMu.RUnlock()
 	return l.stateProofVerification.LookupVerificationData(stateProofLastAttestedRound)

diff --git a/ledger/ledgercore/msgp_gen.go b/ledger/ledgercore/msgp_gen.go
diff --git a/ledger/ledgercore/msgp_gen_test.go b/ledger/ledgercore/msgp_gen_test.go
diff --git a/ledger/ledgercore/stateproofverification.go b/ledger/ledgercore/stateproofverification.go
@@ -22,8 +22,8 @@ import (
 	"github.com/algorand/go-algorand/protocol"
 )
 
-// StateProofVerificationData represents the data provided by the ledger to verify a state proof transaction.
-type StateProofVerificationData struct {
+// SPVerificationContext represents the context provided by the ledger to verify a state proof transaction.
+type SPVerificationContext struct {
 	_struct struct{} `codec:",omitempty,omitemptyarray"`
 
 	// LastAttestedRound is the last attested round of the state proof verified using this data.