Merge pull request #698 from oasisprotocol/andrew7234/consensus-accou…

…nt-stats Andrew7234/consensus account stats
oasisprotocol · May 22, 2024 · c6ebbe7 · c6ebbe7
2 parents 68cfa93 + 92ccea0
commit c6ebbe7
Show file tree

Hide file tree

Showing 19 changed files with 2,479 additions and 608 deletions.
diff --git a/.changelog/698.feature.md b/.changelog/698.feature.md
@@ -0,0 +1 @@
+api: add num_txns stat for consensus accounts
diff --git a/api/spec/v1.yaml b/api/spec/v1.yaml
@@ -2092,7 +2092,7 @@ components:
 
     Account:
       type: object
-      required: [address, nonce, available, escrow, debonding, allowances]
+      required: [address, nonce, available, escrow, debonding, allowances, stats]
       properties:
         address:
           type: string
@@ -2128,6 +2128,8 @@ components:
           items:
             allOf: [$ref: '#/components/schemas/Allowance']
           description: The allowances made by this account.
+        stats:
+          allOf: [$ref: '#/components/schemas/AccountStats']
       description: |
         A consensus layer account.
 
@@ -2966,7 +2968,7 @@ components:
 
     AccountStats:
       type: object
-      required: [total_sent, total_received, num_txns]
+      required: [num_txns]
       properties:
         total_sent:
           allOf: [$ref: '#/components/schemas/TextBigInt']

diff --git a/storage/client/client.go b/storage/client/client.go
@@ -817,6 +817,17 @@ func (c *StorageClient) Account(ctx context.Context, address staking.Address) (*
 		a.Allowances = append(a.Allowances, al)
 	}
 
+	err = c.db.QueryRow(
+		ctx,
+		queries.AccountStats,
+		address.String(),
+	).Scan(
+		&a.Stats.NumTxns,
+	)
+	if err != nil {
+		return nil, wrapError(err)
+	}
+
 	return &a, nil
 }
 
@@ -1736,8 +1747,8 @@ func (c *StorageClient) RuntimeAccount(ctx context.Context, address staking.Addr
 	case nil:
 	case pgx.ErrNoRows:
 		// If an account address has no activity, default to 0.
-		a.Stats.TotalSent = common.NewBigInt(0)
-		a.Stats.TotalReceived = common.NewBigInt(0)
+		a.Stats.TotalSent = common.Ptr(common.NewBigInt(0))
+		a.Stats.TotalReceived = common.Ptr(common.NewBigInt(0))
 		a.Stats.NumTxns = 0
 	default:
 		return nil, wrapError(err)

diff --git a/storage/client/queries/queries.go b/storage/client/queries/queries.go
@@ -191,6 +191,12 @@ const (
 		FROM chain.accounts
 		WHERE address = $1::text`
 
+	AccountStats = `
+		SELECT
+			COUNT(*)
+		FROM chain.accounts_related_transactions
+		WHERE account_address = $1::text`
+
 	AccountAllowances = `
 		SELECT beneficiary, allowance
 			FROM chain.allowances

diff --git a/tests/e2e_regression/common_test_cases.sh b/tests/e2e_regression/common_test_cases.sh
@@ -40,6 +40,7 @@ commonTestCases=(
   'blocks                             /v1/consensus/blocks'
   'bad_account                        /v1/consensus/accounts/oasis1aaaaaaa'
   'account                            /v1/consensus/accounts/oasis1qp0302fv0gz858azasg663ax2epakk5fcssgza7j'
+  'account_with_tx                    /v1/consensus/accounts/oasis1qpn83e8hm3gdhvpfv66xj3qsetkj3ulmkugmmxn3'
   'runtime-only_account               /v1/consensus/accounts/oasis1qphyxz5csvprhnn09r49nuyzl0jdw0wsj5xpvsg2'
   'delegations                        /v1/consensus/accounts/oasis1qpk366qvtjrfrthjp3xuej5mhvvtnkr8fy02hm2s/delegations'
   'delegations_to                     /v1/consensus/accounts/oasis1qp0j5v5mkxk3eg4kxfdsk8tj6p22g4685qk76fw6/delegations_to'

diff --git a/tests/e2e_regression/damask/expected/account.body b/tests/e2e_regression/damask/expected/account.body
@@ -6,5 +6,8 @@
   "debonding_delegations_balance": "0",
   "delegations_balance": "0",
   "escrow": "0",
-  "nonce": 5
+  "nonce": 5,
+  "stats": {
+    "num_txns": 0
+  }
 }
diff --git a/tests/e2e_regression/damask/expected/account_with_tx.body b/tests/e2e_regression/damask/expected/account_with_tx.body
@@ -0,0 +1,13 @@
+{
+  "address": "oasis1qpn83e8hm3gdhvpfv66xj3qsetkj3ulmkugmmxn3",
+  "allowances": [],
+  "available": "98499977445996",
+  "debonding": "12381788591465821",
+  "debonding_delegations_balance": "0",
+  "delegations_balance": "6250650662907336",
+  "escrow": "224562518782971131",
+  "nonce": 8,
+  "stats": {
+    "num_txns": 2
+  }
+}
diff --git a/tests/e2e_regression/damask/expected/account_with_tx.headers b/tests/e2e_regression/damask/expected/account_with_tx.headers
@@ -0,0 +1,6 @@
+HTTP/1.1 200 OK
+Content-Type: application/json
+Vary: Origin
+Date: UNINTERESTING
+Content-Length: UNINTERESTING
+