feat: tainted transaction reporting #5310

Janislav · 2024-10-02T14:41:48Z

Pull Request

Closes: PRO-1664

Checklist

Please conduct a thorough self-review before opening the PR.

I am confident that the code works.
I have written sufficient tests.
I have written and tested required migrations.
I have updated documentation where appropriate.

Summary

Added the functionality to mark a transaction as tainted as a broker or LP.
Check transactions when we process the ingress and stop if the channel is marked as tainted.
Saving tainted transaction details to refund it later.

Non-Breaking changes

If this PR includes non-breaking changes, select the non-breaking label. On merge, CI will automatically cherry-pick the commit to a PR against the release branch.

- Extended DepositChannelDetails with owner field - Added extrinsic to mark transaction as tainted - Handling deposit and save details for a refund if tx is tainted

- Added tests to verify that tainted transactions can get detected for all possible swap types - Added tests to check that txs marked by other brokers are getting ignored

codecov · 2024-10-02T14:54:00Z

Codecov Report

Attention: Patch coverage is 86.78261% with 76 lines in your changes missing coverage. Please review.

Project coverage is 71%. Comparing base (df8771a) to head (c45ec0f).
Report is 9 commits behind head on main.

Files with missing lines	Patch %	Lines
...ess/src/migrations/add_owner_to_channel_details.rs	65%	41 Missing ⚠️
state-chain/pallets/cf-ingress-egress/src/lib.rs	82%	12 Missing and 4 partials ⚠️
...ate-chain/pallets/cf-ingress-egress/src/weights.rs	0%	14 Missing ⚠️
state-chain/runtime/src/chainflip.rs	0%	4 Missing ⚠️
state-chain/pallets/cf-lp/src/lib.rs	94%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@          Coverage Diff           @@
##            main   #5310    +/-   ##
======================================
  Coverage     71%     71%            
======================================
  Files        492     495     +3     
  Lines      85750   86168   +418     
  Branches   85750   86168   +418     
======================================
+ Hits       61107   61423   +316     
- Misses     21908   22002    +94     
- Partials    2735    2743     +8

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

dandanlen

Some early comments.

dandanlen · 2024-10-04T08:46:53Z

state-chain/pallets/cf-ingress-egress/src/lib.rs

+		<T::TargetChain as Chain>::DepositDetails,
+		TaintedTransactionDetails<T::AccountId>,


Consider what happens if same tx is reported twice by different parties.

I think we might need a double-map.

state-chain/pallets/cf-ingress-egress/src/lib.rs

state-chain/traits/src/liquidity.rs

- Taking refund address if we open a deposit channel as lp - Extended ChannelAction to take an optional refund address - Removed all dependencies regarding the LpRegistration trait (added last commit) - Refactored tests, benchmarks, etc

Janislav · 2024-10-07T13:26:10Z

Still working on the benchmark. It's written, but there is something odd with the way we generate the weights.

state-chain/traits/src/lib.rs

state-chain/pallets/cf-lp/src/lib.rs

state-chain/pallets/cf-ingress-egress/src/lib.rs

dandanlen · 2024-10-10T10:27:40Z

Also please remember to rebase against main to pick up the new compiler version.

msgmaxim · 2024-10-22T01:38:03Z

I took the liberty to push a commit with some updates to comments (a few things weren't quite right, and I thought it would help if I did it myself). Feel free to revert @Janislav.

msgmaxim · 2024-10-22T01:40:04Z

state-chain/pallets/cf-ingress-egress/src/lib.rs

@@ -752,6 +810,26 @@ pub mod pallet {
 					Self::recycle_channel(&mut used_weight, address);
 				}
 			}
+
+			// A report gets cleaned up after approx 1 hour and needs to be re-reported by the


What if the broker re-reports? Would it then overwrite the BoostRejected record? (This would be problematic.)

state-chain/pallets/cf-ingress-egress/src/lib.rs

- mark boosted transactions as boosted instead of using channel status - allow pallet config instead of relying on chain - add event for tx reports - only allow reporting of unseen transactions - add doc comments - renaming of types/events - remove unused error

dandanlen · 2024-10-22T12:23:36Z

I added some changes (From the commit description):

mark boosted transactions as boosted instead of using channel status
allow pallet config instead of relying on chain
add event for tx reports
only allow reporting of unseen transactions
add doc comments
renaming of types/events
remove unused error

The main one is that I added a Boosted variant (and renamed) to the transaction report enum. I think this makes everything a bit clearer, in particular avoids having to rely on the channel status to know if a deposit has been boosted: now we just look up the tx_id.

Janislav · 2024-10-23T14:45:41Z

Somehow, the storage of the old DepositChannelDetails is not decodable during migration. No idea why yet.

…waps-close-accounts * origin/main: (44 commits) fix: expire all previous epochs (#5279) feat: add/update contract swaps parameters (#5343) chore: add address to solana logging (#5353) fix: ignore dust underflows in order fills rpc (#5352) chore: consistent naming prewitnessed (#5351) feat: engine-runner verifies gpg signature of old dylib when downloaded (#5339) feat: tainted transaction reporting (#5310) bug: change_utxo not always present (#5340) feat: structured error return types for rpcs (#5346) chore: unify dependencies to root cargo.toml (#5333) feat: Submit a slot number alongside nonce (#5297) chore: use node version from `.nvmrc` 📌 (#5336) chore: add engine account_info logging (#5347) chore: replace manual scale encoding for ts-scale (#5335) chore: more consistent params in Broker API (#5342) feat: broker can encode btc smart contract call (#5329) chore: localnet recreate script can use defaults (#5338) feat: witnessing btc smart contract swaps (#5331) feat: Solana CCM fallback (#5316) fix: scale types for pending ceremonies (#5286) ... # Conflicts: # Cargo.lock # state-chain/chains/src/sol/api.rs # state-chain/pallets/cf-broadcast/src/migrations.rs # state-chain/pallets/cf-environment/Cargo.toml

* feat: Handling of tainted transactions - Extended DepositChannelDetails with owner field - Added extrinsic to mark transaction as tainted - Handling deposit and save details for a refund if tx is tainted * tests: Added tests - Added tests to verify that tainted transactions can get detected for all possible swap types - Added tests to check that txs marked by other brokers are getting ignored * chore: Extended LpRegistration trait + Added to Ingress/Egress config * feat: Getting LP refund address * feature: ensure by lp and broker + added more tests * refactor: Don't error if tx is tainted * refactor: Using DoubleMap instead of Map * refactor: Using BadOrigin + Added unit test * refactor: Inline code + Add Deposit Witness to struct * refactor: Extended lp deposit with refund address - Taking refund address if we open a deposit channel as lp - Extended ChannelAction to take an optional refund address - Removed all dependencies regarding the LpRegistration trait (added last commit) - Refactored tests, benchmarks, etc * feature: Added benchmark * chore: Changes to benchmark * chore: generated mock weights * chore: only allow mark transactions for BTC * feature: expire tainted transaction * test: refactored tests * chore: Removed unused events * chore: Ensure only by broker * chore: removed broker from tainted tx struct * chore: Only clone owner * chore: Moved tx tainted check * feature: Added migration for DepositChannelLookup * refactor: Changed data structure + fixed migrations * chore: Handle LP refund address as requirement * chore: Made clippy happy 🙂 * chore: don't manipulate storage in place in iteration 🙅‍♂️ * test: Added migration test 🧪 * chore: changed pallet storage version 📀 * chore: bumped pallet storage version (again) * refactor: Changed accounting of expired transactions * refactor: using translate for migration * refactor: using append, refactored test * feature: Added handling of boost channels * feature: Marking txs when prewitness and reject when we process the depo * feat: pre-witnessed rejection handling * chore: Fixed logic + added tests * tests: Refactor/Rearranged tests * chore: Using SECONDS_PER_BLOCK instead of static block seconds * chore: Addressed comments * chore: Fixed clippy in CI * chore: update comments * fix: don't allow report overwrite * chore: Renamed event * feat: improvements: - mark boosted transactions as boosted instead of using channel status - allow pallet config instead of relying on chain - add event for tx reports - only allow reporting of unseen transactions - add doc comments - renaming of types/events - remove unused error * fix: migration * fix: made clippy happy --------- Co-authored-by: Daniel <daniel@chainflip.io> Co-authored-by: Maxim Shishmarev <maxim@chainflip.io>

Janislav added 5 commits October 1, 2024 15:32

feat: Handling of tainted transactions

8dcf3b1

- Extended DepositChannelDetails with owner field - Added extrinsic to mark transaction as tainted - Handling deposit and save details for a refund if tx is tainted

tests: Added tests

97967bf

- Added tests to verify that tainted transactions can get detected for all possible swap types - Added tests to check that txs marked by other brokers are getting ignored

chore: Extended LpRegistration trait + Added to Ingress/Egress config

6072fee

feat: Getting LP refund address

89caffd

feature: ensure by lp and broker + added more tests

8706bd8

dandanlen reviewed Oct 4, 2024

View reviewed changes

Janislav added 5 commits October 4, 2024 12:58

refactor: Don't error if tx is tainted

4cbcde1

refactor: Using DoubleMap instead of Map

cb6d4c3

refactor: Using BadOrigin + Added unit test

ca6f813

refactor: Inline code + Add Deposit Witness to struct

84d5182

refactor: Extended lp deposit with refund address

161be64

- Taking refund address if we open a deposit channel as lp - Extended ChannelAction to take an optional refund address - Removed all dependencies regarding the LpRegistration trait (added last commit) - Refactored tests, benchmarks, etc

Janislav marked this pull request as ready for review October 7, 2024 11:12

Janislav requested a review from kylezs as a code owner October 7, 2024 11:12

Janislav added 2 commits October 7, 2024 14:39

feature: Added benchmark

4ba1ecb

chore: Changes to benchmark

ec4ce2d

Janislav added 4 commits October 8, 2024 10:59

chore: generated mock weights

0af1b50

chore: only allow mark transactions for BTC

df4529e

feature: expire tainted transaction

8f835eb

test: refactored tests

8b18adf

dandanlen reviewed Oct 10, 2024

View reviewed changes

Janislav added 7 commits October 10, 2024 15:49

chore: Removed unused events

961b0af

chore: Ensure only by broker

46757df

chore: removed broker from tainted tx struct

d61390c

chore: Only clone owner

3e4d901

chore: Moved tx tainted check

c76fd40

Merge branch 'main' into feature/pro-1664/close-deposit-channel

6373909

feature: Added migration for DepositChannelLookup

19feaf3

chore: Fixed clippy in CI

6a70d60

MxmUrw mentioned this pull request Oct 21, 2024

feat: update custom_rpc, runtime_api and broker api for broker level screening #5341

Merged

4 tasks

chore: update comments

315b278

msgmaxim reviewed Oct 22, 2024

View reviewed changes

fix: don't allow report overwrite

10cdcdf

dandanlen reviewed Oct 22, 2024

View reviewed changes

state-chain/pallets/cf-ingress-egress/src/lib.rs Outdated Show resolved Hide resolved

state-chain/pallets/cf-ingress-egress/src/lib.rs Outdated Show resolved Hide resolved

dandanlen reviewed Oct 22, 2024

View reviewed changes

state-chain/pallets/cf-ingress-egress/src/lib.rs Outdated Show resolved Hide resolved

dandanlen changed the title ~~Mark transaction as tainted~~ feat: tainted transaction reporting Oct 22, 2024

Janislav and others added 2 commits October 22, 2024 13:41

chore: Renamed event

326d304

feat: improvements:

af46925

- mark boosted transactions as boosted instead of using channel status - allow pallet config instead of relying on chain - add event for tx reports - only allow reporting of unseen transactions - add doc comments - renaming of types/events - remove unused error

Merge branch 'main' into feature/pro-1664/close-deposit-channel

7ef3189

dandanlen approved these changes Oct 23, 2024

View reviewed changes

dandanlen added this pull request to the merge queue Oct 23, 2024

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Oct 23, 2024

Janislav added this pull request to the merge queue Oct 23, 2024

Janislav removed this pull request from the merge queue due to a manual request Oct 23, 2024

fix: migration

083ebfa

dandanlen approved these changes Oct 24, 2024

View reviewed changes

fix: made clippy happy

c45ec0f

dandanlen added this pull request to the merge queue Oct 24, 2024

Merged via the queue into main with commit dc8bf3e Oct 24, 2024
48 of 49 checks passed

dandanlen deleted the feature/pro-1664/close-deposit-channel branch October 24, 2024 13:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: tainted transaction reporting #5310

feat: tainted transaction reporting #5310

Janislav commented Oct 2, 2024 •

edited

Loading

codecov bot commented Oct 2, 2024 •

edited

Loading

dandanlen left a comment

dandanlen Oct 4, 2024

Janislav Oct 4, 2024

Janislav commented Oct 7, 2024

dandanlen commented Oct 10, 2024

msgmaxim commented Oct 22, 2024

msgmaxim Oct 22, 2024

dandanlen commented Oct 22, 2024

Janislav commented Oct 23, 2024

		<T::TargetChain as Chain>::DepositDetails,
		TaintedTransactionDetails<T::AccountId>,

feat: tainted transaction reporting #5310

feat: tainted transaction reporting #5310

Conversation

Janislav commented Oct 2, 2024 • edited Loading

Pull Request

Checklist

Summary

Non-Breaking changes

codecov bot commented Oct 2, 2024 • edited Loading

Codecov Report

dandanlen left a comment

Choose a reason for hiding this comment

dandanlen Oct 4, 2024

Choose a reason for hiding this comment

Janislav Oct 4, 2024

Choose a reason for hiding this comment

Janislav commented Oct 7, 2024

dandanlen commented Oct 10, 2024

msgmaxim commented Oct 22, 2024

msgmaxim Oct 22, 2024

Choose a reason for hiding this comment

dandanlen commented Oct 22, 2024

Janislav commented Oct 23, 2024

Janislav commented Oct 2, 2024 •

edited

Loading

codecov bot commented Oct 2, 2024 •

edited

Loading