fix: pwr mint burn collector (#72)

Author: fmorency

cmd/yaci/postgres_test.go

@@ -60,8 +60,8 @@ func testExtractBlocksAndTxs(t *testing.T) {
 
 		transactions := getJSONResponse(t, RestTxEndpoint, nil)
 		require.NotEmpty(t, transactions)
-		// The number of transactions is 42 as defined in the `compose.yaml` file under the `manifest-ledger-tx` service
-		require.Len(t, transactions, 42)
+		// The number of transactions is 48 as defined in the `compose.yaml` file under the `manifest-ledger-tx` service
+		require.Len(t, transactions, 48)
 	})
 }
 
@@ -181,13 +181,16 @@ func testPrometheusMetrics(t *testing.T) {
 		body := string(resp.Body())
 		require.Contains(t, body, "yaci_addresses_total_unique_user{source=\"postgres\"} 3")
 		require.Contains(t, body, "yaci_addresses_total_unique_group{source=\"postgres\"} 3")
-		require.Contains(t, body, "yaci_transactions_total_count{source=\"postgres\"} 42")
+		require.Contains(t, body, "yaci_transactions_total_count{source=\"postgres\"} 48")
 		// 3000000umfx were burned by the MFX to PWR conversion
 		// 123umfx were burned by a POA proposal
 		require.Contains(t, body, "yaci_tokenomics_total_burn_amount{source=\"postgres\"} 3.000123e+06")
 		require.Contains(t, body, "yaci_tokenomics_total_payout_amount{source=\"postgres\"} 7.54321e+06")
 		// 6000000factory/.../upwr were minted by the MFX to PWR conversion
-		require.Contains(t, body, "yaci_tokenomics_total_pwr_minted_amount{source=\"postgres\"} 6e+06")
+		// 123factory/.../upwr were minted by a POA proposal
+		require.Contains(t, body, "yaci_tokenomics_total_pwr_minted_amount{source=\"postgres\"} 6.000123e+06")
+		// 12factory/.../upwr were burned by a POA proposal
+		require.Contains(t, body, "yaci_tokenomics_total_pwr_burned_amount{source=\"postgres\"} 12")
 		require.Contains(t, body, "yaci_locked_tokens_count{amount=\"2000000000\",denom=\"umfx\",source=\"postgres\"} 1")
 	})
 }

docker/.env

@@ -20,7 +20,7 @@ GRPC="9090"
 GRPC_WEB="9091"
 ROSETTA="8080"
 TIMEOUT_COMMIT="3s"
-VOTING_TIMEOUT="5s"
+VOTING_TIMEOUT="10s"
 DENOM=umfx
 BOND_DENOM=upoa
 POA_ADMIN_ADDRESS="manifest1afk9zr2hn2jsac63h4hm60vl9z3e5u69gndzf7c99cqge3vzwjzsfmy9qj"

docker/infra/proposals/burn_upwr.template.json

@@ -0,0 +1,20 @@
+{
+  "group_policy_address": "${POA_ADMIN_ADDRESS}",
+  "messages": [
+    {
+      "@type": "/osmosis.tokenfactory.v1beta1.MsgBurn",
+      "sender": "${POA_ADMIN_ADDRESS}",
+      "burnFromAddress": "${ADDR1}",
+      "amount": {
+        "denom": "factory/${POA_ADMIN_ADDRESS}/upwr",
+        "amount": "12"
+      }
+    }
+  ],
+  "metadata": "",
+  "title": "Burn 12 upwr",
+  "summary": "This proposal will burn 12 upwr",
+  "proposers": [
+    "${ADDR1}"
+  ]
+}

docker/infra/proposals/mint_upwr.template.json

@@ -0,0 +1,20 @@
+{
+  "group_policy_address": "${POA_ADMIN_ADDRESS}",
+  "messages": [
+    {
+      "@type": "/osmosis.tokenfactory.v1beta1.MsgMint",
+      "sender": "${POA_ADMIN_ADDRESS}",
+      "mintToAddress": "${ADDR1}",
+      "amount": {
+        "denom": "factory/${POA_ADMIN_ADDRESS}/upwr",
+        "amount": "123"
+      }
+    }
+  ],
+  "metadata": "",
+  "title": "Mint 123 upwr",
+  "summary": "This proposal will mint 123 upwr",
+  "proposers": [
+    "${ADDR1}"
+  ]
+}

docker/infra/scripts/init_manifest_ledger.sh

@@ -26,7 +26,7 @@ update_test_genesis '.app_state["group"]["group_seq"]="1"'
 update_test_genesis '.app_state["group"]["groups"]=[{"id":"1","admin":"'${POA_ADMIN_ADDRESS}'","metadata":"AQ==","version":"2","total_weight":"2","created_at":"2024-05-16T15:10:54.372190727Z"}]'
 update_test_genesis '.app_state["group"]["group_members"]=[{"group_id":"1","member":{"address":"'${ADDR1}'","weight":"1","metadata":"user1","added_at":"2024-05-16T15:10:54.372190727Z"}},{"group_id":"1","member":{"address":"'${ADDR2}'","weight":"1","metadata":"user2","added_at":"2024-05-16T15:10:54.372190727Z"}}]'
 update_test_genesis '.app_state["group"]["group_policy_seq"]="1"'
-update_test_genesis '.app_state["group"]["group_policies"]=[{"address":"'${POA_ADMIN_ADDRESS}'","group_id":"1","admin":"'${POA_ADMIN_ADDRESS}'","metadata":"AQ==","version":"2","decision_policy":{"@type":"/cosmos.group.v1.ThresholdDecisionPolicy","threshold":"1","windows":{"voting_period":"5s","min_execution_period":"0s"}},"created_at":"2024-05-16T15:10:54.372190727Z"}]'
+update_test_genesis '.app_state["group"]["group_policies"]=[{"address":"'${POA_ADMIN_ADDRESS}'","group_id":"1","admin":"'${POA_ADMIN_ADDRESS}'","metadata":"AQ==","version":"2","decision_policy":{"@type":"/cosmos.group.v1.ThresholdDecisionPolicy","threshold":"1","windows":{"voting_period":"'${VOTING_TIMEOUT}'","min_execution_period":"0s"}},"created_at":"2024-05-16T15:10:54.372190727Z"}]'
 update_test_genesis '.app_state["tokenfactory"]["factory_denoms"]=[{"denom":"factory/manifest1afk9zr2hn2jsac63h4hm60vl9z3e5u69gndzf7c99cqge3vzwjzsfmy9qj/upwr","authority_metadata":{"admin":"manifest1afk9zr2hn2jsac63h4hm60vl9z3e5u69gndzf7c99cqge3vzwjzsfmy9qj"}}]'
 update_test_genesis '.app_state["bank"]["denom_metadata"] |= . + [{"description":"PWR","denom_units":[{"denom":"factory/manifest1afk9zr2hn2jsac63h4hm60vl9z3e5u69gndzf7c99cqge3vzwjzsfmy9qj/upwr","exponent":0,"aliases":["PWR"]},{"denom":"PWR","exponent":6,"aliases":["factory/manifest1afk9zr2hn2jsac63h4hm60vl9z3e5u69gndzf7c99cqge3vzwjzsfmy9qj/upwr"]}],"base":"factory/manifest1afk9zr2hn2jsac63h4hm60vl9z3e5u69gndzf7c99cqge3vzwjzsfmy9qj/upwr","display":"PWR","name":"POWER","symbol":"PWR","uri":"","uri_hash":""}]'
 update_test_genesis '.app_state["wasm"]["params"]["code_upload_access"]["permission"]="Everybody"'

docker/infra/scripts/init_manifest_ledger_txs.sh

@@ -22,6 +22,7 @@ fi
 # $1 = command, rest = optional flags
 function run_tx() {
   manifestd "$@" ${COMMON_MANIFESTD_ARGS} && sleep ${TIMEOUT_COMMIT}
+  printf "\n"
   TX_COUNT=$((TX_COUNT + 1))
 }
 
@@ -31,6 +32,7 @@ function run_proposal() {
   manifestd tx group vote ${PROPOSAL_ID} "$2" VOTE_OPTION_YES '' ${COMMON_MANIFESTD_ARGS} --note "${3}-vote" "${@:4}" && sleep ${TIMEOUT_COMMIT}
   sleep ${VOTING_TIMEOUT} # Wait for the voting period to end
   manifestd tx group exec ${PROPOSAL_ID} ${COMMON_MANIFESTD_ARGS} --note "${3}-exec" "${@:4}" && sleep ${TIMEOUT_COMMIT}
+  printf "\n"
   PROPOSAL_ID=$((PROPOSAL_ID + 1))
   TX_COUNT=$((TX_COUNT + 3))
 }
@@ -50,43 +52,82 @@ echo "-> Converting 3 MFX to 6 PWR"
 run_tx tx wasm execute ${CONVERT_WASM_ADDRESS} '{"convert":{}}' --from $KEY --note "tx-mint-from-converter" --amount 3000000umfx
 
 ## Bank module
+echo "-> Bank send"
 run_tx tx bank send $ADDR1 ${POA_ADMIN_ADDRESS} 10000${DENOM} --from $KEY --note "tx-send-to-poa-admin"
+
+echo "-> Bank multi-send"
 run_tx tx bank multi-send $ADDR1 $ADDR2 ${POA_ADMIN_ADDRESS} 10000${DENOM} --from $KEY --note "tx-multi-send-to-poa-admin"
 
 ## Vesting
+echo "-> Creating periodic vesting account"
 run_tx tx vesting create-periodic-vesting-account ${VESTING_ADDR} /generated/vesting_period.json --from $KEY --note "tx-create-periodic-vesting-account"
 
 ## Tokenfactory module
+echo "-> Create new denom (TF)"
 run_tx tx tokenfactory create-denom ufoobar --from $KEY --note "tx-create-denom-ufoobar"
+
+echo "-> Modify new denom metadata(TF)"
 run_tx tx tokenfactory modify-metadata factory/$ADDR1/ufoobar FOOBAR "This is the foobar token" 6 --from $KEY --note "tx-modify-metadata-foobar"
+
+echo "-> Mint new denom (TF)"
 run_tx tx tokenfactory mint-to $ADDR1 2000000factory/$ADDR1/ufoobar  --from $KEY --note "tx-mint-to"
+
+echo "-> Burn new denom (TF)"
 run_tx tx tokenfactory burn-from $ADDR1 1000000factory/$ADDR1/ufoobar  --from $KEY --note "tx-burn-from"
+
+echo "-> Change admin of new denom (TF)"
 run_tx tx tokenfactory change-admin factory/$ADDR1/ufoobar $ADDR2 --from $KEY --note "tx-change-admin"
 
 ## Manifest module
+echo "-> Payout proposal (Manifest)"
 run_proposal "payout.json" "$ADDR1" "tx-payout-proposal" --from $KEY
+
+echo "-> BurnHeldBalance proposal (Manifest)"
 run_proposal "burn.json" "$ADDR1" "tx-burn-proposal" --from $KEY
 
 # Submit and withdraw payout and burn proposals to make sure collector works properly
+echo "-> Submit and withdraw payout proposal (Manifest)"
 run_tx tx group submit-proposal "/proposals/payout.json" --note "tx-payout-proposal-submit-2" --from $KEY
 run_tx tx group withdraw-proposal $PROPOSAL_ID $ADDR1 --note "tx-payout-proposal-withdraw" --from $KEY
 PROPOSAL_ID=$((PROPOSAL_ID + 1))
+
+echo "-> Submit and withdraw burn proposal (Manifest)"
 run_tx tx group submit-proposal "/proposals/burn.json" --note "tx-burn-proposal-submit-2" --from $KEY
 run_tx tx group withdraw-proposal $PROPOSAL_ID $ADDR1 --note "tx-burn-proposal-withdraw" --from $KEY
 PROPOSAL_ID=$((PROPOSAL_ID + 1))
 
+echo "-> Mint UPWR proposal (Manifest)"
+run_proposal "mint_upwr.json" "$ADDR1" "tx-mint-upwr-proposal" --from $KEY
+
+echo "-> Burn UPWR proposal (Manifest)"
+run_proposal "burn_upwr.json" "$ADDR1" "tx-burn-upwr-proposal" --from $KEY
+
 ### Group module
 echo ${GROUP_MEMBERS} > members.json && cat members.json
 echo ${DECISION_POLICY} > policy.json && cat policy.json
+echo "-> Create group with policy"
 run_tx tx group create-group-with-policy $ADDR1 "" "" members.json policy.json --from $KEY --group-policy-as-admin --note "tx-create-group-with-policy"
+
+echo "-> Send to user group"
 run_tx tx bank send $ADDR1 ${USER_GROUP_ADDRESS} 10000${DENOM} --from $KEY --note "tx-send-to-user-group"
+
+echo "-> Create denom proposal (TF)"
 run_proposal "create_denom.json" "$ADDR1" "tx-create-denom-proposal" --from $KEY
+
+echo "-> Mint new denom proposal (TF)"
 run_proposal "mint_new_denom.json" "$ADDR1" "tx-mint-new-denom-proposal" --from $KEY
+
+echo "-> Send new denom proposal (TF)"
 run_proposal "send_new_denom.json" "$ADDR1" "tx-send-new-denom-proposal" --from $KEY
+
+echo "-> Update group members proposal"
 run_proposal "update_group_members.json" "$ADDR1" "tx-update-group-members-proposal" --from $KEY
 
 ### Error transactions
+echo "-> Send tx that will error (Manifest)"
 run_tx tx bank send $ADDR2 $ADDR1 100000000001000000${DENOM} --from $KEY --note "tx-send-addr2-to-addr1-error"
+
+echo "-> Send proposal that will error (Manifest)"
 run_proposal "send_error.json" "$ADDR1" "tx-send-proposal-error" --from $KEY
 
 echo "Total transactions: $TX_COUNT"

docker/yaci/scripts/yaci_tx_check.sh

@@ -48,10 +48,10 @@ function check_addr_txs() {
 
 # Address-specific configurations
 declare -A ADDRESS_EXPECTED_TXS=(
-  ["${ADDR1}"]="43"
+  ["${ADDR1}"]="51"
   ["${ADDR2}"]="12"
   ["${USER_GROUP_ADDRESS}"]="15"
-  ["${POA_ADMIN_ADDRESS}"]="14"
+  ["${POA_ADMIN_ADDRESS}"]="20"
   ["${VESTING_ADDR}"]="1"
 )
 
@@ -102,6 +102,14 @@ declare -a ADDRESS1_TX_CHECKS=(
   "tx-payout-proposal-withdraw:false"
   "tx-burn-proposal-submit-2:false"
   "tx-burn-proposal-withdraw:false"
+  "tx-mint-upwr-proposal-submit:false"
+  "tx-mint-upwr-proposal-submit:true"
+  "tx-mint-upwr-proposal-vote:false"
+  "tx-mint-upwr-proposal-exec:false"
+  "tx-burn-upwr-proposal-submit:false"
+  "tx-burn-upwr-proposal-submit:true"
+  "tx-burn-upwr-proposal-vote:false"
+  "tx-burn-upwr-proposal-exec:false"
 )
 
 declare -a ADDRESS2_TX_CHECKS=(
@@ -149,6 +157,12 @@ declare -a POA_ADMIN_ADDRESS_TX_CHECKS=(
   "tx-grant-proposal-submit:true"
   "tx-payout-proposal-submit-2:false"
   "tx-burn-proposal-submit-2:false"
+  "tx-mint-upwr-proposal-submit:false"
+  "tx-mint-upwr-proposal-submit:true"
+  "tx-mint-upwr-proposal-exec:false"
+  "tx-burn-upwr-proposal-submit:false"
+  "tx-burn-upwr-proposal-submit:true"
+  "tx-burn-upwr-proposal-exec:false"
 )
 
 declare -A ADDRESS_TX_CHECKS=(

…l/metrics/collectors/total_pwr_minted.go …cs/collectors/total_pwr_minted_burned.gointernal/metrics/collectors/total_pwr_minted.go renamed to internal/metrics/collectors/total_pwr_minted_burned.go internal/metrics/collectors/total_pwr_minted.go renamed to internal/metrics/collectors/total_pwr_minted_burned.go

@@ -8,9 +8,8 @@ import (
 	"github.com/prometheus/client_golang/prometheus"
 )
 
-// TotalPwrMintAmountQuery expected format of the cosmwasm event attribute for mint amounts, e.g., 123456upwr
-// Note: only counts PWR minted via the tf_mint event (i.e., via the tf_mint function)
-const TotalPwrMintAmountQuery = `
+// TotalPwrMintBurnAmountQuery expected format of the event attribute for mint/burn amounts, e.g., 123456upwr
+const TotalPwrMintBurnAmountQuery = `
 		WITH pwr_minted AS (
 		  WITH tf_mint_events AS (
 		    SELECT
@@ -27,18 +26,45 @@ const TotalPwrMintAmountQuery = `
 		  JOIN api.messages_main m
 		    ON m.id = b.id
 		   AND m.message_index = b.msg_index
-		   AND m.type = '/cosmwasm.wasm.v1.MsgExecuteContract'
 		  JOIN LATERAL regexp_matches(
 		    b.amount_raw,
 		    '^([0-9]+)([[:alnum:]_\/\.]+)$'
 		  ) AS rm(captures) ON TRUE
 		  WHERE (rm.captures)[2] = 'factory/manifest1afk9zr2hn2jsac63h4hm60vl9z3e5u69gndzf7c99cqge3vzwjzsfmy9qj/upwr'
+		),
+		pwr_burned AS (
+		  WITH burn_events AS (
+			SELECT
+			  e.id,
+			  e.event_index,
+			  MAX(e.attr_value) FILTER (WHERE e.attr_key = 'amount') AS amount_raw,
+			  MAX(e.msg_index) AS msg_index
+			FROM api.events_main e
+			WHERE e.event_type = 'burn'
+			GROUP BY e.id, e.event_index
+		  )
+		  SELECT COALESCE(SUM((rm.captures)[1]::numeric), 0) AS amount
+		  FROM burn_events b
+		  JOIN api.messages_main m
+			ON m.id = b.id
+		   AND m.message_index = b.msg_index
+		  JOIN api.transactions_main tx
+			ON tx.id = b.id
+		   AND tx.error IS NULL
+		  JOIN LATERAL regexp_matches(
+			b.amount_raw,
+			'^([0-9]+)([[:alnum:]_\/\.]+)$'
+		  ) AS rm(captures) ON TRUE
+		  WHERE (rm.captures)[2] = 'factory/manifest1afk9zr2hn2jsac63h4hm60vl9z3e5u69gndzf7c99cqge3vzwjzsfmy9qj/upwr'
 		)
-		SELECT amount FROM pwr_minted;
+		SELECT
+		  (SELECT amount FROM pwr_minted) as total_pwr_minted,
+		  (SELECT amount FROM pwr_burned) as total_pwr_burned;
 `
 
 type TotalPwrMintedCollector struct {
 	totalPwrMintedAmount *prometheus.Desc
+	totalPwrBurnedAmount *prometheus.Desc
 	db                   *sql.DB
 }
 
@@ -47,7 +73,13 @@ func NewTotalPwrMintedCollector(db *sql.DB) *TotalPwrMintedCollector {
 		db: db,
 		totalPwrMintedAmount: prometheus.NewDesc(
 			prometheus.BuildFQName("yaci", "tokenomics", "total_pwr_minted_amount"),
-			"Total PWR minted",
+			"Total upwr minted",
+			nil,
+			prometheus.Labels{"source": "postgres"},
+		),
+		totalPwrBurnedAmount: prometheus.NewDesc(
+			prometheus.BuildFQName("yaci", "tokenomics", "total_pwr_burned_amount"),
+			"Total upwr burned",
 			nil,
 			prometheus.Labels{"source": "postgres"},
 		),
@@ -56,17 +88,20 @@ func NewTotalPwrMintedCollector(db *sql.DB) *TotalPwrMintedCollector {
 
 func (c *TotalPwrMintedCollector) Describe(ch chan<- *prometheus.Desc) {
 	ch <- c.totalPwrMintedAmount
+	ch <- c.totalPwrBurnedAmount
 }
 
 func (c *TotalPwrMintedCollector) Collect(ch chan<- prometheus.Metric) {
-	var mintAmount float64
-	err := c.db.QueryRow(TotalPwrMintAmountQuery).Scan(&mintAmount)
+	var mintAmount, burnAmount float64
+	err := c.db.QueryRow(TotalPwrMintBurnAmountQuery).Scan(&mintAmount, &burnAmount)
 	if err != nil {
 		ch <- prometheus.NewInvalidMetric(c.totalPwrMintedAmount, err)
+		ch <- prometheus.NewInvalidMetric(c.totalPwrBurnedAmount, err)
 		return
 	}
 
 	ch <- prometheus.MustNewConstMetric(c.totalPwrMintedAmount, prometheus.CounterValue, mintAmount)
+	ch <- prometheus.MustNewConstMetric(c.totalPwrBurnedAmount, prometheus.CounterValue, burnAmount)
 }
 
 func init() {