Merge pull request #404 from valory-xyz/staging

staging to main

Author: truemiller

frontend/context/RewardProvider.tsx

@@ -18,7 +18,7 @@ import { AutonolasService } from '@/service/Autonolas';
 
 import { OnlineStatusContext } from './OnlineStatusProvider';
 import { ServicesContext } from './ServicesProvider';
-import { StakingProgramContext } from './StakingProgramContext';
+import { StakingProgramContext } from './StakingProgramProvider';
 
 export const RewardContext = createContext<{
   accruedServiceStakingRewards?: number;

frontend/context/StakingContractInfoProvider.tsx

@@ -18,7 +18,7 @@ import { AutonolasService } from '@/service/Autonolas';
 import { StakingContractInfo } from '@/types/Autonolas';
 
 import { ServicesContext } from './ServicesProvider';
-import { StakingProgramContext } from './StakingProgramContext';
+import { StakingProgramContext } from './StakingProgramProvider';
 
 type StakingContractInfoContextProps = {
   activeStakingContractInfo?: Partial<StakingContractInfo>;

frontend/context/StakingProgramContext.tsx frontend/context/StakingProgramProvider.tsx

@@ -0,0 +1,49 @@
+import { PropsWithChildren, useCallback, useEffect, useRef } from 'react';
+
+import { DeploymentStatus } from '@/client';
+import { useElectronApi } from '@/hooks/useElectronApi';
+import { useReward } from '@/hooks/useReward';
+import { useServices } from '@/hooks/useServices';
+
+const Notifications = {
+  AgentEarned:
+    "Your agent earned its rewards! It's now idle and will resume working next epoch.",
+};
+
+export const SystemNotificationTriggers = ({ children }: PropsWithChildren) => {
+  const electronApi = useElectronApi();
+  const { serviceStatus } = useServices();
+  const { isEligibleForRewards } = useReward();
+
+  const prevIsEligibleForRewards = useRef<boolean>();
+
+  // Notify the user when the agent earns rewards
+  const handleAgentEarned = useCallback(() => {
+    if (!electronApi.showNotification) return;
+
+    // ignore if agent is not running
+    if (serviceStatus !== DeploymentStatus.DEPLOYED) return;
+    // ignore if eligibility is not yet defined
+    if (isEligibleForRewards === undefined) return;
+    // ignore if agent was previously eligible and is still eligible
+    if (prevIsEligibleForRewards.current && isEligibleForRewards) return;
+    // ignore if eligibility has not changed
+    if (prevIsEligibleForRewards.current === isEligibleForRewards) return;
+
+    // show notification when agent becomes eligible for rewards
+    // (and was not previously eligible)
+    if (isEligibleForRewards && prevIsEligibleForRewards.current === false) {
+      electronApi.showNotification(Notifications.AgentEarned);
+    }
+
+    prevIsEligibleForRewards.current = isEligibleForRewards;
+  }, [electronApi, isEligibleForRewards, serviceStatus]);
+
+  useEffect(() => {
+    if (!electronApi.showNotification) return;
+    // Show notification when agent earns rewards
+    handleAgentEarned();
+  }, [electronApi, handleAgentEarned, isEligibleForRewards, serviceStatus]);
+
+  return children;
+};

frontend/context/SystemNotificationTriggers.tsx

@@ -3,7 +3,7 @@ import { useContext, useMemo } from 'react';
 import { Chain } from '@/client';
 import { SERVICE_STAKING_TOKEN_MECH_USAGE_CONTRACT_ADDRESSES } from '@/constants/contractAddresses';
 import { STAKING_PROGRAM_META } from '@/constants/stakingProgramMeta';
-import { StakingProgramContext } from '@/context/StakingProgramContext';
+import { StakingProgramContext } from '@/context/StakingProgramProvider';
 
 /**
  * Hook to get the active staking program and its metadata, and the default staking program.

frontend/hooks/useStakingProgram.ts

@@ -17,8 +17,9 @@ import { ServicesProvider } from '@/context/ServicesProvider';
 import { SettingsProvider } from '@/context/SettingsProvider';
 import { SetupProvider } from '@/context/SetupProvider';
 import { StakingContractInfoProvider } from '@/context/StakingContractInfoProvider';
-import { StakingProgramProvider } from '@/context/StakingProgramContext';
+import { StakingProgramProvider } from '@/context/StakingProgramProvider';
 import { StoreProvider } from '@/context/StoreProvider';
+import { SystemNotificationTriggers } from '@/context/SystemNotificationTriggers';
 import { WalletProvider } from '@/context/WalletProvider';
 import { mainTheme } from '@/theme';
 
@@ -48,9 +49,11 @@ export default function App({ Component, pageProps }: AppProps) {
                                 <ModalProvider>
                                   {isMounted ? (
                                     <QueryClientProvider client={queryClient}>
-                                      <Layout>
-                                        <Component {...pageProps} />
-                                      </Layout>
+                                      <SystemNotificationTriggers>
+                                        <Layout>
+                                          <Component {...pageProps} />
+                                        </Layout>
+                                      </SystemNotificationTriggers>
                                     </QueryClientProvider>
                                   ) : null}
                                 </ModalProvider>

frontend/pages/_app.tsx

@@ -28,6 +28,7 @@
 import typing as t
 from copy import copy, deepcopy
 from dataclasses import dataclass
+from json import JSONDecodeError
 from pathlib import Path
 from time import sleep
 from traceback import print_exc
@@ -758,8 +759,10 @@ def deployment(self) -> Deployment:
         """Load deployment object for the service."""
         if not (self.path / DEPLOYMENT_JSON).exists():
             self._deployment = Deployment.new(path=self.path)
-        if self._deployment is None:
+        try:
             self._deployment = Deployment.load(path=self.path)
+        except JSONDecodeError:
+            self._deployment = Deployment.new(path=self.path)
         return t.cast(Deployment, self._deployment)
 
     @staticmethod

operate/services/service.py

@@ -63,5 +63,5 @@
     "download-binaries": "sh download_binaries.sh",
     "build:pearl": "sh build_pearl.sh"
   },
-  "version": "0.1.0-rc168"
+  "version": "0.1.0-rc173"
 }

package.json

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "olas-operate-middleware"
-version = "0.1.0-rc168"
+version = "0.1.0-rc173"
 description = ""
 authors = ["David Vilela <[email protected]>", "Viraj Patel <[email protected]>"]
 readme = "README.md"