feat: implement `Filecoin.ChainGetMessagesInTipset` API (server side) #3670

hanabi1224 · 2023-11-06T06:45:06Z

Summary of changes

As part of #3639

Changes introduced in this pull request:

implement Filecoin.ChainGetMessagesInTipset API (server side)

Manually tested on calibnet

request payload:

{
    "jsonrpc": "2.0",
    "id": 2,
    "method": "Filecoin.ChainGetMessagesInTipset",
    "params": [
        [
            {
                "/": "bafy2bzacecctsgyvam3fxhppheh2ubkarpgjvkn7cyvesrmhttuusuwzspk6o"
            },
            {
                "/": "bafy2bzacedt2daxg7mcvbv5sdg47zruj2ogx2wxzrjidoiwpcmyzzyfazjtcu"
            },
            {
                "/": "bafy2bzaceavd2unelg7g2mghiaq2te3qkfyghdjapdyr6ltjti7dlglhuqsni"
            },
            {
                "/": "bafy2bzacebr63zjyie3oqjj7gjxr6mwifazolv44d764hc6g7mhhdehlkgel6"
            }
        ]
    ]
}

Lotus response

{
    "jsonrpc": "2.0",
    "result": [
        {
            "Cid": {
                "/": "bafy2bzaceatwgj5tnix7n2rb3d5vig23wjypzw577rkl4tuq7kxkanbos55yk"
            },
            "Message": {
                "Version": 0,
                "To": "t01022",
                "From": "t3vyfz2c4sc7y3aaujg27cujdirvowx76fzdbowx6tsbrpps54jdgjdz5hnbgghsro7xnodtx3lszg5avmarqq",
                "Nonce": 6813,
                "Value": "147457681006493397129",
                "GasLimit": 34956948,
                "GasFeeCap": "2002463144",
                "GasPremium": "100075",
                "Method": 28,
                "Params": "gYGHCBkIftgqWCkAAYLiA4HoAiComSsWZz1fG4np8VTIbUaUSBVdNw4Li0+ANU5FrokFIRoAEDeUgBoAJ+Ek9g==",
                "CID": {
                    "/": "bafy2bzaceatwgj5tnix7n2rb3d5vig23wjypzw577rkl4tuq7kxkanbos55yk"
                }
            }
        },
        {
            "Cid": {
                "/": "bafy2bzacecvpatko6ylteuqk4prczhpmei3haxrvx6c5lkcsg4zbicqwendci"
            },
            "Message": {
                "Version": 0,
                "To": "t410fgej3qpgoyofbrx4tn4yss7pesbef26zolsew5cq",
                "From": "t410fv6ms7pamek6jigrdfrr5ygymbtkxfukfn2aa4ly",
                "Nonce": 89630,
                "Value": "0",
                "GasLimit": 8247900,
                "GasFeeCap": "1500000200",
                "GasPremium": "1500000000",
                "Method": 3844450837,
                "Params": "WIRVNdv2AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAO2JhZnliZWliem40bzcydXAzdDRuZjdjcmhhY3NnZ3RyY3RzcWJ3emtubDZvYWpnajV5Z25lanBnbWF5AAAAAAA=",
                "CID": {
                    "/": "bafy2bzacebynmaklimwgrrjlwjsvqpg57bjeqfeapvj2ohlm6e446abqrumb4"
                }
            }
        }
    ],
    "id": 2
}

Forest response

{
    "jsonrpc": "2.0",
    "result": [
        {
            "Cid": {
                "/": "bafy2bzaceatwgj5tnix7n2rb3d5vig23wjypzw577rkl4tuq7kxkanbos55yk"
            },
            "Message": {
                "Version": 0,
                "To": "t01022",
                "From": "t3vyfz2c4sc7y3aaujg27cujdirvowx76fzdbowx6tsbrpps54jdgjdz5hnbgghsro7xnodtx3lszg5avmarqq",
                "Nonce": 6813,
                "Value": "147457681006493397129",
                "GasLimit": 34956948,
                "GasFeeCap": "2002463144",
                "GasPremium": "100075",
                "Method": 28,
                "Params": "gYGHCBkIftgqWCkAAYLiA4HoAiComSsWZz1fG4np8VTIbUaUSBVdNw4Li0+ANU5FrokFIRoAEDeUgBoAJ+Ek9g==",
                "CID": {
                    "/": "bafy2bzaceatwgj5tnix7n2rb3d5vig23wjypzw577rkl4tuq7kxkanbos55yk"
                }
            }
        },
        {
            "Cid": {
                "/": "bafy2bzacecvpatko6ylteuqk4prczhpmei3haxrvx6c5lkcsg4zbicqwendci"
            },
            "Message": {
                "Version": 0,
                "To": "t410fgej3qpgoyofbrx4tn4yss7pesbef26zolsew5cq",
                "From": "t410fv6ms7pamek6jigrdfrr5ygymbtkxfukfn2aa4ly",
                "Nonce": 89630,
                "Value": "0",
                "GasLimit": 8247900,
                "GasFeeCap": "1500000200",
                "GasPremium": "1500000000",
                "Method": 3844450837,
                "Params": "WIRVNdv2AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAO2JhZnliZWliem40bzcydXAzdDRuZjdjcmhhY3NnZ3RyY3RzcWJ3emtubDZvYWpnajV5Z25lanBnbWF5AAAAAAA=",
                "CID": {
                    "/": "bafy2bzacebynmaklimwgrrjlwjsvqpg57bjeqfeapvj2ohlm6e446abqrumb4"
                }
            }
        }
    ],
    "id": 2
}

Reference issue to close (if applicable)

Closes

Change checklist

I have performed a self-review of my own code,
I have made corresponding changes to the documentation,
I have added tests that prove my fix is effective or that my feature works (if possible),
I have made sure the CHANGELOG is up-to-date. All user-facing changes should be reflected in this document.

hanabi1224 · 2023-11-06T06:50:34Z

@lemmih Do we need to write tests for each single API?

lemmih · 2023-11-06T06:52:57Z

@lemmih Do we need to write tests for each single API?

Yes.

lemmih · 2023-11-06T06:54:03Z

@lemmih Do we need to write tests for each single API?

Yes.

Testing this method is easy since it has to be identical to Lotus. Add the tests in api_cmd.rs.

hanabi1224 · 2023-11-06T07:07:24Z

Testing this method is easy since it has to be identical to Lotus. Add the tests in api_cmd.rs.

@lemmih It seems that this API has been covered in api_cmd.rs, below is what I get.

     Running `target/debug/forest-tool api compare /home/me/fr/snapshots/calibnet/1063920_2023_11_06T04_13_00Z.car.zst`
| RPC Method                            | Forest              | Lotus         |
|---------------------------------------|---------------------|---------------|
| Filecoin.ChainGetBlock                | Valid               | Valid         |
| Filecoin.ChainGetGenesis              | Valid               | Valid         |
| Filecoin.ChainGetMessage (89)         | InternalServerError | Valid         |
| Filecoin.ChainGetMessage (2)          | Valid               | Valid         |
| Filecoin.ChainGetMessagesInTipset     | Valid               | Valid         |
| Filecoin.ChainGetParentMessages       | MissingMethod       | Valid         |
| Filecoin.ChainGetTipSetByHeight       | Valid               | Valid         |
| Filecoin.ChainHead                    | Valid               | Valid         |
| Filecoin.ChainReadObj                 | InvalidResponse     | Valid         |
| Filecoin.Discover                     | MissingMethod       | Valid         |
| Filecoin.MpoolPending                 | Valid               | Valid         |
| Filecoin.NetAddrsListen               | Valid               | Valid         |
| Filecoin.NetInfo                      | Valid               | MissingMethod |
| Filecoin.NetPeers                     | Valid               | Valid         |
| Filecoin.Session                      | MissingMethod       | Valid         |
| Filecoin.StartTime                    | Valid               | Valid         |
| Filecoin.StateGetActor                | Valid               | Valid         |
| Filecoin.StateGetRandomnessFromBeacon | MissingMethod       | Valid         |
| Filecoin.StateMinerActiveSectors      | MissingMethod       | Valid         |
| Filecoin.StateMinerPower (79)         | MissingMethod       | Valid         |
| Filecoin.StateNetworkName             | Valid               | Valid         |
| Filecoin.StateReadState               | MissingMethod       | Valid         |
| Filecoin.Version                      | Valid               | Valid         |

lemmih · 2023-11-06T07:10:12Z

Testing this method is easy since it has to be identical to Lotus. Add the tests in api_cmd.rs.

@lemmih It seems that this API has been covered in api_cmd.rs, below is what I get.

     Running `target/debug/forest-tool api compare /home/me/fr/snapshots/calibnet/1063920_2023_11_06T04_13_00Z.car.zst`
| RPC Method                            | Forest              | Lotus         |
|---------------------------------------|---------------------|---------------|
| Filecoin.ChainGetBlock                | Valid               | Valid         |
| Filecoin.ChainGetGenesis              | Valid               | Valid         |
| Filecoin.ChainGetMessage (89)         | InternalServerError | Valid         |
| Filecoin.ChainGetMessage (2)          | Valid               | Valid         |
| Filecoin.ChainGetMessagesInTipset     | Valid               | Valid         |
| Filecoin.ChainGetParentMessages       | MissingMethod       | Valid         |
| Filecoin.ChainGetTipSetByHeight       | Valid               | Valid         |
| Filecoin.ChainHead                    | Valid               | Valid         |
| Filecoin.ChainReadObj                 | InvalidResponse     | Valid         |
| Filecoin.Discover                     | MissingMethod       | Valid         |
| Filecoin.MpoolPending                 | Valid               | Valid         |
| Filecoin.NetAddrsListen               | Valid               | Valid         |
| Filecoin.NetInfo                      | Valid               | MissingMethod |
| Filecoin.NetPeers                     | Valid               | Valid         |
| Filecoin.Session                      | MissingMethod       | Valid         |
| Filecoin.StartTime                    | Valid               | Valid         |
| Filecoin.StateGetActor                | Valid               | Valid         |
| Filecoin.StateGetRandomnessFromBeacon | MissingMethod       | Valid         |
| Filecoin.StateMinerActiveSectors      | MissingMethod       | Valid         |
| Filecoin.StateMinerPower (79)         | MissingMethod       | Valid         |
| Filecoin.StateNetworkName             | Valid               | Valid         |
| Filecoin.StateReadState               | MissingMethod       | Valid         |
| Filecoin.Version                      | Valid               | Valid         |

Good.

lemmih

Looks good. Replace MessageInTipset with ApiMessage and it's good to go.

src/rpc_api/mod.rs

…_in_tipset

LesnyRumcajs

How is this tested? Say, I change the chain_get_messages_in_tipset to not return any messages, ever, with messages.clear() at the end. Will this be caught?

lemmih · 2023-11-06T11:30:05Z

How is this tested? Say, I change the chain_get_messages_in_tipset to not return any messages, ever, with messages.clear() at the end. Will this be caught?

There are tests that will catch that (by comparing our output to that of Lotus), but they're not yet part of the CI. Running the tests in CI is out of scope for this PR.

hanabi1224 added 2 commits November 6, 2023 14:34

feat: implement ChainGetMessagesInTipset API(server side)

164f602

Preserve order

513f6c3

changelog

4d905cb

hanabi1224 marked this pull request as ready for review November 6, 2023 07:14

hanabi1224 requested a review from a team as a code owner November 6, 2023 07:14

hanabi1224 requested review from LesnyRumcajs and aatifsyed and removed request for a team November 6, 2023 07:14

lemmih requested changes Nov 6, 2023

View reviewed changes

src/rpc_api/mod.rs Outdated Show resolved Hide resolved

hanabi1224 added 2 commits November 6, 2023 17:05

use ApiMessage

5de40f0

Merge remote-tracking branch 'origin/main' into hm/chain_get_messages…

b4029d3

…_in_tipset

lemmih approved these changes Nov 6, 2023

View reviewed changes

LesnyRumcajs reviewed Nov 6, 2023

View reviewed changes

LesnyRumcajs approved these changes Nov 6, 2023

View reviewed changes

hanabi1224 added this pull request to the merge queue Nov 6, 2023

Merged via the queue into main with commit 7d5ef13 Nov 6, 2023
25 checks passed

hanabi1224 deleted the hm/chain_get_messages_in_tipset branch November 6, 2023 12:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: implement `Filecoin.ChainGetMessagesInTipset` API (server side) #3670

feat: implement `Filecoin.ChainGetMessagesInTipset` API (server side) #3670

hanabi1224 commented Nov 6, 2023 •

edited

Loading

hanabi1224 commented Nov 6, 2023

lemmih commented Nov 6, 2023

lemmih commented Nov 6, 2023

hanabi1224 commented Nov 6, 2023

lemmih commented Nov 6, 2023

lemmih left a comment

LesnyRumcajs left a comment

lemmih commented Nov 6, 2023

feat: implement Filecoin.ChainGetMessagesInTipset API (server side) #3670

feat: implement Filecoin.ChainGetMessagesInTipset API (server side) #3670

Conversation

hanabi1224 commented Nov 6, 2023 • edited Loading

Summary of changes

Reference issue to close (if applicable)

Other information and links

Change checklist

hanabi1224 commented Nov 6, 2023

lemmih commented Nov 6, 2023

lemmih commented Nov 6, 2023

hanabi1224 commented Nov 6, 2023

lemmih commented Nov 6, 2023

lemmih left a comment

Choose a reason for hiding this comment

LesnyRumcajs left a comment

Choose a reason for hiding this comment

lemmih commented Nov 6, 2023

feat: implement `Filecoin.ChainGetMessagesInTipset` API (server side) #3670

feat: implement `Filecoin.ChainGetMessagesInTipset` API (server side) #3670

hanabi1224 commented Nov 6, 2023 •

edited

Loading