Merge pull request #262 from rg911/task/JAV-3_model_enhancement

JAV-3 [#244 #242]Transaction models enhancement

Author: rg911

e2e/infrastructure/TransactionHttp.spec.ts

@@ -219,8 +219,8 @@ describe('TransactionHttp', () => {
                 Deadline.create(),
                 account.publicKey,
                 UInt64.fromUint(5),
-                1,
-                new Uint8Array(11),
+                10,
+                Convert.uint8ToUtf8(new Uint8Array(10)),
                 NetworkType.MIJIN_TEST,
             );
 
@@ -264,7 +264,7 @@ describe('TransactionHttp', () => {
                 UInt64.fromUint(5),
                 mosaicId,
                 10,
-                new Uint8Array(10),
+                Convert.uint8ToUtf8(new Uint8Array(10)),
                 NetworkType.MIJIN_TEST,
             );
 
@@ -376,7 +376,7 @@ describe('TransactionHttp', () => {
                 UInt64.fromUint(5),
                 namespaceId,
                 10,
-                new Uint8Array(10),
+                Convert.uint8ToUtf8(new Uint8Array(10)),
                 NetworkType.MIJIN_TEST,
             );
 
@@ -419,7 +419,6 @@ describe('TransactionHttp', () => {
             const mosaicGlobalRestrictionTransaction = MosaicGlobalRestrictionTransaction.create(
                 Deadline.create(),
                 mosaicId,
-                new MosaicId(UInt64.fromUint(0).toDTO()),
                 UInt64.fromUint(60641),
                 UInt64.fromUint(0),
                 MosaicRestrictionType.NONE,
@@ -453,7 +452,6 @@ describe('TransactionHttp', () => {
             const mosaicGlobalRestrictionTransaction = MosaicGlobalRestrictionTransaction.create(
                 Deadline.create(),
                 mosaicId,
-                new MosaicId(UInt64.fromUint(0).toDTO()),
                 UInt64.fromUint(60641),
                 UInt64.fromUint(0),
                 MosaicRestrictionType.GE,
@@ -494,7 +492,6 @@ describe('TransactionHttp', () => {
                 mosaicId,
                 UInt64.fromUint(60641),
                 account3.address,
-                UInt64.fromHex('FFFFFFFFFFFFFFFF'),
                 UInt64.fromUint(2),
                 NetworkType.MIJIN_TEST,
             );

src/core/format/Convert.ts

@@ -174,6 +174,27 @@ export class Convert {
         return result;
     }
 
+    /**
+     * Convert UTF-8 string to Uint8Array
+     * @param {string} input - An string with UTF-8 encoding
+     * @return {Uint8Array}
+     */
+    public static utf8ToUint8 = (input: string): Uint8Array => {
+        const hex = Convert.utf8ToHex(Convert.rstr2utf8(input));
+        return Convert.hexToUint8(hex);
+    }
+
+    /**
+     * Convert Uint8Array to string with UTF-8 encoding
+     * @param {Uint8Array} input - An UTF-8 string
+     * @return {string}
+     */
+    public static uint8ToUtf8 = (input: Uint8Array): string => {
+        // return new TextDecoder().decode(input);
+        const hex = Convert.uint8ToHex(input);
+        return Convert.decodeHex(hex);
+    }
+
     /**
      * @internal decode hex to uft8 string
      * @param hex - Hex input

src/infrastructure/transaction/CreateTransactionFromDTO.ts

@@ -385,7 +385,7 @@ const CreateStandaloneTransactionFromDTO = (transactionDTO, transactionInfo): Tr
             transactionDTO.targetPublicKey,
             UInt64.fromNumericString(transactionDTO.scopedMetadataKey),
             transactionDTO.valueSizeDelta,
-            convert.hexToUint8(transactionDTO.value),
+            convert.decodeHex(transactionDTO.value),
             transactionDTO.signature,
             transactionDTO.signerPublicKey ? PublicAccount.createFromPublicKey(transactionDTO.signerPublicKey,
                     extractNetworkType(transactionDTO.version)) : undefined,
@@ -401,7 +401,7 @@ const CreateStandaloneTransactionFromDTO = (transactionDTO, transactionInfo): Tr
             UInt64.fromNumericString(transactionDTO.scopedMetadataKey),
             new MosaicId(transactionDTO.targetMosaicId),
             transactionDTO.valueSizeDelta,
-            convert.hexToUint8(transactionDTO.value),
+            convert.decodeHex(transactionDTO.value),
             transactionDTO.signature,
             transactionDTO.signerPublicKey ? PublicAccount.createFromPublicKey(transactionDTO.signerPublicKey,
                     extractNetworkType(transactionDTO.version)) : undefined,
@@ -417,7 +417,7 @@ const CreateStandaloneTransactionFromDTO = (transactionDTO, transactionInfo): Tr
             UInt64.fromNumericString(transactionDTO.scopedMetadataKey),
             NamespaceId.createFromEncoded(transactionDTO.targetNamespaceId),
             transactionDTO.valueSizeDelta,
-            convert.hexToUint8(transactionDTO.value),
+            convert.decodeHex(transactionDTO.value),
             transactionDTO.signature,
             transactionDTO.signerPublicKey ? PublicAccount.createFromPublicKey(transactionDTO.signerPublicKey,
                     extractNetworkType(transactionDTO.version)) : undefined,

src/model/transaction/AccountMetadataTransaction.ts

@@ -41,7 +41,8 @@ export class AccountMetadataTransaction extends Transaction {
      * @param targetPublicKey - Public key of the target account.
      * @param scopedMetadataKey - Metadata key scoped to source, target and type.
      * @param valueSizeDelta - Change in value size in bytes.
-     * @param value - Difference between the previous value and new value.
+     * @param value - String value with UTF-8 encoding
+     *                Difference between the previous value and new value.
      *                You can calculate value as xor(previous-value, new-value).
      *                If there is no previous value, use directly the new value.
      * @param maxFee - (Optional) Max fee defined by the sender
@@ -51,7 +52,7 @@ export class AccountMetadataTransaction extends Transaction {
                          targetPublicKey: string,
                          scopedMetadataKey: UInt64,
                          valueSizeDelta: number,
-                         value: Uint8Array,
+                         value: string,
                          networkType: NetworkType,
                          maxFee: UInt64 = new UInt64([0, 0])): AccountMetadataTransaction {
         return new AccountMetadataTransaction(networkType,
@@ -94,9 +95,10 @@ export class AccountMetadataTransaction extends Transaction {
                  */
                 public readonly valueSizeDelta: number,
                 /**
+                 * String value with UTF-8 encoding.
                  * Difference between the previous value and new value.
                  */
-                public readonly value: Uint8Array,
+                public readonly value: string,
                 signature?: string,
                 signer?: PublicAccount,
                 transactionInfo?: TransactionInfo) {
@@ -123,7 +125,7 @@ export class AccountMetadataTransaction extends Transaction {
             Convert.uint8ToHex(builder.getTargetPublicKey().key),
             new UInt64(builder.getScopedMetadataKey()),
             builder.getValueSizeDelta(),
-            builder.getValue(),
+            Convert.uint8ToUtf8(builder.getValue()),
             networkType,
             isEmbedded ? new UInt64([0, 0]) : new UInt64((builder as AccountMetadataTransactionBuilder).fee.amount),
         );
@@ -167,7 +169,7 @@ export class AccountMetadataTransaction extends Transaction {
             new KeyDto(Convert.hexToUint8(this.targetPublicKey)),
             this.scopedMetadataKey.toDTO(),
             this.valueSizeDelta,
-            this.value,
+            Convert.utf8ToUint8(this.value),
         );
         return transactionBuilder.serialize();
     }
@@ -184,7 +186,7 @@ export class AccountMetadataTransaction extends Transaction {
             new KeyDto(Convert.hexToUint8(this.targetPublicKey)),
             this.scopedMetadataKey.toDTO(),
             this.valueSizeDelta,
-            this.value,
+            Convert.utf8ToUint8(this.value),
         );
         return transactionBuilder.serialize();
     }

src/model/transaction/MosaicAddressRestrictionTransaction.ts

@@ -54,19 +54,19 @@ export class MosaicAddressRestrictionTransaction extends Transaction {
      * @param mosaicId - The mosaic id ex: new MosaicId([481110499, 231112638]).
      * @param restrictionKey - The restriction key.
      * @param targetAddress - The affected unresolved address.
-     * @param previousRestrictionValue - The previous restriction value.
      * @param newRestrictionValue - The new restriction value.
      * @param networkType - The network type.
+     * @param previousRestrictionValue - (Optional) The previous restriction value.
      * @param maxFee - (Optional) Max fee defined by the sender
      * @returns {MosaicAddressRestrictionTransaction}
      */
     public static create(deadline: Deadline,
                          mosaicId: MosaicId,
                          restrictionKey: UInt64,
                          targetAddress: Address,
-                         previousRestrictionValue: UInt64,
                          newRestrictionValue: UInt64,
                          networkType: NetworkType,
+                         previousRestrictionValue: UInt64 = UInt64.fromHex('FFFFFFFFFFFFFFFF'),
                          maxFee: UInt64 = new UInt64([0, 0])): MosaicAddressRestrictionTransaction {
         return new MosaicAddressRestrictionTransaction(networkType,
             TransactionVersion.MOSAIC_ADDRESS_RESTRICTION,
@@ -143,9 +143,9 @@ export class MosaicAddressRestrictionTransaction extends Transaction {
             new MosaicId(builder.getMosaicId().unresolvedMosaicId),
             new UInt64(builder.getRestrictionKey()),
             Address.createFromEncoded(Convert.uint8ToHex(builder.getTargetAddress().unresolvedAddress)),
-            new UInt64(builder.getPreviousRestrictionValue()),
             new UInt64(builder.getNewRestrictionValue()),
             networkType,
+            new UInt64(builder.getPreviousRestrictionValue()),
             isEmbedded ? new UInt64([0, 0]) : new UInt64((builder as MosaicAddressRestrictionTransactionBuilder).fee.amount),
         );
         return isEmbedded ?

src/model/transaction/MosaicGlobalRestrictionTransaction.ts

@@ -54,25 +54,25 @@ export class MosaicGlobalRestrictionTransaction extends Transaction {
      *
      * @param deadline - The deadline to include the transaction.
      * @param mosaicId - The mosaic id ex: new MosaicId([481110499, 231112638]).
-     * @param referenceMosaicId - The mosaic id providing the restriction key.
      * @param restrictionKey - The restriction key.
      * @param previousRestrictionValue - The previous restriction value.
      * @param previousRestrictionType - The previous restriction type.
      * @param newRestrictionValue - The new restriction value.
      * @param previousRestrictionType - The previous restriction tpye.
      * @param networkType - The network type.
+     * @param referenceMosaicId - (Optional) The mosaic id providing the restriction key.
      * @param maxFee - (Optional) Max fee defined by the sender
      * @returns {MosaicGlobalRestrictionTransaction}
      */
     public static create(deadline: Deadline,
                          mosaicId: MosaicId,
-                         referenceMosaicId: MosaicId,
                          restrictionKey: UInt64,
                          previousRestrictionValue: UInt64,
                          previousRestrictionType: MosaicRestrictionType,
                          newRestrictionValue: UInt64,
                          newRestrictionType: MosaicRestrictionType,
                          networkType: NetworkType,
+                         referenceMosaicId: MosaicId = new MosaicId(UInt64.fromUint(0).toDTO()),
                          maxFee: UInt64 = new UInt64([0, 0])): MosaicGlobalRestrictionTransaction {
         return new MosaicGlobalRestrictionTransaction(networkType,
             TransactionVersion.MOSAIC_GLOBAL_RESTRICTION,
@@ -158,13 +158,13 @@ export class MosaicGlobalRestrictionTransaction extends Transaction {
             isEmbedded ? Deadline.create() : Deadline.createFromDTO(
                 (builder as MosaicGlobalRestrictionTransactionBuilder).getDeadline().timestamp),
             new MosaicId(builder.getMosaicId().unresolvedMosaicId),
-            new MosaicId(builder.getReferenceMosaicId().unresolvedMosaicId),
             new UInt64(builder.getRestrictionKey()),
             new UInt64(builder.getPreviousRestrictionValue()),
             builder.getPreviousRestrictionType().valueOf(),
             new UInt64(builder.getNewRestrictionValue()),
             builder.getNewRestrictionType().valueOf(),
             networkType,
+            new MosaicId(builder.getReferenceMosaicId().unresolvedMosaicId),
             isEmbedded ? new UInt64([0, 0]) : new UInt64((builder as MosaicGlobalRestrictionTransactionBuilder).fee.amount),
         );
         return isEmbedded ?

src/model/transaction/MosaicMetadataTransaction.ts

@@ -44,7 +44,8 @@ export class MosaicMetadataTransaction extends Transaction {
      * @param scopedMetadataKey - Metadata key scoped to source, target and type.
      * @param targetMosaicId - Target mosaic identifier.
      * @param valueSizeDelta - Change in value size in bytes.
-     * @param value - Difference between the previous value and new value.
+     * @param value - String value with UTF-8 encoding
+     *                Difference between the previous value and new value.
      *                You can calculate value as xor(previous-value, new-value).
      *                If there is no previous value, use directly the new value.
      * @param maxFee - (Optional) Max fee defined by the sender
@@ -55,7 +56,7 @@ export class MosaicMetadataTransaction extends Transaction {
                          scopedMetadataKey: UInt64,
                          targetMosaicId: MosaicId,
                          valueSizeDelta: number,
-                         value: Uint8Array,
+                         value: string,
                          networkType: NetworkType,
                          maxFee: UInt64 = new UInt64([0, 0])): MosaicMetadataTransaction {
         return new MosaicMetadataTransaction(networkType,
@@ -104,9 +105,10 @@ export class MosaicMetadataTransaction extends Transaction {
                  */
                 public readonly valueSizeDelta: number,
                 /**
+                 * String value with UTF-8 encoding.
                  * Difference between the previous value and new value.
                  */
-                public readonly value: Uint8Array,
+                public readonly value: string,
                 signature?: string,
                 signer?: PublicAccount,
                 transactionInfo?: TransactionInfo) {
@@ -134,7 +136,7 @@ export class MosaicMetadataTransaction extends Transaction {
             new UInt64(builder.getScopedMetadataKey()),
             new MosaicId(builder.getTargetMosaicId().unresolvedMosaicId),
             builder.getValueSizeDelta(),
-            builder.getValue(),
+            Convert.uint8ToUtf8(builder.getValue()),
             networkType,
             isEmbedded ? new UInt64([0, 0]) : new UInt64((builder as MosaicMetadataTransactionBuilder).fee.amount),
         );
@@ -180,7 +182,7 @@ export class MosaicMetadataTransaction extends Transaction {
             this.scopedMetadataKey.toDTO(),
             new UnresolvedMosaicIdDto(this.targetMosaicId.id.toDTO()),
             this.valueSizeDelta,
-            this.value,
+            Convert.utf8ToUint8(this.value),
         );
         return transactionBuilder.serialize();
     }
@@ -198,7 +200,7 @@ export class MosaicMetadataTransaction extends Transaction {
             this.scopedMetadataKey.toDTO(),
             new UnresolvedMosaicIdDto(this.targetMosaicId.id.toDTO()),
             this.valueSizeDelta,
-            this.value,
+            Convert.utf8ToUint8(this.value),
         );
         return transactionBuilder.serialize();
     }

src/model/transaction/NamespaceMetadataTransaction.ts

@@ -44,7 +44,8 @@ export class NamespaceMetadataTransaction extends Transaction {
      * @param scopedMetadataKey - Metadata key scoped to source, target and type.
      * @param targetNamespaceId - Target namespace identifier.
      * @param valueSizeDelta - Change in value size in bytes.
-     * @param value - Difference between the previous value and new value.
+     * @param value - String value with UTF-8 encoding
+     *                Difference between the previous value and new value.
      *                You can calculate value as xor(previous-value, new-value).
      *                If there is no previous value, use directly the new value.
      * @param maxFee - (Optional) Max fee defined by the sender
@@ -55,7 +56,7 @@ export class NamespaceMetadataTransaction extends Transaction {
                          scopedMetadataKey: UInt64,
                          targetNamespaceId: NamespaceId,
                          valueSizeDelta: number,
-                         value: Uint8Array,
+                         value: string,
                          networkType: NetworkType,
                          maxFee: UInt64 = new UInt64([0, 0])): NamespaceMetadataTransaction {
         return new NamespaceMetadataTransaction(networkType,
@@ -104,9 +105,10 @@ export class NamespaceMetadataTransaction extends Transaction {
                  */
                 public readonly valueSizeDelta: number,
                 /**
+                 * String value with UTF-8 encoding.
                  * Difference between the previous value and new value.
                  */
-                public readonly value: Uint8Array,
+                public readonly value: string,
                 signature?: string,
                 signer?: PublicAccount,
                 transactionInfo?: TransactionInfo) {
@@ -135,7 +137,7 @@ export class NamespaceMetadataTransaction extends Transaction {
             new UInt64(builder.getScopedMetadataKey()),
             new NamespaceId(builder.getTargetNamespaceId().namespaceId),
             builder.getValueSizeDelta(),
-            builder.getValue(),
+            Convert.uint8ToUtf8(builder.getValue()),
             networkType,
             isEmbedded ? new UInt64([0, 0]) : new UInt64((builder as NamespaceMetadataTransactionBuilder).fee.amount),
         );
@@ -181,7 +183,7 @@ export class NamespaceMetadataTransaction extends Transaction {
             this.scopedMetadataKey.toDTO(),
             new NamespaceIdDto(this.targetNamespaceId.id.toDTO()),
             this.valueSizeDelta,
-            this.value,
+            Convert.utf8ToUint8(this.value),
         );
         return transactionBuilder.serialize();
     }
@@ -199,7 +201,7 @@ export class NamespaceMetadataTransaction extends Transaction {
             this.scopedMetadataKey.toDTO(),
             new NamespaceIdDto(this.targetNamespaceId.id.toDTO()),
             this.valueSizeDelta,
-            this.value,
+            Convert.utf8ToUint8(this.value),
         );
         return transactionBuilder.serialize();
     }