tapdb+address: allow querying for last event height by version

We'll need to know the last block height we processed for any event
based on the address version.

Author: guggero

address/book.go

@@ -138,6 +138,11 @@ type Storage interface {
 	SetAddrManaged(ctx context.Context, addr *AddrWithKeyInfo,
 		managedFrom time.Time) error
 
+	// LastEventHeightByVersion returns the last event height for a given
+	// address version.
+	LastEventHeightByVersion(ctx context.Context,
+		version Version) (uint32, error)
+
 	// InsertInternalKey inserts an internal key into the database to make
 	// sure it is identified as a local key later on when importing proofs.
 	// The key can be an internal key for an asset script key or the
@@ -701,6 +706,14 @@ func (b *Book) SetAddrManaged(ctx context.Context, addr *AddrWithKeyInfo,
 	return b.cfg.Store.SetAddrManaged(ctx, addr, managedFrom)
 }
 
+// LastEventHeightByVersion returns the last event height for a given address
+// version.
+func (b *Book) LastEventHeightByVersion(ctx context.Context,
+	version Version) (uint32, error) {
+
+	return b.cfg.Store.LastEventHeightByVersion(ctx, version)
+}
+
 // GetOrCreateEvent creates a new address event for the given status, address
 // and transaction. If an event for that address and transaction already exists,
 // then the status and transaction information is updated instead.

address/book_test.go

@@ -146,8 +146,8 @@ func TestBook_QueryAssetInfo(t *testing.T) {
 		expectsError: false,
 	}}
 
-	for _, test := range tests {
-		t.Run(test.name, func(t *testing.T) {
+	for _, tc := range tests {
+		t.Run(tc.name, func(t *testing.T) {
 			mockStorage := &MockStorage{}
 			mockSyncer := &MockAssetSyncer{}
 			book := NewBook(BookConfig{
@@ -157,9 +157,9 @@ func TestBook_QueryAssetInfo(t *testing.T) {
 				Chain:        ChainParams{},
 				StoreTimeout: time.Second,
 			})
-			test.setupMocks(mockStorage, mockSyncer)
-			_, err := book.QueryAssetInfo(ctx, test.specifier)
-			if test.expectsError {
+			tc.setupMocks(mockStorage, mockSyncer)
+			_, err := book.QueryAssetInfo(ctx, tc.specifier)
+			if tc.expectsError {
 				require.Error(t, err)
 			} else {
 				require.NoError(t, err)
@@ -182,6 +182,13 @@ func (m *MockStorage) FetchAllAssetMeta(
 	return args.Get(0).(map[asset.ID]*proof.MetaReveal), args.Error(1)
 }
 
+func (m *MockStorage) LastEventHeightByVersion(ctx context.Context,
+	version Version) (uint32, error) {
+
+	args := m.Called(ctx, version)
+	return args.Get(0).(uint32), args.Error(1)
+}
+
 func (m *MockStorage) AddrByScriptKeyAndVersion(ctx context.Context,
 	key *btcec.PublicKey, version Version) (*AddrWithKeyInfo, error) {
 

tapdb/addrs.go

@@ -194,6 +194,11 @@ type AddrBook interface {
 	// FetchAllAssetMeta fetches all asset metadata records from the
 	// database.
 	FetchAllAssetMeta(ctx context.Context) ([]AllAssetMetaRow, error)
+
+	// QueryLastEventHeight queries the last event height for a given
+	// address version.
+	QueryLastEventHeight(ctx context.Context,
+		version int16) (int64, error)
 }
 
 // AddrBookTxOptions defines the set of db txn options the AddrBook
@@ -1101,6 +1106,26 @@ func (t *TapAddressBook) CompleteEvent(ctx context.Context,
 	})
 }
 
+// LastEventHeightByVersion returns the last event height for a given address
+// version.
+func (t *TapAddressBook) LastEventHeightByVersion(ctx context.Context,
+	version address.Version) (uint32, error) {
+
+	var lastHeight int64
+
+	readOpts := NewAssetStoreReadTx()
+	err := t.db.ExecTx(ctx, &readOpts, func(db AddrBook) error {
+		var err error
+		lastHeight, err = db.QueryLastEventHeight(ctx, int16(version))
+		return err
+	})
+	if err != nil {
+		return 0, err
+	}
+
+	return uint32(lastHeight), nil
+}
+
 // QueryAssetGroup attempts to fetch an asset group by its asset ID. If the
 // asset group cannot be found, then ErrAssetGroupUnknown is returned.
 func (t *TapAddressBook) QueryAssetGroup(ctx context.Context,

tapdb/addrs_test.go

@@ -431,6 +431,15 @@ func TestAddrEventCreation(t *testing.T) {
 
 	ctx := context.Background()
 
+	// Before we start, the last height for any version should be 0, as
+	// we don't have any events yet.
+	height, err := addrBook.LastEventHeightByVersion(ctx, address.V0)
+	require.NoError(t, err)
+	require.EqualValues(t, 0, height)
+	height, err = addrBook.LastEventHeightByVersion(ctx, address.V1)
+	require.NoError(t, err)
+	require.EqualValues(t, 0, height)
+
 	// Create 5 addresses and then events with unconfirmed transactions.
 	const numAddrs = 5
 	proofCourierAddr := address.RandProofCourierAddr(t)
@@ -498,18 +507,30 @@ func TestAddrEventCreation(t *testing.T) {
 
 	// Now we update the status of our event, make the transaction confirmed
 	// and set the tapscript sibling to nil for all of them.
-	for idx := range events {
+	maxHeightByVersion := make(map[address.Version]int32)
+	for idx, event := range events {
+		txn := txns[idx]
 		confirmTx(txns[idx])
 		events[idx].Status = address.StatusTransactionConfirmed
 		events[idx].ConfirmationHeight = uint32(txns[idx].BlockHeight)
 
 		actual, err := addrBook.GetOrCreateEvent(
 			ctx, address.StatusTransactionConfirmed,
-			events[idx].Addr, txns[idx], events[idx].Outpoint.Index,
+			event.Addr, txns[idx], events[idx].Outpoint.Index,
 		)
 		require.NoError(t, err)
 
 		assertEqualAddrEvent(t, *events[idx], *actual)
+
+		if maxHeightByVersion[event.Addr.Version] < txn.BlockHeight {
+			maxHeightByVersion[event.Addr.Version] = txn.BlockHeight
+		}
+	}
+
+	for version, maxHeight := range maxHeightByVersion {
+		height, err := addrBook.LastEventHeightByVersion(ctx, version)
+		require.NoError(t, err)
+		require.EqualValues(t, maxHeight, height)
 	}
 }
 

tapdb/sqlc/addrs.sql.go

@@ -174,3 +174,12 @@ WHERE addr_events.status >= @status_from
   AND COALESCE(@addr_taproot_key, addrs.taproot_output_key) = addrs.taproot_output_key
   AND addr_events.creation_time >= @created_after
 ORDER by addr_events.creation_time;
+
+-- name: QueryLastEventHeight :one
+SELECT cast(coalesce(max(chain_txns.block_height), 0) AS BIGINT) AS last_height
+FROM addr_events
+JOIN chain_txns
+    ON addr_events.chain_txn_id = chain_txns.txn_id
+JOIN addrs
+    ON addr_events.addr_id = addrs.id
+WHERE addrs.version = $1;