Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add PoolRpc::test_tx_pool_accept, check if the transaction can be accepted by TxPool #4433

Merged
merged 1 commit into from
Apr 24, 2024
Merged

Add PoolRpc::test_tx_pool_accept, check if the transaction can be accepted by TxPool #4433

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
121 changes: 121 additions & 0 deletions rpc/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,7 @@ The crate `ckb-rpc`'s minimum supported rustc version is 1.71.1.
* [Module Pool](#module-pool) [👉 OpenRPC spec](http://playground.open-rpc.org/?uiSchema[appBar][ui:title]=CKB-Pool&uiSchema[appBar][ui:splitView]=false&uiSchema[appBar][ui:examplesDropdown]=false&uiSchema[appBar][ui:logoUrl]=https://raw.githubusercontent.com/nervosnetwork/ckb-rpc-resources/develop/ckb-logo.jpg&schemaUrl=https://raw.githubusercontent.com/nervosnetwork/ckb-rpc-resources/develop/json/pool_rpc_doc.json)

* [Method `send_transaction`](#pool-send_transaction)
* [Method `test_tx_pool_accept`](#pool-test_tx_pool_accept)
* [Method `remove_transaction`](#pool-remove_transaction)
* [Method `tx_pool_info`](#pool-tx_pool_info)
* [Method `clear_tx_pool`](#pool-clear_tx_pool)
Expand Down Expand Up @@ -162,6 +163,7 @@ The crate `ckb-rpc`'s minimum supported rustc version is 1.71.1.
* [Type `DeploymentInfo`](#type-deploymentinfo)
* [Type `DeploymentState`](#type-deploymentstate)
* [Type `DeploymentsInfo`](#type-deploymentsinfo)
* [Type `EntryCompleted`](#type-entrycompleted)
* [Type `EpochNumber`](#type-epochnumber)
* [Type `EpochNumber`](#type-epochnumber)
* [Type `EpochNumberWithFraction`](#type-epochnumberwithfraction)
Expand Down Expand Up @@ -4420,6 +4422,114 @@ Response
}
```

<a id="pool-test_tx_pool_accept"></a>
#### Method `test_tx_pool_accept`
* `test_tx_pool_accept(tx, outputs_validator)`
* `tx`: [`Transaction`](#type-transaction)
* `outputs_validator`: [`OutputsValidator`](#type-outputsvalidator) `|` `null`
* result: [`EntryCompleted`](#type-entrycompleted)

Test if a transaction can be accepted by the transaction pool without inserting it into the pool or rebroadcasting it to peers.
The parameters and errors of this method are the same as `send_transaction`.

###### Params

* `transaction` - The transaction.
* `outputs_validator` - Validates the transaction outputs before entering the tx-pool. (**Optional**, default is "passthrough").

###### Errors

* [`PoolRejectedTransactionByOutputsValidator (-1102)`](../enum.RPCError.html#variant.PoolRejectedTransactionByOutputsValidator) - The transaction is rejected by the validator specified by `outputs_validator`. If you really want to send transactions with advanced scripts, please set `outputs_validator` to "passthrough".
* [`PoolRejectedTransactionByMinFeeRate (-1104)`](../enum.RPCError.html#variant.PoolRejectedTransactionByMinFeeRate) - The transaction fee rate must be greater than or equal to the config option `tx_pool.min_fee_rate`.
* [`PoolRejectedTransactionByMaxAncestorsCountLimit (-1105)`](../enum.RPCError.html#variant.PoolRejectedTransactionByMaxAncestorsCountLimit) - The ancestors count must be greater than or equal to the config option `tx_pool.max_ancestors_count`.
* [`PoolIsFull (-1106)`](../enum.RPCError.html#variant.PoolIsFull) - Pool is full.
* [`PoolRejectedDuplicatedTransaction (-1107)`](../enum.RPCError.html#variant.PoolRejectedDuplicatedTransaction) - The transaction is already in the pool.
* [`TransactionFailedToResolve (-301)`](../enum.RPCError.html#variant.TransactionFailedToResolve) - Failed to resolve the referenced cells and headers used in the transaction, as inputs or dependencies.
* [`TransactionFailedToVerify (-302)`](../enum.RPCError.html#variant.TransactionFailedToVerify) - Failed to verify the transaction.

###### Examples

Request

```json
{
"id": 42,
"jsonrpc": "2.0",
"method": "test_tx_pool_accept",
"params": [
{
"cell_deps": [
{
"dep_type": "code",
"out_point": {
"index": "0x0",
"tx_hash": "0xa4037a893eb48e18ed4ef61034ce26eba9c585f15c9cee102ae58505565eccc3"
}
}
],
"header_deps": [
"0x7978ec7ce5b507cfb52e149e36b1a23f6062ed150503c85bbf825da3599095ed"
],
"inputs": [
{
"previous_output": {
"index": "0x0",
"tx_hash": "0x075fe030c1f4725713c5aacf41c2f59b29b284008fdb786e5efd8a058be51d0c"
},
"since": "0x0"
}
],
"outputs": [
{
"capacity": "0x2431ac129",
"lock": {
"code_hash": "0x28e83a1277d48add8e72fadaa9248559e1b632bab2bd60b27955ebc4c03800a5",
"hash_type": "data",
"args": "0x"
},
"type": null
}
],
"outputs_data": [
"0x"
],
"version": "0x0",
"witnesses": []
},
"passthrough"
]
}
```

Response

```json
{
"id": 42,
"jsonrpc": "2.0",
"result": {
"cycles": "0x219",
"fee": "0x2a66f36e90"
}
}
```


The response looks like below if the transaction pool check fails

```text
{
"id": 42,
"jsonrpc": "2.0",
"result": null,
"error": {
"code": -1107,
"data": "Duplicated(Byte32(0xa0ef4eb5f4ceeb08a4c8524d84c5da95dce2f608e0ca2ec8091191b0f330c6e3))",
"message": "PoolRejectedDuplicatedTransaction: Transaction(Byte32(0xa0ef4eb5f4ceeb08a4c8524d84c5da95dce2f608e0ca2ec8091191b0f330c6e3)) already exists in transaction_pool"
}
}
```

<a id="pool-remove_transaction"></a>
#### Method `remove_transaction`
* `remove_transaction(tx_hash)`
Expand Down Expand Up @@ -5739,6 +5849,17 @@ Chain information.

* `hash`: [`H256`](#type-h256) - requested block hash

### Type `EntryCompleted`
Transaction's verify result by test_tx_pool_accept

#### Fields

`EntryCompleted` is a JSON object with the following fields.

* `cycles`: [`Uint64`](#type-uint64) - Cached tx cycles

* `fee`: [`Uint64`](#type-uint64) - Cached tx fee

### Type `EpochNumber`
Consecutive epoch number starting from 0.

Expand Down
182 changes: 162 additions & 20 deletions rpc/src/module/pool.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@ use async_trait::async_trait;
use ckb_chain_spec::consensus::Consensus;
use ckb_constant::hardfork::{mainnet, testnet};
use ckb_jsonrpc_types::{
OutputsValidator, PoolTxDetailInfo, RawTxPool, Script, Transaction, TxPoolInfo,
EntryCompleted, OutputsValidator, PoolTxDetailInfo, RawTxPool, Script, Transaction, TxPoolInfo,
};
use ckb_logger::error;
use ckb_shared::shared::Shared;
use ckb_types::core::TransactionView;
use ckb_types::{core, packed, prelude::*, H256};
use ckb_verification::{Since, SinceMetric};
use jsonrpc_core::Result;
Expand Down Expand Up @@ -109,6 +110,113 @@ pub trait PoolRpc {
outputs_validator: Option<OutputsValidator>,
) -> Result<H256>;

/// Test if a transaction can be accepted by the transaction pool without inserting it into the pool or rebroadcasting it to peers.
/// The parameters and errors of this method are the same as `send_transaction`.
///
/// ## Params
///
/// * `transaction` - The transaction.
/// * `outputs_validator` - Validates the transaction outputs before entering the tx-pool. (**Optional**, default is "passthrough").
///
/// ## Errors
///
/// * [`PoolRejectedTransactionByOutputsValidator (-1102)`](../enum.RPCError.html#variant.PoolRejectedTransactionByOutputsValidator) - The transaction is rejected by the validator specified by `outputs_validator`. If you really want to send transactions with advanced scripts, please set `outputs_validator` to "passthrough".
/// * [`PoolRejectedTransactionByMinFeeRate (-1104)`](../enum.RPCError.html#variant.PoolRejectedTransactionByMinFeeRate) - The transaction fee rate must be greater than or equal to the config option `tx_pool.min_fee_rate`.
/// * [`PoolRejectedTransactionByMaxAncestorsCountLimit (-1105)`](../enum.RPCError.html#variant.PoolRejectedTransactionByMaxAncestorsCountLimit) - The ancestors count must be greater than or equal to the config option `tx_pool.max_ancestors_count`.
/// * [`PoolIsFull (-1106)`](../enum.RPCError.html#variant.PoolIsFull) - Pool is full.
/// * [`PoolRejectedDuplicatedTransaction (-1107)`](../enum.RPCError.html#variant.PoolRejectedDuplicatedTransaction) - The transaction is already in the pool.
/// * [`TransactionFailedToResolve (-301)`](../enum.RPCError.html#variant.TransactionFailedToResolve) - Failed to resolve the referenced cells and headers used in the transaction, as inputs or dependencies.
/// * [`TransactionFailedToVerify (-302)`](../enum.RPCError.html#variant.TransactionFailedToVerify) - Failed to verify the transaction.
///
/// ## Examples
///
/// Request
///
/// ```json
/// {
/// "id": 42,
/// "jsonrpc": "2.0",
/// "method": "test_tx_pool_accept",
/// "params": [
/// {
/// "cell_deps": [
/// {
/// "dep_type": "code",
/// "out_point": {
/// "index": "0x0",
/// "tx_hash": "0xa4037a893eb48e18ed4ef61034ce26eba9c585f15c9cee102ae58505565eccc3"
/// }
/// }
/// ],
/// "header_deps": [
/// "0x7978ec7ce5b507cfb52e149e36b1a23f6062ed150503c85bbf825da3599095ed"
/// ],
/// "inputs": [
/// {
/// "previous_output": {
/// "index": "0x0",
/// "tx_hash": "0x075fe030c1f4725713c5aacf41c2f59b29b284008fdb786e5efd8a058be51d0c"
/// },
/// "since": "0x0"
/// }
/// ],
/// "outputs": [
/// {
/// "capacity": "0x2431ac129",
/// "lock": {
/// "code_hash": "0x28e83a1277d48add8e72fadaa9248559e1b632bab2bd60b27955ebc4c03800a5",
/// "hash_type": "data",
/// "args": "0x"
/// },
/// "type": null
/// }
/// ],
/// "outputs_data": [
/// "0x"
/// ],
/// "version": "0x0",
/// "witnesses": []
/// },
/// "passthrough"
/// ]
/// }
/// ```
///
/// Response
///
/// ```json
/// {
/// "id": 42,
/// "jsonrpc": "2.0",
/// "result": {
/// "cycles": "0x219",
/// "fee": "0x2a66f36e90"
/// }
/// }
/// ```
///
///
/// The response looks like below if the transaction pool check fails
///
/// ```text
/// {
/// "id": 42,
/// "jsonrpc": "2.0",
/// "result": null,
/// "error": {
/// "code": -1107,
/// "data": "Duplicated(Byte32(0xa0ef4eb5f4ceeb08a4c8524d84c5da95dce2f608e0ca2ec8091191b0f330c6e3))",
/// "message": "PoolRejectedDuplicatedTransaction: Transaction(Byte32(0xa0ef4eb5f4ceeb08a4c8524d84c5da95dce2f608e0ca2ec8091191b0f330c6e3)) already exists in transaction_pool"
/// }
/// }
/// ```
#[rpc(name = "test_tx_pool_accept")]
fn test_tx_pool_accept(
&self,
tx: Transaction,
outputs_validator: Option<OutputsValidator>,
) -> Result<EntryCompleted>;

/// Removes a transaction and all transactions which depends on it from tx pool if it exists.
///
/// ## Params
Expand Down Expand Up @@ -359,6 +467,33 @@ impl PoolRpcImpl {
well_known_type_scripts,
}
}

fn check_output_validator(
&self,
outputs_validator: Option<OutputsValidator>,
tx: &TransactionView,
) -> Result<()> {
if let Err(e) = match outputs_validator {
None | Some(OutputsValidator::Passthrough) => Ok(()),
Some(OutputsValidator::WellKnownScriptsOnly) => WellKnownScriptsOnlyValidator::new(
self.shared.consensus(),
&self.well_known_lock_scripts,
&self.well_known_type_scripts,
)
.validate(tx),
} {
return Err(RPCError::custom_with_data(
RPCError::PoolRejectedTransactionByOutputsValidator,
format!(
"The transaction is rejected by OutputsValidator set in params[1]: {}. \
Please check the related information in https://github.com/nervosnetwork/ckb/wiki/Transaction-%C2%BB-Default-Outputs-Validator",
outputs_validator.unwrap_or(OutputsValidator::WellKnownScriptsOnly).json_display()
),
e,
));
}
Ok(())
}
}

/// Build well known lock scripts
Expand Down Expand Up @@ -452,25 +587,7 @@ impl PoolRpc for PoolRpcImpl {
let tx: packed::Transaction = tx.into();
let tx: core::TransactionView = tx.into_view();

if let Err(e) = match outputs_validator {
None | Some(OutputsValidator::Passthrough) => Ok(()),
Some(OutputsValidator::WellKnownScriptsOnly) => WellKnownScriptsOnlyValidator::new(
self.shared.consensus(),
&self.well_known_lock_scripts,
&self.well_known_type_scripts,
)
.validate(&tx),
} {
return Err(RPCError::custom_with_data(
RPCError::PoolRejectedTransactionByOutputsValidator,
format!(
"The transaction is rejected by OutputsValidator set in params[1]: {}. \
Please check the related information in https://github.com/nervosnetwork/ckb/wiki/Transaction-%C2%BB-Default-Outputs-Validator",
outputs_validator.unwrap_or(OutputsValidator::WellKnownScriptsOnly).json_display()
),
e,
));
}
self.check_output_validator(outputs_validator, &tx)?;

let tx_pool = self.shared.tx_pool_controller();
let submit_tx = tx_pool.submit_local_tx(tx.clone());
Expand All @@ -487,6 +604,31 @@ impl PoolRpc for PoolRpcImpl {
}
}

fn test_tx_pool_accept(
&self,
tx: Transaction,
outputs_validator: Option<OutputsValidator>,
) -> Result<EntryCompleted> {
let tx: packed::Transaction = tx.into();
let tx: core::TransactionView = tx.into_view();

self.check_output_validator(outputs_validator, &tx)?;

let tx_pool = self.shared.tx_pool_controller();

let test_accept_tx_reslt = tx_pool.test_accept_tx(tx).map_err(|e| {
error!("Send test_tx_pool_accept_tx request error {}", e);
RPCError::ckb_internal_error(e)
})?;

test_accept_tx_reslt
.map(|test_accept_result| test_accept_result.into())
.map_err(|reject| {
error!("Send test_tx_pool_accept_tx request error {}", reject);
RPCError::from_submit_transaction_reject(&reject)
})
}

fn remove_transaction(&self, tx_hash: H256) -> Result<bool> {
let tx_pool = self.shared.tx_pool_controller();

Expand Down
Loading
Loading