Add claim_USDC command and update docs (#1758)

* Update claim command to replace OCEAN with USDC and mark OCEAN as deprecated

* Add USDC payout functionality to CLI

* Add unit test for USDC claim functionality

* Implement USDC payout functionality in the payout module

* Update payout instructions to include USDC and mark OCEAN as deprecated

* Add unit test for USDC payout functionality

* Refactor payout module to use constants for contract addresses and add tests for payout contract addresses

* un-deprecate

Author: trizin

READMEs/payout.md

@@ -9,7 +9,29 @@ This README describes how you can claim the $ based on running a predictoor bot.
 
 First, congratulations on your participation and progress in making predictions! Whether you've made accurate or erroneous predictions, it's now time to claim your earnings from correct predictions.
 
-There are two sections below: to claim OCEAN payout, and ROSE payout, respectively.
+There are three sections below: to claim USDC payout, OCEAN payout, and ROSE payout, respectively.
+
+## Steps to Request USDC Rewards
+
+### 1. Preparation
+
+Ensure you pause or stop any ongoing prediction submissions. You can use `Ctrl-C` to stop the predictions. This is crucial as active submissions can interfere with the payout process.
+
+### 2. Execute Payout
+
+From console:
+
+```console
+pdr claim_USDC ppss.yaml
+```
+
+### 3. Completion
+
+Once the payout module concludes its operation, your balance will reflect the updated amount.
+
+### 4. Verification
+
+It's good practice to run the payout module again. This ensures any failed blockchain calls from the previous attempt are addressed and verifies that all eligible payouts have been claimed.
 
 ## Steps to Request OCEAN Rewards
 
@@ -33,7 +55,7 @@ Once the payout module concludes its operation, your balance will reflect the up
 
 It's good practice to run the payout module again. This ensures any failed blockchain calls from the previous attempt are addressed and verifies that all eligible payouts have been claimed.
 
-### Steps to Request ROSE Rewards
+## Steps to Request ROSE Rewards
 
 - 1. Preparation
 

pdr_backend/cli/cli_arguments.py

@@ -24,6 +24,7 @@
   pdr predictoor PPSS_FILE NETWORK
   pdr dashboard PPSS_FILE NETWORK
   pdr trader APPROACH PPSS_FILE NETWORK
+  pdr claim_USDC PPSS_FILE
   pdr claim_OCEAN PPSS_FILE
   pdr claim_ROSE PPSS_FILE
 """
@@ -556,6 +557,7 @@ def print_args(arguments: Namespace, nested_args: dict):
 TraderArgParser = _ArgParser_APPROACH_PPSS_NETWORK
 ClaimOceanArgParser = _ArgParser_PPSS
 ClaimRoseArgParser = _ArgParser_PPSS
+ClaimUsdcArgParser = _ArgParser_PPSS
 
 # power tools
 MultisimArgParser = _ArgParser_PPSS
@@ -647,6 +649,7 @@ def __init__(self, description: str, command_name: str):
     "do_sim": SimArgParser("Run simulation", "sim"),
     "do_predictoor": PredictoorArgParser("Run a predictoor bot", "predictoor"),
     "do_trader": TraderArgParser("Run a trader bot", "trader"),
+    "do_claim_USDC": ClaimUsdcArgParser("Claim USDC", "claim_USDC"),
     "do_claim_OCEAN": ClaimOceanArgParser("Claim OCEAN", "claim_OCEAN"),
     "do_claim_ROSE": ClaimRoseArgParser("Claim ROSE", "claim_ROSE"),
     # power tools

pdr_backend/cli/cli_module.py

@@ -20,7 +20,7 @@
 from pdr_backend.cli.cli_arguments_lake import LAKE_SUBCOMMANDS
 from pdr_backend.cli.cli_module_lake import do_lake_subcommand
 from pdr_backend.lake.ohlcv_data_factory import OhlcvDataFactory
-from pdr_backend.payout.payout import do_ocean_payout, do_rose_payout
+from pdr_backend.payout.payout import do_ocean_payout, do_rose_payout, do_usdc_payout
 from pdr_backend.ppss.ppss import PPSS
 from pdr_backend.pred_submitter.deploy import deploy_pred_submitter_mgr_contract
 from pdr_backend.predictoor.predictoor_agent import PredictoorAgent
@@ -142,6 +142,16 @@ def do_claim_ROSE(args, nested_args=None):
     do_rose_payout(ppss)
 
 
+@enforce_types
+def do_claim_USDC(args, nested_args=None):
+    ppss = PPSS(
+        yaml_filename=args.PPSS_FILE,
+        network="sapphire-mainnet",
+        nested_override_args=nested_args,
+    )
+    do_usdc_payout(ppss)
+
+
 @enforce_types
 def do_multisim(args, nested_args=None):
     d = PPSS.constructor_dict(

pdr_backend/cli/test/test_cli_module.py

@@ -11,6 +11,7 @@
     do_sim,
     do_predictoor,
     do_trader,
+    do_claim_USDC,
     do_claim_OCEAN,
     do_claim_ROSE,
     # power tools
@@ -276,6 +277,15 @@ def test_do_claim_ROSE(monkeypatch):
     mock_f.assert_called()
 
 
+@enforce_types
+def test_do_claim_USDC(monkeypatch):
+    mock_f = Mock()
+    monkeypatch.setattr(f"{_CLI_PATH}.do_usdc_payout", mock_f)
+
+    do_claim_USDC(MockArgParser_PPSS().parse_args())
+    mock_f.assert_called()
+
+
 # ---------------------------------------------------------------
 # test: Power tools
 

pdr_backend/payout/payout.py

@@ -16,7 +16,12 @@
 from pdr_backend.ppss.ppss import PPSS
 from pdr_backend.subgraph.subgraph_pending_payouts import query_pending_payouts
 from pdr_backend.subgraph.subgraph_sync import wait_until_subgraph_syncs
-from pdr_backend.util.constants import SAPPHIRE_MAINNET_CHAINID
+from pdr_backend.util.constants import (
+    DFREWARDS_ADDR,
+    SAPPHIRE_MAINNET_CHAINID,
+    USDC_TOKEN_ADDR,
+    WROSE_TOKEN_ADDR,
+)
 from pdr_backend.util.currency_types import Eth, Wei
 
 logger = logging.getLogger("payout")
@@ -114,21 +119,23 @@ def do_rose_payout(ppss: PPSS, check_network: bool = True):
     up_addr = pred_submitter_mgr.pred_submitter_up_address()
     down_addr = pred_submitter_mgr.pred_submitter_down_address()
 
-    dfrewards_addr = "0xc37F8341Ac6e4a94538302bCd4d49Cf0852D30C0"
-    wROSE_addr = "0x8Bc2B030b299964eEfb5e1e0b36991352E56D2D3"
-    wROSE = WrappedToken(ppss.web3_pp, wROSE_addr)
+    wROSE = WrappedToken(ppss.web3_pp, WROSE_TOKEN_ADDR)
 
-    dfrewards_contract = DFRewards(ppss.web3_pp, dfrewards_addr)
-    claimable_rewards_up = dfrewards_contract.get_claimable_rewards(up_addr, wROSE_addr)
+    dfrewards_contract = DFRewards(ppss.web3_pp, DFREWARDS_ADDR)
+    claimable_rewards_up = dfrewards_contract.get_claimable_rewards(
+        up_addr, WROSE_TOKEN_ADDR
+    )
     claimable_rewards_down = dfrewards_contract.get_claimable_rewards(
-        down_addr, wROSE_addr
+        down_addr, WROSE_TOKEN_ADDR
     )
     total_claimable = claimable_rewards_up + claimable_rewards_down
     logger.info("Found %s wROSE available to claim", total_claimable.to_eth().amt_eth)
 
     if total_claimable > Eth(0):
         logger.info("Claiming wROSE rewards from the manager contract...")
-        receipt = pred_submitter_mgr.claim_dfrewards(wROSE_addr, dfrewards_addr, True)
+        receipt = pred_submitter_mgr.claim_dfrewards(
+            WROSE_TOKEN_ADDR, DFREWARDS_ADDR, True
+        )
         if receipt["status"] != 1:
             logger.warning(
                 "Failed to claim wROSE rewards from the contract, tx: %s",
@@ -144,7 +151,7 @@ def _transfer_wrose(instance_address, instance_name):
         if balance > 0:
             instance = PredSubmitterMgr(ppss.web3_pp, instance_address)
             receipt = instance.transfer_erc20(
-                wROSE_addr, web3_config.owner, balance, True
+                WROSE_TOKEN_ADDR, web3_config.owner, balance, True
             )
             if receipt["status"] != 1:
                 logger.warning(
@@ -169,3 +176,68 @@ def _transfer_wrose(instance_address, instance_name):
         wROSE.withdraw(wROSE_bal)
 
     logger.info("ROSE reward claim done")
+
+
+@enforce_types
+def do_usdc_payout(ppss: PPSS, check_network: bool = True):
+    web3_config = ppss.web3_pp.web3_config
+
+    if check_network:
+        assert ppss.web3_pp.network == "sapphire-mainnet"
+        assert web3_config.w3.eth.chain_id == SAPPHIRE_MAINNET_CHAINID
+
+    web3_config = ppss.web3_pp.web3_config
+    pred_submitter_mgr_addr = ppss.predictoor_ss.pred_submitter_mgr
+    pred_submitter_mgr = PredSubmitterMgr(ppss.web3_pp, pred_submitter_mgr_addr)
+    up_addr = pred_submitter_mgr.pred_submitter_up_address()
+    down_addr = pred_submitter_mgr.pred_submitter_down_address()
+
+    usdc = WrappedToken(ppss.web3_pp, USDC_TOKEN_ADDR)
+
+    dfrewards_contract = DFRewards(ppss.web3_pp, DFREWARDS_ADDR)
+    claimable_rewards_up = dfrewards_contract.get_claimable_rewards(
+        up_addr, USDC_TOKEN_ADDR
+    )
+    claimable_rewards_down = dfrewards_contract.get_claimable_rewards(
+        down_addr, USDC_TOKEN_ADDR
+    )
+    total_claimable = claimable_rewards_up + claimable_rewards_down
+    logger.info("Found %s USDC available to claim", total_claimable.to_eth().amt_eth)
+
+    if total_claimable > Eth(0):
+        logger.info("Claiming USDC rewards from the manager contract...")
+        receipt = pred_submitter_mgr.claim_dfrewards(
+            USDC_TOKEN_ADDR, DFREWARDS_ADDR, True
+        )
+        if receipt["status"] != 1:
+            logger.warning(
+                "Failed to claim USDC rewards from the contract, tx: %s",
+                receipt["transactionHash"],
+            )
+            return
+        time.sleep(4)
+    else:
+        logger.warning("No rewards available to claim")
+
+    def _transfer_usdc(instance_address, instance_name):
+        balance = usdc.balanceOf(instance_address)
+        if balance > 0:
+            instance = PredSubmitterMgr(ppss.web3_pp, instance_address)
+            receipt = instance.transfer_erc20(
+                USDC_TOKEN_ADDR, web3_config.owner, balance, True
+            )
+            if receipt["status"] != 1:
+                logger.warning(
+                    "Failed to transfer USDC tokens to the owner from %s, tx: %s",
+                    instance_name,
+                    receipt["transactionHash"],
+                )
+            time.sleep(4)
+
+    logger.info("Transferring USDC to owner")
+
+    _transfer_usdc(up_addr, "up predictoor")
+    _transfer_usdc(down_addr, "down predictoor")
+    _transfer_usdc(pred_submitter_mgr.contract_address, "manager")
+
+    logger.info("USDC reward claim done")

pdr_backend/payout/test/test_payout.py

@@ -10,9 +10,15 @@
     batchify,
     do_ocean_payout,
     do_rose_payout,
+    do_usdc_payout,
     request_payout_batches,
 )
 from pdr_backend.ppss.ppss import PPSS, fast_test_yaml_str
+from pdr_backend.util.constants import (
+    DFREWARDS_ADDR,
+    USDC_TOKEN_ADDR,
+    WROSE_TOKEN_ADDR,
+)
 from pdr_backend.util.currency_types import Eth
 
 
@@ -109,12 +115,12 @@ def test_do_rose_payout(tmpdir):
     ):
         do_rose_payout(ppss, check_network=False)
         mock_contract.claim_dfrewards.assert_called_with(
-            "0x8Bc2B030b299964eEfb5e1e0b36991352E56D2D3",
-            "0xc37F8341Ac6e4a94538302bCd4d49Cf0852D30C0",
+            WROSE_TOKEN_ADDR,
+            DFREWARDS_ADDR,
             True,
         )
         mock_contract.transfer_erc20.assert_called_with(
-            "0x8Bc2B030b299964eEfb5e1e0b36991352E56D2D3",
+            WROSE_TOKEN_ADDR,
             web3_config.owner,
             Eth(100).to_wei(),
             True,
@@ -123,6 +129,49 @@ def test_do_rose_payout(tmpdir):
         mock_wrose.withdraw.assert_called_with(Eth(100).to_wei())
 
 
+@enforce_types
+def test_do_usdc_payout(tmpdir):
+    ppss = _ppss(tmpdir)
+    web3_config = ppss.web3_pp.web3_config
+
+    mock_contract = Mock(spec=PredSubmitterMgr)
+    mock_contract.get_claimable_rewards = Mock()
+    mock_contract.get_claimable_rewards.return_value = Eth(100)
+    mock_contract.contract_address = "0x0"
+    mock_contract.claim_dfrewards = Mock()
+    mock_contract.claim_dfrewards.return_value = {
+        "transactionHash": b"0x1",
+        "status": 1,
+    }
+    mock_contract.transfer_erc20 = Mock()
+    mock_contract.transfer_erc20.return_value = {"transactionHash": b"0x1", "status": 1}
+    mock_contract.pred_submitter_up_address.return_value = "0x1"
+    mock_contract.pred_submitter_down_address.return_value = "0x2"
+
+    mock_usdc = Mock(spec=WrappedToken)
+    mock_usdc.balanceOf = Mock()
+    mock_usdc.balanceOf.return_value = Eth(100).to_wei()
+
+    with patch("pdr_backend.payout.payout.time"), patch(
+        "pdr_backend.payout.payout.WrappedToken", return_value=mock_usdc
+    ), patch("pdr_backend.payout.payout.DFRewards", return_value=mock_contract), patch(
+        "pdr_backend.payout.payout.PredSubmitterMgr", return_value=mock_contract
+    ):
+        do_usdc_payout(ppss, check_network=False)
+        mock_contract.claim_dfrewards.assert_called_with(
+            USDC_TOKEN_ADDR,
+            DFREWARDS_ADDR,
+            True,
+        )
+        mock_contract.transfer_erc20.assert_called_with(
+            USDC_TOKEN_ADDR,
+            web3_config.owner,
+            Eth(100).to_wei(),
+            True,
+        )
+        mock_usdc.balanceOf.assert_called()
+
+
 @enforce_types
 def _ppss(tmpdir):
     s = fast_test_yaml_str(tmpdir)

pdr_backend/util/constants.py

@@ -14,6 +14,11 @@
     SAPPHIRE_TESTNET_CHAINID: "0x973e69303259B0c2543a38665122b773D28405fB",
 }
 
+# Payout contract addresses (Sapphire Mainnet)
+DFREWARDS_ADDR = "0xc37F8341Ac6e4a94538302bCd4d49Cf0852D30C0"
+WROSE_TOKEN_ADDR = "0x8Bc2B030b299964eEfb5e1e0b36991352E56D2D3"
+USDC_TOKEN_ADDR = "0x2c2E3812742Ab2DA53a728A09F5DE670Aba584b6"
+
 S_PER_MIN = 60
 S_PER_DAY = 86400
 S_PER_WEEK = S_PER_DAY * 7

pdr_backend/util/test_noganache/test_util_constants.py

@@ -5,14 +5,17 @@
     CAND_TIMEFRAMES,
     CAND_USDCOINS,
     CHAR_TO_SIGNAL,
+    DFREWARDS_ADDR,
     S_PER_DAY,
     S_PER_MIN,
     SAPPHIRE_MAINNET_CHAINID,
     SAPPHIRE_MAINNET_RPC,
     SAPPHIRE_TESTNET_CHAINID,
     SAPPHIRE_TESTNET_RPC,
     SUBGRAPH_MAX_TRIES,
+    USDC_TOKEN_ADDR,
     WEB3_MAX_TRIES,
+    WROSE_TOKEN_ADDR,
     ZERO_ADDRESS,
 )
 
@@ -39,3 +42,22 @@ def test_util_constants():
     assert "close" in CHAR_TO_SIGNAL.values()
     assert len(CHAR_TO_SIGNAL) == 5
     assert CHAR_TO_SIGNAL["c"] == "close"
+
+
+@enforce_types
+def test_payout_contract_addresses():
+    """Test that payout contract addresses are valid checksummed Ethereum addresses."""
+    # All addresses should start with 0x
+    assert DFREWARDS_ADDR.startswith("0x")
+    assert WROSE_TOKEN_ADDR.startswith("0x")
+    assert USDC_TOKEN_ADDR.startswith("0x")
+
+    # All addresses should be 42 characters (0x + 40 hex chars)
+    assert len(DFREWARDS_ADDR) == 42
+    assert len(WROSE_TOKEN_ADDR) == 42
+    assert len(USDC_TOKEN_ADDR) == 42
+
+    # Verify specific expected addresses on Sapphire Mainnet
+    assert DFREWARDS_ADDR == "0xc37F8341Ac6e4a94538302bCd4d49Cf0852D30C0"
+    assert WROSE_TOKEN_ADDR == "0x8Bc2B030b299964eEfb5e1e0b36991352E56D2D3"
+    assert USDC_TOKEN_ADDR == "0x2c2E3812742Ab2DA53a728A09F5DE670Aba584b6"