fix: filecoin read state API #5620

akaladarshi · 2025-05-03T05:37:51Z

Summary of changes

Changes introduced in this pull request:

Adds actor_states module, which basically holds all the actor state implementing the HasLotusJson trait
Introduces actor_registgry reverse lookup map for CID -> BuiltinActor
Updates the StateReadState API to work with new changes
Added the support for reading the state of actors:
- EVM
- Miner
- Market
- Account
- Cron
- System

Reference issue to close (if applicable)

Partially Closes: #5596

Change checklist

I have performed a self-review of my own code,
I have made corresponding changes to the documentation. All new code adheres to the team's documentation standards,
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.

akaladarshi · 2025-05-15T13:51:11Z

~~Right now I'm using a specific commit for fil-actor-states crate, once we make a release in fil-actor-states I will update the Cargo.toml~~

Updated the fil-actor-states to version 22.2

src/rpc/actor_registry.rs

hanabi1224 · 2025-05-16T10:32:13Z

Could you add API compare tests and RPC snapshot tests for each type of actor state?

… rpc snapshot tests

LesnyRumcajs · 2025-05-22T15:59:12Z

src/tool/subcommands/api_cmd/test_snapshots.txt

+filecoin_statereadstate_1747857537534929.rpcsnap.json.zst
+filecoin_statereadstate_1747857537535135.rpcsnap.json.zst
+filecoin_statereadstate_1747857537535290.rpcsnap.json.zst
+filecoin_statereadstate_1747857537534606.rpcsnap.json.zst
+filecoin_statereadstate_1747857537535026.rpcsnap.json.zst
+filecoin_statereadstate_1747857537535209.rpcsnap.json.zst


We really should have a way of commenting on what those snapshots are. Obviously not something to be done in this PR, but what we could do here is to add something to the name, e.g., statereadstate_account_1234.rpcsnap.json.zst, or something like this.

Yeah, but we would have to manually change it after generating the files, also we'd need to fix the format for the file name as well.

LesnyRumcajs · 2025-05-22T16:00:57Z

src/tool/subcommands/api_cmd/api_compare_tests.rs

+            tipset.key().into(),
+        ))?),
+        RpcTest::identity(StateReadState::request((
+            Address::new_id(78216), // miner actor address `f078216`


Suggested change

Address::new_id(78216), // miner actor address `f078216`

Address::new_id(78216), // miner actor address `t078216`

Also, might be worth linking to a relevant page on a block explorer.

LesnyRumcajs · 2025-05-22T16:04:37Z

src/rpc/actor_registry.rs

+
+    match actor_type {
+        BuiltinActor::Account => {
+            let state = account::State::load(store, *code_cid, *state_cid).map_err(|e| {


Instead of map_err, we could probably use anyhow's .context

It'd end up being less code.

Refactored it.

LesnyRumcajs · 2025-05-22T16:09:56Z

src/rpc/actor_registry.rs

+// Build a map from CIDs to actor types and versions once at startup
+static CID_TO_ACTOR_TYPE: Lazy<HashMap<Cid, (BuiltinActor, u64)>> = Lazy::new(|| {
+    let mut map = HashMap::new();
+
+    // Populate the map using data from ACTOR_BUNDLES_METADATA
+    for ((_, _), metadata) in ACTOR_BUNDLES_METADATA.iter() {
+        if let Ok(version) = metadata.actor_major_version() {
+            for (actor_type, cid) in metadata.manifest.builtin_actors() {
+                map.insert(cid, (actor_type, version));
+            }
+        }
+    }
+
+    map
+});
+
+pub fn get_actor_type_from_code(code_cid: &Cid) -> anyhow::Result<(BuiltinActor, u64)> {
+    CID_TO_ACTOR_TYPE
+        .get(code_cid)
+        .copied()
+        .ok_or_else(|| anyhow!("Unknown actor code CID: {}", code_cid))
+}


nit: it'd be nice to have it as a separate struct so we can abstract away the underlying data structure. It'd only have read_actor_type(cid: &Cid) as a member method.

A unit test would also be nice to have.

LesnyRumcajs · 2025-05-22T16:12:14Z

src/lotus_json/tombstone.rs

+    };
+}
+
+impl_tombstone_lotus_json!(V16, V15, V14, V13, V12, V11, V10);


Can we ensure, at compilation time, that all versions are covered? If it's too complex, let's have it as a follow-up.

You mean through tests?.

Because I think this is already ensured as we are implementing HasLotusJson for the TombstoneState, which itself holds all the versions of the tombstone. and match on self will ensure that at compile time all the versions are covered.

Ah cool, didn't notice there was a match there. Excellent!

LesnyRumcajs

Excellent work @akaladarshi !

akaladarshi · 2025-05-27T14:08:44Z

@LesnyRumcajs I will raise a subsequent PR for adding more actor type support for StateReadState API, this PR has already become very big.

Then we can update the Changelog or should I update right now only?

LesnyRumcajs · 2025-05-27T14:54:51Z

@LesnyRumcajs I will raise a subsequent PR for adding more actor type support for StateReadState API, this PR has already become very big.

Then we can update the Changelog or should I update right now only?

Either works fine for me.

akaladarshi · 2025-05-27T15:37:08Z

@LesnyRumcajs I will raise a subsequent PR for adding more actor type support for StateReadState API, this PR has already become very big.
Then we can update the Changelog or should I update right now only?

Either works fine for me.

Will do it in a Subsequent PR

fix: filecoin read state API

122015d

akaladarshi force-pushed the akaladarshi/fix-state-read-state-api branch from 3adf408 to 122015d Compare May 3, 2025 11:42

akaladarshi added 6 commits May 5, 2025 18:33

Merge branch 'main' into akaladarshi/fix-state-read-state-api

7632a53

refactor: add errors in actor registry

36f6b6f

bump up the fil actor crate to the latest version

5f5c3e2

add LotusJson support for miner and vesting fund actor states

cd03c1a

add LotusJson support for market actor states

c40562a

add LotusJson support for evm actor state

3ded21c

akaladarshi added 3 commits May 15, 2025 19:29

uncomment dev profile

db0dfe1

Update fil-actor-state crate dependencies to version 22.2

b55215a

Merge branch 'main' into akaladarshi/fix-state-read-state-api

2d459b3

akaladarshi marked this pull request as ready for review May 16, 2025 08:01

akaladarshi requested a review from a team as a code owner May 16, 2025 08:01

akaladarshi requested review from hanabi1224 and elmattic and removed request for a team May 16, 2025 08:01

hanabi1224 reviewed May 16, 2025

View reviewed changes

src/rpc/actor_registry.rs Outdated Show resolved Hide resolved

akaladarshi added 5 commits May 16, 2025 16:07

Add LotusJson support for System actor state

49d4c70

Merge branch 'main' into akaladarshi/fix-state-read-state-api

f31d046

Merge branch 'main' into akaladarshi/fix-state-read-state-api

2abb98e

Merge branch 'main' into akaladarshi/fix-state-read-state-api

679e093

add all the actor types for read state api in state tests to generate…

bf394ee

… rpc snapshot tests

akaladarshi requested a review from hanabi1224 May 21, 2025 20:45

add new test snapshots for read state API

405b892

akaladarshi added the RPC requires calibnet RPC checks to run on CI label May 22, 2025

akaladarshi self-assigned this May 22, 2025

LesnyRumcajs reviewed May 22, 2025

View reviewed changes

Merge branch 'main' into akaladarshi/fix-state-read-state-api

99c82df

akaladarshi force-pushed the akaladarshi/fix-state-read-state-api branch from 10bf489 to 12aac4d Compare May 27, 2025 11:04

address comments

0874d91

akaladarshi force-pushed the akaladarshi/fix-state-read-state-api branch from 12aac4d to 0874d91 Compare May 27, 2025 11:26

LesnyRumcajs approved these changes May 27, 2025

View reviewed changes

Merge branch 'main' into akaladarshi/fix-state-read-state-api

9ccedbb

hanabi1224 approved these changes May 27, 2025

View reviewed changes

akaladarshi added this pull request to the merge queue May 28, 2025

Merged via the queue into ChainSafe:main with commit 7ab303c May 28, 2025
32 checks passed

akaladarshi mentioned this pull request May 28, 2025

feat(api): add support for all the actor state in read state API #5666

Draft

10 tasks

	Address::new_id(78216), // miner actor address `f078216`
	Address::new_id(78216), // miner actor address `t078216`

fix: filecoin read state API #5620

fix: filecoin read state API #5620

Uh oh!

Conversation

akaladarshi commented May 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary of changes

Reference issue to close (if applicable)

Other information and links

Change checklist

Uh oh!

akaladarshi commented May 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

hanabi1224 commented May 16, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

LesnyRumcajs left a comment

Choose a reason for hiding this comment

Uh oh!

akaladarshi commented May 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

LesnyRumcajs commented May 27, 2025

Uh oh!

akaladarshi commented May 27, 2025

Uh oh!

Uh oh!

Uh oh!

akaladarshi commented May 3, 2025 •

edited

Loading

akaladarshi commented May 15, 2025 •

edited

Loading

akaladarshi commented May 27, 2025 •

edited

Loading