backport: fix(mempool): pending withdrawals not in mem block aren't restored

crates/mem-pool/src/pool.rs

@@ -197,6 +197,7 @@ impl MemPool {
             mem_pool_state,
             dynamic_config_manager,
         };
+        mem_pool.restore_pending_withdrawals().await?;
 
         // update mem block info
         let snap = mem_pool.mem_pool_state().load();
@@ -1103,6 +1104,30 @@ impl MemPool {
         Ok(tx_receipt)
     }
 
+    async fn restore_pending_withdrawals(&mut self) -> Result<()> {
+        let db = self.store.begin_transaction();
+        let withdrawals_iter = db.get_mem_pool_withdrawal_iter();
+
+        for (withdrawal_hash, withdrawal) in withdrawals_iter {
+            if self.mem_block.withdrawals_set().contains(&withdrawal_hash) {
+                continue;
+            }
+
+            if let Err(err) = self.push_withdrawal_request(withdrawal).await {
+                // Outdated withdrawal in db before bug fix
+                log::info!(
+                    "[mem-pool] withdrawal restore outdated pending {:x} {}, drop it",
+                    withdrawal_hash.pack(),
+                    err
+                );
+                db.remove_mem_pool_withdrawal(&withdrawal_hash)?;
+            }
+        }
+
+        db.commit()?;
+        Ok(())
+    }
+
     // Only **ReadOnly** node needs this.
     // Refresh mem block with those params.
     // Always expects next block number equals with current_tip_block_number + 1.

crates/store/src/transaction/store_transaction.rs

@@ -616,6 +616,19 @@ impl StoreTransaction {
             &[],
         )
     }
+
+    pub fn get_mem_pool_withdrawal_iter(
+        &self,
+    ) -> impl Iterator<Item = (H256, packed::WithdrawalRequestExtra)> + '_ {
+        self.get_iter(COLUMN_MEM_POOL_WITHDRAWAL, IteratorMode::End)
+            .map(|(key, val)| {
+                packed::WithdrawalRequestExtraReader::from_slice_should_be_ok(val.as_ref());
+                (
+                    packed::Byte32Reader::from_slice_should_be_ok(key.as_ref()).unpack(),
+                    packed::WithdrawalRequestExtra::new_unchecked(val.into()),
+                )
+            })
+    }
 }
 
 impl ChainStore for StoreTransaction {}

crates/tests/src/tests/mod.rs

@@ -2,4 +2,5 @@ mod chain;
 mod deposit_withdrawal;
 mod mem_block_repackage;
 mod restore_mem_block;
+mod restore_mem_pool_pending_withdrawal;
 mod unlock_withdrawal_to_owner;

crates/tests/src/tests/restore_mem_pool_pending_withdrawal.rs

@@ -0,0 +1,229 @@
+use std::time::Duration;
+
+use crate::testing_tool::chain::{
+    build_sync_tx, construct_block, restart_chain, setup_chain, ALWAYS_SUCCESS_CODE_HASH,
+};
+use crate::testing_tool::mem_pool_provider::DummyMemPoolProvider;
+
+use ckb_types::prelude::{Builder, Entity};
+use gw_chain::chain::{L1Action, L1ActionContext, SyncParam};
+use gw_common::H256;
+use gw_types::core::ScriptHashType;
+use gw_types::offchain::CollectedCustodianCells;
+use gw_types::packed::{
+    CellOutput, DepositRequest, L2BlockCommittedInfo, RawWithdrawalRequest, Script,
+    WithdrawalRequest, WithdrawalRequestExtra,
+};
+use gw_types::prelude::Pack;
+
+const ACCOUNTS_COUNT: usize = 20;
+const CKB: u64 = 100000000;
+const DEPOSIT_CAPACITY: u64 = 1000000 * CKB;
+const WITHDRAWAL_CAPACITY: u64 = 1000 * CKB;
+
+#[tokio::test]
+async fn test_restore_mem_pool_pending_withdrawal() {
+    let _ = env_logger::builder().is_test(true).try_init();
+
+    let rollup_type_script = Script::default();
+    let rollup_script_hash: H256 = rollup_type_script.hash().into();
+    let rollup_cell = CellOutput::new_builder()
+        .type_(Some(rollup_type_script.clone()).pack())
+        .build();
+    let mut chain = setup_chain(rollup_type_script.clone()).await;
+
+    // Deposit accounts
+    let accounts: Vec<_> = (0..ACCOUNTS_COUNT)
+        .map(|_| random_always_success_script(&rollup_script_hash))
+        .collect();
+    let deposits = accounts.iter().map(|account_script| {
+        DepositRequest::new_builder()
+            .capacity(DEPOSIT_CAPACITY.pack())
+            .sudt_script_hash(H256::zero().pack())
+            .amount(0.pack())
+            .script(account_script.to_owned())
+            .build()
+    });
+
+    let block_result = {
+        let mem_pool = chain.mem_pool().as_ref().unwrap();
+        let mut mem_pool = mem_pool.lock().await;
+        construct_block(&chain, &mut mem_pool, deposits.clone().collect())
+            .await
+            .unwrap()
+    };
+    let apply_deposits = L1Action {
+        context: L1ActionContext::SubmitBlock {
+            l2block: block_result.block.clone(),
+            deposit_requests: deposits.collect(),
+            deposit_asset_scripts: Default::default(),
+        },
+        transaction: build_sync_tx(rollup_cell.clone(), block_result),
+        l2block_committed_info: L2BlockCommittedInfo::new_builder()
+            .number(1u64.pack())
+            .build(),
+    };
+    let param = SyncParam {
+        updates: vec![apply_deposits],
+        reverts: Default::default(),
+    };
+    chain.sync(param).await.unwrap();
+    assert!(chain.last_sync_event().is_success());
+
+    // Generate withdrawals
+    let mut withdrawals: Vec<_> = {
+        accounts
+            .iter()
+            .map(|account_script| {
+                let raw = RawWithdrawalRequest::new_builder()
+                    .capacity(WITHDRAWAL_CAPACITY.pack())
+                    .account_script_hash(account_script.hash().pack())
+                    .sudt_script_hash(H256::zero().pack())
+                    .build();
+                let withdrawal = WithdrawalRequest::new_builder().raw(raw).build();
+                WithdrawalRequestExtra::new_builder()
+                    .request(withdrawal)
+                    .build()
+            })
+            .collect()
+    };
+    let pending_withdrawals = withdrawals.split_off(withdrawals.len() - 5);
+    let mem_block_withdrawals = withdrawals;
+
+    // Insert error nonce withdrawal and expect them to be removed during pending restore
+    let invalid_withdrawals_count = pending_withdrawals.len() - 5;
+    let invalid_withdrawals: Vec<_> = pending_withdrawals
+        .iter()
+        .take(invalid_withdrawals_count)
+        .map(|w| {
+            let raw = w.request().raw();
+            let raw_with_invalid_nonce = raw.as_builder().nonce(9u32.pack()).build();
+            let request = w.request().as_builder().raw(raw_with_invalid_nonce).build();
+            w.clone().as_builder().request(request).build()
+        })
+        .collect();
+    {
+        let db = chain.store().begin_transaction();
+        for withdrawal in invalid_withdrawals {
+            db.insert_mem_pool_withdrawal(&withdrawal.hash().into(), withdrawal)
+                .unwrap();
+        }
+        db.commit().unwrap();
+    }
+
+    // Push withdrawals
+    let finalized_custodians = CollectedCustodianCells {
+        capacity: ((ACCOUNTS_COUNT + 2) as u64 * WITHDRAWAL_CAPACITY) as u128,
+        cells_info: vec![Default::default()],
+        ..Default::default()
+    };
+    {
+        let mem_pool = chain.mem_pool().as_ref().unwrap();
+        let mut mem_pool = mem_pool.lock().await;
+        let provider = DummyMemPoolProvider {
+            deposit_cells: vec![],
+            fake_blocktime: Duration::from_millis(0),
+            collected_custodians: finalized_custodians.clone(),
+        };
+        mem_pool.set_provider(Box::new(provider));
+
+        for withdrawal in mem_block_withdrawals.clone() {
+            mem_pool.push_withdrawal_request(withdrawal).await.unwrap();
+        }
+        mem_pool.reset_mem_block().await.unwrap();
+
+        for withdrawal in pending_withdrawals.clone() {
+            mem_pool.push_withdrawal_request(withdrawal).await.unwrap();
+        }
+
+        let mem_block = mem_pool.mem_block();
+        assert_eq!(mem_block.withdrawals().len(), mem_block_withdrawals.len());
+
+        // Dump mem block
+        mem_pool.save_mem_block().unwrap();
+
+        let db = chain.store().begin_transaction();
+        assert_eq!(
+            db.get_mem_pool_withdrawal_iter().count(),
+            mem_block_withdrawals.len() + pending_withdrawals.len() + invalid_withdrawals_count
+        );
+    }
+
+    // Simualte chain restart
+    let provider = DummyMemPoolProvider {
+        deposit_cells: vec![],
+        fake_blocktime: Duration::from_millis(0),
+        collected_custodians: finalized_custodians,
+    };
+    let mut chain = restart_chain(&chain, rollup_type_script.clone(), Some(provider)).await;
+
+    // Check restore mem block withdrawals
+    {
+        let mem_pool = chain.mem_pool().as_ref().unwrap();
+        let mem_pool = mem_pool.lock().await;
+
+        let mem_block = mem_pool.mem_block();
+        assert_eq!(mem_block.withdrawals().len(), mem_block_withdrawals.len());
+        assert_eq!(
+            mem_block.state_checkpoints().len(),
+            mem_block_withdrawals.len()
+        );
+    }
+
+    // Check whether invalid withdrawals are removed
+    let db = chain.store().begin_transaction();
+    assert_eq!(
+        db.get_mem_pool_withdrawal_iter().count(),
+        mem_block_withdrawals.len() + pending_withdrawals.len()
+    );
+
+    // Produce new block then check pending withdrawals
+    let block_result = {
+        let mem_pool = chain.mem_pool().as_ref().unwrap();
+        let mut mem_pool = mem_pool.lock().await;
+        construct_block(&chain, &mut mem_pool, vec![])
+            .await
+            .unwrap()
+    };
+    let apply_mem_block_withdrawals = L1Action {
+        context: L1ActionContext::SubmitBlock {
+            l2block: block_result.block.clone(),
+            deposit_requests: vec![],
+            deposit_asset_scripts: Default::default(),
+        },
+        transaction: build_sync_tx(rollup_cell, block_result),
+        l2block_committed_info: L2BlockCommittedInfo::new_builder()
+            .number(2u64.pack())
+            .build(),
+    };
+    let param = SyncParam {
+        updates: vec![apply_mem_block_withdrawals],
+        reverts: Default::default(),
+    };
+    chain.sync(param).await.unwrap();
+    assert!(chain.last_sync_event().is_success());
+
+    let mem_pool = chain.mem_pool().as_ref().unwrap();
+    let mut mem_pool = mem_pool.lock().await;
+    mem_pool.reset_mem_block().await.unwrap();
+
+    let mem_block = mem_pool.mem_block();
+    assert_eq!(mem_block.withdrawals().len(), pending_withdrawals.len());
+    assert_eq!(
+        mem_block.state_checkpoints().len(),
+        pending_withdrawals.len()
+    );
+}
+
+fn random_always_success_script(rollup_script_hash: &H256) -> Script {
+    let random_bytes: [u8; 32] = rand::random();
+    Script::new_builder()
+        .code_hash(ALWAYS_SUCCESS_CODE_HASH.clone().pack())
+        .hash_type(ScriptHashType::Type.into())
+        .args({
+            let mut args = rollup_script_hash.as_slice().to_vec();
+            args.extend_from_slice(&random_bytes);
+            args.pack()
+        })
+        .build()
+}