Milestone Events by lucca30 · Pull Request #184 · 0xPolygon/heimdall-v2

lucca30 · 2025-03-04T15:33:36Z

Description

This features enables us including milestone events on cosmos sdk event feature. It allows us subscribe to new blocks and filter milestone events.

You can query events via websocket endpoint:

echo '{ "jsonrpc": "2.0","method": "subscribe","id": 0,"params": {"query": "tm.event='"'NewBlock'"' AND milestone.number>0"} }' | websocat -n -t ws://127.0.0.1:26657/websocket

And the result will be like:

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": {
        "query": "tm.event='NewBlock'",
        "data": {
            "type": "tendermint/event/NewBlock",
            "value": {
                "block": {
                    "header": {
                        "version": {
                            "block": "11"
                        },
                        "chain_id": "heimdall-8509",
                        "height": "1983",
                        "time": "2025-03-04T15:13:39.613566597Z",
                        "last_block_id": {
                            "hash": "10AA8156D08D7B3EE963CDF8DC69AB4D2CEFD9151612120EEC6D23CC0AA58C08",
                            "parts": {
                                "total": 1,
                                "hash": "F962ED66CA7F606E062D5B2249A3F715648D01E1F43BDED0E3D9A15A46F74106"
                            }
                        },
                        "last_commit_hash": "7CED70D2E994C325F471F7218FB14446840393F1809C63D0244BF533FEFC197B",
                        "data_hash": "261FA6009219C8B1FFFEAF9CBF526B1AC68D719259A5319ABF70EC98CDF7C86F",
                        "validators_hash": "8FEE2AADCC436D6272D59016783DF28BE340B891D49CEA7414FCA62F8D8EABC0",
                        "next_validators_hash": "8FEE2AADCC436D6272D59016783DF28BE340B891D49CEA7414FCA62F8D8EABC0",
                        "consensus_hash": "048091BC7DDC283F77BFBF91D73C44DA58C3DF8A9CBC867405D8B7F3DAADA22F",
                        "app_hash": "6B85F206E343306FCD778DE2D2DDEE08A7BADD371FCE57654ED947F602ACD19D",
                        "last_results_hash": "697AC0DA637A4D63975EEEC4D0114CA918111C81B7B2C0DD7F9BE63F9EC40B40",
                        "evidence_hash": "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855",
                        "proposer_address": "0DB3924C18D33A4B2B65116B4447EB3DE1CBF730"
                    },
                    "data": {
                        "txs": [
                            "EqkCChkKFA2zkkwY0zpLK2URa0RH6z3hy/cwGJBOGkwKIBCqgVbQjXs+6WPN+Nxpq00s79kVFhISDuxtI8wKpYwIEL4PIiUKIJgmpcOm0Ah9kFEJmGs3MYMNBHk3LYHHOXQIqpvBCI3iEKUGIkEs7GRJNggoKGOjeqt+8Ma0wskVLHHnVwj+wE3YpLaiVy1zQTHCKfQDm7ZAu+FWVAD93v4GVOZUl3X0fTVNzUUQACgCMjYJDQojSEVJTURBTEwtVk9URS1FWFRFTlNJT04jDQoJfAAAAAAAAAe+fGhlaW1kYWxsLTg1MDk6QaFV7M+/Bejmbm8XYtqKPbrSexRKapKU6Ua/Baa8ELHiNW6wXQpMDqHllNZxV9aJHicXqo+Pl7fIwZZ2QNuAqD4BEqkCChkKFI9SJJDmi5BzBX7SL54pJwZkv1MjGJBOGkwKIBCqgVbQjXs+6WPN+Nxpq00s79kVFhISDuxtI8wKpYwIEL4PIiUKIJgmpcOm0Ah9kFEJmGs3MYMNBHk3LYHHOXQIqpvBCI3iEKUGIkHVuiPaJa3t7wp0jbhfYX/ScJNABQOsazFtrl8lDfAEGnenXMOUmfyuL9nK/EU4GCUfjcz1pJysIdivoORG9GK+ASgCMjYJDQojSEVJTURBTEwtVk9URS1FWFRFTlNJT04jDQoJfAAAAAAAAAe+fGhlaW1kYWxsLTg1MDk6Qa7K3upReoipGrtfjEwVlZh3MpswT3GKdOg9U6GZGKznOvx0GxcimbIcM1YxtLR+apT97nsTujr4ChLax+kkT2AA"
                        ]
                    },
                    "evidence": {
                        "evidence": []
                    },
                    "last_commit": {
                        "height": "1982",
                        "round": 0,
                        "block_id": {
                            "hash": "10AA8156D08D7B3EE963CDF8DC69AB4D2CEFD9151612120EEC6D23CC0AA58C08",
                            "parts": {
                                "total": 1,
                                "hash": "F962ED66CA7F606E062D5B2249A3F715648D01E1F43BDED0E3D9A15A46F74106"
                            }
                        },
                        "signatures": [
                            {
                                "block_id_flag": 2,
                                "validator_address": "0DB3924C18D33A4B2B65116B4447EB3DE1CBF730",
                                "timestamp": "2025-03-04T15:13:39.613566597Z",
                                "signature": "XGW8NZqal24skls+mE+n3ffRnHJ0a1y/a249Lqk8xWo8AW0x/MQfNRKKGMYdlDJiyh/zfWgRbC7aS6fPGWk90gA="
                            },
                            {
                                "block_id_flag": 2,
                                "validator_address": "8F522490E68B9073057ED22F9E29270664BF5323",
                                "timestamp": "2025-03-04T15:13:39.709985018Z",
                                "signature": "OblJACV5x0T97WneJBrVwVU7atcj6hOTs6SHh68KMtpKlEyEkcoUSmfHyxALkj4SR0mqgFmBuimDXdbfhMHefgE="
                            }
                        ]
                    }
                },
                "block_id": {
                    "hash": "3FA09E2F20FC305E240A4299436127751E10DFB984B3683A82DF7050C9317C36",
                    "parts": {
                        "total": 1,
                        "hash": "EA4657C96C190C42B6826A91EAF8D4434D87949E1FE6BEF15B6FA9BB0E08A4F8"
                    }
                },
                "result_finalize_block": {
                    "events": [
                        {
                            "type": "milestone",
                            "attributes": [
                                {
                                    "key": "proposer",
                                    "value": "0x0db3924c18d33a4b2b65116b4447eb3de1cbf730",
                                    "index": false
                                },
                                {
                                    "key": "hash",
                                    "value": "9826a5c3a6d0087d905109986b3731830d0479372d81c7397408aa9bc1088de2",
                                    "index": false
                                },
                                {
                                    "key": "start_block",
                                    "value": "805",
                                    "index": false
                                },
                                {
                                    "key": "end_block",
                                    "value": "805",
                                    "index": false
                                },
                                {
                                    "key": "bor_chain_id",
                                    "value": "8509",
                                    "index": false
                                },
                                {
                                    "key": "milestone_id",
                                    "value": "7591f79b6ba7c3dd494a9086d27e02b0a27506bca5eb0d01f0dc2406bfecca3e",
                                    "index": false
                                },
                                {
                                    "key": "timestamp",
                                    "value": "1741101219",
                                    "index": false
                                },
                                {
                                    "key": "number",
                                    "value": "801",
                                    "index": false
                                }
                            ]
                        }
                    ],
                    "tx_results": [
                        {
                            "code": 2,
                            "data": null,
                            "log": "tx parse error",
                            "info": "",
                            "gas_wanted": "0",
                            "gas_used": "0",
                            "events": [],
                            "codespace": "sdk"
                        }
                    ],
                    "validator_updates": [],
                    "consensus_param_updates": {
                        "block": {
                            "max_bytes": "22020096",
                            "max_gas": "-1"
                        },
                        "evidence": {
                            "max_age_num_blocks": "100000",
                            "max_age_duration": "172800000000000",
                            "max_bytes": "1048576"
                        },
                        "validator": {
                            "pub_key_types": [
                                "secp256k1"
                            ]
                        },
                        "version": {},
                        "abci": {
                            "vote_extensions_enable_height": "1"
                        }
                    },
                    "app_hash": "QoVnc+Bvrq7iApEAWIxFPUplfOeTLNApA7PHqF5hg68="
                }
            }
        },
        "events": {
            "milestone.end_block": [
                "805"
            ],
            "tm.event": [
                "NewBlock"
            ],
            "milestone.start_block": [
                "805"
            ],
            "milestone.proposer": [
                "0x0db3924c18d33a4b2b65116b4447eb3de1cbf730"
            ],
            "milestone.bor_chain_id": [
                "8509"
            ],
            "milestone.milestone_id": [
                "7591f79b6ba7c3dd494a9086d27e02b0a27506bca5eb0d01f0dc2406bfecca3e"
            ],
            "milestone.timestamp": [
                "1741101219"
            ],
            "milestone.number": [
                "801"
            ],
            "milestone.hash": [
                "9826a5c3a6d0087d905109986b3731830d0479372d81c7397408aa9bc1088de2"
            ]
        }
    }
}

Changes

Bugfix (non-breaking change that solves an issue)
Hotfix (change that solves an urgent issue, and requires immediate attention)
New feature (non-breaking change that adds functionality)
Breaking change (change that is not backwards-compatible and/or changes current functionality)
Changes only for a subset of nodes

Checklist

I have added at least 2 reviewer or the whole pos-v1 team
I have added sufficient documentation in code
I will be resolving comments - if any - by pushing each fix in a separate commit and linking the commit hash in the comment reply

Testing

I have added unit tests
I have added tests to CI
I have tested this code manually on local environment
I have tested this code manually on remote devnet using express-cli
I have tested this code manually on amoy/mumbai
I have created new e2e tests into express-cli

sonarqubecloud · 2025-03-04T16:07:22Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

lucca30 added 3 commits March 4, 2025 11:23

including milestone events

64e9159

fix extra hash

c686798

including docs

8112943

lucca30 requested review from a team and avalkov March 4, 2025 15:33

avalkov approved these changes Mar 4, 2025

View reviewed changes

avalkov force-pushed the avalkov/Milestones-via-vote-extensions branch from 82bcaf0 to 16d3302 Compare March 4, 2025 15:43

Raneet10 approved these changes Mar 4, 2025

View reviewed changes

lucca30 merged commit decc27a into avalkov/Milestones-via-vote-extensions Mar 4, 2025
9 checks passed

This was referenced Mar 6, 2025

Including ws address 0xPolygon/matic-cli#323

Merged

Add optional HeimdallWSAddress configuration and refactor handler_bor methods 0xPolygon/bor#1481

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Milestone Events#184

Milestone Events#184
lucca30 merged 3 commits intoavalkov/Milestones-via-vote-extensionsfrom
lmartins/milestone-ws-events

lucca30 commented Mar 4, 2025

Uh oh!

sonarqubecloud bot commented Mar 4, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

lucca30 commented Mar 4, 2025

Description

Changes

Checklist

Testing

Uh oh!

sonarqubecloud bot commented Mar 4, 2025

Quality Gate passed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants