add IRewardClaim interface (#3610)

* add IRewardClaim interface

This is taken from PR

#3491

Would like to review and merge it into main first before we finish the
contract so that it's easy to share with external parties.

* rename event for consistency

* add IRewardClaim ABI Json

Author: sveitser

contracts/artifacts/abi/IRewardClaim.json

@@ -0,0 +1,85 @@
+[
+  {
+    "type": "function",
+    "name": "claimRewards",
+    "inputs": [
+      {
+        "name": "lifetimeRewards",
+        "type": "uint256",
+        "internalType": "uint256"
+      },
+      {
+        "name": "proof",
+        "type": "tuple",
+        "internalType": "struct IRewardClaim.LifetimeRewardsProof",
+        "components": [
+          {
+            "name": "siblings",
+            "type": "bytes32[]",
+            "internalType": "bytes32[]"
+          }
+        ]
+      },
+      {
+        "name": "authRootInputs",
+        "type": "bytes32[7]",
+        "internalType": "bytes32[7]"
+      }
+    ],
+    "outputs": [],
+    "stateMutability": "nonpayable"
+  },
+  {
+    "type": "function",
+    "name": "claimedRewards",
+    "inputs": [
+      {
+        "name": "claimer",
+        "type": "address",
+        "internalType": "address"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "stateMutability": "view"
+  },
+  {
+    "type": "event",
+    "name": "RewardsClaimed",
+    "inputs": [
+      {
+        "name": "user",
+        "type": "address",
+        "indexed": true,
+        "internalType": "address"
+      },
+      {
+        "name": "amount",
+        "type": "uint256",
+        "indexed": false,
+        "internalType": "uint256"
+      }
+    ],
+    "anonymous": false
+  },
+  {
+    "type": "error",
+    "name": "AlreadyClaimed",
+    "inputs": []
+  },
+  {
+    "type": "error",
+    "name": "InvalidAuthRoot",
+    "inputs": []
+  },
+  {
+    "type": "error",
+    "name": "InvalidRewardAmount",
+    "inputs": []
+  }
+]

contracts/src/interfaces/IRewardClaim.sol

@@ -0,0 +1,38 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.28;
+
+interface IRewardClaim {
+    /// @notice Proof for rewards merkle tree. Obtained from Espresso query service API.
+    struct LifetimeRewardsProof {
+        bytes32[] siblings;
+    }
+
+    /// @notice User claimed rewards
+    event RewardsClaimed(address indexed user, uint256 amount);
+
+    /// @notice Unable to authenticate rewards against Light Client contract
+    error InvalidAuthRoot();
+
+    /// @notice All available rewards already claimed
+    error AlreadyClaimed();
+
+    /// @notice Reward amount must be greater than zero
+    error InvalidRewardAmount();
+
+    /// @notice Claim staking rewards
+    ///
+    /// @param lifetimeRewards Total earned lifetime rewards for the user
+    /// @param proof Merkle proof attesting to lifetime rewards for the user
+    /// @param authRootInputs The authRootInputs must all be zero at the moment,
+    ///        this may change in the future with Espresso protocol upgrades.
+    ///
+    /// @notice Obtain rewards and proof from the Espresso query service API.
+    function claimRewards(
+        uint256 lifetimeRewards,
+        LifetimeRewardsProof calldata proof,
+        bytes32[7] calldata authRootInputs
+    ) external;
+
+    /// @notice Check amount of rewards claimed by a user
+    function claimedRewards(address claimer) external view returns (uint256);
+}

justfile

@@ -170,7 +170,7 @@ gen-bindings:
 export-contract-abis:
     rm -rv contracts/artifacts/abi
     mkdir -p contracts/artifacts/abi
-    for contract in LightClient{,Mock,V2{,Mock}} StakeTable EspToken; do \
+    for contract in LightClient{,Mock,V2{,Mock}} StakeTable EspToken IRewardClaim; do \
         cat "contracts/out/${contract}.sol/${contract}.json" | jq .abi > "contracts/artifacts/abi/${contract}.json"; \
     done