Problem: ibc refund is not tested in integration test (#613)

* add ibc timeout case

* test refund

* configurable ibc timeout height

* revert covert for timeout

introduced from cdcfda1

* fix for nonSource

* fix isort under nix

* fix parse trace for refund

* test refund on ack err

* Revert "configurable ibc timeout height"

This reverts commit 1ba6e7a.

* align pattern

* revert debug

* rename test

* replace try finally with yield from

for more info, https://stackoverflow.com/questions/9708902/in-practice-what-are-the-main-uses-for-the-yield-from-syntax-in-python-3-3

Co-authored-by: yihuang <huang@crypto.com>

Author: mmsqe

integration_tests/configs/ibc.jsonnet

@@ -84,6 +84,9 @@ config {
     },
   },
   relayer: {
+    global: {
+      strategy: 'all',
+    },
     rest: {
       enabled: true,
       host: '127.0.0.1',

integration_tests/configs/ibc_timeout.jsonnet

@@ -0,0 +1,15 @@
+local ibc = import 'ibc.jsonnet';
+
+ibc {
+  'cronos_777-1'+: {
+    genesis+: {
+      app_state+: {
+        cronos+: {
+          params+: {
+            ibc_timeout: 0,
+          },
+        },
+      },
+    },
+  },
+}

integration_tests/ibc_utils.py

@@ -0,0 +1,79 @@
+import json
+import subprocess
+from pathlib import Path
+from typing import NamedTuple
+
+from pystarport import ports
+
+from .network import Chainmain, Cronos, Hermes, setup_custom_cronos
+from .utils import ADDRS, eth_to_bech32, supervisorctl, wait_for_port
+
+RATIO = 10**10
+
+
+class IBCNetwork(NamedTuple):
+    cronos: Cronos
+    chainmain: Chainmain
+    hermes: Hermes
+
+
+def prepare_network(tmp_path, file):
+    file = f"configs/{file}.jsonnet"
+    gen = setup_custom_cronos(tmp_path, 26700, Path(__file__).parent / file)
+    cronos = next(gen)
+    chainmain = Chainmain(cronos.base_dir.parent / "chainmain-1")
+    hermes = Hermes(cronos.base_dir.parent / "relayer.toml")
+    # wait for grpc ready
+    wait_for_port(ports.grpc_port(chainmain.base_port(0)))  # chainmain grpc
+    wait_for_port(ports.grpc_port(cronos.base_port(0)))  # cronos grpc
+    subprocess.check_call(
+        [
+            "hermes",
+            "-c",
+            hermes.configpath,
+            "create",
+            "channel",
+            "cronos_777-1",
+            "chainmain-1",
+            "--port-a",
+            "transfer",
+            "--port-b",
+            "transfer",
+        ]
+    )
+    supervisorctl(cronos.base_dir / "../tasks.ini", "start", "relayer-demo")
+    wait_for_port(hermes.port)
+    yield IBCNetwork(cronos, chainmain, hermes)
+
+
+def assert_ready(ibc):
+    # wait for hermes
+    output = subprocess.getoutput(
+        f"curl -s -X GET 'http://127.0.0.1:{ibc.hermes.port}/state' | jq"
+    )
+    assert json.loads(output)["status"] == "success"
+
+
+def prepare(ibc):
+    assert_ready(ibc)
+    # chainmain-1 -> cronos_777-1
+    my_ibc0 = "chainmain-1"
+    my_ibc1 = "cronos_777-1"
+    my_channel = "channel-0"
+    dst_addr = eth_to_bech32(ADDRS["signer2"])
+    src_amount = 10
+    src_denom = "basecro"
+    # dstchainid srcchainid srcportid srchannelid
+    cmd = (
+        f"hermes -c {ibc.hermes.configpath} tx raw ft-transfer "
+        f"{my_ibc1} {my_ibc0} transfer {my_channel} {src_amount} "
+        f"-o 1000 -n 1 -d {src_denom} -r {dst_addr} -k relayer"
+    )
+    subprocess.run(cmd, check=True, shell=True)
+    return src_amount
+
+
+def get_balance(chain, addr, denom):
+    balance = chain.cosmos_cli().balance(addr, denom)
+    print("balance", balance, addr, denom)
+    return balance

integration_tests/test_ibc.py

@@ -1,182 +1,150 @@
 import base64
 import json
-import subprocess
-from pathlib import Path
-from typing import NamedTuple
 
 import pytest
-from pystarport import ports
 
-from .network import Chainmain, Cronos, Hermes, setup_custom_cronos
+from .ibc_utils import RATIO, assert_ready, get_balance, prepare, prepare_network
 from .utils import (
     ADDRS,
     CONTRACTS,
     deploy_contract,
     eth_to_bech32,
     send_transaction,
-    supervisorctl,
     wait_for_fn,
     wait_for_new_blocks,
-    wait_for_port,
 )
 
 
-class IBCNetwork(NamedTuple):
-    cronos: Cronos
-    chainmain: Chainmain
-    hermes: Hermes
-
-
 @pytest.fixture(scope="module")
 def ibc(request, tmp_path_factory):
-    "start-cronos"
-    path = tmp_path_factory.mktemp("ibc")
-    gen = setup_custom_cronos(
-        path, 26700, Path(__file__).parent / "configs/ibc.jsonnet"
-    )
-    cronos = next(gen)
-    try:
-        chainmain = Chainmain(cronos.base_dir.parent / "chainmain-1")
-        hermes = Hermes(cronos.base_dir.parent / "relayer.toml")
-        # wait for grpc ready
-        wait_for_port(ports.grpc_port(chainmain.base_port(0)))  # chainmain grpc
-        wait_for_port(ports.grpc_port(cronos.base_port(0)))  # cronos grpc
-        subprocess.check_call(
-            [
-                "hermes",
-                "-c",
-                hermes.configpath,
-                "create",
-                "channel",
-                "cronos_777-1",
-                "chainmain-1",
-                "--port-a",
-                "transfer",
-                "--port-b",
-                "transfer",
-            ]
-        )
-        supervisorctl(cronos.base_dir / "../tasks.ini", "start", "relayer-demo")
-        wait_for_port(hermes.port)
-        yield IBCNetwork(cronos, chainmain, hermes)
-    finally:
-        try:
-            next(gen)
-        except StopIteration:
-            pass
-
-
-def get_balance(chain, addr, denom):
-    return chain.cosmos_cli().balance(addr, denom)
+    "prepare-network"
+    name = "ibc"
+    path = tmp_path_factory.mktemp(name)
+    network = prepare_network(path, name)
+    yield from network
 
 
 def get_balances(chain, addr):
     return chain.cosmos_cli().balances(addr)
 
 
 def test_ibc(ibc):
-    "test sending basecro from crypto-org chain to cronos"
-    # wait for hermes
-    output = subprocess.getoutput(
-        f"curl -s -X GET 'http://127.0.0.1:{ibc.hermes.port}/state' | jq"
-    )
-    assert json.loads(output)["status"] == "success"
-
-    my_ibc0 = "chainmain-1"
-    my_ibc1 = "cronos_777-1"
-    my_channel = "channel-0"
-    my_config = ibc.hermes.configpath
-    # signer2
-    coin_receiver = eth_to_bech32(ADDRS["signer2"])
-    src_amount = 10
-    dst_amount = src_amount * (10**10)  # the decimal places difference
-    src_denom = "basecro"
+    src_amount = prepare(ibc)
+    dst_amount = src_amount * RATIO  # the decimal places difference
     dst_denom = "basetcro"
-    # dstchainid srcchainid srcportid srchannelid
-    # chainmain-1 -> cronos_777-1
-    cmd = (
-        f"hermes -c {my_config} tx raw ft-transfer "
-        f"{my_ibc1} {my_ibc0} transfer {my_channel} {src_amount} "
-        f"-o 1000 -n 1 -d {src_denom} -r {coin_receiver} -k relayer"
-    )
-    subprocess.run(cmd, check=True, shell=True)
-    dstaddr = f"{coin_receiver}"
-    olddstbalance = get_balance(ibc.cronos, dstaddr, dst_denom)
-    newdstbalance = 0
+    dst_addr = eth_to_bech32(ADDRS["signer2"])
+    old_dst_balance = get_balance(ibc.cronos, dst_addr, dst_denom)
+
+    new_dst_balance = 0
 
     def check_balance_change():
-        nonlocal newdstbalance
-        newdstbalance = get_balance(ibc.cronos, dstaddr, dst_denom)
-        return newdstbalance != olddstbalance
+        nonlocal new_dst_balance
+        new_dst_balance = get_balance(ibc.cronos, dst_addr, dst_denom)
+        return new_dst_balance != old_dst_balance
 
-    wait_for_fn("check balance change", check_balance_change)
-    expectedbalance = olddstbalance + dst_amount
-    assert expectedbalance == newdstbalance
+    wait_for_fn("balance change", check_balance_change)
+    assert old_dst_balance + dst_amount == new_dst_balance
 
 
 def test_cronos_transfer_tokens(ibc):
     """
     test sending basetcro from cronos to crypto-org-chain using cli transfer_tokens.
     depends on `test_ibc` to send the original coins.
     """
-    output = subprocess.getoutput(
-        f"curl -s -X GET 'http://127.0.0.1:{ibc.hermes.port}/state' | jq"
-    )
-    assert json.loads(output)["status"] == "success"
-
-    coin_receiver = ibc.chainmain.cosmos_cli().address("signer2")
+    assert_ready(ibc)
+    dst_addr = ibc.chainmain.cosmos_cli().address("signer2")
     dst_amount = 2
-    src_amount = dst_amount * (10**10)  # the decimal places difference
+    dst_denom = "basecro"
+    cli = ibc.cronos.cosmos_cli()
+    src_amount = dst_amount * RATIO  # the decimal places difference
+    src_addr = cli.address("signer2")
+    src_denom = "basetcro"
 
     # case 1: use cronos cli
-    oldbalance = get_balance(ibc.chainmain, coin_receiver, "basecro")
+    old_src_balance = get_balance(ibc.cronos, src_addr, src_denom)
+    old_dst_balance = get_balance(ibc.chainmain, dst_addr, dst_denom)
+    rsp = cli.transfer_tokens(
+        src_addr,
+        dst_addr,
+        f"{src_amount}{src_denom}",
+    )
+    assert rsp["code"] == 0, rsp["raw_log"]
+
+    new_dst_balance = 0
+
+    def check_balance_change():
+        nonlocal new_dst_balance
+        new_dst_balance = get_balance(ibc.chainmain, dst_addr, dst_denom)
+        return old_dst_balance != new_dst_balance
+
+    wait_for_fn("balance change", check_balance_change)
+    assert old_dst_balance + dst_amount == new_dst_balance
+    new_src_balance = get_balance(ibc.cronos, src_addr, src_denom)
+    assert old_src_balance - src_amount == new_src_balance
+
+
+def test_cronos_transfer_tokens_acknowledgement_error(ibc):
+    """
+    test sending basetcro from cronos to crypto-org-chain using cli transfer_tokens
+    with invalid receiver for acknowledgement error.
+    depends on `test_ibc` to send the original coins.
+    """
+    assert_ready(ibc)
+    dst_addr = "invalid_address"
+    dst_amount = 2
     cli = ibc.cronos.cosmos_cli()
+    src_amount = dst_amount * RATIO  # the decimal places difference
+    src_addr = cli.address("signer2")
+    src_denom = "basetcro"
+
+    old_src_balance = get_balance(ibc.cronos, src_addr, src_denom)
     rsp = cli.transfer_tokens(
-        cli.address("signer2"),
-        coin_receiver,
-        f"{src_amount}basetcro",
+        src_addr,
+        dst_addr,
+        f"{src_amount}{src_denom}",
     )
     assert rsp["code"] == 0, rsp["raw_log"]
 
-    newbalance = 0
+    new_src_balance = 0
 
     def check_balance_change():
-        nonlocal newbalance
-        newbalance = get_balance(ibc.chainmain, coin_receiver, "basecro")
-        return oldbalance != newbalance
+        nonlocal new_src_balance
+        new_src_balance = get_balance(ibc.cronos, src_addr, src_denom)
+        return old_src_balance == new_src_balance
 
-    wait_for_fn("check balance change", check_balance_change)
-    assert oldbalance + dst_amount == newbalance
+    wait_for_fn("balance no change", check_balance_change)
+    new_src_balance = get_balance(ibc.cronos, src_addr, src_denom)
 
 
 def test_cro_bridge_contract(ibc):
     """
     test sending basetcro from cronos to crypto-org-chain using CroBridge contract.
     depends on `test_ibc` to send the original coins.
     """
-    coin_receiver = ibc.chainmain.cosmos_cli().address("signer2")
+    dst_addr = ibc.chainmain.cosmos_cli().address("signer2")
     dst_amount = 2
-    src_amount = dst_amount * (10**10)  # the decimal places difference
-    oldbalance = get_balance(ibc.chainmain, coin_receiver, "basecro")
+    dst_denom = "basecro"
+    src_amount = dst_amount * RATIO  # the decimal places difference
+    old_dst_balance = get_balance(ibc.chainmain, dst_addr, dst_denom)
 
     # case 2: use CroBridge contract
     w3 = ibc.cronos.w3
     contract = deploy_contract(w3, CONTRACTS["CroBridge"])
-    tx = contract.functions.send_cro_to_crypto_org(coin_receiver).buildTransaction(
+    tx = contract.functions.send_cro_to_crypto_org(dst_addr).buildTransaction(
         {"from": ADDRS["signer2"], "value": src_amount}
     )
     receipt = send_transaction(w3, tx)
     assert receipt.status == 1
 
-    newbalance = 0
+    new_dst_balance = 0
 
     def check_balance_change():
-        nonlocal newbalance
-        newbalance = get_balance(ibc.chainmain, coin_receiver, "basecro")
-        return oldbalance != newbalance
+        nonlocal new_dst_balance
+        new_dst_balance = get_balance(ibc.chainmain, dst_addr, dst_denom)
+        return old_dst_balance != new_dst_balance
 
     wait_for_fn("check balance change", check_balance_change)
-    assert oldbalance + dst_amount == newbalance
+    assert old_dst_balance + dst_amount == new_dst_balance
 
 
 def test_ica(ibc, tmp_path):
@@ -271,11 +239,7 @@ def test_cronos_transfer_source_tokens(ibc):
     """
     test sending crc20 tokens originated from cronos to crypto-org-chain
     """
-    output = subprocess.getoutput(
-        f"curl -s -X GET 'http://127.0.0.1:{ibc.hermes.port}/state' | jq"
-    )
-    assert json.loads(output)["status"] == "success"
-
+    assert_ready(ibc)
     # deploy crc21 contract
     w3 = ibc.cronos.w3
     contract = deploy_contract(w3, CONTRACTS["TestERC21Source"])