From b869695e400ee39472dd86718a7a12d2878cfada Mon Sep 17 00:00:00 2001 From: Jaco Greeff Date: Wed, 8 Apr 2020 15:55:04 +0200 Subject: [PATCH] Bump util (#2144) --- packages/api-contract/package.json | 2 +- packages/api-derive/package.json | 6 +- packages/api-derive/src/democracy/types.ts | 2 + .../api-derive/src/democracy/util.spec.ts | 39 +++++++++ packages/api-derive/src/democracy/util.ts | 69 +++++++++++++++- packages/api/package.json | 8 +- packages/metadata/package.json | 6 +- packages/rpc-core/package.json | 4 +- packages/rpc-provider/package.json | 6 +- packages/typegen/package.json | 2 +- packages/types-known/package.json | 2 +- packages/types/package.json | 6 +- yarn.lock | 82 +++++++++++-------- 13 files changed, 175 insertions(+), 59 deletions(-) create mode 100644 packages/api-derive/src/democracy/util.spec.ts diff --git a/packages/api-contract/package.json b/packages/api-contract/package.json index 38be49bb98..0c5df877b1 100644 --- a/packages/api-contract/package.json +++ b/packages/api-contract/package.json @@ -30,7 +30,7 @@ "@polkadot/api": "1.10.0-beta.16", "@polkadot/rpc-core": "1.10.0-beta.16", "@polkadot/types": "1.10.0-beta.16", - "@polkadot/util": "^2.7.1", + "@polkadot/util": "^2.8.0-beta.7", "bn.js": "^5.1.1", "rxjs": "^6.5.5" } diff --git a/packages/api-derive/package.json b/packages/api-derive/package.json index b75da23b50..cef9317a80 100644 --- a/packages/api-derive/package.json +++ b/packages/api-derive/package.json @@ -32,13 +32,13 @@ "@polkadot/rpc-core": "1.10.0-beta.16", "@polkadot/rpc-provider": "1.10.0-beta.16", "@polkadot/types": "1.10.0-beta.16", - "@polkadot/util": "^2.7.1", - "@polkadot/util-crypto": "^2.7.1", + "@polkadot/util": "^2.8.0-beta.7", + "@polkadot/util-crypto": "^2.8.0-beta.7", "bn.js": "^5.1.1", "memoizee": "^0.4.14", "rxjs": "^6.5.5" }, "devDependencies": { - "@polkadot/keyring": "^2.7.1" + "@polkadot/keyring": "^2.8.0-beta.7" } } diff --git a/packages/api-derive/src/democracy/types.ts b/packages/api-derive/src/democracy/types.ts index bf38e3c213..a2ce33e0a1 100644 --- a/packages/api-derive/src/democracy/types.ts +++ b/packages/api-derive/src/democracy/types.ts @@ -61,6 +61,8 @@ export interface DeriveReferendumVoteState { } export interface DeriveReferendumVotes extends DeriveReferendumVoteState { + changeAye: BN; + changeNay: BN; isPassing: boolean; votes: DeriveReferendumVote[]; } diff --git a/packages/api-derive/src/democracy/util.spec.ts b/packages/api-derive/src/democracy/util.spec.ts new file mode 100644 index 0000000000..3f79042b02 --- /dev/null +++ b/packages/api-derive/src/democracy/util.spec.ts @@ -0,0 +1,39 @@ +// Copyright 2017-2020 @polkadot/api-derive authors & contributors +// This software may be modified and distributed under the terms +// of the Apache-2.0 license. See the LICENSE file for details. + +import BN from 'bn.js'; +import { TypeRegistry } from '@polkadot/types'; + +import { approxChanges, calcPassing } from './util'; + +const ACTUAL = { + sqrtElectorate: new BN('2949443240'), + votedAye: new BN('358406690000000000'), + votedNay: new BN('18942000000000000'), + votedTotal: new BN('136099900000000000') +}; + +const registry = new TypeRegistry(); + +describe('approxChanges', (): void => { + it('approximates where the points are', (): void => { + const threshold = registry.createType('VoteThreshold', 0); + + console.time('approxChanges'); + + const { changeAye, changeNay, isPassing } = approxChanges(threshold, ACTUAL.sqrtElectorate, ACTUAL.votedAye, ACTUAL.votedNay, ACTUAL.votedTotal); + + console.timeEnd('approxChanges'); + + console.error(isPassing, changeAye.toString(), changeNay.toString()); + + expect(isPassing).toBe(true); + expect( + calcPassing(threshold, ACTUAL.sqrtElectorate, ACTUAL.votedAye.sub(changeAye), ACTUAL.votedNay, ACTUAL.votedTotal) + ).toBe(false); + expect( + calcPassing(threshold, ACTUAL.sqrtElectorate, ACTUAL.votedAye, ACTUAL.votedNay.add(changeNay), ACTUAL.votedTotal) + ).toBe(false); + }); +}); diff --git a/packages/api-derive/src/democracy/util.ts b/packages/api-derive/src/democracy/util.ts index 88540849ee..08be51e3be 100644 --- a/packages/api-derive/src/democracy/util.ts +++ b/packages/api-derive/src/democracy/util.ts @@ -14,6 +14,12 @@ import { bnSqrt } from '@polkadot/util'; type PreimageInfo = [Bytes, AccountId, Balance, BlockNumber]; type OldPreimage = ITuple; +interface Approx { + changeAye: BN; + changeNay: BN; + isPassing: boolean; +} + function isOldInfo (info: ReferendumInfo | ReferendumInfoTo239): info is ReferendumInfoTo239 { return !!(info as ReferendumInfoTo239).proposalHash; } @@ -53,7 +59,7 @@ export function compareRationals (n1: BN, d1: BN, n2: BN, d2: BN): boolean { } } -function isPassing (threshold: VoteThreshold, sqrtElectorate: BN, { votedAye, votedNay, votedTotal }: DeriveReferendumVoteState): boolean { +export function calcPassing (threshold: VoteThreshold, sqrtElectorate: BN, votedAye: BN, votedNay: BN, votedTotal: BN): boolean { const sqrtVoters = bnSqrt(votedTotal); return sqrtVoters.isZero() @@ -65,6 +71,65 @@ function isPassing (threshold: VoteThreshold, sqrtElectorate: BN, { votedAye, vo : compareRationals(votedNay, sqrtElectorate, votedAye, sqrtVoters); } +function calcChangeAye (threshold: VoteThreshold, sqrtElectorate: BN, votedAye: BN, votedNay: BN, votedTotal: BN, isPassing: boolean, changeAye: BN, inc: BN, isFinal: boolean): BN { + while (true) { + const newChangeAye = changeAye.add(inc); + + if (isPassing !== calcPassing(threshold, sqrtElectorate, isPassing ? votedAye.sub(newChangeAye) : votedAye.add(newChangeAye), votedNay, votedTotal)) { + return isFinal + ? newChangeAye + : changeAye; + } + + changeAye = newChangeAye; + } +} + +function calcChangeNay (threshold: VoteThreshold, sqrtElectorate: BN, votedAye: BN, votedNay: BN, votedTotal: BN, isPassing: boolean, changeNay: BN, inc: BN, isFinal: boolean): BN { + while (true) { + const newChangeNay = changeNay.add(inc); + + if (isPassing !== calcPassing(threshold, sqrtElectorate, votedAye, isPassing ? votedNay.add(changeNay) : votedNay.sub(changeNay), votedTotal)) { + return isFinal + ? newChangeNay + : changeNay; + } + + changeNay = newChangeNay; + } +} + +export function approxChanges (threshold: VoteThreshold, sqrtElectorate: BN, votedAye: BN, votedNay: BN, votedTotal: BN): Approx { + const isPassing = calcPassing(threshold, sqrtElectorate, votedAye, votedNay, votedTotal); + + if (threshold.isSimplemajority) { + const change = isPassing + ? votedAye.sub(votedNay) + : votedNay.sub(votedAye); + + return { + changeAye: change, + changeNay: change, + isPassing + }; + } + + const inc = votedTotal.divn(10); + let changeAye = new BN(0); + let changeNay = new BN(0); + + while (!inc.isZero()) { + const isFinal = inc.divn(10).isZero(); + + changeAye = calcChangeAye(threshold, sqrtElectorate, votedAye, votedNay, votedTotal, isPassing, changeAye, inc, isFinal); + changeNay = calcChangeNay(threshold, sqrtElectorate, votedAye, votedNay, votedTotal, isPassing, changeNay, inc, isFinal); + + inc.idivn(10); + } + + return { changeAye, changeNay, isPassing }; +} + function calcVotesPrev (votesFor: DeriveReferendumVote[]): DeriveReferendumVoteState { return votesFor.reduce((state: DeriveReferendumVoteState, derived): DeriveReferendumVoteState => { const { balance, vote } = derived; @@ -130,7 +195,7 @@ export function calcVotes (sqrtElectorate: BN, referendum: DeriveReferendum, vot return { ...state, - isPassing: isPassing(referendum.status.threshold, sqrtElectorate, state), + ...approxChanges(referendum.status.threshold, sqrtElectorate, state.votedAye, state.votedNay, state.votedTotal), votes }; } diff --git a/packages/api/package.json b/packages/api/package.json index d43c46427f..a0d4155586 100644 --- a/packages/api/package.json +++ b/packages/api/package.json @@ -28,19 +28,19 @@ "dependencies": { "@babel/runtime": "^7.9.2", "@polkadot/api-derive": "1.10.0-beta.16", - "@polkadot/keyring": "^2.7.1", + "@polkadot/keyring": "^2.8.0-beta.7", "@polkadot/metadata": "1.10.0-beta.16", "@polkadot/rpc-core": "1.10.0-beta.16", "@polkadot/rpc-provider": "1.10.0-beta.16", "@polkadot/types": "1.10.0-beta.16", "@polkadot/types-known": "1.10.0-beta.16", - "@polkadot/util": "^2.7.1", - "@polkadot/util-crypto": "^2.7.1", + "@polkadot/util": "^2.8.0-beta.7", + "@polkadot/util-crypto": "^2.8.0-beta.7", "bn.js": "^5.1.1", "eventemitter3": "^4.0.0", "rxjs": "^6.5.5" }, "devDependencies": { - "@polkadot/keyring": "^2.7.1" + "@polkadot/keyring": "^2.8.0-beta.7" } } diff --git a/packages/metadata/package.json b/packages/metadata/package.json index 0a85c6e470..70ed7de9bb 100644 --- a/packages/metadata/package.json +++ b/packages/metadata/package.json @@ -29,11 +29,11 @@ "@babel/runtime": "^7.9.2", "@polkadot/types": "1.10.0-beta.16", "@polkadot/types-known": "1.10.0-beta.16", - "@polkadot/util": "^2.7.1", - "@polkadot/util-crypto": "^2.7.1", + "@polkadot/util": "^2.8.0-beta.7", + "@polkadot/util-crypto": "^2.8.0-beta.7", "bn.js": "^5.1.1" }, "devDependencies": { - "@polkadot/keyring": "^2.7.1" + "@polkadot/keyring": "^2.8.0-beta.7" } } diff --git a/packages/rpc-core/package.json b/packages/rpc-core/package.json index 6b37bb270c..1a9648bded 100644 --- a/packages/rpc-core/package.json +++ b/packages/rpc-core/package.json @@ -30,11 +30,11 @@ "@polkadot/metadata": "1.10.0-beta.16", "@polkadot/rpc-provider": "1.10.0-beta.16", "@polkadot/types": "1.10.0-beta.16", - "@polkadot/util": "^2.7.1", + "@polkadot/util": "^2.8.0-beta.7", "memoizee": "^0.4.14", "rxjs": "^6.5.5" }, "devDependencies": { - "@polkadot/keyring": "^2.7.1" + "@polkadot/keyring": "^2.8.0-beta.7" } } diff --git a/packages/rpc-provider/package.json b/packages/rpc-provider/package.json index d7bcdaadbb..e108f8e832 100644 --- a/packages/rpc-provider/package.json +++ b/packages/rpc-provider/package.json @@ -29,15 +29,15 @@ "@babel/runtime": "^7.9.2", "@polkadot/metadata": "1.10.0-beta.16", "@polkadot/types": "1.10.0-beta.16", - "@polkadot/util": "^2.7.1", - "@polkadot/util-crypto": "^2.7.1", + "@polkadot/util": "^2.8.0-beta.7", + "@polkadot/util-crypto": "^2.8.0-beta.7", "bn.js": "^5.1.1", "eventemitter3": "^4.0.0", "isomorphic-fetch": "^2.2.1", "websocket": "^1.0.31" }, "devDependencies": { - "@polkadot/keyring": "^2.7.1", + "@polkadot/keyring": "^2.8.0-beta.7", "mock-socket": "^9.0.3", "nock": "^12.0.3" } diff --git a/packages/typegen/package.json b/packages/typegen/package.json index 3a9224e8a2..75312cd9fa 100644 --- a/packages/typegen/package.json +++ b/packages/typegen/package.json @@ -40,7 +40,7 @@ "@polkadot/metadata": "1.10.0-beta.16", "@polkadot/rpc-provider": "1.10.0-beta.16", "@polkadot/types": "1.10.0-beta.16", - "@polkadot/util": "^2.7.1", + "@polkadot/util": "^2.8.0-beta.7", "websocket": "^1.0.31", "yargs": "^15.3.1" }, diff --git a/packages/types-known/package.json b/packages/types-known/package.json index aca22a1401..029c1fa22a 100644 --- a/packages/types-known/package.json +++ b/packages/types-known/package.json @@ -28,7 +28,7 @@ "dependencies": { "@babel/runtime": "^7.9.2", "@polkadot/types": "1.10.0-beta.16", - "@polkadot/util": "^2.7.1", + "@polkadot/util": "^2.8.0-beta.7", "bn.js": "^5.1.1" }, "devDependencies": { diff --git a/packages/types/package.json b/packages/types/package.json index 3b5d5c1758..7e9e56f549 100644 --- a/packages/types/package.json +++ b/packages/types/package.json @@ -28,15 +28,15 @@ "dependencies": { "@babel/runtime": "^7.9.2", "@polkadot/metadata": "1.10.0-beta.16", - "@polkadot/util": "^2.7.1", - "@polkadot/util-crypto": "^2.7.1", + "@polkadot/util": "^2.8.0-beta.7", + "@polkadot/util-crypto": "^2.8.0-beta.7", "@types/bn.js": "^4.11.6", "bn.js": "^5.1.1", "memoizee": "^0.4.14", "rxjs": "^6.5.5" }, "devDependencies": { - "@polkadot/keyring": "^2.7.1", + "@polkadot/keyring": "^2.8.0-beta.7", "@types/memoizee": "^0.4.3" } } diff --git a/yarn.lock b/yarn.lock index 1abdc72e2a..4e51629f3c 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2587,7 +2587,7 @@ __metadata: "@polkadot/api": 1.10.0-beta.16 "@polkadot/rpc-core": 1.10.0-beta.16 "@polkadot/types": 1.10.0-beta.16 - "@polkadot/util": ^2.7.1 + "@polkadot/util": ^2.8.0-beta.7 bn.js: ^5.1.1 rxjs: ^6.5.5 languageName: unknown @@ -2599,12 +2599,12 @@ __metadata: dependencies: "@babel/runtime": ^7.9.2 "@polkadot/api": 1.10.0-beta.16 - "@polkadot/keyring": ^2.7.1 + "@polkadot/keyring": ^2.8.0-beta.7 "@polkadot/rpc-core": 1.10.0-beta.16 "@polkadot/rpc-provider": 1.10.0-beta.16 "@polkadot/types": 1.10.0-beta.16 - "@polkadot/util": ^2.7.1 - "@polkadot/util-crypto": ^2.7.1 + "@polkadot/util": ^2.8.0-beta.7 + "@polkadot/util-crypto": ^2.8.0-beta.7 bn.js: ^5.1.1 memoizee: ^0.4.14 rxjs: ^6.5.5 @@ -2617,14 +2617,14 @@ __metadata: dependencies: "@babel/runtime": ^7.9.2 "@polkadot/api-derive": 1.10.0-beta.16 - "@polkadot/keyring": ^2.7.1 + "@polkadot/keyring": ^2.8.0-beta.7 "@polkadot/metadata": 1.10.0-beta.16 "@polkadot/rpc-core": 1.10.0-beta.16 "@polkadot/rpc-provider": 1.10.0-beta.16 "@polkadot/types": 1.10.0-beta.16 "@polkadot/types-known": 1.10.0-beta.16 - "@polkadot/util": ^2.7.1 - "@polkadot/util-crypto": ^2.7.1 + "@polkadot/util": ^2.8.0-beta.7 + "@polkadot/util-crypto": ^2.8.0-beta.7 bn.js: ^5.1.1 eventemitter3: ^4.0.0 rxjs: ^6.5.5 @@ -2718,14 +2718,14 @@ __metadata: languageName: node linkType: hard -"@polkadot/keyring@npm:^2.7.1": - version: 2.7.1 - resolution: "@polkadot/keyring@npm:2.7.1" +"@polkadot/keyring@npm:^2.8.0-beta.7": + version: 2.8.0-beta.7 + resolution: "@polkadot/keyring@npm:2.8.0-beta.7" dependencies: "@babel/runtime": ^7.9.2 - "@polkadot/util": 2.7.1 - "@polkadot/util-crypto": 2.7.1 - checksum: 2/eee6dd0d4f4b0d40cd593e0e086d0efc1d6f1d3837978bbc853428bbd9e37f2f578d25c8d923a05341b9c62f103d63551ab330d98281ae00571144965edaae14 + "@polkadot/util": 2.8.0-beta.7 + "@polkadot/util-crypto": 2.8.0-beta.7 + checksum: 2/c5f00ed035b5193e9dce7ed29a511474d56209ffc9b65d7475147def12f0afb3c1c4ec4ca03dbe0f1ef1f8f500626fc00799a3ed783f85c5d7dc8b6c0fe42003 languageName: node linkType: hard @@ -2734,11 +2734,11 @@ __metadata: resolution: "@polkadot/metadata@workspace:packages/metadata" dependencies: "@babel/runtime": ^7.9.2 - "@polkadot/keyring": ^2.7.1 + "@polkadot/keyring": ^2.8.0-beta.7 "@polkadot/types": 1.10.0-beta.16 "@polkadot/types-known": 1.10.0-beta.16 - "@polkadot/util": ^2.7.1 - "@polkadot/util-crypto": ^2.7.1 + "@polkadot/util": ^2.8.0-beta.7 + "@polkadot/util-crypto": ^2.8.0-beta.7 bn.js: ^5.1.1 languageName: unknown linkType: soft @@ -2748,11 +2748,11 @@ __metadata: resolution: "@polkadot/rpc-core@workspace:packages/rpc-core" dependencies: "@babel/runtime": ^7.9.2 - "@polkadot/keyring": ^2.7.1 + "@polkadot/keyring": ^2.8.0-beta.7 "@polkadot/metadata": 1.10.0-beta.16 "@polkadot/rpc-provider": 1.10.0-beta.16 "@polkadot/types": 1.10.0-beta.16 - "@polkadot/util": ^2.7.1 + "@polkadot/util": ^2.8.0-beta.7 memoizee: ^0.4.14 rxjs: ^6.5.5 languageName: unknown @@ -2763,11 +2763,11 @@ __metadata: resolution: "@polkadot/rpc-provider@workspace:packages/rpc-provider" dependencies: "@babel/runtime": ^7.9.2 - "@polkadot/keyring": ^2.7.1 + "@polkadot/keyring": ^2.8.0-beta.7 "@polkadot/metadata": 1.10.0-beta.16 "@polkadot/types": 1.10.0-beta.16 - "@polkadot/util": ^2.7.1 - "@polkadot/util-crypto": ^2.7.1 + "@polkadot/util": ^2.8.0-beta.7 + "@polkadot/util-crypto": ^2.8.0-beta.7 bn.js: ^5.1.1 eventemitter3: ^4.0.0 isomorphic-fetch: ^2.2.1 @@ -2797,7 +2797,7 @@ __metadata: "@polkadot/metadata": 1.10.0-beta.16 "@polkadot/rpc-provider": 1.10.0-beta.16 "@polkadot/types": 1.10.0-beta.16 - "@polkadot/util": ^2.7.1 + "@polkadot/util": ^2.8.0-beta.7 "@types/websocket": ^1.0.0 "@types/yargs": ^15.0.4 websocket: ^1.0.31 @@ -2817,7 +2817,7 @@ __metadata: dependencies: "@babel/runtime": ^7.9.2 "@polkadot/types": 1.10.0-beta.16 - "@polkadot/util": ^2.7.1 + "@polkadot/util": ^2.8.0-beta.7 "@types/bn.js": ^4.11.6 bn.js: ^5.1.1 languageName: unknown @@ -2828,10 +2828,10 @@ __metadata: resolution: "@polkadot/types@workspace:packages/types" dependencies: "@babel/runtime": ^7.9.2 - "@polkadot/keyring": ^2.7.1 + "@polkadot/keyring": ^2.8.0-beta.7 "@polkadot/metadata": 1.10.0-beta.16 - "@polkadot/util": ^2.7.1 - "@polkadot/util-crypto": ^2.7.1 + "@polkadot/util": ^2.8.0-beta.7 + "@polkadot/util-crypto": ^2.8.0-beta.7 "@types/bn.js": ^4.11.6 "@types/memoizee": ^0.4.3 bn.js: ^5.1.1 @@ -2840,12 +2840,12 @@ __metadata: languageName: unknown linkType: soft -"@polkadot/util-crypto@npm:2.7.1, @polkadot/util-crypto@npm:^2.7.1": - version: 2.7.1 - resolution: "@polkadot/util-crypto@npm:2.7.1" +"@polkadot/util-crypto@npm:2.8.0-beta.7, @polkadot/util-crypto@npm:^2.8.0-beta.7": + version: 2.8.0-beta.7 + resolution: "@polkadot/util-crypto@npm:2.8.0-beta.7" dependencies: "@babel/runtime": ^7.9.2 - "@polkadot/util": 2.7.1 + "@polkadot/util": 2.8.0-beta.7 "@polkadot/wasm-crypto": ^1.2.1 base-x: ^3.0.8 bip39: ^3.0.2 @@ -2857,21 +2857,21 @@ __metadata: pbkdf2: ^3.0.17 tweetnacl: ^1.0.3 xxhashjs: ^0.2.2 - checksum: 2/0aa314fac3dc0de299f517752b23c465a6505cb339875c15d6259ca0e0695c52a26bdc2d64843fd3cff7e2e58dfa94f341cf3fd6f88f1328c5b3409f85956c25 + checksum: 2/7c22a314f4f89c442740f621945bf927053f3ebe55dd85a59788e7c17f5097ebba51dbf9420829c633bcf84e93988678d1128c38df71b11567e1511b0e39655e languageName: node linkType: hard -"@polkadot/util@npm:2.7.1, @polkadot/util@npm:^2.7.1": - version: 2.7.1 - resolution: "@polkadot/util@npm:2.7.1" +"@polkadot/util@npm:2.8.0-beta.7, @polkadot/util@npm:^2.8.0-beta.7": + version: 2.8.0-beta.7 + resolution: "@polkadot/util@npm:2.8.0-beta.7" dependencies: "@babel/runtime": ^7.9.2 "@types/bn.js": ^4.11.6 bn.js: ^5.1.1 camelcase: ^5.3.1 - chalk: ^3.0.0 + chalk: ^4.0.0 ip-regex: ^4.1.0 - checksum: 2/282c0535dbcb2863e63f3366d2cdf81027a8430a299431b0562068630d174d4ce10262bb67c8493a39c262a56fb04d2e8e9eeb31f1a14f6f4c57237d5fca2105 + checksum: 2/8158e74d1c903a9497a0eb1ccbfae882fb534c2b4bf0715b18407efa94d34711445a14e1b9ec8444cc119e48028a28f2e59e6b083fe864e68abd779c4b9adb0c languageName: node linkType: hard @@ -5168,6 +5168,16 @@ __metadata: languageName: node linkType: hard +"chalk@npm:^4.0.0": + version: 4.0.0 + resolution: "chalk@npm:4.0.0" + dependencies: + ansi-styles: ^4.1.0 + supports-color: ^7.1.0 + checksum: 2/12b01a228b5ca2f03a82684c62d54c06e2ba2f7b81dd08fac56c5b9288958dd24f9cae866e140df5c29cb736059cb4be0165157ebb0b15039cc1ea511a2dab60 + languageName: node + linkType: hard + "chardet@npm:^0.7.0": version: 0.7.0 resolution: "chardet@npm:0.7.0"