@snapshot-labs/snapshot.js 0.3.104 → 0.4.0

package/dist/snapshot.cjs.js

@@ -2781,6 +2781,10 @@ var gateways = [
 	"ipfs.infura.io"
 ];
 
+function isValidChoice(voteChoice, proposalChoices) {
+    return (typeof voteChoice === 'number' &&
+        (proposalChoices === null || proposalChoices === void 0 ? void 0 : proposalChoices[voteChoice - 1]) !== undefined);
+}
 var SingleChoiceVoting = /** @class */ (function () {
     function SingleChoiceVoting(proposal, votes, strategies, selected) {
         this.proposal = proposal;
@@ -2788,38 +2792,49 @@ var SingleChoiceVoting = /** @class */ (function () {
         this.strategies = strategies;
         this.selected = selected;
     }
-    //  Returns an array with the results for each choice
-    SingleChoiceVoting.prototype.resultsByVoteBalance = function () {
+    SingleChoiceVoting.prototype.getValidVotes = function () {
+        var _this = this;
+        return this.votes.filter(function (vote) {
+            return isValidChoice(vote.choice, _this.proposal.choices);
+        });
+    };
+    SingleChoiceVoting.prototype.getScores = function () {
         var _this = this;
         return this.proposal.choices.map(function (choice, i) {
-            return _this.votes
-                .filter(function (vote) { return vote.choice === i + 1; })
-                .reduce(function (a, b) { return a + b.balance; }, 0);
+            var votes = _this.getValidVotes().filter(function (vote) { return vote.choice === i + 1; });
+            var balanceSum = votes.reduce(function (a, b) { return a + b.balance; }, 0);
+            return balanceSum;
         });
     };
-    //  Returns an array with the results for each choice
-    //  and for each strategy
-    SingleChoiceVoting.prototype.resultsByStrategyScore = function () {
+    SingleChoiceVoting.prototype.getScoresByStrategy = function () {
         var _this = this;
         return this.proposal.choices.map(function (choice, i) {
-            return _this.strategies.map(function (strategy, sI) {
-                return _this.votes
-                    .filter(function (vote) { return vote.choice === i + 1; })
-                    .reduce(function (a, b) { return a + b.scores[sI]; }, 0);
+            var scores = _this.strategies.map(function (strategy, sI) {
+                var votes = _this.getValidVotes().filter(function (vote) { return vote.choice === i + 1; });
+                var scoreSum = votes.reduce(function (a, b) { return a + b.scores[sI]; }, 0);
+                return scoreSum;
             });
+            return scores;
         });
     };
-    // Returns the total amount of the results
-    SingleChoiceVoting.prototype.sumOfResultsBalance = function () {
-        return this.votes.reduce(function (a, b) { return a + b.balance; }, 0);
+    SingleChoiceVoting.prototype.getScoresTotal = function () {
+        return this.getValidVotes().reduce(function (a, b) { return a + b.balance; }, 0);
     };
-    //  Returns a string of all choices
     SingleChoiceVoting.prototype.getChoiceString = function () {
         return this.proposal.choices[this.selected - 1];
     };
     return SingleChoiceVoting;
 }());
 
+function isValidChoice$1(voteChoice, proposalChoices) {
+    return (Array.isArray(voteChoice) &&
+        // If voteChoice index is not in proposalChoices, return false
+        voteChoice.every(function (choice) { return (proposalChoices === null || proposalChoices === void 0 ? void 0 : proposalChoices[choice - 1]) !== undefined; }) &&
+        // If any voteChoice is duplicated, return false
+        voteChoice.length === new Set(voteChoice).size &&
+        // If voteChoice is empty, return false
+        voteChoice.length > 0);
+}
 var ApprovalVoting = /** @class */ (function () {
     function ApprovalVoting(proposal, votes, strategies, selected) {
         this.proposal = proposal;
@@ -2827,26 +2842,32 @@ var ApprovalVoting = /** @class */ (function () {
         this.strategies = strategies;
         this.selected = selected;
     }
-    ApprovalVoting.prototype.resultsByVoteBalance = function () {
+    ApprovalVoting.prototype.getValidVotes = function () {
+        var _this = this;
+        return this.votes.filter(function (vote) {
+            return isValidChoice$1(vote.choice, _this.proposal.choices);
+        });
+    };
+    ApprovalVoting.prototype.getScores = function () {
         var _this = this;
         return this.proposal.choices.map(function (choice, i) {
-            return _this.votes
+            return _this.getValidVotes()
                 .filter(function (vote) { return vote.choice.includes(i + 1); })
                 .reduce(function (a, b) { return a + b.balance; }, 0);
         });
     };
-    ApprovalVoting.prototype.resultsByStrategyScore = function () {
+    ApprovalVoting.prototype.getScoresByStrategy = function () {
         var _this = this;
         return this.proposal.choices.map(function (choice, i) {
             return _this.strategies.map(function (strategy, sI) {
-                return _this.votes
+                return _this.getValidVotes()
                     .filter(function (vote) { return vote.choice.includes(i + 1); })
                     .reduce(function (a, b) { return a + b.scores[sI]; }, 0);
             });
         });
     };
-    ApprovalVoting.prototype.sumOfResultsBalance = function () {
-        return this.votes.reduce(function (a, b) { return a + b.balance; }, 0);
+    ApprovalVoting.prototype.getScoresTotal = function () {
+        return this.getValidVotes().reduce(function (a, b) { return a + b.balance; }, 0);
     };
     ApprovalVoting.prototype.getChoiceString = function () {
         var _this = this;
@@ -2859,6 +2880,17 @@ var ApprovalVoting = /** @class */ (function () {
     return ApprovalVoting;
 }());
 
+function isValidChoice$2(voteChoice, proposalChoices) {
+    return (typeof voteChoice === 'object' &&
+        !Array.isArray(voteChoice) &&
+        voteChoice !== null &&
+        // If voteChoice object keys are not in choices, return false
+        Object.keys(voteChoice).every(function (key) { return (proposalChoices === null || proposalChoices === void 0 ? void 0 : proposalChoices[Number(key) - 1]) !== undefined; }) &&
+        // If voteChoice object is empty, return false
+        Object.keys(voteChoice).length > 0 &&
+        // If voteChoice object values are not a positive integer, return false
+        Object.values(voteChoice).every(function (value) { return typeof value === 'number' && value > 0; }));
+}
 function percentageOfTotal(i, values, total) {
     var reducedTotal = total.reduce(function (a, b) { return a + b; }, 0);
     var percent = (values[i] / reducedTotal) * 100;
@@ -2867,32 +2899,38 @@ function percentageOfTotal(i, values, total) {
 function quadraticMath(i, choice, balance) {
     return Math.sqrt((percentageOfTotal(i + 1, choice, Object.values(choice)) / 100) * balance);
 }
-var ApprovalVoting$1 = /** @class */ (function () {
-    function ApprovalVoting(proposal, votes, strategies, selected) {
+var QuadraticVoting = /** @class */ (function () {
+    function QuadraticVoting(proposal, votes, strategies, selected) {
         this.proposal = proposal;
         this.votes = votes;
         this.strategies = strategies;
         this.selected = selected;
     }
-    ApprovalVoting.prototype.resultsByVoteBalance = function () {
+    QuadraticVoting.prototype.getValidVotes = function () {
+        var _this = this;
+        return this.votes.filter(function (vote) {
+            return isValidChoice$2(vote.choice, _this.proposal.choices);
+        });
+    };
+    QuadraticVoting.prototype.getScores = function () {
         var _this = this;
         var results = this.proposal.choices
             .map(function (choice, i) {
-            return _this.votes
+            return _this.getValidVotes()
                 .map(function (vote) { return quadraticMath(i, vote.choice, vote.balance); })
                 .reduce(function (a, b) { return a + b; }, 0);
         })
             .map(function (sqrt) { return sqrt * sqrt; });
         return results
             .map(function (res, i) { return percentageOfTotal(i, results, results); })
-            .map(function (p) { return (_this.sumOfResultsBalance() / 100) * p; });
+            .map(function (p) { return (_this.getScoresTotal() / 100) * p; });
     };
-    ApprovalVoting.prototype.resultsByStrategyScore = function () {
+    QuadraticVoting.prototype.getScoresByStrategy = function () {
         var _this = this;
         var results = this.proposal.choices
             .map(function (choice, i) {
             return _this.strategies.map(function (strategy, sI) {
-                return _this.votes
+                return _this.getValidVotes()
                     .map(function (vote) { return quadraticMath(i, vote.choice, vote.scores[sI]); })
                     .reduce(function (a, b) { return a + b; }, 0);
             });
@@ -2900,16 +2938,17 @@ var ApprovalVoting$1 = /** @class */ (function () {
             .map(function (arr) { return arr.map(function (sqrt) { return [sqrt * sqrt]; }); });
         return results.map(function (res, i) {
             return _this.strategies
-                .map(function (strategy, sI) { return [
-                percentageOfTotal(0, results[i][sI], results.flat(2))
-            ]; })
-                .map(function (p) { return [(_this.sumOfResultsBalance() / 100) * p]; });
+                .map(function (strategy, sI) {
+                return percentageOfTotal(0, results[i][sI], results.flat(2));
+            })
+                .map(function (p) { return [(_this.getScoresTotal() / 100) * p]; })
+                .flat();
         });
     };
-    ApprovalVoting.prototype.sumOfResultsBalance = function () {
-        return this.votes.reduce(function (a, b) { return a + b.balance; }, 0);
+    QuadraticVoting.prototype.getScoresTotal = function () {
+        return this.getValidVotes().reduce(function (a, b) { return a + b.balance; }, 0);
     };
-    ApprovalVoting.prototype.getChoiceString = function () {
+    QuadraticVoting.prototype.getChoiceString = function () {
         var _this = this;
         return this.proposal.choices
             .map(function (choice, i) {
@@ -2920,19 +2959,34 @@ var ApprovalVoting$1 = /** @class */ (function () {
             .filter(function (el) { return el != null; })
             .join(', ');
     };
-    return ApprovalVoting;
+    return QuadraticVoting;
 }());
 
+function isValidChoice$3(voteChoice, proposalChoices) {
+    return (Array.isArray(voteChoice) &&
+        // If voteChoice index is not in choices, return false
+        voteChoice.every(function (voteChoice) { return (proposalChoices === null || proposalChoices === void 0 ? void 0 : proposalChoices[voteChoice - 1]) !== undefined; }) &&
+        // If any voteChoice is duplicated, return false
+        voteChoice.length === new Set(voteChoice).size &&
+        // If voteChoice is empty, return false
+        voteChoice.length > 0 &&
+        // If not all proposalChoices are selected, return false
+        // TODO: We should add support for pacial bailout in the future
+        voteChoice.length === proposalChoices.length);
+}
 function irv(ballots, rounds) {
     var candidates = __spread(new Set(ballots.map(function (vote) { return vote[0]; }).flat()));
     var votes = Object.entries(ballots.reduce(function (votes, _a, i, src) {
         var _b = __read(_a, 1), v = _b[0];
-        votes[v[0]][0] += src[i][1];
-        if (votes[v[0]][1].length > 1)
-            votes[v[0]][1] = votes[v[0]][1].map(function (score, sI) { return score + src[i][2][sI]; });
+        var balance = src[i][1];
+        votes[v[0]][0] += balance;
+        var score = src[i][2];
+        if (score.length > 1) {
+            votes[v[0]][1] = score.map(function (s, sI) { return s + votes[v[0]][1][sI] || s; });
+        }
         else
             votes[v[0]][1] = [
-                votes[v[0]][1].concat(src[i][2]).reduce(function (a, b) { return a + b; }, 0)
+                votes[v[0]][1].concat(score).reduce(function (a, b) { return a + b; }, 0)
             ];
         return votes;
     }, Object.assign.apply(Object, __spread([{}], candidates.map(function (c) {
@@ -2960,7 +3014,8 @@ function irv(ballots, rounds) {
         round: rounds.length + 1,
         sortedByHighest: sortedByHighest
     });
-    return topCount > totalPowerOfVotes / 2 || sortedByHighest.length < 3
+    return topCount > totalPowerOfVotes / 2 ||
+        sortedByHighest.length < 3
         ? rounds
         : irv(ballots
             .map(function (ballot) { return [
@@ -2968,38 +3023,49 @@ function irv(ballots, rounds) {
             ballot[1],
             ballot[2]
         ]; })
-            .filter(function (b) { return b[0].length > 0; }), rounds);
+            .filter(function (ballot) { return ballot[0].length > 0; }), rounds);
 }
-function getFinalRound(i, votes) {
-    var results = irv(votes.map(function (vote) { return [vote.choice, vote.balance, vote.scores]; }), []);
-    var finalRound = results[results.length - 1];
-    return finalRound.sortedByHighest.filter(function (res) { return res[0] == i + 1; });
+function getFinalRound(votes) {
+    var rounds = irv(votes.map(function (vote) { return [vote.choice, vote.balance, vote.scores]; }), []);
+    var finalRound = rounds[rounds.length - 1];
+    return finalRound.sortedByHighest;
 }
-var ApprovalVoting$2 = /** @class */ (function () {
-    function ApprovalVoting(proposal, votes, strategies, selected) {
+var RankedChoiceVoting = /** @class */ (function () {
+    function RankedChoiceVoting(proposal, votes, strategies, selected) {
         this.proposal = proposal;
         this.votes = votes;
         this.strategies = strategies;
         this.selected = selected;
     }
-    ApprovalVoting.prototype.resultsByVoteBalance = function () {
+    RankedChoiceVoting.prototype.getValidVotes = function () {
         var _this = this;
+        return this.votes.filter(function (vote) {
+            return isValidChoice$3(vote.choice, _this.proposal.choices);
+        });
+    };
+    RankedChoiceVoting.prototype.getScores = function () {
+        var finalRound = getFinalRound(this.getValidVotes());
         return this.proposal.choices.map(function (choice, i) {
-            return getFinalRound(i, _this.votes).reduce(function (a, b) { return a + b[1][0]; }, 0);
+            return finalRound
+                .filter(function (res) { return Number(res[0]) === i + 1; })
+                .reduce(function (a, b) { return a + b[1][0]; }, 0);
         });
     };
-    ApprovalVoting.prototype.resultsByStrategyScore = function () {
+    RankedChoiceVoting.prototype.getScoresByStrategy = function () {
         var _this = this;
+        var finalRound = getFinalRound(this.getValidVotes());
         return this.proposal.choices.map(function (choice, i) {
             return _this.strategies.map(function (strategy, sI) {
-                return getFinalRound(i, _this.votes).reduce(function (a, b) { return a + b[1][1][sI]; }, 0);
+                return finalRound
+                    .filter(function (res) { return Number(res[0]) === i + 1; })
+                    .reduce(function (a, b) { return a + b[1][1][sI]; }, 0);
             });
         });
     };
-    ApprovalVoting.prototype.sumOfResultsBalance = function () {
-        return this.resultsByVoteBalance().reduce(function (a, b) { return a + b; });
+    RankedChoiceVoting.prototype.getScoresTotal = function () {
+        return this.getScores().reduce(function (a, b) { return a + b; });
     };
-    ApprovalVoting.prototype.getChoiceString = function () {
+    RankedChoiceVoting.prototype.getChoiceString = function () {
         var _this = this;
         return this.selected
             .map(function (choice) {
@@ -3009,9 +3075,22 @@ var ApprovalVoting$2 = /** @class */ (function () {
             .map(function (el, i) { return "(" + getNumberWithOrdinal(i + 1) + ") " + el; })
             .join(', ');
     };
-    return ApprovalVoting;
+    return RankedChoiceVoting;
 }());
 
+function isValidChoice$4(voteChoice, proposalChoices) {
+    return (typeof voteChoice === 'object' &&
+        !Array.isArray(voteChoice) &&
+        voteChoice !== null &&
+        // If voteChoice object keys are not in choices, return false
+        Object.keys(voteChoice).every(function (key) { return (proposalChoices === null || proposalChoices === void 0 ? void 0 : proposalChoices[Number(key) - 1]) !== undefined; }) &&
+        // If voteChoice object is empty, return false
+        Object.keys(voteChoice).length > 0 &&
+        // If voteChoice object values are not a positive integer, return false
+        Object.values(voteChoice).every(function (value) { return typeof value === 'number' && value > 0; }) &&
+        // If voteChoice is empty, return false
+        Object.keys(voteChoice).length > 0);
+}
 function percentageOfTotal$1(i, values, total) {
     var reducedTotal = total.reduce(function (a, b) { return a + b; }, 0);
     var percent = (values[i] / reducedTotal) * 100;
@@ -3027,23 +3106,29 @@ var WeightedVoting = /** @class */ (function () {
         this.strategies = strategies;
         this.selected = selected;
     }
-    WeightedVoting.prototype.resultsByVoteBalance = function () {
+    WeightedVoting.prototype.getValidVotes = function () {
+        var _this = this;
+        return this.votes.filter(function (vote) {
+            return isValidChoice$4(vote.choice, _this.proposal.choices);
+        });
+    };
+    WeightedVoting.prototype.getScores = function () {
         var _this = this;
         var results = this.proposal.choices.map(function (choice, i) {
-            return _this.votes
+            return _this.getValidVotes()
                 .map(function (vote) { return weightedPower(i, vote.choice, vote.balance); })
                 .reduce(function (a, b) { return a + b; }, 0);
         });
         return results
             .map(function (res, i) { return percentageOfTotal$1(i, results, results); })
-            .map(function (p) { return (_this.sumOfResultsBalance() / 100) * p; });
+            .map(function (p) { return (_this.getScoresTotal() / 100) * p; });
     };
-    WeightedVoting.prototype.resultsByStrategyScore = function () {
+    WeightedVoting.prototype.getScoresByStrategy = function () {
         var _this = this;
         var results = this.proposal.choices
             .map(function (choice, i) {
             return _this.strategies.map(function (strategy, sI) {
-                return _this.votes
+                return _this.getValidVotes()
                     .map(function (vote) { return weightedPower(i, vote.choice, vote.scores[sI]); })
                     .reduce(function (a, b) { return a + b; }, 0);
             });
@@ -3051,14 +3136,15 @@ var WeightedVoting = /** @class */ (function () {
             .map(function (arr) { return arr.map(function (pwr) { return [pwr]; }); });
         return results.map(function (res, i) {
             return _this.strategies
-                .map(function (strategy, sI) { return [
-                percentageOfTotal$1(0, results[i][sI], results.flat(2))
-            ]; })
-                .map(function (p) { return [(_this.sumOfResultsBalance() / 100) * p]; });
+                .map(function (strategy, sI) {
+                return percentageOfTotal$1(0, results[i][sI], results.flat(2));
+            })
+                .map(function (p) { return [(_this.getScoresTotal() / 100) * p]; })
+                .flat();
         });
     };
-    WeightedVoting.prototype.sumOfResultsBalance = function () {
-        return this.votes.reduce(function (a, b) { return a + b.balance; }, 0);
+    WeightedVoting.prototype.getScoresTotal = function () {
+        return this.getValidVotes().reduce(function (a, b) { return a + b.balance; }, 0);
     };
     WeightedVoting.prototype.getChoiceString = function () {
         var _this = this;
@@ -3077,8 +3163,8 @@ var WeightedVoting = /** @class */ (function () {
 var voting = {
     'single-choice': SingleChoiceVoting,
     approval: ApprovalVoting,
-    quadratic: ApprovalVoting$1,
-    'ranked-choice': ApprovalVoting$2,
+    quadratic: QuadraticVoting,
+    'ranked-choice': RankedChoiceVoting,
     weighted: WeightedVoting,
     basic: SingleChoiceVoting
 };