Use MultiAddress as the default type (#3123)

jacogr · web-flow · commit 23b5601eebef · 2021-01-31T11:02:54.000+01:00
* Use MultiAddress as the default type

* Update tests

* Update tests
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,17 @@
 # CHANGELOG
 
+## 3.7.x
+
+Upgrade priority: Low. However recoemmended for current Substrate master, Polkadot and Rococo users and those wishing to support the upcoming Polkadot 28 runtime with the new `MultiAddress`.
+
+- **Breaking change** As indicated in the 3.5.1 release notes, th Address/LookupSource default have now been adjusted for `MultiAddress` by default. This extensible format is mean to cater for all address types, removing a lot of discrepancies between chains.
+
+Changes:
+
+- Apply `MultiAddress` as a default
+- Adds support for the upcoming Polkadot 28 and Kusama 2028 runtimes
+
+
 ## 3.6.1 Jan 24, 2020
 
 Upgrade priority: Medium if not already on at least 3.3.1. The next upgrade of Kusama/Polkadot requires it.
diff --git a/packages/api/src/augment/tx.ts b/packages/api/src/augment/tx.ts
diff --git a/packages/api/src/promise/index.spec.ts b/packages/api/src/promise/index.spec.ts
@@ -12,7 +12,7 @@ import { hexToU8a } from '@polkadot/util';
 import { SingleAccountSigner } from '../../test/util';
 import { ApiPromise } from '.';
 
-const TRANSFER_SIG = '0x7a10e5ed9a14284eca7bea53f81631981dddda5a3d2dee973b136475947264801465726e4829ae3994d9058df638d959d4e043c7f1924299546790dda1dea20a';
+const TRANSFER_SIG = '0x54f39e43f32376a5ab6cdfd4d0ce57802aa9ff85514a7ffa9f2a949078f02beca16af87427c45fe60d54aa847fd241d127ed39e21b101806f6b1f50f7a82500b';
 
 describe('ApiPromise', (): void => {
   const registry = new TypeRegistry();
diff --git a/packages/metadata/src/decorate/extrinsics/index.spec.ts b/packages/metadata/src/decorate/extrinsics/index.spec.ts
@@ -15,6 +15,7 @@ const registry = new TypeRegistry();
 const metadata = new Metadata(registry, metadataStatic);
 
 registry.setMetadata(metadata);
+registry.register({ Address: 'IndicesLookupSource', LookupSource: 'IndicesLookupSource' });
 
 const extrinsics = decorateExtrinsics(registry, metadata.asLatest, metadata.version);
 
diff --git a/packages/types-known/src/spec/node.ts b/packages/types-known/src/spec/node.ts
@@ -8,21 +8,13 @@ import type { OverrideVersionedType } from '@polkadot/types/types';
 // these are override types for Polkadot
 const versioned: OverrideVersionedType[] = [
   {
-    minmax: [0, 259],
+    minmax: [0, 260],
     types: {
       AccountInfo: 'AccountInfoWithRefCount',
       Address: 'LookupSource',
       LookupSource: 'IndicesLookupSource'
     }
   },
-  {
-    minmax: [260, 260],
-    types: {
-      AccountInfo: 'AccountInfoWithRefCount',
-      Address: 'MultiAddress',
-      LookupSource: 'MultiAddress'
-    }
-  },
   {
     minmax: [261, undefined],
     types: {
diff --git a/packages/types/src/codec/Enum.spec.ts b/packages/types/src/codec/Enum.spec.ts
@@ -389,7 +389,7 @@ describe('Enum', (): void => {
       expect(test.toHex()).toEqual(
         '0x' +
         '00' + // index
-        'ff' + // Address indicating an embedded AccountId
+        '00' + // MultiAddress indicating an embedded AccountId
         '0001020304050607080910111213141516171819202122232425262728293031' // AccountId
       );
     });
diff --git a/packages/types/src/extrinsic/Extrinsic.spec.ts b/packages/types/src/extrinsic/Extrinsic.spec.ts
@@ -20,7 +20,7 @@ describe('Extrinsic', (): void => {
         '0x' +
         '5d02' + // length
         '84' + // V4, signing bit set
-        'ff' + // lookup, AccountId of sender follows
+        '00' + // MultiAddress, AccountId of sender follows
         'fcc4910cb536b4333db4bccb40e2cf6427b4766518e754b91e70c97e4a87dbb3' + // sender
         '00' + // multisig, type ed25519
         'd99ffe3e610ad234e1414bda5831395a6df9098bf80b01561ce89a5065ae89d5' + // sig first 32
@@ -29,7 +29,7 @@ describe('Extrinsic', (): void => {
         '1101' + // nonce, compact 68
         '0700ac23fc06' + // tip, 0.03 KSM
         '0600' + // balances.transfer (on Kusama this was 0400, changed here to match metadata)
-        'ff' + // lookup, AccountId of recipient follows
+        '00' + // MultiAddress, AccountId of recipient follows
         '495e1e506f266418af07fa0c5c108dd436f2faa59fe7d9e54403779f5bbd7718' + // recipient
         '0bc01eb1fc185f' // value, 104.560 KSM
       );
@@ -38,7 +38,7 @@ describe('Extrinsic', (): void => {
       expect(extrinsic.nonce.toNumber()).toEqual(68);
       expect(extrinsic.tip.toHuman()).toEqual('30.0000 mUnit');
       expect(extrinsic.callIndex).toEqual(new Uint8Array([6, 0]));
-      expect(extrinsic.args[0].toHex()).toEqual('0xff495e1e506f266418af07fa0c5c108dd436f2faa59fe7d9e54403779f5bbd7718');
+      expect(extrinsic.args[0].toHex()).toEqual('0x00495e1e506f266418af07fa0c5c108dd436f2faa59fe7d9e54403779f5bbd7718');
       expect(extrinsic.args[1].toHuman()).toEqual('104.5609 Unit');
     });
   });
diff --git a/packages/types/src/extrinsic/SignerPayload.spec.ts b/packages/types/src/extrinsic/SignerPayload.spec.ts
@@ -19,7 +19,7 @@ describe('SignerPayload', (): void => {
     blockNumber: '0x00231d30',
     era: '0x0703',
     genesisHash: '0xdcd1346701ca8396496e52aa2785b1748deb6db09551b72159dcb3e08991025b',
-    method: '0x0600ffd7568e5f0a7eda67a82691ff379ac4bba4f9c9b859fe779b5d46363b61ad2db9e56c',
+    method: '0x060000d7568e5f0a7eda67a82691ff379ac4bba4f9c9b859fe779b5d46363b61ad2db9e56c',
     nonce: '0x00001234',
     signedExtensions: ['CheckNonce', 'CheckWeight'],
     specVersion: '0x00000006',
@@ -36,7 +36,7 @@ describe('SignerPayload', (): void => {
         blockNumber: '0x231d30',
         era: registry.createType('ExtrinsicEra', { current: 2301232, period: 200 }),
         genesisHash: '0xdcd1346701ca8396496e52aa2785b1748deb6db09551b72159dcb3e08991025b',
-        method: registry.createType('Call', '0x0600ffd7568e5f0a7eda67a82691ff379ac4bba4f9c9b859fe779b5d46363b61ad2db9e56c'),
+        method: registry.createType('Call', '0x060000d7568e5f0a7eda67a82691ff379ac4bba4f9c9b859fe779b5d46363b61ad2db9e56c'),
         nonce: 0x1234,
         signedExtensions: ['CheckNonce'],
         tip: 0x5678,
@@ -48,7 +48,7 @@ describe('SignerPayload', (): void => {
       blockNumber: '0x00231d30',
       era: '0x0703',
       genesisHash: '0xdcd1346701ca8396496e52aa2785b1748deb6db09551b72159dcb3e08991025b',
-      method: '0x0600ffd7568e5f0a7eda67a82691ff379ac4bba4f9c9b859fe779b5d46363b61ad2db9e56c',
+      method: '0x060000d7568e5f0a7eda67a82691ff379ac4bba4f9c9b859fe779b5d46363b61ad2db9e56c',
       nonce: '0x00001234',
       signedExtensions: ['CheckNonce'],
       specVersion: '0x00000000',
diff --git a/packages/types/src/extrinsic/v4/ExtrinsicSignature.spec.ts b/packages/types/src/extrinsic/v4/ExtrinsicSignature.spec.ts
@@ -32,7 +32,7 @@ describe('ExtrinsicSignatureV4', (): void => {
 
     const u8a = new Uint8Array([
       // signer as an AccountIndex
-      0x09,
+      0x01, 0x08, // 4 << 2
       // signature type
       0x01,
       // signature
@@ -65,7 +65,7 @@ describe('ExtrinsicSignatureV4', (): void => {
       ).toHex()
     ).toEqual(
       '0x' +
-      'ff' +
+      '00' + // MultiAddress
       'd43593c715fdd31c61141abd04a99fd6822c8558854ccde39a5684e7a56da27d' +
       '01' +
       '4242424242424242424242424242424242424242424242424242424242424242' +
@@ -93,7 +93,7 @@ describe('ExtrinsicSignatureV4', (): void => {
     ).toEqual(
       '0x' +
       // Address = AccountId
-      // 'ff' +
+      // '00' +
       'd43593c715fdd31c61141abd04a99fd6822c8558854ccde39a5684e7a56da27d' +
       // This is a prefix-less signature, anySignture as opposed to Multi above
       // '01' +
diff --git a/packages/types/src/generic/Call.spec.ts b/packages/types/src/generic/Call.spec.ts
@@ -19,12 +19,16 @@ describe('Call', (): void => {
         args: [],
         callIndex: [6, 1] // balances.setBalance
       }).toU8a()
-    ).toEqual(new Uint8Array([6, 1, 0, 0, 0]));
+    ).toEqual(
+      new Uint8Array([6, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0])
+    );
   });
 
   it('handles creation from a hex value properly', (): void => {
     expect(
       new Call(registry, '0x0601').toU8a()
-    ).toEqual(new Uint8Array([6, 1, 0, 0, 0])); // balances.setBalance
+    ).toEqual(
+      new Uint8Array([6, 1, 1, 110, 7, 17, 0, 0, 0])
+    ); // balances.setBalance
   });
 });
diff --git a/packages/types/src/generic/LookupSource.spec.ts b/packages/types/src/generic/LookupSource.spec.ts
@@ -9,7 +9,7 @@ describe('LookupSource', (): void => {
 
   const testDecode = (type: string, input: LookupSource | AccountId | AccountIndex | number[] | Uint8Array, expected: string): void =>
     it(`can decode from ${type}`, (): void => {
-      const a = registry.createType('Address', input);
+      const a = registry.createType('IndicesLookupSource', input);
 
       expect(a.toString()).toBe(expected);
     });
@@ -18,19 +18,19 @@ describe('LookupSource', (): void => {
     it('equals on AccountId', (): void => {
       const addr = '5DkQbYAExs3M2sZgT1Ec3mKfZnAQCL4Dt9beTCknkCUn5jzo';
 
-      expect(registry.createType('LookupSource', addr).eq(addr)).toBe(true);
+      expect(registry.createType('IndicesLookupSource', addr).eq(addr)).toBe(true);
     });
 
     it('equals on AccountIndex', (): void => {
       // see the test below - these are equivalent (with different prefix encoding)
-      expect(registry.createType('LookupSource', '2jpAFn').eq('25GUyv')).toBe(true);
+      expect(registry.createType('IndicesLookupSource', '2jpAFn').eq('25GUyv')).toBe(true);
     });
   });
 
   describe('decoding', (): void => {
     testDecode(
       'Address',
-      registry.createType('LookupSource', '5C62W7ELLAAfix9LYrcx5smtcffbhvThkM5x7xfMeYXCtGwF'),
+      registry.createType('IndicesLookupSource', '5C62W7ELLAAfix9LYrcx5smtcffbhvThkM5x7xfMeYXCtGwF'),
       '5C62W7ELLAAfix9LYrcx5smtcffbhvThkM5x7xfMeYXCtGwF'
     );
     testDecode(
@@ -40,7 +40,7 @@ describe('LookupSource', (): void => {
     );
     testDecode(
       'AccountIndex (mixed prefixes)',
-      registry.createType('LookupSource', '2jpAFn'),
+      registry.createType('IndicesLookupSource', '2jpAFn'),
       // NOTE Expected adress here is encoded with prefix 42, input above with 68
       '25GUyv'
     );
@@ -95,7 +95,7 @@ describe('LookupSource', (): void => {
   describe('encoding', (): void => {
     const testEncode = (to: 'toHex' | 'toString' | 'toU8a', expected: string | Uint8Array): void =>
       it(`can encode ${to}`, (): void => {
-        const a = registry.createType('Address', '5C62W7ELLAAfix9LYrcx5smtcffbhvThkM5x7xfMeYXCtGwF');
+        const a = registry.createType('IndicesLookupSource', '5C62W7ELLAAfix9LYrcx5smtcffbhvThkM5x7xfMeYXCtGwF');
 
         expect(a[to]()).toEqual(expected);
       });
diff --git a/packages/types/src/interfaces/runtime/definitions.ts b/packages/types/src/interfaces/runtime/definitions.ts
@@ -29,7 +29,7 @@ export default {
     AccountId: 'GenericAccountId',
     AccountIdOf: 'AccountId',
     AccountIndex: 'GenericAccountIndex',
-    Address: 'LookupSource',
+    Address: 'MultiAddress',
     AssetId: 'u32',
     Balance: 'UInt<128, Balance>',
     BalanceOf: 'Balance',
@@ -82,7 +82,7 @@ export default {
     KeyValue: '(StorageKey, StorageData)',
     KeyTypeId: 'u32',
     LockIdentifier: '[u8; 8]',
-    LookupSource: 'IndicesLookupSource',
+    LookupSource: 'MultiAddress',
     LookupTarget: 'AccountId',
     ModuleId: 'LockIdentifier',
     MultiAddress: 'GenericMultiAddress',
diff --git a/packages/types/src/interfaces/runtime/types.ts b/packages/types/src/interfaces/runtime/types.ts
@@ -17,7 +17,7 @@ export interface AccountIdOf extends AccountId {}
 export interface AccountIndex extends GenericAccountIndex {}
 
 /** @name Address */
-export interface Address extends LookupSource {}
+export interface Address extends MultiAddress {}
 
 /** @name AssetId */
 export interface AssetId extends u32 {}
@@ -157,7 +157,7 @@ export interface KeyValue extends ITuple<[StorageKey, StorageData]> {}
 export interface LockIdentifier extends U8aFixed {}
 
 /** @name LookupSource */
-export interface LookupSource extends IndicesLookupSource {}
+export interface LookupSource extends MultiAddress {}
 
 /** @name LookupTarget */
 export interface LookupTarget extends AccountId {}
