Bump metadata (#2058)

* Bump metadata

* Add missing @types/jest

* Update tests for new metadata

* CHANGELOG for linked map removals

* expand re-added check

Author: jacogr

CHANGELOG.md

@@ -1,7 +1,9 @@
 # 1.7.0-beta.x
 
+- **Important** Current versions of Polkadot/Substrate has dropped linked maps, if you are using these, e.g. `staking.{nominators,validators}()` to retrieve all entries, and using an upgraded chain, you need to swap to retrieving values via `.entries()`
+- Support latest Substrate types & metadata
 - Add support for new Substrate `state_getKeysPaged` RPC
-- Re-add fixed (with tests) checks for query args
+- Re-add fixed (with tests) checks for query args, previously disabled in 1.6.2
 - Move `derive.staking.controllers` to `derive.staking.stashes`, reflecting actual content
 - Cater for adjusted storage (non-linked maps) for `derive.staking.stashes` (with old-compat)
 - Expanded `derive.staking.*` derives, including addition of `derive.staking.own*`

package.json

@@ -27,9 +27,10 @@
     "@babel/core": "^7.8.7",
     "@babel/register": "^7.8.6",
     "@babel/runtime": "^7.8.7",
-    "@polkadot/dev": "^0.51.1",
-    "@polkadot/ts": "^0.3.11",
+    "@polkadot/dev": "^0.51.5",
+    "@polkadot/ts": "^0.3.13",
     "@polkadot/typegen": "workspace:packages/typegen",
+    "@types/jest": "^25.1.4",
     "copyfiles": "^2.2.0"
   }
 }

packages/api/src/augment/consts.ts

@@ -2,7 +2,7 @@
 /* eslint-disable @typescript-eslint/no-empty-interface */
 
 import { Codec } from '@polkadot/types/types';
-import { Bytes, u32, u64 } from '@polkadot/types/primitive';
+import { u32, u64 } from '@polkadot/types/primitive';
 import { Gas } from '@polkadot/types/interfaces/contracts';
 import { Balance, BalanceOf, BlockNumber, Moment, Percent, Permill } from '@polkadot/types/interfaces/runtime';
 import { SessionIndex } from '@polkadot/types/interfaces/session';
@@ -160,14 +160,6 @@ declare module '@polkadot/metadata/Decorated/consts/types' {
        **/
       windowSize: AugmentedConst<BlockNumber>;
     };
-    session: {
-      [index: string]: AugmentedConst<object & Codec>;
-      /**
-       * Used as first key for `NextKeys` and `KeyOwner` to put all the data into the same branch
-       * of the trie.
-       **/
-      dedupKeyPrefix: AugmentedConst<Bytes>;
-    };
     society: {
       [index: string]: AugmentedConst<object & Codec>;
       /**

packages/api/src/augment/query.ts

@@ -2,7 +2,7 @@
 /* eslint-disable @typescript-eslint/no-empty-interface */
 
 import { AnyNumber, ITuple } from '@polkadot/types/types';
-import { Linkage, Option, U8aFixed, Vec } from '@polkadot/types/codec';
+import { Option, U8aFixed, Vec } from '@polkadot/types/codec';
 import { Bytes, Data, bool, u32, u64 } from '@polkadot/types/primitive';
 import { UncleEntryItem } from '@polkadot/types/interfaces/authorship';
 import { BabeAuthorityWeight, MaybeVrf } from '@polkadot/types/interfaces/babe';
@@ -21,7 +21,7 @@ import { AccountId, AccountIndex, Balance, BalanceOf, BlockNumber, Hash, KeyType
 import { Keys, SessionIndex } from '@polkadot/types/interfaces/session';
 import { Bid, BidKind, SocietyVote, StrikeCount, VouchingStatus } from '@polkadot/types/interfaces/society';
 import { ActiveEraInfo, EraIndex, EraRewardPoints, Exposure, Forcing, Nominations, ReleasesStaking, RewardDestination, SlashingSpans, SpanIndex, SpanRecord, StakingLedger, UnappliedSlash, ValidatorPrefs } from '@polkadot/types/interfaces/staking';
-import { AccountInfo, DigestOf, EventIndex, EventRecord } from '@polkadot/types/interfaces/system';
+import { AccountInfo, DigestOf, EventIndex, EventRecord, LastRuntimeUpgradeInfo } from '@polkadot/types/interfaces/system';
 import { OpenTip, TreasuryProposal } from '@polkadot/types/interfaces/treasury';
 import { Multiplier } from '@polkadot/types/interfaces/txpayment';
 import { Multisig } from '@polkadot/types/interfaces/utility';
@@ -194,7 +194,7 @@ declare module '@polkadot/api/types/storage' {
       /**
        * Get the account (and lock periods) to which another account is delegating vote.
        **/
-      delegations: AugmentedQuery<ApiType, (arg: AccountId | string | Uint8Array) => Observable<ITuple<[ITuple<[AccountId, Conviction]>, Linkage<AccountId>]>>> & QueryableStorageEntry<ApiType>;
+      delegations: AugmentedQuery<ApiType, (arg: AccountId | string | Uint8Array) => Observable<ITuple<[AccountId, Conviction]>>> & QueryableStorageEntry<ApiType>;
       /**
        * Those who have locked a deposit.
        **/
@@ -289,7 +289,7 @@ declare module '@polkadot/api/types/storage' {
       /**
        * Votes of a particular voter, with the round index of the votes.
        **/
-      votesOf: AugmentedQuery<ApiType, (arg: AccountId | string | Uint8Array) => Observable<ITuple<[Vec<AccountId>, Linkage<AccountId>]>>> & QueryableStorageEntry<ApiType>;
+      votesOf: AugmentedQuery<ApiType, (arg: AccountId | string | Uint8Array) => Observable<Vec<AccountId>>> & QueryableStorageEntry<ApiType>;
     };
     grandpa: {
       [index: string]: QueryableStorageEntry<ApiType>;
@@ -313,7 +313,8 @@ declare module '@polkadot/api/types/storage' {
        **/
       pendingChange: AugmentedQuery<ApiType, () => Observable<Option<StoredPendingChange>>> & QueryableStorageEntry<ApiType>;
       /**
-       * A mapping from grandpa set ID to the index of the *most recent* session for which its members were responsible.
+       * A mapping from grandpa set ID to the index of the *most recent* session for which its
+       * members were responsible.
        **/
       setIdSession: AugmentedQuery<ApiType, (arg: SetId | AnyNumber | Uint8Array) => Observable<Option<SessionIndex>>> & QueryableStorageEntry<ApiType>;
       /**
@@ -368,8 +369,8 @@ declare module '@polkadot/api/types/storage' {
        **/
       keys: AugmentedQuery<ApiType, () => Observable<Vec<AuthorityId>>> & QueryableStorageEntry<ApiType>;
       /**
-       * For each session index, we keep a mapping of `AuthIndex`
-       * to `offchain::OpaqueNetworkState`.
+       * For each session index, we keep a mapping of `AuthIndex` to
+       * `offchain::OpaqueNetworkState`.
        **/
       receivedHeartbeats: AugmentedQueryDoubleMap<ApiType, (key1: SessionIndex | AnyNumber | Uint8Array, key2: AuthIndex | AnyNumber | Uint8Array) => Observable<Option<Bytes>>> & QueryableStorageEntry<ApiType>;
     };
@@ -437,17 +438,13 @@ declare module '@polkadot/api/types/storage' {
        **/
       disabledValidators: AugmentedQuery<ApiType, () => Observable<Vec<u32>>> & QueryableStorageEntry<ApiType>;
       /**
-       * The owner of a key. The second key is the `KeyTypeId` + the encoded key.
-       * The first key is always `DEDUP_KEY_PREFIX` to have all the data in the same branch of
-       * the trie. Having all data in the same branch should prevent slowing down other queries.
+       * The owner of a key. The key is the `KeyTypeId` + the encoded key.
        **/
-      keyOwner: AugmentedQueryDoubleMap<ApiType, (key1: Bytes | string | Uint8Array, key2: ITuple<[KeyTypeId, Bytes]> | [KeyTypeId | AnyNumber | Uint8Array, Bytes | string | Uint8Array]) => Observable<Option<ValidatorId>>> & QueryableStorageEntry<ApiType>;
+      keyOwner: AugmentedQuery<ApiType, (arg: ITuple<[KeyTypeId, Bytes]> | [KeyTypeId | AnyNumber | Uint8Array, Bytes | string | Uint8Array]) => Observable<Option<ValidatorId>>> & QueryableStorageEntry<ApiType>;
       /**
        * The next session keys for a validator.
-       * The first key is always `DEDUP_KEY_PREFIX` to have all the data in the same branch of
-       * the trie. Having all data in the same branch should prevent slowing down other queries.
        **/
-      nextKeys: AugmentedQueryDoubleMap<ApiType, (key1: Bytes | string | Uint8Array, key2: ValidatorId | string | Uint8Array) => Observable<Option<Keys>>> & QueryableStorageEntry<ApiType>;
+      nextKeys: AugmentedQuery<ApiType, (arg: ValidatorId | string | Uint8Array) => Observable<Option<Keys>>> & QueryableStorageEntry<ApiType>;
       /**
        * True if the underlying economic identities or weighting behind the validators
        * has changed in the queued validator set.
@@ -580,6 +577,7 @@ declare module '@polkadot/api/types/storage' {
        * Clipped Exposure of validator at era.
        * This is similar to [`ErasStakers`] but number of nominators exposed is reduce to the
        * `T::MaxNominatorRewardedPerValidator` biggest stakers.
+       * (Note: the field `total` and `own` of the exposure remains unchanged).
        * This is used to limit the i/o cost for the nominator payout.
        * This is keyed fist by the era index to allow bulk deletion and then the stash account.
        * Is it removed after `HISTORY_DEPTH` eras.
@@ -597,7 +595,7 @@ declare module '@polkadot/api/types/storage' {
       erasTotalStake: AugmentedQuery<ApiType, (arg: EraIndex | AnyNumber | Uint8Array) => Observable<BalanceOf>> & QueryableStorageEntry<ApiType>;
       /**
        * Similarly to `ErasStakers` this holds the preferences of validators.
-       * This is keyed fist by the era index to allow bulk deletion and then the stash account.
+       * This is keyed first by the era index to allow bulk deletion and then the stash account.
        * Is it removed after `HISTORY_DEPTH` eras.
        **/
       erasValidatorPrefs: AugmentedQueryDoubleMap<ApiType, (key1: EraIndex | AnyNumber | Uint8Array, key2: AccountId | string | Uint8Array) => Observable<ValidatorPrefs>> & QueryableStorageEntry<ApiType>;
@@ -635,7 +633,7 @@ declare module '@polkadot/api/types/storage' {
       /**
        * The map from nominator stash key to the set of stash keys of all validators to nominate.
        **/
-      nominators: AugmentedQuery<ApiType, (arg: AccountId | string | Uint8Array) => Observable<ITuple<[Option<Nominations>, Linkage<AccountId>]>>> & QueryableStorageEntry<ApiType>;
+      nominators: AugmentedQuery<ApiType, (arg: AccountId | string | Uint8Array) => Observable<Option<Nominations>>> & QueryableStorageEntry<ApiType>;
       /**
        * All slashing events on nominators, mapped by era to the highest slash value of the era.
        **/
@@ -674,7 +672,7 @@ declare module '@polkadot/api/types/storage' {
       /**
        * The map from (wannabe) validator stash key to the preferences of that validator.
        **/
-      validators: AugmentedQuery<ApiType, (arg: AccountId | string | Uint8Array) => Observable<ITuple<[ValidatorPrefs, Linkage<AccountId>]>>> & QueryableStorageEntry<ApiType>;
+      validators: AugmentedQuery<ApiType, (arg: AccountId | string | Uint8Array) => Observable<ValidatorPrefs>> & QueryableStorageEntry<ApiType>;
       /**
        * All slashing events on validators, mapped by era to the highest slash proportion
        * and slash value of the era.
@@ -741,6 +739,10 @@ declare module '@polkadot/api/types/storage' {
        * Extrinsics root of the current block, also part of the block header.
        **/
       extrinsicsRoot: AugmentedQuery<ApiType, () => Observable<Hash>> & QueryableStorageEntry<ApiType>;
+      /**
+       * Stores the `spec_version` and `spec_name` of when the last runtime upgrade happened.
+       **/
+      lastRuntimeUpgrade: AugmentedQuery<ApiType, () => Observable<Option<LastRuntimeUpgradeInfo>>> & QueryableStorageEntry<ApiType>;
       /**
        * The current block number being processed. Set by `execute_block`.
        **/
@@ -749,10 +751,6 @@ declare module '@polkadot/api/types/storage' {
        * Hash of the previous block.
        **/
       parentHash: AugmentedQuery<ApiType, () => Observable<Hash>> & QueryableStorageEntry<ApiType>;
-      /**
-       * A bool to track if the runtime was upgraded last block.
-       **/
-      runtimeUpgraded: AugmentedQuery<ApiType, () => Observable<bool>> & QueryableStorageEntry<ApiType>;
     };
     technicalCommittee: {
       [index: string]: QueryableStorageEntry<ApiType>;

packages/api/src/augment/tx.ts

@@ -1215,6 +1215,7 @@ declare module '@polkadot/api/types/submittable' {
        * be the account that controls it.
        * `value` must be more than the `minimum_balance` specified by `T::Currency`.
        * The dispatch origin for this call must be _Signed_ by the stash account.
+       * Emits `Bonded`.
        * # <weight>
        * - Independent of the arguments. Moderate complexity.
        * - O(1).
@@ -1231,6 +1232,7 @@ declare module '@polkadot/api/types/submittable' {
        * Unlike [`bond`] or [`unbond`] this function does not impose any limitation on the amount
        * that can be added.
        * The dispatch origin for this call must be _Signed_ by the stash, not the controller.
+       * Emits `Bonded`.
        * # <weight>
        * - Independent of the arguments. Insignificant complexity.
        * - O(1).
@@ -1300,7 +1302,10 @@ declare module '@polkadot/api/types/submittable' {
        * - `who` is the controller account of the nominator to pay out.
        * - `era` may not be lower than one following the most recently paid era. If it is higher,
        * then it indicates an instruction to skip the payout of all previous eras.
-       * - `validators` is the list of all validators that `who` had exposure to during `era`.
+       * - `validators` is the list of all validators that `who` had exposure to during `era`,
+       * alongside the index of `who` in the clipped exposure of the validator.
+       * I.e. each element is a tuple of
+       * `(validator, index of `who` in clipped exposure of validator)`.
        * If it is incomplete, then less than the full reward will be paid out.
        * It must not exceed `MAX_NOMINATIONS`.
        * WARNING: once an era is payed for a validator such validator can't claim the payout of
@@ -1392,6 +1397,7 @@ declare module '@polkadot/api/types/submittable' {
        * can co-exists at the same time. In that case, [`Call::withdraw_unbonded`] need
        * to be called first to remove some of the chunks (if possible).
        * The dispatch origin for this call must be _Signed_ by the controller, not the stash.
+       * Emits `Unbonded`.
        * See also [`Call::withdraw_unbonded`].
        * # <weight>
        * - Independent of the arguments. Limited but potentially exploitable complexity.
@@ -1420,6 +1426,7 @@ declare module '@polkadot/api/types/submittable' {
        * This essentially frees up that balance to be used by the stash account to do
        * whatever it wants.
        * The dispatch origin for this call must be _Signed_ by the controller, not the stash.
+       * Emits `Withdrawn`.
        * See also [`Call::unbond`].
        * # <weight>
        * - Could be dependent on the `origin` argument and how much `unlocking` chunks exist.
@@ -1481,6 +1488,7 @@ declare module '@polkadot/api/types/submittable' {
        * Kill some items from storage.
        **/
       killStorage: AugmentedSubmittable<(keys: Vec<Key> | (Key | string | Uint8Array)[]) => SubmittableExtrinsic<ApiType>>;
+      migrateAccounts: AugmentedSubmittable<(accounts: Vec<AccountId> | (AccountId | string | Uint8Array)[]) => SubmittableExtrinsic<ApiType>>;
       /**
        * Make some on-chain remark.
        **/

packages/api/src/util/validate.spec.ts

@@ -80,19 +80,20 @@ describe('extractStorageArgs', (): void => {
     ).toThrow('staking.erasStakers(EraIndex, AccountId) is a doublemap, requiring 2 arguments, 1 found');
   });
 
-  it('validates linked map, no args', (): void => {
+  // Linked maps have been removed
+  it.skip('validates linked map, no args', (): void => {
     expect(
       extractStorageArgs(storage.staking.validators, [])
     ).toEqual([storage.staking.validators]);
   });
 
-  it('validates linked map, single arg', (): void => {
+  it.skip('validates linked map, single arg', (): void => {
     expect(
       extractStorageArgs(storage.staking.validators, [123])
     ).toEqual([storage.staking.validators, 123]);
   });
 
-  it('validates linked map (failing with extra args)', (): void => {
+  it.skip('validates linked map (failing with extra args)', (): void => {
     expect(
       (): any[] =>
         extractStorageArgs(storage.staking.validators, [123, 456])

packages/metadata/src/Decorated/Decorated.spec.ts

@@ -18,7 +18,7 @@ describe('Decorated', () => {
         decorated.query.system.account('5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY')
       )
     ).toEqual(
-      '0x010126aa394eea5630e07c48ae0c9558cef7b99d880ec681799c0cf30e8886371da92e3fb4c297a84c5cebc0e78257d213d0927ccc7596044c6ba013dd05522aacba'
+      '0x410126aa394eea5630e07c48ae0c9558cef7b99d880ec681799c0cf30e8886371da9de1e86a9a8c739864cf3cc5ec2bea59fd43593c715fdd31c61141abd04a99fd6822c8558854ccde39a5684e7a56da27d'
     );
   });
 

packages/metadata/src/Decorated/consts/fromMetadata/fromMetadata.spec.ts

@@ -19,7 +19,8 @@ describe('fromMetadata', (): void => {
     expect(consts.democracy.cooloffPeriod.toNumber()).toEqual(28 * 24 * 60 * (60 / 3));
   });
 
-  it('correctly handles bytes', (): void => {
+  // removed from session
+  it.skip('correctly handles bytes', (): void => {
     // 0x34 removes as the length prefix removed
     expect(consts.session.dedupKeyPrefix.toHex()).toEqual('0x3a73657373696f6e3a6b657973');
   });

packages/metadata/src/Decorated/storage/fromMetadata/fromMetadata.spec.ts

@@ -31,8 +31,7 @@ describe('fromMetadata', (): void => {
           decorated.query.system.account(keyring.alice.address)
         )
       ).toEqual(
-        // new storage key format
-        '0x010126aa394eea5630e07c48ae0c9558cef7b99d880ec681799c0cf30e8886371da92e3fb4c297a84c5cebc0e78257d213d0927ccc7596044c6ba013dd05522aacba'
+        '0x410126aa394eea5630e07c48ae0c9558cef7b99d880ec681799c0cf30e8886371da9de1e86a9a8c739864cf3cc5ec2bea59fd43593c715fdd31c61141abd04a99fd6822c8558854ccde39a5684e7a56da27d'
       );
     });
   });