[Multi-Chain] Enable payments on other chains

.github/workflows/pull-request.yaml

@@ -27,4 +27,4 @@ jobs:
         run:
           python -m pytest tests/unit
         env:
-          NODE_URL: https://rpc.ankr.com/eth
+          NODE_URL_MAINNET: https://rpc.ankr.com/eth

src/config.py

@@ -41,6 +41,8 @@ class RewardConfig:
     @staticmethod
     def from_network(network: Network) -> RewardConfig:
         """Initialize reward config for a given network."""
+        cow_bonding_pool = Address("0x5d4020b9261f01b6f8a45db929704b0ad6f5e9e6")
+        service_fee_factor = Fraction(15, 100)
         match network:
             case Network.MAINNET:
                 return RewardConfig(
@@ -51,10 +53,32 @@ def from_network(network: Network) -> RewardConfig:
                     batch_reward_cap_lower=10 * 10**15,
                     quote_reward_cow=6 * 10**18,
                     quote_reward_cap_native=6 * 10**14,
-                    service_fee_factor=Fraction(15, 100),
-                    cow_bonding_pool=Address(
-                        "0x5d4020b9261f01b6f8a45db929704b0ad6f5e9e6"
+                    service_fee_factor=service_fee_factor,
+                    cow_bonding_pool=cow_bonding_pool,
+                )
+            case Network.GNOSIS:
+                return RewardConfig(
+                    reward_token_address=Address(
+                        "0x177127622c4a00f3d409b75571e12cb3c8973d3c"
                     ),
+                    batch_reward_cap_upper=30 * 10**18,
+                    batch_reward_cap_lower=5 * 10**18,
+                    quote_reward_cow=6 * 10**18,
+                    quote_reward_cap_native=1 * 10**18,
+                    service_fee_factor=service_fee_factor,
+                    cow_bonding_pool=cow_bonding_pool,
+                )
+            case Network.ARBITRUM_ONE:
+                return RewardConfig(
+                    reward_token_address=Address(
+                        "0xcb8b5cd20bdcaea9a010ac1f8d835824f5c87a04"
+                    ),
+                    batch_reward_cap_upper=12 * 10**15,
+                    batch_reward_cap_lower=10 * 10**15,
+                    quote_reward_cow=6 * 10**18,
+                    quote_reward_cap_native=6 * 10**14,
+                    service_fee_factor=service_fee_factor,
+                    cow_bonding_pool=cow_bonding_pool,
                 )
             case _:
                 raise ValueError(f"No reward config set up for network {network}.")
@@ -80,7 +104,7 @@ class ProtocolFeeConfig:
     def from_network(network: Network) -> ProtocolFeeConfig:
         """Initialize protocol fee config for a given network."""
         match network:
-            case Network.MAINNET:
+            case Network.MAINNET | Network.GNOSIS | Network.ARBITRUM_ONE:
                 return ProtocolFeeConfig(
                     protocol_fee_safe=Address(
                         "0xB64963f95215FDe6510657e719bd832BB8bb941B"
@@ -106,12 +130,16 @@ def from_network(network: Network) -> BufferAccountingConfig:
         """Initialize buffer accounting config for a given network."""
         match network:
             case Network.MAINNET:
-                return BufferAccountingConfig(include_slippage=True)
+                include_slippage = True
+            case Network.GNOSIS | Network.ARBITRUM_ONE:
+                include_slippage = False
             case _:
                 raise ValueError(
                     f"No buffer accounting config set up for network {network}."
                 )
 
+        return BufferAccountingConfig(include_slippage=include_slippage)
+
 
 @dataclass(frozen=True)
 class OrderbookConfig:
@@ -121,10 +149,20 @@ class OrderbookConfig:
     barn_db_url: str
 
     @staticmethod
-    def from_env() -> OrderbookConfig:
+    def from_network(network: Network) -> OrderbookConfig:
         """Initialize orderbook config from environment variables."""
-        prod_db_url = os.environ.get("PROD_DB_URL", "")
-        barn_db_url = os.environ.get("BARN_DB_URL", "")
+        match network:
+            case Network.MAINNET:
+                prod_db_url = os.environ.get("PROD_DB_URL_MAINNET", "")
+                barn_db_url = os.environ.get("BARN_DB_URL_MAINNET", "")
+            case Network.GNOSIS:
+                prod_db_url = os.environ.get("PROD_DB_URL_GNOSIS", "")
+                barn_db_url = os.environ.get("BARN_DB_URL_GNOSIS", "")
+            case Network.ARBITRUM_ONE:
+                prod_db_url = os.environ.get("PROD_DB_URL_ARBITRUM", "")
+                barn_db_url = os.environ.get("BARN_DB_URL_ARBITRUM", "")
+            case _:
+                raise ValueError(f"No orderbook config set up for network {network}.")
 
         return OrderbookConfig(prod_db_url=prod_db_url, barn_db_url=barn_db_url)
 
@@ -142,10 +180,16 @@ def from_network(network: Network) -> DuneConfig:
         dune_api_key = os.environ.get("DUNE_API_KEY", "")
         match network:
             case Network.MAINNET:
-                return DuneConfig(dune_api_key=dune_api_key, dune_blockchain="ethereum")
+                dune_blockchain = "ethereum"
+            case Network.GNOSIS:
+                dune_blockchain = "gnosis"
+            case Network.ARBITRUM_ONE:
+                dune_blockchain = "arbitrum"
             case _:
                 raise ValueError(f"No dune config set up for network {network}.")
 
+        return DuneConfig(dune_api_key=dune_api_key, dune_blockchain=dune_blockchain)
+
 
 @dataclass(frozen=True)
 class NodeConfig:
@@ -158,7 +202,11 @@ def from_network(network: Network) -> NodeConfig:
         """Initialize node config for a given network."""
         match network:
             case Network.MAINNET:
-                node_url = os.environ.get("NODE_URL", "")
+                node_url = os.environ.get("NODE_URL_MAINNET", "")
+            case Network.GNOSIS:
+                node_url = os.environ.get("NODE_URL_GNOSIS", "")
+            case Network.ARBITRUM_ONE:
+                node_url = os.environ.get("NODE_URL_ARBITRUM", "")
             case _:
                 raise ValueError(f"No node config set up for network {network}.")
 
@@ -177,7 +225,7 @@ class PaymentConfig:
     signing_key: str | None
     safe_queue_url: str
     verification_docs_url: str
-    weth_address: ChecksumAddress
+    wrapped_native_token_address: ChecksumAddress
 
     @staticmethod
     def from_network(network: Network) -> PaymentConfig:
@@ -188,42 +236,66 @@ def from_network(network: Network) -> PaymentConfig:
 
         docs_url = "https://www.notion.so/cownation/Solver-Payouts-3dfee64eb3d449ed8157a652cc817a8c"
 
-        network_short_name = {
-            Network.MAINNET: "eth",
-            Network.GNOSIS: "gno",
-        }
-
         match network:
             case Network.MAINNET:
+                payment_network = EthereumNetwork.MAINNET
                 payment_safe_address = Web3.to_checksum_address(
                     os.environ.get(
-                        "SAFE_ADDRESS", "0xA03be496e67Ec29bC62F01a428683D7F9c204930"
+                        "SAFE_ADDRESS_MAINNET",
+                        "0xA03be496e67Ec29bC62F01a428683D7F9c204930",
                     )
                 )
-                short_name = network_short_name[network]
-                safe_url = (
-                    f"https://app.safe.global/{short_name}:{payment_safe_address}"
+                short_name = "eth"
+
+                cow_token_address = Address(
+                    "0xDEf1CA1fb7FBcDC777520aa7f396b4E015F497aB"
+                )
+                wrapped_native_token_address = Web3.to_checksum_address(
+                    "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2"
                 )
-                safe_queue_url = f"{safe_url}/transactions/queue"
 
-                return PaymentConfig(
-                    network=EthereumNetwork.MAINNET,
-                    cow_token_address=Address(
-                        "0xDEf1CA1fb7FBcDC777520aa7f396b4E015F497aB"
-                    ),
-                    payment_safe_address=Web3.to_checksum_address(
-                        "0xA03be496e67Ec29bC62F01a428683D7F9c204930"
-                    ),
-                    signing_key=signing_key,
-                    safe_queue_url=safe_queue_url,
-                    verification_docs_url=docs_url,
-                    weth_address=Web3.to_checksum_address(
-                        "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2"
-                    ),
+            case Network.GNOSIS:
+                payment_network = EthereumNetwork.GNOSIS
+                payment_safe_address = Web3.to_checksum_address(
+                    os.environ.get("SAFE_ADDRESS_GNOSIS", "")
+                )
+                short_name = "gno"
+
+                cow_token_address = Address(
+                    "0x177127622c4a00f3d409b75571e12cb3c8973d3c"
+                )
+                wrapped_native_token_address = Web3.to_checksum_address(
+                    "0xe91d153e0b41518a2ce8dd3d7944fa863463a97d"
+                )
+            case Network.ARBITRUM_ONE:
+                payment_network = EthereumNetwork.GNOSIS
+                payment_safe_address = Web3.to_checksum_address(
+                    os.environ.get("SAFE_ADDRESS_ARBITRUM", "")
+                )
+                short_name = "arb1"
+
+                cow_token_address = Address(
+                    "0xcb8b5cd20bdcaea9a010ac1f8d835824f5c87a04"
+                )
+                wrapped_native_token_address = Web3.to_checksum_address(
+                    "0x82af49447d8a07e3bd95bd0d56f35241523fbab1"
                 )
             case _:
                 raise ValueError(f"No payment config set up for network {network}.")
 
+        safe_url = f"https://app.safe.global/{short_name}:{payment_safe_address}"
+        safe_queue_url = f"{safe_url}/transactions/queue"
+
+        return PaymentConfig(
+            network=payment_network,
+            cow_token_address=cow_token_address,
+            payment_safe_address=payment_safe_address,
+            signing_key=signing_key,
+            safe_queue_url=safe_queue_url,
+            verification_docs_url=docs_url,
+            wrapped_native_token_address=wrapped_native_token_address,
+        )
+
 
 @dataclass(frozen=True)
 class IOConfig:
@@ -281,7 +353,7 @@ def from_network(network: Network) -> AccountingConfig:
 
         return AccountingConfig(
             payment_config=PaymentConfig.from_network(network),
-            orderbook_config=OrderbookConfig.from_env(),
+            orderbook_config=OrderbookConfig.from_network(network),
             dune_config=DuneConfig.from_network(network),
             node_config=NodeConfig.from_network(network),
             reward_config=RewardConfig.from_network(network),

src/fetch/dune.py

@@ -22,13 +22,16 @@ class DuneFetcher:
 
     dune: DuneClient
     period: AccountingPeriod
+    blockchain: str
 
     def __init__(
         self,
         dune: DuneClient,
+        blockchain: str,
         period: AccountingPeriod,
     ):
         self.dune = dune
+        self.blockchain = blockchain
         self.period = period
         # Already have period set, so we might as well store this upon construction.
         # This may become an issue when we make the fetchers async;
@@ -39,6 +42,13 @@ def _period_params(self) -> list[QueryParameter]:
         """Easier access to these parameters."""
         return self.period.as_query_params()
 
+    def _network_and_period_params(self) -> list[QueryParameter]:
+        """Easier access to parameters for network and accounting period."""
+        network_param = QueryParameter.text_type("blockchain", self.blockchain)
+        period_params = self._period_params()
+
+        return period_params + [network_param]
+
     @staticmethod
     def _parameterized_query(
         query_data: QueryData, params: list[QueryParameter]
@@ -71,7 +81,7 @@ def get_block_interval(self) -> tuple[str, str]:
         """Returns block numbers corresponding to date interval"""
         results = self._get_query_results(
             self._parameterized_query(
-                QUERIES["PERIOD_BLOCK_INTERVAL"], self._period_params()
+                QUERIES["PERIOD_BLOCK_INTERVAL"], self._network_and_period_params()
             )
         )
         assert len(results) == 1, "Block Interval Query should return only 1 result!"
@@ -87,6 +97,7 @@ def get_vouches(self) -> list[DuneRecord]:
                 params=[
                     QueryParameter.date_type("end_time", self.period.end),
                     QueryParameter.enum_type("vouch_cte_name", "named_results"),
+                    QueryParameter.text_type("blockchain", self.blockchain),
                 ],
             )
         )

src/fetch/payouts.py

@@ -107,12 +107,12 @@ def from_series(cls, frame: Series) -> RewardAndPenaltyDatum:
         )
         solver = frame["solver"]
         reward_target = frame["reward_target"]
-        if reward_target is None:
+        if pandas.isna(reward_target):
             log.warning(f"Solver {solver} without reward_target. Using solver")
             reward_target = solver
 
         buffer_accounting_target = frame["buffer_accounting_target"]
-        if buffer_accounting_target is None:
+        if pandas.isna(buffer_accounting_target):
             log.warning(
                 f"Solver {solver} without buffer_accounting_target. Using solver"
             )
@@ -516,7 +516,13 @@ def construct_payouts(
         for service_fee_flag in service_fee_df["service_fee"]
     ]
 
-    reward_target_df = pandas.DataFrame(dune.get_vouches())
+    vouches = dune.get_vouches()
+    if vouches:
+        reward_target_df = pandas.DataFrame(dune.get_vouches())
+    else:
+        reward_target_df = DataFrame(
+            columns=["solver", "solver_name", "reward_target", "pool_address"]
+        )
     # construct slippage df
     if ignore_slippage_flag or (not config.buffer_accounting_config.include_slippage):
         slippage_df_temp = pandas.merge(
@@ -534,7 +540,7 @@ def construct_payouts(
         slippage_df = slippage_df.rename(columns={"solver_address": "solver"})
 
     reward_token = config.reward_config.reward_token_address
-    native_token = Address(config.payment_config.weth_address)
+    native_token = Address(config.payment_config.wrapped_native_token_address)
     price_day = dune.period.end - timedelta(days=1)
     exchange_rate_native_to_cow = exchange_rate_atoms(
         native_token, reward_token, price_day

src/fetch/prices.py

@@ -29,6 +29,7 @@ class TokenId(Enum):
     """Coin Ids for coin paprika"""
 
     ETH = "eth-ethereum"
+    XDAI = "xdai-xdai"
     COW = "cow-cow-protocol-token"
     USDC = "usdc-usd-coin"
 
@@ -40,9 +41,16 @@ def decimals(self) -> int:
 
 
 TOKEN_ADDRESS_TO_ID = {
+    # mainnet tokens
     Address("0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2"): TokenId.ETH,
     Address("0xDEf1CA1fb7FBcDC777520aa7f396b4E015F497aB"): TokenId.COW,
     Address("0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"): TokenId.USDC,
+    # gnosis tokens
+    Address("0xe91d153e0b41518a2ce8dd3d7944fa863463a97d"): TokenId.XDAI,
+    Address("0x177127622c4a00f3d409b75571e12cb3c8973d3c"): TokenId.COW,
+    # arbitrum tokens
+    Address("0xcb8b5cd20bdcaea9a010ac1f8d835824f5c87a04"): TokenId.COW,
+    Address("0x82af49447d8a07e3bd95bd0d56f35241523fbab1"): TokenId.ETH,
 }
 
 

src/fetch/transfer_file.py

@@ -75,7 +75,7 @@ def auto_propose(
     transactions = prepend_unwrap_if_necessary(
         client,
         config.payment_config.payment_safe_address,
-        wrapped_native_token=config.payment_config.weth_address,
+        wrapped_native_token=config.payment_config.wrapped_native_token_address,
         transactions=[t.as_multisend_tx() for t in transfers],
     )
     if len(transactions) > len(transfers):
@@ -117,13 +117,14 @@ def main() -> None:
 
     config = AccountingConfig.from_network(Network(os.environ["NETWORK"]))
 
-    accounting_period = AccountingPeriod(args.start, length_days=1)
+    accounting_period = AccountingPeriod(args.start, length_days=7)
 
     orderbook = MultiInstanceDBFetcher(
         [config.orderbook_config.prod_db_url, config.orderbook_config.barn_db_url]
     )
     dune = DuneFetcher(
         dune=DuneClient(config.dune_config.dune_api_key),
+        blockchain=config.dune_config.dune_blockchain,
         period=accounting_period,
     )
 

src/queries.py

@@ -32,11 +32,11 @@ def with_params(self, params: list[QueryParameter]) -> QueryBase:
 QUERIES = {
     "PERIOD_BLOCK_INTERVAL": QueryData(
         name="Block Interval for Accounting Period",
-        q_id=3333356,
+        q_id=4227027,
     ),
     "VOUCH_REGISTRY": QueryData(
         name="Vouch Registry",
-        q_id=1541516,
+        q_id=4339624,
     ),
     "SERVICE_FEE_STATUS": QueryData(
         name="CIP-48 Service fee status",