Merge pull request #258 from rg911/task/g143_harvesting_delegation_unlocking

JAV-8 [Github #143] Persistent Harvesting Delegation Unlocking

Author: rg911

e2e/infrastructure/AccountHttp.spec.ts

@@ -24,6 +24,7 @@ import { AccountRestrictionType } from '../../src/model/account/AccountRestricti
 import {Address} from '../../src/model/account/Address';
 import {PublicAccount} from '../../src/model/account/PublicAccount';
 import {NetworkType} from '../../src/model/blockchain/NetworkType';
+import { PlainMessage } from '../../src/model/message/PlainMessage';
 import { NetworkCurrencyMosaic } from '../../src/model/mosaic/NetworkCurrencyMosaic';
 import { AliasAction } from '../../src/model/namespace/AliasAction';
 import { NamespaceId } from '../../src/model/namespace/NamespaceId';
@@ -36,7 +37,6 @@ import { Deadline } from '../../src/model/transaction/Deadline';
 import { MultisigAccountModificationTransaction } from '../../src/model/transaction/MultisigAccountModificationTransaction';
 import { MultisigCosignatoryModification } from '../../src/model/transaction/MultisigCosignatoryModification';
 import { NamespaceRegistrationTransaction } from '../../src/model/transaction/NamespaceRegistrationTransaction';
-import { PlainMessage } from '../../src/model/transaction/PlainMessage';
 import { TransferTransaction } from '../../src/model/transaction/TransferTransaction';
 import { UInt64 } from '../../src/model/UInt64';
 

e2e/infrastructure/BlockHttp.spec.ts

@@ -20,9 +20,9 @@ import { Listener, TransactionHttp } from '../../src/infrastructure/infrastructu
 import {QueryParams} from '../../src/infrastructure/QueryParams';
 import { Account } from '../../src/model/account/Account';
 import { NetworkType } from '../../src/model/blockchain/NetworkType';
+import { PlainMessage } from '../../src/model/message/PlainMessage';
 import { NetworkCurrencyMosaic } from '../../src/model/mosaic/NetworkCurrencyMosaic';
 import { Deadline } from '../../src/model/transaction/Deadline';
-import { PlainMessage } from '../../src/model/transaction/PlainMessage';
 import { Transaction } from '../../src/model/transaction/Transaction';
 import { TransferTransaction } from '../../src/model/transaction/TransferTransaction';
 

e2e/infrastructure/Listener.spec.ts

@@ -20,6 +20,7 @@ import { Listener } from '../../src/infrastructure/Listener';
 import { TransactionHttp } from '../../src/infrastructure/TransactionHttp';
 import { Account } from '../../src/model/account/Account';
 import { NetworkType } from '../../src/model/blockchain/NetworkType';
+import { PlainMessage } from '../../src/model/message/PlainMessage';
 import { Mosaic, UInt64 } from '../../src/model/model';
 import { MosaicId } from '../../src/model/mosaic/MosaicId';
 import { NetworkCurrencyMosaic } from '../../src/model/mosaic/NetworkCurrencyMosaic';
@@ -29,7 +30,6 @@ import { CosignatoryModificationAction } from '../../src/model/transaction/Cosig
 import { Deadline } from '../../src/model/transaction/Deadline';
 import { MultisigAccountModificationTransaction } from '../../src/model/transaction/MultisigAccountModificationTransaction';
 import { MultisigCosignatoryModification } from '../../src/model/transaction/MultisigCosignatoryModification';
-import { PlainMessage } from '../../src/model/transaction/PlainMessage';
 import { TransferTransaction } from '../../src/model/transaction/TransferTransaction';
 import { TransactionUtils } from './TransactionUtils';
 

e2e/infrastructure/TransactionHttp.spec.ts

@@ -28,6 +28,7 @@ import {Account} from '../../src/model/account/Account';
 import { AccountRestrictionModificationAction } from '../../src/model/account/AccountRestrictionModificationAction';
 import { AccountRestrictionType } from '../../src/model/account/AccountRestrictionType';
 import {NetworkType} from '../../src/model/blockchain/NetworkType';
+import { PlainMessage } from '../../src/model/message/PlainMessage';
 import { Mosaic } from '../../src/model/mosaic/Mosaic';
 import {MosaicFlags} from '../../src/model/mosaic/MosaicFlags';
 import {MosaicId} from '../../src/model/mosaic/MosaicId';
@@ -61,7 +62,6 @@ import { MosaicMetadataTransaction } from '../../src/model/transaction/MosaicMet
 import {MosaicSupplyChangeTransaction} from '../../src/model/transaction/MosaicSupplyChangeTransaction';
 import { NamespaceMetadataTransaction } from '../../src/model/transaction/NamespaceMetadataTransaction';
 import {NamespaceRegistrationTransaction} from '../../src/model/transaction/NamespaceRegistrationTransaction';
-import { PlainMessage } from '../../src/model/transaction/PlainMessage';
 import {SecretLockTransaction} from '../../src/model/transaction/SecretLockTransaction';
 import {SecretProofTransaction} from '../../src/model/transaction/SecretProofTransaction';
 import { SignedTransaction } from '../../src/model/transaction/SignedTransaction';

e2e/infrastructure/TransactionUtils.ts

@@ -19,17 +19,17 @@ import {Account} from '../../src/model/account/Account';
 import {Address} from '../../src/model/account/Address';
 import { PublicAccount } from '../../src/model/account/PublicAccount';
 import {NetworkType} from '../../src/model/blockchain/NetworkType';
+import {PlainMessage} from '../../src/model/message/PlainMessage';
 import { Mosaic } from '../../src/model/mosaic/Mosaic';
 import { MosaicId } from '../../src/model/mosaic/MosaicId';
 import {NetworkCurrencyMosaic} from '../../src/model/mosaic/NetworkCurrencyMosaic';
 import {AggregateTransaction} from '../../src/model/transaction/AggregateTransaction';
+import { CosignatoryModificationAction } from '../../src/model/transaction/CosignatoryModificationAction';
 import {CosignatureTransaction} from '../../src/model/transaction/CosignatureTransaction';
 import {Deadline} from '../../src/model/transaction/Deadline';
 import { LockFundsTransaction } from '../../src/model/transaction/LockFundsTransaction';
 import { MultisigAccountModificationTransaction } from '../../src/model/transaction/MultisigAccountModificationTransaction';
 import { MultisigCosignatoryModification } from '../../src/model/transaction/MultisigCosignatoryModification';
-import { CosignatoryModificationAction } from '../../src/model/transaction/CosignatoryModificationAction';
-import {PlainMessage} from '../../src/model/transaction/PlainMessage';
 import { SignedTransaction } from '../../src/model/transaction/SignedTransaction';
 import {TransferTransaction} from '../../src/model/transaction/TransferTransaction';
 import {UInt64} from '../../src/model/UInt64';
@@ -104,8 +104,8 @@ export class TransactionUtils {
     }
 
     public static createMultisigAccountModificationTransaction( account: Account,
-                                                          transactionHttp: TransactionHttp,
-                                                          generationHash: string) {
+                                                                transactionHttp: TransactionHttp,
+                                                                generationHash: string) {
         const modifyMultisig = MultisigAccountModificationTransaction.create(
             Deadline.create(),
             2,
@@ -119,4 +119,4 @@ export class TransactionUtils {
         const signedTransaction = account.sign(modifyMultisig, generationHash);
         transactionHttp.announce(signedTransaction);
     }
-}
+}

src/core/crypto/Crypto.ts

@@ -19,6 +19,7 @@ import { Convert as convert } from '../format/Convert';
 import { KeyPair } from './KeyPair';
 import { SignSchema } from './SignSchema';
 import * as utility from './Utilities';
+
 // tslint:disable-next-line: no-var-requires
 const CryptoJS = require('crypto-js');
 export class Crypto {
@@ -223,7 +224,12 @@ export class Crypto {
      * @param {SignSchema} signSchema The Sign Schema. (KECCAK(NIS1) / SHA3(Catapult))
      * @return {string} - The encoded message
      */
-    public static _encode = (senderPriv, recipientPub, msg, iv, salt, signSchema: SignSchema) => {
+    public static _encode = (senderPriv: string,
+                             recipientPub: string,
+                             msg: string,
+                             iv: Uint8Array,
+                             salt: Uint8Array,
+                             signSchema: SignSchema): string => {
         // Errors
         if (!senderPriv || !recipientPub || !msg || !iv || !salt) { throw new Error('Missing argument !'); }
         // Processing
@@ -233,7 +239,7 @@ export class Crypto {
         const encIv = {
             iv: utility.ua2words(iv, 16),
         };
-        const encrypted = CryptoJS.AES.encrypt(CryptoJS.enc.Hex.parse(convert.utf8ToHex(msg)), encKey, encIv);
+        const encrypted = CryptoJS.AES.encrypt(CryptoJS.enc.Hex.parse(msg), encKey, encIv);
         // Result
         const result = convert.uint8ToHex(salt) + convert.uint8ToHex(iv) + CryptoJS.enc.Hex.stringify(encrypted.ciphertext);
         return result;
@@ -246,15 +252,20 @@ export class Crypto {
      * @param {string} recipientPub - A recipient public key
      * @param {string} msg - A text message
      * @param {SignSchema} signSchema The Sign Schema. (KECCAK(NIS1) / SHA3(Catapult))
+     * @param {boolean} isHexString - Is payload string a hexadecimal string (default = false)
      * @return {string} - The encoded message
      */
-    public static encode = (senderPriv, recipientPub, msg, signSchema: SignSchema) => {
+    public static encode = (senderPriv: string,
+                            recipientPub: string,
+                            msg: string,
+                            signSchema: SignSchema,
+                            isHexString: boolean = false): string => {
         // Errors
         if (!senderPriv || !recipientPub || !msg) { throw new Error('Missing argument !'); }
         // Processing
         const iv = Crypto.randomBytes(16);
         const salt = Crypto.randomBytes(32);
-        const encoded = Crypto._encode(senderPriv, recipientPub, msg, iv, salt, signSchema);
+        const encoded = Crypto._encode(senderPriv, recipientPub, isHexString ? msg : convert.utf8ToHex(msg), iv, salt, signSchema);
         // Result
         return encoded;
     }
@@ -264,11 +275,18 @@ export class Crypto {
      *
      * @param {string} recipientPrivate - A recipient private key
      * @param {string} senderPublic - A sender public key
-     * @param {Uint8Array} _payload - An encrypted message payload in bytes
+     * @param {Uint8Array} payload - An encrypted message payload in bytes
+     * @param {Uint8Array} iv - 16-byte AES initialization vector
+     * @param {Uint8Array} salt - 32-byte salt
      * @param {SignSchema} signSchema The Sign Schema. (KECCAK(NIS1) / SHA3(Catapult))
      * @return {string} - The decoded payload as hex
      */
-    public static _decode = (recipientPrivate, senderPublic, payload, iv, salt, signSchema: SignSchema) => {
+    public static _decode = (recipientPrivate: string,
+                             senderPublic: string,
+                             payload: Uint8Array,
+                             iv: Uint8Array,
+                             salt: Uint8Array,
+                             signSchema: SignSchema): string => {
         // Error
         if (!recipientPrivate || !senderPublic || !payload) { throw new Error('Missing argument !'); }
         // Processing
@@ -292,10 +310,13 @@ export class Crypto {
      * @param {string} recipientPrivate - A recipient private key
      * @param {string} senderPublic - A sender public key
      * @param {string} payload - An encrypted message payload
-     * @param {SignSchema} signSchema The Sign Schema. (KECCAK(NIS1) / SHA3(Catapult))
+     * @param {SignSchema} signSchema - The Sign Schema. (KECCAK(NIS1) / SHA3(Catapult))
      * @return {string} - The decoded payload as hex
      */
-    public static decode = (recipientPrivate, senderPublic, payload, signSchema: SignSchema) => {
+    public static decode = (recipientPrivate: string,
+                            senderPublic: string,
+                            payload: string,
+                            signSchema: SignSchema): string => {
         // Error
         if (!recipientPrivate || !senderPublic || !payload) { throw new Error('Missing argument !'); }
         // Processing

src/infrastructure/transaction/CreateTransactionFromDTO.ts

@@ -18,7 +18,10 @@ import {RawUInt64 as UInt64Library} from '../../core/format';
 import {Address} from '../../model/account/Address';
 import {PublicAccount} from '../../model/account/PublicAccount';
 import {NetworkType} from '../../model/blockchain/NetworkType';
-import {Id} from '../../model/Id';
+import { EncryptedMessage } from '../../model/message/EncryptedMessage';
+import { MessageType } from '../../model/message/MessageType';
+import { PersistentHarvestingDelegationMessage } from '../../model/message/PersistentHarvestingDelegationMessage';
+import {EmptyMessage, PlainMessage} from '../../model/message/PlainMessage';
 import {Mosaic} from '../../model/mosaic/Mosaic';
 import {MosaicFlags} from '../../model/mosaic/MosaicFlags';
 import {MosaicId} from '../../model/mosaic/MosaicId';
@@ -34,9 +37,7 @@ import {AggregateTransaction} from '../../model/transaction/AggregateTransaction
 import {AggregateTransactionCosignature} from '../../model/transaction/AggregateTransactionCosignature';
 import {AggregateTransactionInfo} from '../../model/transaction/AggregateTransactionInfo';
 import {Deadline} from '../../model/transaction/Deadline';
-import { EncryptedMessage } from '../../model/transaction/EncryptedMessage';
 import {LockFundsTransaction} from '../../model/transaction/LockFundsTransaction';
-import { MessageType } from '../../model/transaction/MessageType';
 import { MosaicAddressRestrictionTransaction } from '../../model/transaction/MosaicAddressRestrictionTransaction';
 import {MosaicAliasTransaction} from '../../model/transaction/MosaicAliasTransaction';
 import {MosaicDefinitionTransaction} from '../../model/transaction/MosaicDefinitionTransaction';
@@ -47,7 +48,6 @@ import {MultisigAccountModificationTransaction} from '../../model/transaction/Mu
 import {MultisigCosignatoryModification} from '../../model/transaction/MultisigCosignatoryModification';
 import { NamespaceMetadataTransaction } from '../../model/transaction/NamespaceMetadataTransaction';
 import {NamespaceRegistrationTransaction} from '../../model/transaction/NamespaceRegistrationTransaction';
-import {EmptyMessage, PlainMessage} from '../../model/transaction/PlainMessage';
 import {SecretLockTransaction} from '../../model/transaction/SecretLockTransaction';
 import {SecretProofTransaction} from '../../model/transaction/SecretProofTransaction';
 import {SignedTransaction} from '../../model/transaction/SignedTransaction';
@@ -524,6 +524,8 @@ const extractMessage = (message: any): PlainMessage | EncryptedMessage => {
                                                     PlainMessage.create(message.payload);
         } else if (message.type === MessageType.EncryptedMessage) {
             msgObj = EncryptedMessage.createFromPayload(message.payload);
+        } else if (message.type === MessageType.PersistentHarvestingDelegationMessage) {
+            msgObj = PersistentHarvestingDelegationMessage.createFromPayload(message.payload);
         }
     }
     return msgObj;

src/model/account/Account.ts

@@ -18,11 +18,11 @@ import {Crypto, KeyPair} from '../../core/crypto';
 import {SHA3Hasher} from '../../core/crypto/SHA3Hasher';
 import {Convert, RawAddress} from '../../core/format';
 import {NetworkType} from '../blockchain/NetworkType';
+import {EncryptedMessage} from '../message/EncryptedMessage';
+import {PlainMessage} from '../message/PlainMessage';
 import {AggregateTransaction} from '../transaction/AggregateTransaction';
 import {CosignatureSignedTransaction} from '../transaction/CosignatureSignedTransaction';
 import {CosignatureTransaction} from '../transaction/CosignatureTransaction';
-import {EncryptedMessage} from '../transaction/EncryptedMessage';
-import {PlainMessage} from '../transaction/PlainMessage';
 import {SignedTransaction} from '../transaction/SignedTransaction';
 import {Transaction} from '../transaction/Transaction';
 import {Address} from './Address';

src/model/transaction/EncryptedMessage.ts renamed to src/model/message/EncryptedMessage.ts

@@ -42,7 +42,10 @@ export class EncryptedMessage extends Message {
      * @param {NetworkType} networkType - Catapult network type
      * @return {EncryptedMessage}
      */
-    public static create(message: string, recipientPublicAccount: PublicAccount, privateKey, networkType: NetworkType) {
+    public static create(message: string,
+                         recipientPublicAccount: PublicAccount,
+                         privateKey: string,
+                         networkType: NetworkType): EncryptedMessage {
         const signSchema = SHA3Hasher.resolveSignSchema(networkType);
         return new EncryptedMessage(
             Crypto.encode(privateKey,