Skip to content

API: Filtering for fields with 0 values #1670

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gmalouf wants to merge 2 commits into
base: main
Choose a base branch
from
Open

API: Filtering for fields with 0 values #1670

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5ed4104
Custom handle asset_id=0 and application_id=0 queries to detect creat…
gmalouf Aug 7, 2025
97446da
Support better currency less than filtering for algo transfers specif…
gmalouf Aug 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
150 changes: 150 additions & 0 deletions api/handlers_e2e_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2826,3 +2826,153 @@ func TestTxnSearchByGroupID(t *testing.T) {
}
}
}

// TestApplicationCreationZeroValueFilteringE2E tests application creation zero-value filtering
// end-to-end with real application transaction data.
func TestApplicationCreationZeroValueFilteringE2E(t *testing.T) {
db, shutdownFunc := setupIdb(t, test.MakeGenesis())
defer shutdownFunc()

// Load test data that contains application creation transactions
vb, err := test.ReadValidatedBlockFromFile("test_resources/validated_blocks/ApplicationHandlers.vb")
require.NoError(t, err)
err = db.AddBlock(&vb)
require.NoError(t, err)

api := testServerImplementation(db)

t.Run("application-id=0 should find app creation transactions", func(t *testing.T) {
// First, get all application transactions to establish baseline
e := echo.New()
req := httptest.NewRequest(http.MethodGet, "/v2/transactions?tx-type=appl", nil)
rec := httptest.NewRecorder()
c := e.NewContext(req, rec)

txType := generated.SearchForTransactionsParamsTxType("appl")
params := generated.SearchForTransactionsParams{TxType: &txType}
err := api.SearchForTransactions(c, params)
require.NoError(t, err)
require.Equal(t, http.StatusOK, rec.Code)

var allApplResponse generated.TransactionsResponse
err = json.Decode(rec.Body.Bytes(), &allApplResponse)
require.NoError(t, err)

// Find transactions that have ApplicationID=0 (creation transactions)
var creationTransactions []generated.Transaction
for _, txn := range allApplResponse.Transactions {
if txn.ApplicationTransaction != nil && txn.ApplicationTransaction.ApplicationId == 0 {
creationTransactions = append(creationTransactions, txn)
}
}

// Fail the test if we don't have creation transactions in the test data
// This ensures we're actually testing what we claim to test
require.Greater(t, len(creationTransactions), 0,
"Test data must contain application creation transactions to validate application-id=0 filtering")

// Now test the zero-value filtering
req2 := httptest.NewRequest(http.MethodGet, "/v2/transactions?application-id=0", nil)
rec2 := httptest.NewRecorder()
c2 := e.NewContext(req2, rec2)

applicationID := uint64(0)
params2 := generated.SearchForTransactionsParams{ApplicationId: &applicationID}
err = api.SearchForTransactions(c2, params2)
require.NoError(t, err)
require.Equal(t, http.StatusOK, rec2.Code)

var filteredResponse generated.TransactionsResponse
err = json.Decode(rec2.Body.Bytes(), &filteredResponse)
require.NoError(t, err)

// After our fix, this should find the creation transactions
assert.Equal(t, len(creationTransactions), len(filteredResponse.Transactions),
"application-id=0 filter should return the same number of transactions as creation transactions found")

// Verify all returned transactions are application creation transactions
for _, txn := range filteredResponse.Transactions {
require.NotNil(t, txn.ApplicationTransaction, "All filtered transactions should be application transactions")
assert.Equal(t, uint64(0), txn.ApplicationTransaction.ApplicationId,
"All filtered transactions should have ApplicationID=0 (creation transactions)")
}
})
}

// TestAssetCreationZeroValueFilteringE2E tests asset creation zero-value filtering
// end-to-end with real asset transaction data.
func TestAssetCreationZeroValueFilteringE2E(t *testing.T) {
db, shutdownFunc := setupIdb(t, test.MakeGenesis())
defer shutdownFunc()

// Load test data that contains asset creation transactions
vb, err := test.ReadValidatedBlockFromFile("test_resources/validated_blocks/AssetHoldings1.vb")
require.NoError(t, err)
err = db.AddBlock(&vb)
require.NoError(t, err)

api := testServerImplementation(db)

t.Run("asset-id=0 should find asset creation transactions", func(t *testing.T) {
// First, get all asset config transactions to see what we have
e := echo.New()
req := httptest.NewRequest(http.MethodGet, "/v2/transactions?tx-type=acfg", nil)
rec := httptest.NewRecorder()
c := e.NewContext(req, rec)

txType := generated.SearchForTransactionsParamsTxType("acfg")
params := generated.SearchForTransactionsParams{TxType: &txType}
err := api.SearchForTransactions(c, params)
require.NoError(t, err)
require.Equal(t, http.StatusOK, rec.Code)

var allAssetConfigResponse generated.TransactionsResponse
err = json.Decode(rec.Body.Bytes(), &allAssetConfigResponse)
require.NoError(t, err)

// Look for asset creation transactions (where the transaction creates a new asset)
var assetCreationTransactions []generated.Transaction
for _, txn := range allAssetConfigResponse.Transactions {
if txn.AssetConfigTransaction != nil {
// Asset creation transactions have AssetId=0 and a non-zero CreatedAssetIndex
if txn.AssetConfigTransaction.AssetId != nil && *txn.AssetConfigTransaction.AssetId == 0 &&
txn.CreatedAssetIndex != nil && *txn.CreatedAssetIndex > 0 {
assetCreationTransactions = append(assetCreationTransactions, txn)
}
}
}

// Fail the test if we don't have asset creation transactions in the test data
// This ensures we're actually testing what we claim to test
require.Greater(t, len(assetCreationTransactions), 0,
"Test data must contain asset creation transactions to validate asset-id=0 filtering")

// Now test the zero-value filtering
req2 := httptest.NewRequest(http.MethodGet, "/v2/transactions?asset-id=0", nil)
rec2 := httptest.NewRecorder()
c2 := e.NewContext(req2, rec2)

assetID := uint64(0)
params2 := generated.SearchForTransactionsParams{AssetId: &assetID}
err = api.SearchForTransactions(c2, params2)
require.NoError(t, err)
require.Equal(t, http.StatusOK, rec2.Code)

var filteredResponse generated.TransactionsResponse
err = json.Decode(rec2.Body.Bytes(), &filteredResponse)
require.NoError(t, err)

// After our fix, this should find the creation transactions
assert.Equal(t, len(assetCreationTransactions), len(filteredResponse.Transactions),
"asset-id=0 filter should return the same number of transactions as asset creation transactions found")

// Verify all returned transactions are asset creation transactions
for _, txn := range filteredResponse.Transactions {
if txn.AssetConfigTransaction != nil {
require.NotNil(t, txn.AssetConfigTransaction.AssetId, "AssetConfigTransaction.AssetId should not be nil")
assert.Equal(t, uint64(0), *txn.AssetConfigTransaction.AssetId,
"All filtered transactions should have AssetId=0 (creation transactions)")
}
}
})
}
64 changes: 57 additions & 7 deletions idb/postgres/postgres.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -590,27 +590,75 @@ func buildTransactionQuery(tf idb.TransactionFilter) (query string, whereArgs []
}
if tf.AssetID != nil || tf.ApplicationID != nil {
var creatableID uint64
var isApplicationID bool
if tf.AssetID != nil {
creatableID = *tf.AssetID
isApplicationID = false
if tf.ApplicationID != nil {
if *tf.AssetID != *tf.ApplicationID {
return "", nil, fmt.Errorf("cannot search both assetid and appid")
}
isApplicationID = true // Both are set with same value
}
} else {
creatableID = *tf.ApplicationID
isApplicationID = true
}

// For zero values, we need to query the original JSON field to find creation transactions
// For non-zero values, we can use the optimized t.asset column
if creatableID == 0 {
if isApplicationID {
// ApplicationID=0 means application creation - query the original field
// We also need to restrict to application call transactions
whereParts = append(whereParts, fmt.Sprintf("t.typeenum = $%d", partNumber))
whereArgs = append(whereArgs, int(idb.TypeEnumApplication))
partNumber++

// For application creation, the apid field might be 0, null, or missing
// We check for all these cases
whereParts = append(whereParts, fmt.Sprintf("((t.txn -> 'txn' -> 'apid')::bigint = $%d OR (t.txn -> 'txn' -> 'apid') IS NULL)", partNumber))
whereArgs = append(whereArgs, creatableID)
partNumber++
} else {
// AssetID=0 can mean:
// 1. Asset transfers of Algos (XferAsset=0) - these work with t.asset=0
// 2. Asset creation (ConfigAsset=0) - these need original field query
// We need to handle both cases with an OR condition
whereParts = append(whereParts, fmt.Sprintf("(t.asset = $%d OR (t.typeenum = $%d AND ((t.txn -> 'txn' -> 'caid')::bigint = $%d OR (t.txn -> 'txn' -> 'caid') IS NULL)))", partNumber, partNumber+1, partNumber+2))
whereArgs = append(whereArgs, creatableID) // For asset transfers (XferAsset=0)
whereArgs = append(whereArgs, int(idb.TypeEnumAssetConfig)) // Asset creation transactions
whereArgs = append(whereArgs, creatableID) // For asset creation (ConfigAsset=0)
partNumber += 3
}
} else {
// Non-zero values: continue using the optimized t.asset column
whereParts = append(whereParts, fmt.Sprintf("t.asset = $%d", partNumber))
whereArgs = append(whereArgs, creatableID)
partNumber++
}
whereParts = append(whereParts, fmt.Sprintf("t.asset = $%d", partNumber))
whereArgs = append(whereArgs, creatableID)
partNumber++
}
if tf.AssetAmountGT != nil {
whereParts = append(whereParts, fmt.Sprintf("(t.txn -> 'txn' -> 'aamt')::numeric(20) > $%d", partNumber))
// Handle asset amount filtering with proper field selection and NULL handling
if tf.AssetID != nil && *tf.AssetID == 0 {
// For Algo transfers (asset-id=0), use the 'amt' field with COALESCE
whereParts = append(whereParts, fmt.Sprintf("COALESCE((t.txn -> 'txn' -> 'amt')::bigint, 0) > $%d", partNumber))
} else {
// For asset transfers, use the 'aamt' field with COALESCE
whereParts = append(whereParts, fmt.Sprintf("COALESCE((t.txn -> 'txn' -> 'aamt')::numeric(20), 0) > $%d", partNumber))
}
whereArgs = append(whereArgs, *tf.AssetAmountGT)
partNumber++
}
if tf.AssetAmountLT != nil {
whereParts = append(whereParts, fmt.Sprintf("(t.txn -> 'txn' -> 'aamt')::numeric(20) < $%d", partNumber))
// Handle asset amount filtering with proper field selection and NULL handling
if tf.AssetID != nil && *tf.AssetID == 0 {
// For Algo transfers (asset-id=0), use the 'amt' field with COALESCE
whereParts = append(whereParts, fmt.Sprintf("COALESCE((t.txn -> 'txn' -> 'amt')::bigint, 0) < $%d", partNumber))
} else {
// For asset transfers, use the 'aamt' field with COALESCE
whereParts = append(whereParts, fmt.Sprintf("COALESCE((t.txn -> 'txn' -> 'aamt')::numeric(20), 0) < $%d", partNumber))
}
whereArgs = append(whereArgs, *tf.AssetAmountLT)
partNumber++
}
Expand Down Expand Up @@ -660,12 +708,14 @@ func buildTransactionQuery(tf idb.TransactionFilter) (query string, whereArgs []
partNumber++
}
if tf.AlgosGT != nil {
whereParts = append(whereParts, fmt.Sprintf("(t.txn -> 'txn' -> 'amt')::bigint > $%d", partNumber))
// Handle Algo amount filtering with COALESCE for NULL values
whereParts = append(whereParts, fmt.Sprintf("COALESCE((t.txn -> 'txn' -> 'amt')::bigint, 0) > $%d", partNumber))
whereArgs = append(whereArgs, *tf.AlgosGT)
partNumber++
}
if tf.AlgosLT != nil {
whereParts = append(whereParts, fmt.Sprintf("(t.txn -> 'txn' -> 'amt')::bigint < $%d", partNumber))
// Handle Algo amount filtering with COALESCE for NULL values
whereParts = append(whereParts, fmt.Sprintf("COALESCE((t.txn -> 'txn' -> 'amt')::bigint, 0) < $%d", partNumber))
whereArgs = append(whereArgs, *tf.AlgosLT)
partNumber++
}
Expand Down
Loading
Loading