Use a DataNFT to determine and set the start block

.github/workflows/dispense_volume.yml

@@ -79,6 +79,7 @@ jobs:
           echo "GOERLI_RPC_URL=https://rpc.ankr.com/eth_goerli" >> $GITHUB_ENV
           echo "INFURA_NETWORKS=polygon,mumbai,mainnet" >> $GITHUB_ENV
           echo "SEPOLIA_RPC_URL=https://rpc.sepolia.org/" >> $GITHUB_ENV
+          echo "DATANFT_ADDR=0xc5eba5234B69dAeC98747c906658AEa31d74b3d2" >> $GITHUB_ENV
 
       - name: Make dftool executable
         run: chmod +x dftool
@@ -90,19 +91,36 @@ jobs:
           ./dftool get_rate MATIC $date $now $CSV_DIR --RETRIES $RETRY_TIMES
           ./dftool get_rate ROSE $date $now $CSV_DIR --RETRIES $RETRY_TIMES
 
+      - name: Set block start and end numbers
+        if: github.event_name == 'schedule'
+        run: |
+          ./dftool set_datanft_block_numbers $date $now 1
+          ./dftool set_datanft_block_numbers $date $now 137
+          ./dftool set_datanft_block_numbers $date $now 23294
+
+
+      - name: Set block start and end numbers for test network
+        if: github.event_name != 'schedule'
+        env:
+          DATANFT_ADDR: "0x23D41CBdceF94132edB21b7f2ae58c959B0C9bD9"
+          POLYGON_RPC_URL: "https://polygon-mumbai.infura.io/v3/"
+        run: |
+          ./dftool set_datanft_block_numbers $date $now 1
+
+
       - name: Run dftool volsym
         run: |
-          ./dftool volsym $date $now 200 $CSV_DIR 1 --RETRIES $RETRY_TIMES
-          ./dftool volsym $date $now 200 $CSV_DIR 137 --RETRIES $RETRY_TIMES
-          ./dftool volsym $date $now 200 $CSV_DIR 23294 --RETRIES $RETRY_TIMES
+          ./dftool volsym $date $now 200 $CSV_DIR 1 --RETRIES $RETRY_TIMES --USE_DATANFT True
+          ./dftool volsym $date $now 200 $CSV_DIR 137 --RETRIES $RETRY_TIMES --USE_DATANFT True
+          ./dftool volsym $date $now 200 $CSV_DIR 23294 --RETRIES $RETRY_TIMES --USE_DATANFT True
 
       - name: Run dftool vebals
         run: |
-          ./dftool vebals $date $now 200 $CSV_DIR 1 --RETRIES $RETRY_TIMES
+          ./dftool vebals $date $now 200 $CSV_DIR 1 --RETRIES $RETRY_TIMES --USE_DATANFT True
 
       - name: Run dftool allocations
         run: |
-          ./dftool allocations $date $now 200 $CSV_DIR 1 --RETRIES $RETRY_TIMES
+          ./dftool allocations $date $now 200 $CSV_DIR 1 --RETRIES $RETRY_TIMES --USE_DATANFT True
 
       - name: Run dftool predictoor_data
         run: |

df_py/conftest.py

@@ -2,7 +2,11 @@
 
 from df_py.util import networkutil, oceantestutil
 from df_py.util.base18 import to_wei
-from df_py.util.oceanutil import OCEAN_token, record_dev_deployed_contracts
+from df_py.util.oceanutil import (
+    OCEAN_token,
+    create_data_nft,
+    record_dev_deployed_contracts,
+)
 
 
 def pytest_sessionstart():
@@ -30,3 +34,11 @@ def account0():
 @pytest.fixture
 def all_accounts():
     return oceantestutil.get_all_accounts()
+
+
+@pytest.fixture
+# pylint: disable=redefined-outer-name
+def nft_addr(w3, account0, monkeypatch):
+    data_NFT = create_data_nft(w3, "1", "1", account0)
+    monkeypatch.setenv("DATANFT_ADDR", data_NFT.contract.address)
+    return data_NFT.contract.address

df_py/util/blockrange.py

@@ -68,8 +68,10 @@ def __str__(self):
         )
 
 
-def create_range(web3, st, fin, samples, rndseed) -> BlockRange:
-    st_block, fin_block = get_st_fin_blocks(web3, st, fin)
+def create_range(
+    web3, st, fin, samples, rndseed, use_data_nft: bool = False
+) -> BlockRange:
+    st_block, fin_block = get_st_fin_blocks(web3, st, fin, use_data_nft)
     rng = BlockRange(st_block, fin_block, samples, rndseed, web3=web3)
     rng.filter_by_max_block(web3.eth.get_block("latest").number - 4)
 

df_py/util/blocktime.py

@@ -6,6 +6,10 @@
 from scipy import optimize
 from web3.main import Web3
 
+from df_py.util.datanft_blocktime import (
+    get_blocknumber_from_date,
+)
+
 
 @enforce_types
 def get_block_number_thursday(web3) -> int:
@@ -248,22 +252,46 @@ def eth_find_closest_block(
 
 
 @enforce_types
-def get_fin_block(web3, FIN):
+def get_block_number_from_datanft(web3, timestamp: int) -> int:
+    date = datetime.fromtimestamp(timestamp)
+    block_number = get_blocknumber_from_date(web3, date)
+    block_found = web3.eth.get_block(block_number)
+    block_timestamp = block_found.timestamp
+    if abs(block_timestamp - timestamp) > 60 * 15:
+        print("The recorded block number is too far from the target")
+        print("Canceling use_data_nft")
+        return 0
+    return block_number
+
+
+@enforce_types
+def get_fin_block(web3, FIN, use_data_nft: bool = False):
     fin_block = 0
     if FIN == "latest":
-        fin_block = web3.eth.get_block("latest").number - 4
-    elif FIN == "thu":
-        fin_block = get_block_number_thursday(web3)
-    elif "-" in str(FIN):
+        return web3.eth.get_block("latest").number - 4
+    if FIN == "thu":
+        return get_block_number_thursday(web3)
+    if use_data_nft:
+        timestamp = int(timestr_to_timestamp(FIN) if "-" in str(FIN) else int(FIN))
+        block_number = get_block_number_from_datanft(web3, timestamp)
+        if block_number != 0:
+            return block_number
+    if "-" in str(FIN):
         fin_block = timestr_to_block(web3, FIN)
     else:
         fin_block = int(FIN)
     return fin_block
 
 
 @enforce_types
-def get_st_block(web3, ST):
+def get_st_block(web3, ST, use_data_nft: bool = False):
     st_block = 0
+
+    if use_data_nft:
+        timestamp = timestr_to_timestamp(ST) if "-" in str(ST) else int(ST)
+        block_number = get_block_number_from_datanft(web3, int(timestamp))
+        if block_number != 0:
+            return block_number
     if "-" in str(ST):
         st_block = timestr_to_block(web3, ST)
     else:
@@ -272,7 +300,7 @@ def get_st_block(web3, ST):
 
 
 @enforce_types
-def get_st_fin_blocks(web3, ST, FIN):
-    st_block = get_st_block(web3, ST)
-    fin_block = get_fin_block(web3, FIN)
+def get_st_fin_blocks(web3, ST, FIN, use_data_nft: bool = False):
+    st_block = get_st_block(web3, ST, use_data_nft)
+    fin_block = get_fin_block(web3, FIN, use_data_nft)
     return (st_block, fin_block)

df_py/util/datanft_blocktime.py

@@ -0,0 +1,96 @@
+import os
+import json
+from datetime import datetime
+from typing import Dict, Union
+
+from enforce_typing import enforce_types
+from web3 import Web3
+
+from df_py.volume.reward_calculator import get_df_week_number
+from df_py.util.contract_base import ContractBase
+from df_py.util.web3 import get_web3, get_rpc_url
+
+
+@enforce_types
+def _set_data(w3, nft_addr: str, field_label: str, data: str) -> bool:
+    field_label_hash = Web3.keccak(text=field_label)
+    field_value_bytes = data.encode()
+    contract_instance = ContractBase(w3, "ERC721Template", nft_addr)
+    tx = contract_instance.contract.functions.setNewData(
+        field_label_hash, field_value_bytes
+    ).transact()
+    receipt = w3.eth.wait_for_transaction_receipt(tx)
+    return receipt is not None and receipt["status"] == 1
+
+
+@enforce_types
+def _read_data(w3, nft_addr: str, field_label: str) -> str:
+    field_label_hash = Web3.keccak(text=field_label)
+    contract_instance = ContractBase(w3, "ERC721Template", nft_addr)
+    value = contract_instance.contract.functions.getData(field_label_hash).call()
+    value_str = value.decode("utf-8")
+    return value_str
+
+
+@enforce_types
+def _get_w3_object():
+    # DataNFT that holds the block numbers is deployed on Polygon
+    w3 = get_web3(get_rpc_url("polygon"))
+    return w3
+
+
+@enforce_types
+def _set_blocknumber_data(
+    nft_addr: str,
+    from_account,
+    blocknumbers: Dict[str, Dict[str, int]],
+    week_number: str,
+    w3=None,
+) -> bool:
+    w3 = _get_w3_object() if w3 is None else w3
+    w3.eth.default_account = from_account
+    # w3.middleware_onion.add(construct_sign_and_send_raw_middleware(from_account))
+    data = json.dumps(blocknumbers)
+    return _set_data(w3, nft_addr, week_number, data)
+
+
+@enforce_types
+def _read_blocknumber_data(
+    nft_addr: str, week_number: str, w3
+) -> Dict[str, Dict[str, int]]:
+    w3 = _get_w3_object() if w3 is None else w3
+    data = _read_data(w3, nft_addr, week_number)
+    if data == "":
+        return {}
+    return json.loads(data)
+
+
+@enforce_types
+def get_block_number_from_weeknumber(
+    chainid: Union[str, int], week_number: Union[str, int], w3=None
+) -> int:
+    data = _read_blocknumber_data(os.getenv("DATANFT_ADDR"), str(week_number), w3)
+    week_number = str(week_number)
+    if week_number not in data:
+        return 0
+    return data[week_number].get(str(chainid), 0)
+
+
+@enforce_types
+def set_blocknumber_to_datanft(
+    chainid: int, from_account, blocknumber: int, week_number: Union[str, int], w3=None
+) -> bool:
+    nft_addr = os.getenv("DATANFT_ADDR")
+    week_number = str(week_number)
+    data = _read_blocknumber_data(nft_addr, week_number, w3)
+    if week_number not in data:
+        data[week_number] = {}
+    data[week_number][chainid] = blocknumber
+    return _set_blocknumber_data(nft_addr, from_account, data, str(week_number), w3)
+
+
+@enforce_types
+def get_blocknumber_from_date(w3, date: datetime) -> int:
+    df_week = get_df_week_number(date)
+    chainid = w3.eth.chain_id
+    return get_block_number_from_weeknumber(chainid, df_week)