feat: add support for hibernated spaces (#4350)

* feat: disable proposal creation on hibernate spaces

* fix: add button to reactivate space

* fix: add link to hibernation doc

* fix: add translations

* chore: fix formatting

* refactor: extract hibernation warning message to its own component

* feat: reactivate space via sequencer

* chore: formatting fix

* fix: show success message on space reactivation

* fix: add link to doc

* chore: fix formatting

* fix: use settings basic update to reactivate space

* chore: fix formatting

* fix: redirect reactivate space CTA to settings page

* fix: update hibernated warning message

* feat: add space reactivation message in space settings

* Update src/components/MessageWarningHibernated.vue

Co-authored-by: Sam <51686767+samuveth@users.noreply.github.com>

* fix: increase warning level to red

* fix: remove title and change layout

* fix: "learn more" should only visible to admin/controller

* refactor: extract message into its own components

* Update src/locales/default.json

* Fixes

* Update src/locales/default.json

---------

Co-authored-by: Sam <51686767+samuveth@users.noreply.github.com>
Co-authored-by: Sam <samuv.eth@gmail.com>
Co-authored-by: Chaitanya <yourchaitu@gmail.com>

src/components/MessageWarningHibernated.vue

@@ -0,0 +1,43 @@
+<script setup lang="ts">
+import { ExtendedSpace } from '@/helpers/interfaces';
+
+const props = defineProps<{
+  space: ExtendedSpace;
+}>();
+
+const { web3Account } = useWeb3();
+const { loadSpaceController, isSpaceController } = useSpaceController();
+
+const isAuthorized = computed(() => {
+  const admins = (props.space.admins || []).map(admin => admin.toLowerCase());
+  return (
+    admins.includes(web3Account.value?.toLowerCase()) || isSpaceController.value
+  );
+});
+
+onMounted(async () => {
+  await loadSpaceController();
+});
+</script>
+
+<template>
+  <BaseMessageBlock v-if="space.hibernated" level="warning-red" is-responsive>
+    {{
+      isAuthorized
+        ? $t('create.errorSpaceHibernatedAdmin')
+        : $t('create.errorSpaceHibernatedUsers')
+    }}
+    <BaseLink
+      v-if="isAuthorized"
+      link="https://docs.snapshot.org/user-guides/spaces/space-hibernation"
+    >
+      {{ $t('learnMore') }}
+    </BaseLink>
+
+    <p v-if="isAuthorized" class="mt-3">
+      <router-link :to="{ name: 'spaceSettings' }">
+        <BaseButton> Go to Settings </BaseButton>
+      </router-link>
+    </p>
+  </BaseMessageBlock>
+</template>

src/components/SpaceCreateWarnings.vue

@@ -41,8 +41,10 @@ const strategySymbolsString = computed(() => {
 
 <template>
   <div class="mb-4 space-y-2">
+    <MessageWarningHibernated v-if="space.hibernated" :space="space" />
+
     <MessageWarningGnosisNetwork
-      v-if="isGnosisAndNotSpaceNetwork"
+      v-else-if="isGnosisAndNotSpaceNetwork"
       :space="space"
       action="create"
       is-responsive

src/components/SpaceSettingsMessageHibernated.vue

@@ -0,0 +1,37 @@
+<script setup lang="ts">
+import { ExtendedSpace } from '@/helpers/interfaces';
+
+defineProps<{
+  space: ExtendedSpace;
+  isSending: boolean;
+  isValid: boolean;
+}>();
+
+const emit = defineEmits(['showErrors', 'reactivateSpace']);
+
+onMounted(() => {
+  emit('showErrors');
+});
+</script>
+
+<template>
+  <BaseMessageBlock level="warning-red" is-responsive>
+    <div v-if="isValid">
+      {{ $t('settings.reactivatingHibernatedSpace.information') }}
+    </div>
+
+    <div v-else>
+      {{ $t('settings.reactivatingHibernatedSpace.disabledInformation') }}
+    </div>
+
+    <BaseButton
+      primary
+      :loading="isSending"
+      :disabled="!isValid"
+      class="mt-3 whitespace-nowrap"
+      @click="emit('reactivateSpace')"
+    >
+      {{ $t('reactivateSpace') }}
+    </BaseButton>
+  </BaseMessageBlock>
+</template>

src/composables/useClient.ts

@@ -164,6 +164,20 @@ export function useClient() {
         proposalId: payload.proposal.id
       });
 
+      return receipt;
+    } else if (type === 'reactivate-space') {
+      const receipt = await client.reactivateSpace(
+        auth.web3,
+        web3.value.account,
+        {
+          space: space.id
+        }
+      );
+
+      mixpanel.track('Reactivate space', {
+        space: space.id
+      });
+
       return receipt;
     }
   }

src/composables/useFormSpaceSettings.ts

@@ -123,6 +123,7 @@ export function useFormSpaceSettings(context: 'setup' | 'settings') {
     delete formData.followersCount;
     delete formData.verified;
     delete formData.flagged;
+    delete formData.hibernated;
 
     if (formData.filters.invalids) delete formData.filters.invalids;
   }

src/helpers/interfaces.ts

@@ -112,6 +112,7 @@ export interface Space {
   activeProposals: number;
   followersCount: number;
   flagged: boolean;
+  hibernated: boolean;
   terms: string;
 }
 
@@ -165,6 +166,7 @@ export interface ExtendedSpace {
   guidelines: string;
   verified: boolean;
   flagged: boolean;
+  hibernated: boolean;
   voting: {
     delay: number | null;
     hideAbstain: boolean;

src/helpers/queries.ts

@@ -407,6 +407,7 @@ export const SPACES_QUERY = gql`
       followersCount
       terms
       flagged
+      hibernated
     }
   }
 `;
@@ -452,6 +453,7 @@ export const SPACE_QUERY = gql`
       guidelines
       verified
       flagged
+      hibernated
       parent {
         id
         name

src/locales/default.json

@@ -174,6 +174,7 @@
   "createASpace": "Create a space",
   "getStarted": "Get started",
   "skip": "Skip",
+  "reactivateSpace": "Reactivate space",
   "newSpaceNotice": {
     "header": "Your space is live!",
     "mainText": "You can change how voting power is calculated via strategies in your {settings}. Changes to your settings will only affect new proposals, existing proposals can not be changed.",
@@ -235,7 +236,9 @@
     "uploading": "Uploading image",
     "markdown": "Styling with Markdown is supported",
     "errorGettingSnapshot": "We encountered an error while fetching the snapshot block number which is needed to calculate your voting power. Please try again later.",
-    "errorTimeInPast": "Entered time is in the past. Please select a future time."
+    "errorTimeInPast": "Entered time is in the past. Please select a future time.",
+    "errorSpaceHibernatedAdmin": "Admins your attention is required. This space has been hibernated due to a lack of activity, and as a result, proposal creation is currently disabled. To re-enable your space, please go to the settings page and click \"Reactivate\".",
+    "errorSpaceHibernatedUsers": "This space has been hibernated due to a lack of activity. As a result, the creation of proposals has been temporarily disabled. To resume your ability to create proposals, the space needs to be reactivated by an admin. Please check back later or contact your space admin for further information."
   },
   "delegates": {
     "header": "Delegates",
@@ -534,6 +537,10 @@
     "delegationPortal": {
       "title": "Delegation portal",
       "information": "Please ensure your token adheres to a compatible delegation standard to enable delegate discovery and activity within your Snapshot space."
+    },
+    "reactivatingHibernatedSpace": {
+      "information": "Your space is currently in hibernation due to six months of inactivity. To re-enable proposal creation, please click the button below to reactivate your space. There are no penalties for hibernation, but the space will remain inactive for proposal creation until reactivation by an admin.",
+      "disabledInformation": "Your space contains invalid settings since your last update. Fix the errors below and your space will be reactivated automatically upon save."
     }
   },
   "setup": {
@@ -652,7 +659,8 @@
     "ensSet": "ENS text record was successfully set",
     "transactionSent": "Transaction sent",
     "emailPreferencesUpdated": "Email preferences updated",
-    "delegationAdded": "Well done. Delegate was successfully added"
+    "delegationAdded": "Well done. Delegate was successfully added",
+    "spaceReactivated": "The space has been reactivated"
   },
   "explore": {
     "createStrategy": "Create strategy",

src/views/SpaceCreate.vue

@@ -493,7 +493,8 @@ onBeforeRouteLeave(async () => {
             web3.authLoading ||
             hasAuthorValidationFailed ||
             validationLoading ||
-            isGnosisAndNotSpaceNetwork
+            isGnosisAndNotSpaceNetwork ||
+            space.hibernated
           "
           primary
           :data-testid="

src/views/SpaceSettings.vue

@@ -148,13 +148,6 @@ async function handleSubmit() {
   }
 }
 
-onMounted(async () => {
-  populateForm(props.space);
-  await loadEnsOwner();
-  await loadSpaceController();
-  loaded.value = true;
-});
-
 const {
   isRevealed: isConfirmLeaveOpen,
   reveal: openConfirmLeave,
@@ -172,6 +165,13 @@ const isViewOnly = computed(() => {
   return !(isSpaceController.value || isSpaceAdmin.value);
 });
 
+onMounted(async () => {
+  populateForm(props.space);
+  await loadEnsOwner();
+  await loadSpaceController();
+  loaded.value = true;
+});
+
 onBeforeRouteLeave(async () => {
   if (hasFormChanged.value && !isViewOnly.value) {
     const { data } = await openConfirmLeave();
@@ -190,6 +190,15 @@ onBeforeRouteLeave(async () => {
 
       <template v-else>
         <div class="mt-3 space-y-3 sm:mt-0">
+          <SpaceSettingsMessageHibernated
+            v-if="space.hibernated && !isViewOnly"
+            :space="space"
+            :is-sending="isSending"
+            :is-valid="isValid"
+            @show-errors="showFormErrors = true"
+            @reactivate-space="handleSubmit"
+          />
+
           <BaseMessageBlock
             v-if="showFormErrors && Object.keys(validationErrors).length"
             level="warning-red"