Get summary lifecycle through SnsSummaryWrapper (#5192)

# Motivation

We want to stop using the `summary.swap` field because it's deprecated
and everything on it is available in other ways.
One of the things we get from the `swap` field is the `lifecycle`.
In this PR we introduce a getter on `SnsSummaryWrapper` to determine in
a single place how we get the lifecycle.
This will make it easy to switch over in another PR.

# Changes

1. Add `getLifecycle()` to `SnsSummaryWrapper` which returns the
lifecycle from an `SnsSummary`.
2. Use `SnsSummaryWrapper` and `getLifecycle()` instead of getting
`summary.swap.lifecycle` directly.
3. Add `override()` to `SnsSummaryWrapper` because `SnsSummaryWrapper`
can't be spread into a new `SnsSummary` object.

# Tests

1. Unit tests added for `SnsSummaryWrapper`.
2. Existing unt tests updated.

# Todos

- [ ] Add entry to changelog (if necessary).
not necessary

frontend/src/lib/components/launchpad/ProjectCardSwapInfo.svelte

@@ -3,11 +3,8 @@
   import ProjectUserCommitmentLabel from "$lib/components/project-detail/ProjectUserCommitmentLabel.svelte";
   import type { SnsFullProject } from "$lib/derived/sns/sns-projects.derived";
   import { i18n } from "$lib/stores/i18n";
-  import type {
-    SnsSummary,
-    SnsSwapCommitment,
-    SnsSummarySwap,
-  } from "$lib/types/sns";
+  import type { SnsSummarySwap, SnsSwapCommitment } from "$lib/types/sns";
+  import type { SnsSummaryWrapper } from "$lib/types/sns-summary-wrapper";
   import {
     durationTillSwapDeadline,
     durationTillSwapStart,
@@ -23,17 +20,15 @@
   // The data to know whether it's finalizing or not is not in the SnsFullProject.
   export let isFinalizing: boolean;
 
-  let summary: SnsSummary;
+  let summary: SnsSummaryWrapper;
   let swapCommitment: SnsSwapCommitment | undefined;
   $: ({ summary, swapCommitment } = project);
 
   let swap: SnsSummarySwap;
   $: ({ swap } = summary);
 
   let lifecycle: number;
-  $: ({
-    swap: { lifecycle },
-  } = summary);
+  $: lifecycle = summary.getLifecycle();
 
   let durationTillDeadline: bigint | undefined;
   $: durationTillDeadline = durationTillSwapDeadline(swap);

frontend/src/lib/components/project-detail/ParticipateButton.svelte

@@ -11,11 +11,10 @@
     PROJECT_DETAIL_CONTEXT_KEY,
     type ProjectDetailContext,
   } from "$lib/types/project-detail.context";
-  import type { SnsSummary } from "$lib/types/sns";
   import {
     hasUserParticipatedToSwap,
-    type ParticipationButtonStatus,
     participateButtonStatus,
+    type ParticipationButtonStatus,
   } from "$lib/utils/projects.utils";
   import { BottomSheet } from "@dfinity/gix-components";
   import { Tooltip } from "@dfinity/gix-components";
@@ -29,13 +28,8 @@
   );
 
   let lifecycle: number;
-  $: ({
-    swap: { lifecycle },
-  } =
-    $projectDetailStore.summary ??
-    ({
-      swap: { state: { lifecycle: SnsSwapLifecycle.Unspecified } },
-    } as unknown as SnsSummary));
+  $: lifecycle =
+    $projectDetailStore.summary?.getLifecycle() ?? SnsSwapLifecycle.Unspecified;
 
   let showModal = false;
   const openModal = () => (showModal = true);

frontend/src/lib/components/project-detail/ProjectMetadataSection.svelte

@@ -8,7 +8,8 @@
     PROJECT_DETAIL_CONTEXT_KEY,
     type ProjectDetailContext,
   } from "$lib/types/project-detail.context";
-  import type { SnsSummary, SnsSummaryMetadata } from "$lib/types/sns";
+  import type { SnsSummaryMetadata } from "$lib/types/sns";
+  import type { SnsSummaryWrapper } from "$lib/types/sns-summary-wrapper";
   import { snsProjectDashboardUrl } from "$lib/utils/projects.utils";
   import type { Principal } from "@dfinity/principal";
   import { SnsSwapLifecycle } from "@dfinity/sns";
@@ -19,14 +20,14 @@
     PROJECT_DETAIL_CONTEXT_KEY
   );
 
-  let summary: SnsSummary | undefined | null;
+  let summary: SnsSummaryWrapper | undefined | null;
   $: summary = $projectDetailStore.summary;
 
   let rootCanisterId: Principal | undefined;
   $: rootCanisterId = summary?.rootCanisterId;
 
   let lifecycle: SnsSwapLifecycle | undefined;
-  $: lifecycle = summary?.swap.lifecycle;
+  $: lifecycle = summary?.getLifecycle();
 
   let metadata: SnsSummaryMetadata | undefined;
   let token: IcrcTokenMetadata | undefined;

frontend/src/lib/components/project-detail/ProjectStatusSection.svelte

@@ -3,14 +3,14 @@
     PROJECT_DETAIL_CONTEXT_KEY,
     type ProjectDetailContext,
   } from "$lib/types/project-detail.context";
-  import type { SnsSwapCommitment, SnsSummary } from "$lib/types/sns";
+  import type { SnsSwapCommitment } from "$lib/types/sns";
   import { getCommitmentE8s } from "$lib/utils/sns.utils";
   import ParticipateButton from "./ParticipateButton.svelte";
   import ProjectCommitment from "./ProjectCommitment.svelte";
   import ProjectStatus from "./ProjectStatus.svelte";
   import ProjectTimelineUserCommitment from "./ProjectTimelineUserCommitment.svelte";
   import { SnsSwapLifecycle } from "@dfinity/sns";
-  import { TokenAmount, ICPToken, nonNullish } from "@dfinity/utils";
+  import { ICPToken, TokenAmount, nonNullish } from "@dfinity/utils";
   import { isNullish } from "@dfinity/utils";
   import { getContext } from "svelte";
 
@@ -34,13 +34,8 @@
   $: loadingSummary = isNullish($projectDetailStore.summary);
 
   let lifecycle: number;
-  $: ({
-    swap: { lifecycle },
-  } =
-    $projectDetailStore.summary ??
-    ({
-      swap: { state: { lifecycle: SnsSwapLifecycle.Unspecified } },
-    } as unknown as SnsSummary));
+  $: lifecycle =
+    $projectDetailStore.summary?.getLifecycle() ?? SnsSwapLifecycle.Unspecified;
 
   let displayStatusSection = false;
   $: displayStatusSection =

frontend/src/lib/components/project-detail/ProjectTimelineUserCommitment.svelte

@@ -1,24 +1,21 @@
 <script lang="ts">
   import { i18n } from "$lib/stores/i18n";
-  import type {
-    SnsSummary,
-    SnsSummarySwap,
-    SnsSwapCommitment,
-  } from "$lib/types/sns";
+  import type { SnsSummarySwap, SnsSwapCommitment } from "$lib/types/sns";
+  import type { SnsSummaryWrapper } from "$lib/types/sns-summary-wrapper";
   import {
     durationTillSwapDeadline,
     durationTillSwapStart,
   } from "$lib/utils/projects.utils";
   import AmountDisplay from "../ic/AmountDisplay.svelte";
   import Separator from "../ui/Separator.svelte";
   import ProjectUserCommitmentLabel from "./ProjectUserCommitmentLabel.svelte";
-  import { Value, KeyValuePair } from "@dfinity/gix-components";
+  import { KeyValuePair, Value } from "@dfinity/gix-components";
   import { SnsSwapLifecycle } from "@dfinity/sns";
   import { TokenAmount, nonNullish } from "@dfinity/utils";
   import { secondsToDuration } from "@dfinity/utils";
 
   export let myCommitment: TokenAmount | undefined;
-  export let summary: SnsSummary;
+  export let summary: SnsSummaryWrapper;
   export let swapCommitment: SnsSwapCommitment | undefined | null;
 
   let swap: SnsSummarySwap;
@@ -31,11 +28,14 @@
   let durationTillStart: bigint | undefined;
   $: durationTillStart = durationTillSwapStart(swap);
 
+  let lifecycle: SnsSwapLifecycle;
+  $: lifecycle = summary.getLifecycle();
+
   let isOpen: boolean;
-  $: isOpen = swap.lifecycle === SnsSwapLifecycle.Open;
+  $: isOpen = lifecycle === SnsSwapLifecycle.Open;
 
   let isAdopted: boolean;
-  $: isAdopted = swap.lifecycle === SnsSwapLifecycle.Adopted;
+  $: isAdopted = lifecycle === SnsSwapLifecycle.Adopted;
 
   let hasParticipated: boolean;
   $: hasParticipated = nonNullish(myCommitment) && myCommitment.toE8s() > 0n;

frontend/src/lib/components/project-detail/ProjectUserCommitmentLabel.svelte

@@ -1,9 +1,10 @@
 <script lang="ts">
   import { i18n } from "$lib/stores/i18n";
-  import type { SnsSummary, SnsSwapCommitment } from "$lib/types/sns";
+  import type { SnsSwapCommitment } from "$lib/types/sns";
+  import type { SnsSummaryWrapper } from "$lib/types/sns-summary-wrapper";
   import { canUserParticipateToSwap } from "$lib/utils/projects.utils";
 
-  export let summary: SnsSummary | undefined | null;
+  export let summary: SnsSummaryWrapper | undefined | null;
   export let swapCommitment: SnsSwapCommitment | undefined | null;
 
   let canParticipate = false;

frontend/src/lib/derived/sns/sns-projects.derived.ts

@@ -3,11 +3,8 @@ import {
   snsSwapCommitmentsStore,
   type SnsSwapCommitmentsStore,
 } from "$lib/stores/sns.store";
-import type {
-  RootCanisterIdText,
-  SnsSummary,
-  SnsSwapCommitment,
-} from "$lib/types/sns";
+import type { RootCanisterIdText, SnsSwapCommitment } from "$lib/types/sns";
+import type { SnsSummaryWrapper } from "$lib/types/sns-summary-wrapper";
 import {
   filterActiveProjects,
   filterCommittedProjects,
@@ -21,7 +18,7 @@ import { derived, type Readable } from "svelte/store";
 
 export interface SnsFullProject {
   rootCanisterId: Principal;
-  summary: SnsSummary;
+  summary: SnsSummaryWrapper;
   swapCommitment: SnsSwapCommitment | undefined;
 }
 
@@ -32,7 +29,7 @@ export interface SnsFullProject {
  * @return SnsFullProject[] | undefined What we called project - i.e. the summary and swap of a Sns with the user commitment
  */
 export const snsProjectsStore = derived<
-  [Readable<SnsSummary[]>, SnsSwapCommitmentsStore],
+  [Readable<SnsSummaryWrapper[]>, SnsSwapCommitmentsStore],
   SnsFullProject[]
 >(
   [snsSummariesStore, snsSwapCommitmentsStore],

frontend/src/lib/modals/sns/sale/ParticipateSwapModal.svelte

@@ -19,7 +19,8 @@
     type ProjectDetailContext,
   } from "$lib/types/project-detail.context";
   import { SaleStep } from "$lib/types/sale";
-  import type { SnsSummary, SnsSwapCommitment } from "$lib/types/sns";
+  import type { SnsSwapCommitment } from "$lib/types/sns";
+  import type { SnsSummaryWrapper } from "$lib/types/sns-summary-wrapper";
   import type {
     NewTransaction,
     ValidateAmountFn,
@@ -36,7 +37,7 @@
     hasOpenTicketInProcess,
   } from "$lib/utils/sns.utils";
   import type { WizardStep } from "@dfinity/gix-components";
-  import { TokenAmount, ICPToken } from "@dfinity/utils";
+  import { ICPToken, TokenAmount } from "@dfinity/utils";
   import { nonNullish } from "@dfinity/utils";
   import {
     createEventDispatcher,
@@ -56,10 +57,10 @@
   const { store: projectDetailStore, reload } =
     getContext<ProjectDetailContext>(PROJECT_DETAIL_CONTEXT_KEY);
 
-  let summary: SnsSummary;
+  let summary: SnsSummaryWrapper;
   let swapCommitment: SnsSwapCommitment | undefined | null;
   // type safety validation is done in ProjectDetail component
-  $: summary = $projectDetailStore.summary as SnsSummary;
+  $: summary = $projectDetailStore.summary as SnsSummaryWrapper;
   $: swapCommitment = $projectDetailStore.swapCommitment;
   let userHasParticipatedToSwap = false;
   $: userHasParticipatedToSwap = hasUserParticipatedToSwap({

frontend/src/lib/pages/ProjectDetail.svelte

@@ -19,9 +19,9 @@
   } from "$lib/services/sns-sale.services";
   import { loadSnsSwapMetrics } from "$lib/services/sns-swap-metrics.services";
   import {
+    loadSnsDerivedState,
     loadSnsLifecycle,
     loadSnsSwapCommitment,
-    loadSnsDerivedState,
     watchSnsTotalCommitment,
   } from "$lib/services/sns.services";
   import { loadUserCountry } from "$lib/services/user-country.services";
@@ -42,7 +42,7 @@
   import { Principal } from "@dfinity/principal";
   import { SnsSwapLifecycle } from "@dfinity/sns";
   import { isNullish, nonNullish } from "@dfinity/utils";
-  import { setContext, onDestroy } from "svelte";
+  import { onDestroy, setContext } from "svelte";
   import { writable } from "svelte/store";
 
   export let rootCanisterId: string | undefined | null;
@@ -148,7 +148,7 @@
 
   let enableOpenProjectWatchers = false;
   $: enableOpenProjectWatchers =
-    $projectDetailStore?.summary?.swap.lifecycle === SnsSwapLifecycle.Open;
+    $projectDetailStore?.summary?.getLifecycle() === SnsSwapLifecycle.Open;
 
   let swapCanisterId: Principal | undefined;
   $: swapCanisterId = $projectDetailStore.summary?.swapCanisterId;
@@ -175,7 +175,7 @@
 
   $: if (
     nonNullish(rootCanisterId) &&
-    $projectDetailStore.summary?.swap.lifecycle === SnsSwapLifecycle.Committed
+    $projectDetailStore.summary?.getLifecycle() === SnsSwapLifecycle.Committed
   ) {
     loadSnsFinalizationStatus({
       rootCanisterId: Principal.fromText(rootCanisterId),
@@ -235,7 +235,7 @@
   // - no root canister id
   // - ticket already in progress for the same root canister id
   $: if (
-    $projectDetailStore.summary?.swap.lifecycle === SnsSwapLifecycle.Open &&
+    $projectDetailStore.summary?.getLifecycle() === SnsSwapLifecycle.Open &&
     $authSignedInStore &&
     nonNullish(userCommitment) &&
     nonNullish(swapCanisterId) &&

frontend/src/lib/services/neurons.services.ts

@@ -983,10 +983,7 @@ export const makeDummyProposals = async (neuronId: NeuronId): Promise<void> => {
     const { snsSummariesStore } = await import("../stores/sns.store");
     const projects = get(snsSummariesStore);
     const pendingProject = projects.find(
-      ({
-        swap: { lifecycle },
-        // Use 1 instead of using enum to avoid importing sns-js
-      }) => lifecycle === 1
+      (summary) => summary.getLifecycle() === 1
     );
     await makeDummyProposalsApi({
       neuronId,

frontend/src/lib/services/sns-finalization.services.ts

@@ -31,7 +31,7 @@ export const loadSnsFinalizationStatus = async ({
   if (
     !forceFetch &&
     (isNullish(summary) ||
-      summary.swap.lifecycle !== SnsSwapLifecycle.Committed ||
+      summary.getLifecycle() !== SnsSwapLifecycle.Committed ||
       swapEndedMoreThanOneWeekAgo({ summary, nowInSeconds: nowInSeconds() }))
   ) {
     return;

frontend/src/lib/stores/sns.store.ts

@@ -1,4 +1,4 @@
-import type { SnsSummary, SnsSwapCommitment } from "$lib/types/sns";
+import type { SnsSwapCommitment } from "$lib/types/sns";
 import type { SnsSummaryWrapper } from "$lib/types/sns-summary-wrapper";
 import { convertDtoToSnsSummary } from "$lib/utils/sns-aggregator-converters.utils";
 import { ProposalStatus, type ProposalInfo } from "@dfinity/nns";
@@ -151,7 +151,7 @@ const overrideLifecycle =
  */
 export const snsSummariesStore = derived<
   [SnsAggregatorStore, SnsDerivedStateStore, SnsLifecycleStore],
-  SnsSummary[]
+  SnsSummaryWrapper[]
 >(
   [snsAggregatorStore, snsDerivedStateStore, snsLifecycleStore],
   ([aggregatorData, derivedStates, lifecycles]) => {

frontend/src/lib/types/project-detail.context.ts

@@ -1,6 +1,7 @@
+import type { SnsSummaryWrapper } from "$lib/types/sns-summary-wrapper";
 import type { TokenAmountV2 } from "@dfinity/utils";
 import type { Writable } from "svelte/store";
-import type { SnsSummary, SnsSwapCommitment } from "./sns";
+import type { SnsSwapCommitment } from "./sns";
 
 /**
  * SnsSummary or SnsSwapCommitment is a valid project
@@ -9,7 +10,7 @@ import type { SnsSummary, SnsSwapCommitment } from "./sns";
  * `undefined` means not found
  */
 export type ProjectDetailStore = {
-  summary: SnsSummary | undefined | null;
+  summary: SnsSummaryWrapper | undefined | null;
   swapCommitment: SnsSwapCommitment | undefined | null;
   totalTokensSupply?: TokenAmountV2 | undefined | null;
 };

frontend/src/lib/types/sns-summary-wrapper.ts

@@ -10,6 +10,7 @@ import type {
   SnsParams,
   SnsSwapDerivedState,
   SnsSwapInit,
+  SnsSwapLifecycle,
 } from "@dfinity/sns";
 import { fromNullable, isNullish } from "@dfinity/utils";
 
@@ -56,6 +57,10 @@ export class SnsSummaryWrapper implements SnsSummary {
     return this.summary.lifecycle;
   }
 
+  getLifecycle(): SnsSwapLifecycle {
+    return this.swap.lifecycle;
+  }
+
   public overrideDerivedState(
     newDerivedState: SnsSwapDerivedState
   ): SnsSummaryWrapper {
@@ -85,4 +90,18 @@ export class SnsSummaryWrapper implements SnsSummary {
       lifecycle: newLifecycle,
     });
   }
+
+  public overrideLifecycle(lifecycle: SnsSwapLifecycle): SnsSummaryWrapper {
+    return this.overrideLifecycleResponse({
+      ...this.lifecycle,
+      lifecycle: [lifecycle],
+    });
+  }
+
+  public override(summary: Partial<SnsSummary>): SnsSummaryWrapper {
+    return new SnsSummaryWrapper({
+      ...this.summary,
+      ...summary,
+    });
+  }
 }