enhancement: refactor idb module

accounting/accounting.go

@@ -1,26 +1,24 @@
 package accounting
 
 import (
-	"github.com/algorand/go-algorand/data/basics"
-	"github.com/algorand/go-algorand/data/transactions"
-	"github.com/algorand/go-algorand/protocol"
+	sdk "github.com/algorand/go-algorand-sdk/types"
 )
 
 // GetTransactionParticipants calls function `add` for every address referenced in the
 // given transaction, possibly with repetition.
-func GetTransactionParticipants(stxnad *transactions.SignedTxnWithAD, includeInner bool, add func(address basics.Address)) {
+func GetTransactionParticipants(stxnad *sdk.SignedTxnWithAD, includeInner bool, add func(address sdk.Address)) {
 	txn := &stxnad.Txn
 
 	add(txn.Sender)
 
 	switch txn.Type {
-	case protocol.PaymentTx:
+	case sdk.PaymentTx:
 		add(txn.Receiver)
 		// Close address is optional.
 		if !txn.CloseRemainderTo.IsZero() {
 			add(txn.CloseRemainderTo)
 		}
-	case protocol.AssetTransferTx:
+	case sdk.AssetTransferTx:
 		// If asset sender is non-zero, it is a clawback transaction. Otherwise,
 		// the transaction sender address is used.
 		if !txn.AssetSender.IsZero() {
@@ -31,9 +29,9 @@ func GetTransactionParticipants(stxnad *transactions.SignedTxnWithAD, includeInn
 		if !txn.AssetCloseTo.IsZero() {
 			add(txn.AssetCloseTo)
 		}
-	case protocol.AssetFreezeTx:
+	case sdk.AssetFreezeTx:
 		add(txn.FreezeAccount)
-	case protocol.ApplicationCallTx:
+	case sdk.ApplicationCallTx:
 		for _, address := range txn.ApplicationCallTxnFields.Accounts {
 			add(address)
 		}

accounting/rewind.go

@@ -4,12 +4,11 @@ import (
 	"context"
 	"fmt"
 
-	"github.com/algorand/go-algorand/data/basics"
-	"github.com/algorand/go-algorand/data/transactions"
-	"github.com/algorand/go-algorand/protocol"
 	models "github.com/algorand/indexer/api/generated/v2"
-
 	"github.com/algorand/indexer/idb"
+	"github.com/algorand/indexer/types"
+
+	sdk "github.com/algorand/go-algorand-sdk/types"
 )
 
 // ConsistencyError is returned when the database returns inconsistent (stale) results.
@@ -60,15 +59,15 @@ func (sare *SpecialAccountRewindError) Error() string {
 	return fmt.Sprintf("unable to rewind the %s", sare.account)
 }
 
-var specialAccounts *transactions.SpecialAddresses
+var specialAccounts *types.SpecialAddresses
 
 // AccountAtRound queries the idb.IndexerDb object for transactions and rewinds most fields of the account back to
 // their values at the requested round.
 // `round` must be <= `account.Round`
 func AccountAtRound(ctx context.Context, account models.Account, round uint64, db idb.IndexerDb) (acct models.Account, err error) {
 	// Make sure special accounts cache has been initialized.
 	if specialAccounts == nil {
-		var accounts transactions.SpecialAddresses
+		var accounts types.SpecialAddresses
 		accounts, err = db.GetSpecialAccounts(ctx)
 		if err != nil {
 			return models.Account{}, fmt.Errorf("unable to get special accounts: %v", err)
@@ -77,8 +76,8 @@ func AccountAtRound(ctx context.Context, account models.Account, round uint64, d
 	}
 
 	acct = account
-	var addr basics.Address
-	addr, err = basics.UnmarshalChecksumAddress(account.Address)
+	var addr sdk.Address
+	addr, err = sdk.DecodeAddress(account.Address)
 	if err != nil {
 		return
 	}
@@ -126,34 +125,34 @@ func AccountAtRound(ctx context.Context, account models.Account, round uint64, d
 				fmt.Errorf("rewinding past inner transactions is not supported")
 		}
 		if addr == stxn.Txn.Sender {
-			acct.AmountWithoutPendingRewards += stxn.Txn.Fee.ToUint64()
-			acct.AmountWithoutPendingRewards -= stxn.SenderRewards.ToUint64()
+			acct.AmountWithoutPendingRewards += uint64(stxn.Txn.Fee)
+			acct.AmountWithoutPendingRewards -= uint64(stxn.SenderRewards)
 		}
 		switch stxn.Txn.Type {
-		case protocol.PaymentTx:
+		case sdk.PaymentTx:
 			if addr == stxn.Txn.Sender {
-				acct.AmountWithoutPendingRewards += stxn.Txn.Amount.ToUint64()
+				acct.AmountWithoutPendingRewards += uint64(stxn.Txn.Amount)
 			}
 			if addr == stxn.Txn.Receiver {
-				acct.AmountWithoutPendingRewards -= stxn.Txn.Amount.ToUint64()
-				acct.AmountWithoutPendingRewards -= stxn.ReceiverRewards.ToUint64()
+				acct.AmountWithoutPendingRewards -= uint64(stxn.Txn.Amount)
+				acct.AmountWithoutPendingRewards -= uint64(stxn.ReceiverRewards)
 			}
 			if addr == stxn.Txn.CloseRemainderTo {
 				// unwind receiving a close-to
-				acct.AmountWithoutPendingRewards -= stxn.ClosingAmount.ToUint64()
-				acct.AmountWithoutPendingRewards -= stxn.CloseRewards.ToUint64()
+				acct.AmountWithoutPendingRewards -= uint64(stxn.ClosingAmount)
+				acct.AmountWithoutPendingRewards -= uint64(stxn.CloseRewards)
 			} else if !stxn.Txn.CloseRemainderTo.IsZero() {
 				// unwind sending a close-to
-				acct.AmountWithoutPendingRewards += stxn.ClosingAmount.ToUint64()
+				acct.AmountWithoutPendingRewards += uint64(stxn.ClosingAmount)
 			}
-		case protocol.KeyRegistrationTx:
+		case sdk.KeyRegistrationTx:
 			// TODO: keyreg does not rewind. workaround: query for txns on an account with typeenum=2 to find previous values it was set to.
-		case protocol.AssetConfigTx:
+		case sdk.AssetConfigTx:
 			if stxn.Txn.ConfigAsset == 0 {
 				// create asset, unwind the application of the value
 				assetUpdate(&acct, txnrow.AssetID, 0, stxn.Txn.AssetParams.Total)
 			}
-		case protocol.AssetTransferTx:
+		case sdk.AssetTransferTx:
 			if addr == stxn.Txn.AssetSender || addr == stxn.Txn.Sender {
 				assetUpdate(&acct, uint64(stxn.Txn.XferAsset), stxn.Txn.AssetAmount+txnrow.Extra.AssetCloseAmount, 0)
 			}
@@ -163,7 +162,7 @@ func AccountAtRound(ctx context.Context, account models.Account, round uint64, d
 			if addr == stxn.Txn.AssetCloseTo {
 				assetUpdate(&acct, uint64(stxn.Txn.XferAsset), 0, txnrow.Extra.AssetCloseAmount)
 			}
-		case protocol.AssetFreezeTx:
+		case sdk.AssetFreezeTx:
 		default:
 			err = fmt.Errorf("%s[%d,%d]: rewinding past txn type %s is not currently supported", account.Address, txnrow.Round, txnrow.Intra, stxn.Txn.Type)
 			return

accounting/rewind_test.go

@@ -5,9 +5,10 @@ import (
 	"errors"
 	"testing"
 
+	sdk "github.com/algorand/go-algorand-sdk/types"
 	"github.com/algorand/go-algorand/data/basics"
 	"github.com/algorand/go-algorand/data/transactions"
-	"github.com/algorand/go-algorand/protocol"
+	"github.com/algorand/indexer/types"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/mock"
 
@@ -17,7 +18,7 @@ import (
 )
 
 func TestBasic(t *testing.T) {
-	var a basics.Address
+	var a sdk.Address
 	a[0] = 'a'
 
 	account := models.Account{
@@ -29,13 +30,13 @@ func TestBasic(t *testing.T) {
 
 	txnRow := idb.TxnRow{
 		Round: 7,
-		Txn: &transactions.SignedTxnWithAD{
-			SignedTxn: transactions.SignedTxn{
-				Txn: transactions.Transaction{
-					Type: protocol.PaymentTx,
-					PaymentTxnFields: transactions.PaymentTxnFields{
+		Txn: &sdk.SignedTxnWithAD{
+			SignedTxn: sdk.SignedTxn{
+				Txn: sdk.Transaction{
+					Type: sdk.PaymentTx,
+					PaymentTxnFields: sdk.PaymentTxnFields{
 						Receiver: a,
-						Amount:   basics.MicroAlgos{Raw: 2},
+						Amount:   sdk.MicroAlgos(2),
 					},
 				},
 			},
@@ -48,7 +49,7 @@ func TestBasic(t *testing.T) {
 	var outCh <-chan idb.TxnRow = ch
 
 	db := &mocks.IndexerDb{}
-	db.On("GetSpecialAccounts", mock.Anything).Return(transactions.SpecialAddresses{}, nil)
+	db.On("GetSpecialAccounts", mock.Anything).Return(types.SpecialAddresses{}, nil)
 	db.On("Transactions", mock.Anything, mock.Anything).Return(outCh, uint64(8))
 
 	account, err := AccountAtRound(context.Background(), account, 6, db)