First version of working GOTH test and payment deposit fixes

.github/workflows/integration-test-nightly.yml

@@ -81,7 +81,7 @@ jobs:
 
       - name: Run test suite
         env:
-          GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
           # Runs on branches defined within matrix
           poetry run poe goth-tests --config-override docker-compose.build-environment.branch=${{ matrix.branch }}

.github/workflows/integration-test.yml

@@ -188,7 +188,7 @@ jobs:
 
       - name: Run test suite
         env:
-          GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
           poetry run poe goth-tests --splits 2 --group ${{ matrix.group }} --config-override docker-compose.build-environment.binary-path=/tmp/yagna-build
 

Cargo.toml

@@ -232,8 +232,8 @@ members = [
 # diesel 1.4.* supports up to 0.23.0, but sqlx 0.5.9 requires 0.22.0
 # sqlx 0.5.10 need 0.23.2, so 0.5.9 is last version possible
 derive_more = "0.99.11"
-erc20_payment_lib = { git = "https://github.com/golemfactory/erc20_payment_lib", rev = "c2d548c2d58d04d1c3ca865ac621b8ec7bf0d471" }
-erc20_processor = { git = "https://github.com/golemfactory/erc20_payment_lib", rev = "c2d548c2d58d04d1c3ca865ac621b8ec7bf0d471" }
+erc20_payment_lib = { git = "https://github.com/golemfactory/erc20_payment_lib", rev = "0e693a31ed62a293b7cf11f926a9b159f785107b" }
+erc20_processor = { git = "https://github.com/golemfactory/erc20_payment_lib", rev = "0e693a31ed62a293b7cf11f926a9b159f785107b" }
 #erc20_payment_lib = { path = "../../payments/erc20_payment_lib/crates/erc20_payment_lib" }
 #erc20_processor = { path = "../../payments/erc20_payment_lib" }
 #erc20_payment_lib = { version = "=0.4.1" }

core/payment-driver/erc20/Readme.md

@@ -26,6 +26,7 @@ See `config-payments.toml` for the list of supported chains and token symbols.
 * `{CHAIN}_MAX_FEE_PER_GAS` -- [max fee per gas](https://ethereum.org/nl/developers/docs/gas/#maxfee).
 * `{CHAIN}_{SYMBOL}_CONTRACT_ADDRESS` -- Address of the GLM contract.
 * `{CHAIN}_MULTI_PAYMENT_CONTRACT_ADDRESS` -- Address of a custom Golem contract allowing for executing multiple transfers at once.
+* `{CHAIN}_LOCK_PAYMENT_CONTRACT_ADDRESS` -- Address of a custom Golem contract for deposits.
 * `ERC20_{CHAIN}_REQUIRED_CONFIRMATIONS` -- The number of confirmation blocks required to consider a transaction complete.
 
 Be aware that options not prefixed with `ERC20` are also applicable to the old Erc20 driver.

core/payment-driver/erc20/src/service.rs

@@ -6,7 +6,9 @@ use std::sync::Arc;
 use std::{env, path::PathBuf, str::FromStr};
 // External crates
 use erc20_payment_lib::config;
-use erc20_payment_lib::config::{AdditionalOptions, MultiContractSettings, RpcSettings};
+use erc20_payment_lib::config::{
+    AdditionalOptions, LockContractSettings, MultiContractSettings, RpcSettings,
+};
 use erc20_payment_lib::runtime::{PaymentRuntime, PaymentRuntimeArgs};
 use ethereum_types::H160;
 
@@ -90,6 +92,7 @@ impl Erc20Service {
                 let max_fee_per_gas_env = format!("{prefix}_MAX_FEE_PER_GAS");
                 let token_addr_env = format!("{prefix}_{symbol}_CONTRACT_ADDRESS");
                 let multi_payment_addr_env = format!("{prefix}_MULTI_PAYMENT_CONTRACT_ADDRESS");
+                let lock_payment_addr_env = format!("{prefix}_LOCK_PAYMENT_CONTRACT_ADDRESS");
                 let confirmations_env = format!("ERC20_{prefix}_REQUIRED_CONFIRMATIONS");
 
                 if let Ok(addr) = env::var(&rpc_env) {
@@ -181,6 +184,21 @@ impl Erc20Service {
                         }
                     };
                 }
+                if let Ok(lock_payment_addr) = env::var(&lock_payment_addr_env) {
+                    match H160::from_str(&lock_payment_addr) {
+                        Ok(parsed) => {
+                            log::info!(
+                                "{network} lock payment contract address set to {lock_payment_addr}"
+                            );
+                            chain.lock_contract = Some(LockContractSettings { address: parsed })
+                        }
+                        Err(e) => {
+                            log::warn!(
+                                "Value {lock_payment_addr} for {lock_payment_addr_env} is not valid H160 address: {e}"
+                            );
+                        }
+                    };
+                }
             }
 
             log::debug!("Starting payment engine: {:#?}", config);

goth_tests/README.md

@@ -147,7 +147,7 @@ You will need to grant your new token the `public_repo` scope, as well as the `r
 Once your token is generated you need to do two things:
 
 1. Log in to GitHub's Docker registry by calling: `docker login docker.pkg.github.com -u {username}`, replacing `{username}` with your GitHub username and pasting in your access token as the password. You only need to do this once on your development machine.
-2. Export an environment variable named `GITHUB_API_TOKEN` and use the access token as its value. This environment variable will need to be available in the shell from which you run the integration tests.
+2. Export an environment variable named `GITHUB_TOKEN` and use the access token as its value. This environment variable will need to be available in the shell from which you run the integration tests.
 
 #### Running a test session
 

goth_tests/assets/docker/docker-compose.yml

@@ -26,17 +26,17 @@ services:
             - "host.docker.internal:host-gateway"
 
     ethereum-mainnet:
-        image: ghcr.io/golemfactory/gnt2/gnt2-docker-yagna:eecb4791c0c6
+        image: ghcr.io/golemfactory/gnt2/gnt2-docker-yagna:2f58ea08e056
         environment:
             - GANACHE_CHAIN_ID=1
 
     ethereum-holesky:
-        image: ghcr.io/golemfactory/gnt2/gnt2-docker-yagna:eecb4791c0c6
+        image: ghcr.io/golemfactory/gnt2/gnt2-docker-yagna:2f58ea08e056
         environment:
             - GANACHE_CHAIN_ID=17000
 
     ethereum-polygon:
-        image: ghcr.io/golemfactory/gnt2/gnt2-docker-yagna:eecb4791c0c6
+        image: ghcr.io/golemfactory/gnt2/gnt2-docker-yagna:2f58ea08e056
         environment:
             - GANACHE_CHAIN_ID=137
 

goth_tests/domain/payments/test_deposit_payments.py

@@ -0,0 +1,134 @@
+"""Tests deposit-agreement payments"""
+
+import asyncio
+import logging
+import pytest
+import goth_tests.helpers.payment
+from datetime import datetime, timezone
+from pathlib import Path
+from typing import List, Tuple
+
+from goth.configuration import load_yaml, Override, Configuration
+from goth.runner import Runner
+from goth.runner.probe import RequestorProbe
+
+from goth_tests.helpers.negotiation import DemandBuilder, negotiate_agreements
+from goth_tests.helpers.probe import ProviderProbe
+from goth_tests.helpers.payment import accept_debit_notes, DebitNoteStats
+
+logger = logging.getLogger("goth.test.deposit_payments")
+
+DEBIT_NOTE_INTERVAL_SEC = 2
+PAYMENT_TIMEOUT_SEC = 5
+ITERATION_COUNT = 10
+ITERATION_STOP_JOB = 4
+
+def build_demand(
+        requestor: RequestorProbe,
+):
+    return (
+        DemandBuilder(requestor)
+        .props_from_template(None)
+        .property(
+            "golem.com.scheme.payu.debit-note.interval-sec?", DEBIT_NOTE_INTERVAL_SEC
+        )
+        .property("golem.com.scheme.payu.payment-timeout-sec?", PAYMENT_TIMEOUT_SEC)
+        .constraints(
+            "(&(golem.com.pricing.model=linear)\
+                (golem.runtime.name=wasmtime))"
+        )
+        .build()
+    )
+
+
+def _create_runner(
+        common_assets: Path, config_overrides: List[Override], log_dir: Path
+) -> Tuple[Runner, Configuration]:
+    goth_config = load_yaml(
+        Path(__file__).parent / "goth-config.yml",
+        config_overrides,
+        )
+
+    runner = Runner(
+        base_log_dir=log_dir,
+        compose_config=goth_config.compose_config,
+        web_root_path=common_assets / "web-root",
+    )
+
+    return runner, goth_config
+
+
+@pytest.mark.asyncio
+async def test_deposit_agreement_payments(
+        common_assets: Path,
+        config_overrides: List[Override],
+        log_dir: Path,
+):
+    deposit_id_1 = "0xd59ca627af68d29c547b91066297a7c469a7bf72000000000000000000000666"
+    deposit_id_2 = "0xd59ca627af68d29c547b91066297a7c469a7bf72000000000000000000000667"
+    deposit_id_3 = "0xd59ca627af68d29c547b91066297a7c469a7bf72000000000000000000000668"
+    deposit_contract = "0xD756fb6A081CC11e7F513C39399DB296b1DE3036"
+
+    goth_tests.helpers.payment.global_deposits = [
+        {
+            "id": deposit_id_1,
+            "contract": deposit_contract
+        },
+        {
+            "id": deposit_id_2,
+            "contract": deposit_contract
+        },
+        {
+            "id": deposit_id_3,
+            "contract": deposit_contract
+        }
+    ]
+
+    """Test deposit-agreement payments"""
+    runner, config = _create_runner(common_assets, config_overrides, log_dir)
+
+    ts = datetime.now(timezone.utc)
+    amount = 0.0
+    number_of_payments = 0
+
+    async with runner(config.containers):
+        requestor = runner.get_probes(probe_type=RequestorProbe)[0]
+        providers = runner.get_probes(probe_type=ProviderProbe)
+        assert providers
+
+        agreement_providers = await negotiate_agreements(
+            requestor,
+            build_demand(requestor),
+            providers,
+        )
+
+        stats = DebitNoteStats()
+        asyncio.create_task(accept_debit_notes(requestor, stats))
+
+        agreement_id, provider = agreement_providers[0]
+        activity_id = await requestor.create_activity(agreement_id)
+        await provider.wait_for_exeunit_started()
+
+        logger.debug(f"Activity created: {activity_id}")
+        for i in range(0, ITERATION_COUNT):
+            await asyncio.sleep(PAYMENT_TIMEOUT_SEC)
+
+            logger.debug(f"Fetching payments: {i}/{ITERATION_COUNT}")
+            payments = await provider.api.payment.get_payments(after_timestamp=ts)
+            for payment in payments:
+                number_of_payments += 1
+                amount += float(payment.amount)
+                logger.info(f"Received payment: amount {payment.amount}."
+                            f" Total amount {amount}. Number of payments {number_of_payments}")
+                ts = payment.timestamp if payment.timestamp > ts else ts
+
+            # prevent new debit notes in the last iteration
+            if i == ITERATION_STOP_JOB:
+                await requestor.destroy_activity(activity_id)
+                await provider.wait_for_exeunit_finished()
+
+        # this test is failing too much, so not expect exact amount paid,
+        # but at least two payments have to be made
+        assert stats.amount > 0
+        assert amount > 0
+        assert number_of_payments >= 2