keeping this repo in sync

src/interfaces/augment-types.ts

@@ -8,6 +8,7 @@ import { ExchangeKey, FeeRate } from '@cennznet/api-types/interfaces/cennzx';
 import { AssetInfo } from '@cennznet/api-types/interfaces/ga';
 import { RewardBalance, RewardBalanceOf, RewardDestination } from '@cennznet/api-types/interfaces/staking';
 import { AcceptPayload, DeviceId, DeviceIdResponse, Group, Invite, Member, MemberRoles, Message, MessageId, Meta, PendingInvite, PreKeyBundle, PreKeyBundlesResponse, Response, VaultKey, VaultValue, WithdrawnPreKeyBundle } from '@cennznet/api-types/interfaces/sylo';
+import { doughnut } from '@cennznet/api-types/interfaces/system';
 import { ChargeTransactionPayment, FeeExchange, FeeExchangeV1 } from '@cennznet/api-types/interfaces/transactionPayment';
 import { BlockAttestations, IncludedBlocks, MoreAttestations } from '@polkadot/types/interfaces/attestations';
 import { RawAuraPreDigest } from '@polkadot/types/interfaces/aura';
@@ -1583,6 +1584,9 @@ declare module '@polkadot/types/types/registry' {
     Message: Message;
     'Option<Message>': Option<Message>;
     'Vec<Message>': Vec<Message>;
+    doughnut: doughnut;
+    'Option<doughnut>': Option<doughnut>;
+    'Vec<doughnut>': Vec<doughnut>;
     FeeExchangeV1: FeeExchangeV1;
     'Option<FeeExchangeV1>': Option<FeeExchangeV1>;
     'Vec<FeeExchangeV1>': Vec<FeeExchangeV1>;

src/interfaces/extrinsic/index.ts

@@ -14,4 +14,5 @@
 
 export {default as CENNZnetExtrinsicPayloadV1} from './v1/ExtrinsicPayload';
 export {default as CENNZnetExtrinsicSignatureV1} from './v1/ExtrinsicSignature';
+export { default as CENNZnetExtrinsicSignatureV0 } from './v0/ExtrinsicSignatureV0';
 export {default as SignerPayload} from './SignerPayload';

src/interfaces/extrinsic/types.ts

@@ -19,7 +19,9 @@ import {
   ExtrinsicPayloadValue as ExtrinsicPayloadValueBase,
   SignatureOptions as SignatureOptionsBase,
 } from '@polkadot/types/types';
+import { Option } from '@polkadot/types';
 import {ChargeTransactionPayment } from '../transactionPayment';
+import { doughnut } from '../types';
 
 export interface ExtrinsicPayloadValue extends ExtrinsicPayloadValueBase {
   transactionPayment?: AnyU8a | ChargeTransactionPayment;
@@ -28,3 +30,9 @@ export interface ExtrinsicPayloadValue extends ExtrinsicPayloadValueBase {
 export interface SignatureOptions extends SignatureOptionsBase {
   transactionPayment?: AnyU8a | ChargeTransactionPayment;
 }
+
+export interface ExtrinsicV0SignatureOptions extends SignatureOptionsBase {
+  doughnut?: Option<doughnut>;
+  transactionPayment?: ChargeTransactionPayment;
+  feeExchange?: any;
+}

src/interfaces/extrinsic/v0/ExtrinsicPayloadV0.ts

@@ -0,0 +1,145 @@
+// Copyright 2019-2020 Centrality Investments Limited & @polkadot/types authors & contributors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+// tslint:disable member-ordering no-magic-numbers
+import { Bytes, Compact, Raw, Struct, u32 } from '@polkadot/types';
+import { Balance, ExtrinsicEra, Hash } from '@polkadot/types/interfaces';
+import { sign } from '@polkadot/types/extrinsic/util';
+import { AnyNumber, AnyU8a, IExtrinsicEra, IKeyringPair, IMethod, Registry } from '@polkadot/types/types';
+import Option from '@polkadot/types/codec/Option';
+import { ChargeTransactionPayment, doughnut, Index } from '../../types';
+
+export interface ExtrinsicPayloadValueV0 {
+  blockHash: AnyU8a;
+  doughnut: Option<Raw>;
+  era: AnyU8a | IExtrinsicEra;
+  genesisHash: AnyU8a;
+  method: AnyU8a | IMethod;
+  nonce: AnyNumber;
+  specVersion: AnyNumber;
+  tip: AnyNumber;
+  transactionPayment?: AnyU8a | ChargeTransactionPayment;
+}
+
+// The base of an extrinsic payload
+export const BasePayloadV0: Record<string, any> = {
+  method: 'Bytes',
+  doughnut: 'Option<Doughnut>',
+  era: 'ExtrinsicEra',
+  nonce: 'Compact<Index>',
+  transactionPayment: 'ChargeTransactionPayment',
+};
+
+// These fields are signed here as part of the extrinsic signature but are NOT encoded in
+// the final extrinsic payload itself.
+// The CENNZnet node will populate these fields from on-chain data and check the signature compares
+// hence 'implicit'
+export const PayloadImplicitAddonsV0: Record<string, any> = {
+  specVersion: 'u32',
+  genesisHash: 'Hash',
+  blockHash: 'Hash',
+};
+
+// The full definition for the extrinsic payload.
+// It will be encoded (+ hashed if len > 256) and then signed to make the extrinsic signature
+export const FullPayloadV0: Record<string, any> = {
+  ...BasePayloadV0,
+  ...PayloadImplicitAddonsV0,
+};
+/**
+ * @name ExtrinsicPayloadV0
+ * @description
+ * A signing payload for an [[Extrinsic]]. For the final encoding, it is variable length based
+ * on the contents included
+ *
+ *   1-8 bytes: The Transaction Compact<Index/Nonce> as provided in the transaction itself.
+ *   2+ bytes: The Function Descriptor as provided in the transaction itself.
+ *   1/2 bytes: The Transaction Era as provided in the transaction itself.
+ *   32 bytes: The hash of the authoring block implied by the Transaction Era and the current block.
+ */
+export default class ExtrinsicPayloadV0 extends Struct {
+  constructor(registry: Registry, value?: ExtrinsicPayloadValueV0 | Uint8Array | string) {
+    super(registry, FullPayloadV0, value);
+  }
+
+  /**
+   * @description The block [[Hash]] the signature applies to (mortal/immortal)
+   */
+  get blockHash(): Hash {
+    return this.get('blockHash') as Hash;
+  }
+
+  /**
+   * @description The genesis [[Hash]] the signature applies to (mortal/immortal)
+   */
+  get genesisHash(): Hash {
+    return this.get('genesisHash') as Hash;
+  }
+
+  /**
+   * @description The [[Bytes]] contained in the payload
+   */
+  get method(): Bytes {
+    return this.get('method') as Bytes;
+  }
+
+  /**
+   * @description The [[ExtrinsicEra]]
+   */
+  get era(): ExtrinsicEra {
+    return this.get('era') as ExtrinsicEra;
+  }
+
+  /**
+   * @description The [[Index]]
+   */
+  get nonce(): Compact<Index> {
+    return this.get('nonce') as Compact<Index>;
+  }
+
+  /**
+   * @description The specVersion for this signature
+   */
+  get specVersion(): u32 {
+    return this.get('specVersion') as u32;
+  }
+
+  /**
+   * @description tip (here for compatibility with [[IExtrinsic]] definition)
+   */
+  get tip(): Compact<Balance> {
+    return this.transactionPayment.tip as Compact<Balance>;
+  }
+
+  /**
+   * @description The transaction fee metadata e.g tip, fee exchange
+   */
+  get transactionPayment(): ChargeTransactionPayment {
+    return this.get('transactionPayment') as ChargeTransactionPayment;
+  }
+
+  /**
+   * @description The [[Doughnut]]
+   */
+  get doughnut(): Option<doughnut> {
+    return this.get('doughnut') as Option<doughnut>;
+  }
+
+  /**
+   * @description Sign the payload with the keypair
+   */
+  sign(signerPair: IKeyringPair): Uint8Array {
+    return sign(this.registry, signerPair, this.toU8a({ method: true }), { withType: true });
+  }
+}