feat(interchain-token-service): add flow limit #130

AttissNgo · 2025-01-09T02:29:06Z

- implement flow limit for interchain transfers - add Operatable trait and change constructor - update golden files (tests generate different contract addresses due to updated constructor) - minor changes to test helper functions

codecov-commenter · 2025-01-09T02:31:24Z

Codecov Report

Attention: Patch coverage is 99.27536% with 1 line in your changes missing coverage. Please review.

Project coverage is 94.84%. Comparing base (7adc13d) to head (f4a549a).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
...ntracts/interchain-token-service/src/flow_limit.rs	99.04%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #130      +/-   ##
==========================================
+ Coverage   94.63%   94.84%   +0.20%     
==========================================
  Files          52       53       +1     
  Lines        3130     3276     +146     
==========================================
+ Hits         2962     3107     +145     
- Misses        168      169       +1

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

contracts/interchain-token-service/src/flow_limit.rs

contracts/interchain-token-service/src/storage_types.rs

contracts/interchain-token-service/src/interface.rs

contracts/interchain-token-service/src/event.rs

contracts/interchain-token-service/src/interface.rs

contracts/interchain-token-service/src/flow_limit.rs

contracts/interchain-token-service/src/interface.rs

contracts/interchain-token-service/tests/flow_limit.rs

- Add docstrings to entrypoints - Create FlowKey struct for better organization of storage keys - Move flow logic into FlowDirection impl - Organize imports and group public functions - Allow zero flow limit to 'freeze' token

contracts/interchain-token-service/src/flow_limit.rs

contracts/interchain-token-service/src/contract.rs

contracts/interchain-token-service/src/event.rs

contracts/interchain-token-service/src/contract.rs

packages/axelar-soroban-std/src/events.rs

contracts/interchain-token-service/src/flow_limit.rs

- encapsulate add flow logic in Flow Direction enum - add comments/docstring where necessary - move entrypoint docstring from contract to interface - refactor imports

contracts/interchain-token-service/src/interface.rs

contracts/interchain-token-service/src/flow_limit.rs

- improve docstring describing flow direction - remove unneeded variables in add_flow

milapsheth · 2025-01-14T01:50:59Z

contracts/interchain-token-service/tests/flow_limit.rs

+const TEST_FLOW_LIMIT: Option<i128> = Some(1000);
+const EPOCH_TIME: u64 = 6 * 60 * 60;
+
+fn setup_flow_limit(env: &Env, client: &InterchainTokenServiceClient) -> (BytesN<32>, Address) {


Suggested change

fn setup_flow_limit(env: &Env, client: &InterchainTokenServiceClient) -> (BytesN<32>, Address) {

fn setup(env: &Env, client: &InterchainTokenServiceClient) -> (BytesN<32>, Address) {

perhaps

milapsheth · 2025-01-14T01:52:40Z

contracts/interchain-token-service/tests/flow_limit.rs

+    client: &InterchainTokenServiceClient,
+    token_id: &BytesN<32>,
+    amount: i128,
+) -> (String, String, String, Bytes, Vec<GatewayMessage>) {


Suggested change

) -> (String, String, String, Bytes, Vec<GatewayMessage>) {

) -> TestMessage {

create a struct

milapsheth · 2025-01-14T02:00:40Z

contracts/interchain-token-service/tests/flow_limit.rs

+    (token_id, deployer)
+}
+
+fn create_interchain_transfer_message(


Suggested change

fn create_interchain_transfer_message(

fn execute_its_transfer(

perhaps. It can approve and execute ITS in the helper itself to reduce duplication

milapsheth · 2025-01-14T02:01:40Z

contracts/interchain-token-service/tests/flow_limit.rs

+            payload_hash,
+        },
+    ];
+


call approve gateway within this method to reduce duplication

milapsheth · 2025-01-14T02:03:17Z

contracts/interchain-token-service/tests/flow_limit.rs

+    let recipient = Address::generate(env).to_xdr(env);
+    let source_chain = client.its_hub_chain_name();
+    let source_address = Address::generate(env).to_string();
+


Suggested change

let message_id = Address::generate(env).to_string();

milapsheth · 2025-01-14T02:34:04Z

contracts/interchain-token-service/tests/flow_limit.rs

+    let gas_token = setup_gas_token(&env, &sender);
+
+    let amount = 1000;
+    let destination_chain = String::from_str(&env, "ethereum");


create a helper for these dummy values

milapsheth · 2025-01-14T02:34:59Z

contracts/interchain-token-service/tests/flow_limit.rs

+        .mock_all_auths()
+        .set_trusted_chain(&destination_chain);
+
+    client.mock_all_auths().interchain_transfer(


same comment on hard to tell which call panicked, so use assert_auth_ok here

milapsheth · 2025-01-14T02:37:03Z

contracts/interchain-token-service/tests/flow_limit.rs

+    let (token_id, sender) = setup_flow_limit(&env, &client);
+    let gas_token = setup_gas_token(&env, &sender);
+
+    client


Suggested change

client

let flow_limit = i128::MAX - 50;

client

milapsheth · 2025-01-14T02:37:19Z

contracts/interchain-token-service/tests/flow_limit.rs

+        .mock_all_auths()
+        .set_flow_limit(&token_id, &Some(i128::MAX - 50));
+
+    let high_amount = i128::MAX - 100;


Suggested change

let high_amount = i128::MAX - 100;

let high_amount = flow_limit - 1;

reuse value

milapsheth · 2025-01-14T02:37:28Z

contracts/interchain-token-service/tests/flow_limit.rs

+    approve_gateway_messages(&env, &gateway_client, signers, messages);
+    client.execute(&source_chain, &message_id, &source_address, &payload);
+
+    let small_amount = 100;


Suggested change

let small_amount = 100;

let small_amount = 2;

I recommend creating a vector of flow in + flow out test cases, and running the test logic here in a loop over them to try different scenarios

feat(interchain-token-service): add flow limit

c5516c6

- implement flow limit for interchain transfers - add Operatable trait and change constructor - update golden files (tests generate different contract addresses due to updated constructor) - minor changes to test helper functions

AttissNgo requested a review from a team as a code owner January 9, 2025 02:29

AttissNgo added 2 commits January 8, 2025 20:35

remove unneeded references and clones from test

b42d7e7

remove unneeded references from tests

f4f6f36

milapsheth reviewed Jan 9, 2025

View reviewed changes

feat(interchain-token-service): add flow limit

40de86e

- Add docstrings to entrypoints - Create FlowKey struct for better organization of storage keys - Move flow logic into FlowDirection impl - Organize imports and group public functions - Allow zero flow limit to 'freeze' token

Foivos reviewed Jan 10, 2025

View reviewed changes

contracts/interchain-token-service/src/flow_limit.rs Show resolved Hide resolved

contracts/interchain-token-service/src/flow_limit.rs Outdated Show resolved Hide resolved

contracts/interchain-token-service/src/flow_limit.rs Outdated Show resolved Hide resolved

add newlines for readability

f4a549a

milapsheth reviewed Jan 10, 2025

View reviewed changes

AttissNgo and others added 2 commits January 13, 2025 11:29

feat(interchain-token-service): add flow limit

00bfe8d

- encapsulate add flow logic in Flow Direction enum - add comments/docstring where necessary - move entrypoint docstring from contract to interface - refactor imports

Merge branch 'main' into feat/its-add-flow-limit

50a2e91

milapsheth approved these changes Jan 14, 2025

View reviewed changes

feat(interchain-token-service): add flow limit

a90af89

- improve docstring describing flow direction - remove unneeded variables in add_flow

AttissNgo merged commit 7da3677 into main Jan 14, 2025
5 checks passed

AttissNgo deleted the feat/its-add-flow-limit branch January 14, 2025 02:32

milapsheth reviewed Jan 14, 2025

View reviewed changes

AttissNgo mentioned this pull request Jan 16, 2025

fix(interchain-token-service): fix flow limit storage and testing #144

Closed

talalashraf mentioned this pull request Jan 17, 2025

chore: release v0.1.0 #153

Merged

ahramy mentioned this pull request Jan 21, 2025

chore: release v0.1.0 #166

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(interchain-token-service): add flow limit #130

feat(interchain-token-service): add flow limit #130

AttissNgo commented Jan 9, 2025 •

edited by jira bot

Loading

codecov-commenter commented Jan 9, 2025 •

edited

Loading

milapsheth Jan 14, 2025

milapsheth Jan 14, 2025

milapsheth Jan 14, 2025

milapsheth Jan 14, 2025

milapsheth Jan 14, 2025

milapsheth Jan 14, 2025

milapsheth Jan 14, 2025

milapsheth Jan 14, 2025

milapsheth Jan 14, 2025

milapsheth Jan 14, 2025

milapsheth Jan 14, 2025

	fn setup_flow_limit(env: &Env, client: &InterchainTokenServiceClient) -> (BytesN<32>, Address) {
	fn setup(env: &Env, client: &InterchainTokenServiceClient) -> (BytesN<32>, Address) {

	) -> (String, String, String, Bytes, Vec<GatewayMessage>) {
	) -> TestMessage {

	fn create_interchain_transfer_message(
	fn execute_its_transfer(

-    client
+    let flow_limit = i128::MAX - 50;
+    client

	let high_amount = i128::MAX - 100;
	let high_amount = flow_limit - 1;

feat(interchain-token-service): add flow limit #130

feat(interchain-token-service): add flow limit #130

Conversation

AttissNgo commented Jan 9, 2025 • edited by jira bot Loading

codecov-commenter commented Jan 9, 2025 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AttissNgo commented Jan 9, 2025 •

edited by jira bot

Loading

codecov-commenter commented Jan 9, 2025 •

edited

Loading