feat(rpc): Implement Filecoin.StateMinerAvailableBalance (#4061)

Co-authored-by: David Himmelstrup <[email protected]>
ChainSafe · Mar 15, 2024 · 36c3514 · 36c3514
1 parent 59ff9a4
commit 36c3514
Show file tree

Hide file tree

Showing 5 changed files with 67 additions and 0 deletions.
diff --git a/src/rpc/mod.rs b/src/rpc/mod.rs
@@ -254,6 +254,10 @@ where
     module.register_async_method(STATE_MINER_SECTOR_COUNT, state_miner_sector_count::<DB>)?;
     module.register_async_method(STATE_MINER_FAULTS, state_miner_faults::<DB>)?;
     module.register_async_method(STATE_MINER_RECOVERIES, state_miner_recoveries::<DB>)?;
+    module.register_async_method(
+        STATE_MINER_AVAILABLE_BALANCE,
+        state_miner_available_balance::<DB>,
+    )?;
     module.register_async_method(STATE_MINER_POWER, state_miner_power::<DB>)?;
     module.register_async_method(STATE_MINER_DEADLINES, state_miner_deadlines::<DB>)?;
     module.register_async_method(STATE_LIST_MESSAGES, state_list_messages::<DB>)?;

diff --git a/src/rpc/state_api.rs b/src/rpc/state_api.rs
@@ -416,6 +416,54 @@ pub async fn state_miner_recoveries<DB: Blockstore + Send + Sync + 'static>(
         .map(|r| r.into())
 }
 
+pub async fn state_miner_available_balance<DB: Blockstore + Send + Sync + 'static>(
+    params: Params<'_>,
+    data: Data<RPCState<DB>>,
+) -> Result<LotusJson<TokenAmount>, JsonRpcError> {
+    let LotusJson((miner_address, ApiTipsetKey(tsk))): LotusJson<(Address, ApiTipsetKey)> =
+        params.parse()?;
+
+    let store = data.chain_store.blockstore();
+    let ts = data
+        .state_manager
+        .chain_store()
+        .load_required_tipset_or_heaviest(&tsk)?;
+    let actor = data
+        .state_manager
+        .get_actor(&miner_address, *ts.parent_state())?
+        .ok_or_else(|| anyhow::anyhow!("Miner actor not found"))?;
+    let state = miner::State::load(store, actor.code, actor.state)?;
+    let actor_balance: TokenAmount = actor.balance.clone().into();
+    let (vested, available): (TokenAmount, TokenAmount) = match &state {
+        miner::State::V13(s) => (
+            s.check_vested_funds(store, ts.epoch())?.into(),
+            s.get_available_balance(&actor_balance.into())?.into(),
+        ),
+        miner::State::V12(s) => (
+            s.check_vested_funds(store, ts.epoch())?.into(),
+            s.get_available_balance(&actor_balance.into())?.into(),
+        ),
+        miner::State::V11(s) => (
+            s.check_vested_funds(store, ts.epoch())?.into(),
+            s.get_available_balance(&actor_balance.into())?.into(),
+        ),
+        miner::State::V10(s) => (
+            s.check_vested_funds(store, ts.epoch())?.into(),
+            s.get_available_balance(&actor_balance.into())?.into(),
+        ),
+        miner::State::V9(s) => (
+            s.check_vested_funds(store, ts.epoch())?.into(),
+            s.get_available_balance(&actor_balance.into())?.into(),
+        ),
+        miner::State::V8(s) => (
+            s.check_vested_funds(store, ts.epoch())?.into(),
+            s.get_available_balance(&actor_balance.into())?.into(),
+        ),
+    };
+
+    Ok(LotusJson(vested + available))
+}
+
 /// returns the message receipt for the given message
 pub async fn state_get_receipt<DB: Blockstore + Send + Sync + 'static>(
     params: Params<'_>,

diff --git a/src/rpc_api/mod.rs b/src/rpc_api/mod.rs
@@ -96,6 +96,7 @@ pub static ACCESS_MAP: Lazy<HashMap<&str, Access>> = Lazy::new(|| {
     access.insert(state_api::STATE_MINER_POWER, Access::Read);
     access.insert(state_api::STATE_MINER_DEADLINES, Access::Read);
     access.insert(state_api::STATE_MINER_PROVING_DEADLINE, Access::Read);
+    access.insert(state_api::STATE_MINER_AVAILABLE_BALANCE, Access::Read);
     access.insert(state_api::STATE_GET_RECEIPT, Access::Read);
     access.insert(state_api::STATE_WAIT_MSG, Access::Read);
     access.insert(state_api::STATE_SEARCH_MSG, Access::Read);
@@ -378,6 +379,7 @@ pub mod state_api {
     pub const STATE_MINER_POWER: &str = "Filecoin.StateMinerPower";
     pub const STATE_MINER_DEADLINES: &str = "Filecoin.StateMinerDeadlines";
     pub const STATE_MINER_PROVING_DEADLINE: &str = "Filecoin.StateMinerProvingDeadline";
+    pub const STATE_MINER_AVAILABLE_BALANCE: &str = "Filecoin.StateMinerAvailableBalance";
     pub const STATE_GET_RECEIPT: &str = "Filecoin.StateGetReceipt";
     pub const STATE_WAIT_MSG: &str = "Filecoin.StateWaitMsg";
     pub const STATE_FETCH_ROOT: &str = "Filecoin.StateFetchRoot";

diff --git a/src/rpc_client/state_ops.rs b/src/rpc_client/state_ops.rs
@@ -99,6 +99,13 @@ impl ApiInfo {
         RpcRequest::new(STATE_MINER_PROVING_DEADLINE, (miner, tsk))
     }
 
+    pub fn state_miner_available_balance_req(
+        miner: Address,
+        tsk: ApiTipsetKey,
+    ) -> RpcRequest<TokenAmount> {
+        RpcRequest::new(STATE_MINER_AVAILABLE_BALANCE, (miner, tsk))
+    }
+
     pub fn state_get_randomness_from_tickets_req(
         tsk: ApiTipsetKey,
         personalization: DomainSeparationTag,

diff --git a/src/tool/subcommands/api_cmd.rs b/src/tool/subcommands/api_cmd.rs
@@ -708,6 +708,12 @@ fn snapshot_tests(store: &ManyCar, n_tipsets: usize) -> anyhow::Result<Vec<RpcTe
             tests.push(RpcTest::identity(
                 ApiInfo::state_miner_proving_deadline_req(block.miner_address, tipset.key().into()),
             ));
+            tests.push(RpcTest::identity(
+                ApiInfo::state_miner_available_balance_req(
+                    block.miner_address,
+                    tipset.key().into(),
+                ),
+            ));
             tests.push(RpcTest::identity(ApiInfo::state_miner_faults_req(
                 block.miner_address,
                 tipset.key().into(),