Add support for wildcards in packet filter #1931

hu55a1n1 · 2022-03-02T14:19:27Z

Closes: #1927

For testing, follow the instructions at https://github.com/cosmos/interchain-accounts-demo or look at the integration test.

For example, to only relay on channel-0 and on all ICA channels:

[chains.packet_filter]
policy = 'allow'
list = [
  ['ica*', '*'],    # <- wildcards
  ['transfer', 'channel-0'],
]

PR author checklist:

Added changelog entry, using unclog.
Added tests: integration (for Hermes) or unit/mock tests (for modules).
Linked to GitHub issue.
Updated code comments and documentation (e.g., docs/).

Reviewer checklist:

Reviewed Files changed in the GitHub PR explorer.
Manually tested (in case integration/unit/mock tests are absent).

… integration tests

relayer/src/config.rs

relayer/src/supervisor/scan.rs

romac · 2022-03-18T16:21:16Z

Added a proper integration test which performs an ICA bank transfer.

tools/integration-test/src/tests/ordered_channel.rs

soareschen · 2022-03-21T11:38:48Z

tools/integration-test/src/tests/ica_filter.rs

+        .register_interchain_account(&wallet_a.address(), &connection_a.connection_id_a.as_ref())?;
+
+    let channel_id_a: TaggedChannelId<ChainA, ChainB> =
+        TaggedChannelId::new("channel-0".parse().unwrap());


Is there any way we can get back the channel ID that is not hard coded? Should Hermes also implement CLI and function for registering interchain account instead of doing it through Gaia?

Is there any way we can get back the channel ID that is not hard coded?

Maybe we can query the channels for a given connection?

Should Hermes also implement CLI and function for registering interchain account instead of doing it through Gaia?

I don't think that should be the responsibility of the relayer, though it might be useful for testing but it's not clear whether it's worth the cost or not at the moment. Maybe if we hear the need from operators.

We can discuss during the weekly sync, but let's keep it out of this PR anyway.

tools/test-framework/src/chain/driver.rs

.github/workflows/integration.yaml

…ad of gaiad without having to hard code the path

…dress

tools/integration-test/src/tests/mod.rs

tools/integration-test/src/tests/ica_filter.rs

.changelog/unreleased/improvements/relayer/1927-packet-clearing-wildcards.md

ancazamfir · 2022-03-22T12:08:38Z

Great stuff! Looks good to me. One unrelated question but showed up while testing this. Why do we spawn the packet workers on OpenAckChannel and OpenConfirmChannel events? The following sequences result in different worker set for hermes:

hermes start then hermes create channel...
hermes create channel... then hermes start

Code is here https://github.com/informalsystems/ibc-rs/blob/1481a16ee077f6708e3f2ce1866f8e90340fdf46/relayer/src/supervisor.rs#L403-L405
and here
https://github.com/informalsystems/ibc-rs/blob/1481a16ee077f6708e3f2ce1866f8e90340fdf46/relayer/src/supervisor.rs#L419-L421

* Add filter match support * Implement AsRef<str> for PortId and ChannelId * Fix Deserialize validation for filters * Implement regex support * Add FIXME * Fix clippy errors * Fix regex validation * Refactoring and renaming * Update config.toml * Add unclog entry * Add documentation for `PacketFilter` and associated types. * Fix deserialize impl for FilterPatterns * Rename filter_match.rs to filter_pattern.rs * Add `FromStr` and remove `Into<String>` for `ics04_channel::Version` * Parse channel `Version` directly in `create channel` command * Use `Version` instead of `String` in `Channel::new` * Add `ChannelVersionOverride` trait to override the channel version in integration tests * Fix warning * WIP: Write an integration test that creates a ICA channel * Add facility to modify genesis file * Rename some things * Add packet filtering snippet to relayer config example. * Add test for deserializing packet filter policy * Add packet filter policy serialization test. * Fix serialize_packet_filter_policy test * Cleanup config tests * Fix TOML serialization of ChannelFilters and FilterPattern * Rename some methods * Move filter-related code into its own module * Uncomment packet filter policy in relayer example config * Fix link in doc comment * Remove some unnecessary clones * Add test for iter_exact and impl PartialEq for Wildcard * Get iter_exact test passing * Add allow and deny filter tests * Disable ICA filter test * Rename `spec` to `filters` * Update `regex` crate to v1.5.5 * Update lockfiles * Revert "Add facility to modify genesis file" This reverts commit dd803a9. * Comment out ICA filter test * Add `ChannelFilters::new` * Add working ICA filter integration test * Add test for when ICA channels are disallowed * Apply the channel filter to channel handshakes as well * Enable ICA filter test on CI * Update Nix path to icad * Refactor ICA test * Add changelog entry * Extend ICA filter test with ICA transfer * Add facility for modifying the genesis file * Modify genesis file to allow MsgSend messages over ICA * Cleanup * Add comments * Re-enable ordered channel test * Remove top-level unrelated file * Use `CHAIN_COMMAND_PATH` env variable to run the test with icad instead of gaiad without having to hard code the path * Move ICA driver methods into their own module as functions * Change signature of `assert_eventual_wallet_amount` to take wallet address * Add some doc comments * Rename `ica-filter` test feature and module to `ica` * Remove duplicate changelog entry * Add back missing file Co-authored-by: Sean Chen <[email protected]> Co-authored-by: Romain Ruetschi <[email protected]> Co-authored-by: Soares Chen <[email protected]>

hu55a1n1 and others added 21 commits March 2, 2022 18:49

Add filter match support

6b030ed

Implement AsRef<str> for PortId and ChannelId

64e413a

Fix Deserialize validation for filters

185f64c

Implement regex support

5d5a40f

Add FIXME

2e77873

Fix clippy errors

8fdb7ab

Fix regex validation

2caf033

Refactoring and renaming

02dae79

Update config.toml

2b1987a

Add unclog entry

527e469

Add documentation for PacketFilter and associated types.

0afcf3a

Fix deserialize impl for FilterPatterns

f15f6f2

Rename filter_match.rs to filter_pattern.rs

018184d

Add FromStr and remove Into<String> for ics04_channel::Version

75f40e3

Parse channel Version directly in create channel command

b756e07

Use Version instead of String in Channel::new

ae70357

Add ChannelVersionOverride trait to override the channel version in…

79a4152

… integration tests

Fix warning

2c0dbeb

WIP: Write an integration test that creates a ICA channel

81776e6

Add facility to modify genesis file

dd803a9

Merge branch 'master' into hu55a1n1/1927-packet-filtering-wildcards

fb94f43

romac reviewed Mar 2, 2022

View reviewed changes

relayer/src/config.rs Outdated Show resolved Hide resolved

relayer/src/config.rs Outdated Show resolved Hide resolved

relayer/src/supervisor/scan.rs Outdated Show resolved Hide resolved

seanchen1991 and others added 8 commits March 2, 2022 11:59

Rename some things

87dfbac

Fix merge conflicts

66f74c2

Add packet filtering snippet to relayer config example.

fd76d24

Add test for deserializing packet filter policy

c7efade

Add packet filter policy serialization test.

82bd6b3

Fix serialize_packet_filter_policy test

d9d0f3c

Cleanup config tests

391a64c

Merge branch 'master' into hu55a1n1/1927-packet-filtering-wildcards

5c9b1aa

romac added 4 commits March 18, 2022 17:03

Add facility for modifying the genesis file

61a68ed

Modify genesis file to allow MsgSend messages over ICA

a9698eb

Cleanup

626b9e0

Add comments

7351f41

Merge branch 'master' into hu55a1n1/1927-packet-filtering-wildcards

d82a4ed

romac requested review from seanchen1991 and soareschen March 18, 2022 16:53

hu55a1n1 commented Mar 18, 2022

View reviewed changes

tools/integration-test/src/tests/ordered_channel.rs Outdated Show resolved Hide resolved

romac added 2 commits March 18, 2022 18:34

Re-enable ordered channel test

2964464

Remove top-level unrelated file

62aeb9c

soareschen reviewed Mar 21, 2022

View reviewed changes

soareschen requested changes Mar 21, 2022

View reviewed changes

tools/test-framework/src/chain/driver.rs Outdated Show resolved Hide resolved

tools/test-framework/src/chain/driver.rs Outdated Show resolved Hide resolved

.github/workflows/integration.yaml Show resolved Hide resolved

romac added 3 commits March 21, 2022 15:08

Use CHAIN_COMMAND_PATH env variable to run the test with icad inste…

91faaf4

…ad of gaiad without having to hard code the path

Move ICA driver methods into their own module as functions

d5adce1

Change signature of assert_eventual_wallet_amount to take wallet ad…

1b90428

…dress

soareschen requested changes Mar 21, 2022

View reviewed changes

tools/integration-test/src/tests/mod.rs Outdated Show resolved Hide resolved

tools/integration-test/src/tests/ica_filter.rs Outdated Show resolved Hide resolved

tools/integration-test/src/tests/ica_filter.rs Outdated Show resolved Hide resolved

Add some doc comments

3e26f02

seanchen1991 reviewed Mar 21, 2022

View reviewed changes

.changelog/unreleased/improvements/relayer/1927-packet-clearing-wildcards.md Outdated Show resolved Hide resolved

romac added 4 commits March 21, 2022 16:52

Rename ica-filter test feature and module to ica

6c23ab0

Remove duplicate changelog entry

5ae6391

Merge branch 'master' into hu55a1n1/1927-packet-filtering-wildcards

f126839

Add back missing file

123ef49

seanchen1991 approved these changes Mar 21, 2022

View reviewed changes

soareschen approved these changes Mar 22, 2022

View reviewed changes

romac mentioned this pull request Mar 22, 2022

Packet worker is spawned on channel ack and confirm events #1991

Closed

romac merged commit bc989c3 into master Mar 22, 2022

romac deleted the hu55a1n1/1927-packet-filtering-wildcards branch March 22, 2022 14:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for wildcards in packet filter #1931

Add support for wildcards in packet filter #1931

hu55a1n1 commented Mar 2, 2022 •

edited by romac

Loading

romac commented Mar 18, 2022

soareschen Mar 21, 2022

romac Mar 21, 2022

romac Mar 21, 2022

ancazamfir commented Mar 22, 2022

Add support for wildcards in packet filter #1931

Add support for wildcards in packet filter #1931

Conversation

hu55a1n1 commented Mar 2, 2022 • edited by romac Loading

PR author checklist:

Reviewer checklist:

romac commented Mar 18, 2022

soareschen Mar 21, 2022

Choose a reason for hiding this comment

romac Mar 21, 2022

Choose a reason for hiding this comment

romac Mar 21, 2022

Choose a reason for hiding this comment

ancazamfir commented Mar 22, 2022

hu55a1n1 commented Mar 2, 2022 •

edited by romac

Loading