Merge branch 'proposal-based-votable-state' of github.com:dfinity/ic-…

…js into proposal-based-votable-state
dfinity · Oct 2, 2024 · 6745fe7 · 6745fe7
2 parents fe1eb82 + 10eabef
commit 6745fe7
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 12 deletions.
diff --git a/packages/nns/README.md b/packages/nns/README.md
@@ -96,7 +96,7 @@ Parameters:
 - `params.neurons`: The neurons to filter.
 - `params.proposal`: The proposal to match against the selected neurons.
 
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/utils/neurons.utils.ts#L38)
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/utils/neurons.utils.ts#L29)
 
 #### :gear: votableNeurons
 
@@ -111,22 +111,22 @@ Parameters:
 - `params.neurons`: The neurons to filter.
 - `params.proposal`: The proposal to match against the selected neurons.
 
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/utils/neurons.utils.ts#L67)
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/utils/neurons.utils.ts#L58)
 
 #### :gear: votedNeurons
 
 Filter the neurons that have voted for a proposal.
 
-| Function       | Type                                                                                                        |
-| -------------- | ----------------------------------------------------------------------------------------------------------- |
-| `votedNeurons` | `({ neurons, proposal: { ballots }, }: { neurons: NeuronInfo[]; proposal: ProposalInfo; }) => NeuronInfo[]` |
+| Function       | Type                                                                                           |
+| -------------- | ---------------------------------------------------------------------------------------------- |
+| `votedNeurons` | `({ neurons, proposal, }: { neurons: NeuronInfo[]; proposal: ProposalInfo; }) => NeuronInfo[]` |
 
 Parameters:
 
 - `params.neurons`: The neurons to filter.
 - `params.proposal`: The proposal for which some neurons might have already voted.
 
-[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/utils/neurons.utils.ts#L93)
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/utils/neurons.utils.ts#L81)
 
 ### :factory: GenesisTokenCanister
 

diff --git a/packages/nns/src/utils/neurons.utils.ts b/packages/nns/src/utils/neurons.utils.ts
@@ -1,5 +1,4 @@
 import { Vote } from "../enums/governance.enums";
-import type { NeuronId } from "../types/common";
 import type {
   Ballot,
   NeuronInfo,
@@ -8,13 +7,12 @@ import type {
 
 const getNeuronVoteForProposal = ({
   proposal: { ballots },
-  neuron: {neuronId},
+  neuron: { neuronId },
 }: {
   proposal: ProposalInfo;
   neuron: NeuronInfo;
-}): Vote | undefined => ballots.find(
-    ({ neuronId: id }) => id === neuronId,
-  )?.vote;
+}): Vote | undefined =>
+  ballots.find(({ neuronId: id }) => id === neuronId)?.vote;
 
 /**
  * Filter the neurons that are ineligible to vote to a proposal.
@@ -63,7 +61,8 @@ export const votableNeurons = ({
 }: {
   neurons: NeuronInfo[];
   proposal: ProposalInfo;
-}): NeuronInfo[] => neurons.filter(
+}): NeuronInfo[] =>
+  neurons.filter(
     (neuron: NeuronInfo) =>
       getNeuronVoteForProposal({ proposal, neuron }) === Vote.Unspecified &&
       ineligibleNeurons({ neurons, proposal }).find(