fix: Upgraded catbuffer to generated classes using the latest schemas names (#822)

Co-authored-by: Fernando <fernando@symbol.dev>

Author: fboucquez

package-lock.json

@@ -94,7 +94,7 @@
     },
     "dependencies": {
         "@js-joda/core": "^3.2.0",
-        "catbuffer-typescript": "1.0.0",
+        "catbuffer-typescript": "^1.0.1-alpha-202111091444",
         "crypto-js": "^4.0.0",
         "futoin-hkdf": "^1.3.2",
         "js-sha256": "^0.9.0",

package.json

@@ -27,10 +27,10 @@ import {
     ImportanceDto,
     ImportanceHeightDto,
     ImportanceSnapshotBuilder,
-    KeyDto,
     MosaicBuilder,
     PinnedVotingKeyBuilder,
-    VotingKeyDto,
+    PublicKeyDto,
+    VotingPublicKeyDto,
 } from 'catbuffer-typescript';
 import { Convert } from '../../core/format';
 import { Mosaic, MosaicId } from '../mosaic';
@@ -112,16 +112,16 @@ export class AccountInfo {
     public serialize(): Uint8Array {
         const address: AddressDto = this.address.toBuilder();
         const addressHeight: HeightDto = new HeightDto(this.addressHeight.toDTO());
-        const publicKey: KeyDto = new KeyDto(Convert.hexToUint8(this.publicKey));
+        const publicKey: PublicKeyDto = new PublicKeyDto(Convert.hexToUint8(this.publicKey));
         const publicKeyHeight: HeightDto = new HeightDto(this.publicKeyHeight.toDTO());
         const accountType = this.accountType.valueOf();
         const supplementalPublicKeysMask = this.getAccountKeyTypeFlags();
         const votingPublicKeys: PinnedVotingKeyBuilder[] =
             this.supplementalPublicKeys.voting?.map((key) => AccountInfo.toPinnedVotingKeyBuilder(key)) || [];
         const balances: MosaicBuilder[] = this.mosaics.map((m) => AccountInfo.toMosaicBuilder(m));
-        const linkedPublicKey: KeyDto | undefined = AccountInfo.toKeyDto(this?.supplementalPublicKeys?.linked?.publicKey);
-        const nodePublicKey = AccountInfo.toKeyDto(this?.supplementalPublicKeys?.node?.publicKey);
-        const vrfPublicKey = AccountInfo.toKeyDto(this?.supplementalPublicKeys?.vrf?.publicKey);
+        const linkedPublicKey: PublicKeyDto | undefined = AccountInfo.toPublicKeyDto(this?.supplementalPublicKeys?.linked?.publicKey);
+        const nodePublicKey = AccountInfo.toPublicKeyDto(this?.supplementalPublicKeys?.node?.publicKey);
+        const vrfPublicKey = AccountInfo.toPublicKeyDto(this?.supplementalPublicKeys?.vrf?.publicKey);
         const importanceSnapshots: ImportanceSnapshotBuilder = new ImportanceSnapshotBuilder(
             new ImportanceDto(this.importance.toDTO()),
             new ImportanceHeightDto(this.importanceHeight.toDTO()),
@@ -179,21 +179,21 @@ export class AccountInfo {
     }
 
     private static toPinnedVotingKeyBuilder(key: AccountLinkVotingKey): PinnedVotingKeyBuilder {
-        const votingKeyDto = new VotingKeyDto(Convert.hexToUint8(key.publicKey).slice(0, 32));
+        const votingPublicKeyDto = new VotingPublicKeyDto(Convert.hexToUint8(key.publicKey).slice(0, 32));
         const startEpoch: FinalizationEpochDto = new FinalizationEpochDto(key.startEpoch);
         const endEpoch: FinalizationEpochDto = new FinalizationEpochDto(key.endEpoch);
-        return new PinnedVotingKeyBuilder(votingKeyDto, startEpoch, endEpoch);
+        return new PinnedVotingKeyBuilder(votingPublicKeyDto, startEpoch, endEpoch);
     }
 
     private static toMosaicBuilder(m: Mosaic): MosaicBuilder {
         return new MosaicBuilder((m.id as MosaicId).toBuilder(), new AmountDto(m.amount.toDTO()));
     }
 
-    private static toKeyDto(publicKey: string | undefined): KeyDto | undefined {
+    private static toPublicKeyDto(publicKey: string | undefined): PublicKeyDto | undefined {
         if (!publicKey) {
             return undefined;
         }
-        return new KeyDto(Convert.hexToUint8(publicKey));
+        return new PublicKeyDto(Convert.hexToUint8(publicKey));
     }
 
     private static toHeightActivityBucketsBuilder(b: ActivityBucket): HeightActivityBucketBuilder {

src/model/account/AccountInfo.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { KeyDto } from 'catbuffer-typescript';
+import { PublicKeyDto } from 'catbuffer-typescript';
 import { KeyPair } from '../../core/crypto';
 import { Convert } from '../../core/format';
 import { NetworkType } from '../network/NetworkType';
@@ -101,7 +101,7 @@ export class PublicAccount {
     /**
      * Create Builder object
      */
-    toBuilder(): KeyDto {
-        return new KeyDto(Convert.hexToUint8(this.publicKey));
+    toBuilder(): PublicKeyDto {
+        return new PublicKeyDto(Convert.hexToUint8(this.publicKey));
     }
 }

src/model/account/PublicAccount.ts

@@ -112,7 +112,7 @@ export class AccountAddressRestrictionTransaction extends Transaction {
         const builder = isEmbedded
             ? EmbeddedAccountAddressRestrictionTransactionBuilder.loadFromBinary(Convert.hexToUint8(payload))
             : AccountAddressRestrictionTransactionBuilder.loadFromBinary(Convert.hexToUint8(payload));
-        const signerPublicKey = Convert.uint8ToHex(builder.getSignerPublicKey().key);
+        const signerPublicKey = Convert.uint8ToHex(builder.getSignerPublicKey().publicKey);
         const networkType = builder.getNetwork().valueOf();
         const signature = Transaction.getSignatureFromPayload(payload, isEmbedded);
         const transaction = AccountAddressRestrictionTransaction.create(

src/model/transaction/AccountAddressRestrictionTransaction.ts

@@ -19,7 +19,7 @@ import {
     AmountDto,
     EmbeddedAccountKeyLinkTransactionBuilder,
     EmbeddedTransactionBuilder,
-    KeyDto,
+    PublicKeyDto,
     TimestampDto,
     TransactionBuilder,
 } from 'catbuffer-typescript';
@@ -114,14 +114,14 @@ export class AccountKeyLinkTransaction extends Transaction {
         const builder = isEmbedded
             ? EmbeddedAccountKeyLinkTransactionBuilder.loadFromBinary(Convert.hexToUint8(payload))
             : AccountKeyLinkTransactionBuilder.loadFromBinary(Convert.hexToUint8(payload));
-        const signerPublicKey = Convert.uint8ToHex(builder.getSignerPublicKey().key);
+        const signerPublicKey = Convert.uint8ToHex(builder.getSignerPublicKey().publicKey);
         const networkType = builder.getNetwork().valueOf();
         const signature = Transaction.getSignatureFromPayload(payload, isEmbedded);
         const transaction = AccountKeyLinkTransaction.create(
             isEmbedded
                 ? Deadline.createEmtpy()
                 : Deadline.createFromDTO((builder as AccountKeyLinkTransactionBuilder).getDeadline().timestamp),
-            Convert.uint8ToHex(builder.getLinkedPublicKey().key),
+            Convert.uint8ToHex(builder.getLinkedPublicKey().publicKey),
             builder.getLinkAction().valueOf(),
             networkType,
             isEmbedded ? new UInt64([0, 0]) : new UInt64((builder as AccountKeyLinkTransactionBuilder).fee.amount),
@@ -144,7 +144,7 @@ export class AccountKeyLinkTransaction extends Transaction {
             TransactionType.ACCOUNT_KEY_LINK.valueOf(),
             new AmountDto(this.maxFee.toDTO()),
             new TimestampDto(this.deadline.toDTO()),
-            new KeyDto(Convert.hexToUint8(this.linkedPublicKey)),
+            new PublicKeyDto(Convert.hexToUint8(this.linkedPublicKey)),
             this.linkAction.valueOf(),
         );
     }
@@ -159,7 +159,7 @@ export class AccountKeyLinkTransaction extends Transaction {
             this.versionToDTO(),
             this.networkType.valueOf(),
             TransactionType.ACCOUNT_KEY_LINK.valueOf(),
-            new KeyDto(Convert.hexToUint8(this.linkedPublicKey)),
+            new PublicKeyDto(Convert.hexToUint8(this.linkedPublicKey)),
             this.linkAction.valueOf(),
         );
     }

src/model/transaction/AccountKeyLinkTransaction.ts

@@ -132,7 +132,7 @@ export class AccountMetadataTransaction extends Transaction {
         const builder = isEmbedded
             ? EmbeddedAccountMetadataTransactionBuilder.loadFromBinary(Convert.hexToUint8(payload))
             : AccountMetadataTransactionBuilder.loadFromBinary(Convert.hexToUint8(payload));
-        const signerPublicKey = Convert.uint8ToHex(builder.getSignerPublicKey().key);
+        const signerPublicKey = Convert.uint8ToHex(builder.getSignerPublicKey().publicKey);
         const networkType = builder.getNetwork().valueOf();
         const signature = Transaction.getSignatureFromPayload(payload, isEmbedded);
         const transaction = AccountMetadataTransaction.create(

src/model/transaction/AccountMetadataTransaction.ts

@@ -115,7 +115,7 @@ export class AccountMosaicRestrictionTransaction extends Transaction {
         const builder = isEmbedded
             ? EmbeddedAccountMosaicRestrictionTransactionBuilder.loadFromBinary(Convert.hexToUint8(payload))
             : AccountMosaicRestrictionTransactionBuilder.loadFromBinary(Convert.hexToUint8(payload));
-        const signerPublicKey = Convert.uint8ToHex(builder.getSignerPublicKey().key);
+        const signerPublicKey = Convert.uint8ToHex(builder.getSignerPublicKey().publicKey);
         const networkType = builder.getNetwork().valueOf();
         const signature = Transaction.getSignatureFromPayload(payload, isEmbedded);
         const transaction = AccountMosaicRestrictionTransaction.create(

src/model/transaction/AccountMosaicRestrictionTransaction.ts

@@ -110,7 +110,7 @@ export class AccountOperationRestrictionTransaction extends Transaction {
         const builder = isEmbedded
             ? EmbeddedAccountOperationRestrictionTransactionBuilder.loadFromBinary(Convert.hexToUint8(payload))
             : AccountOperationRestrictionTransactionBuilder.loadFromBinary(Convert.hexToUint8(payload));
-        const signer = Convert.uint8ToHex(builder.getSignerPublicKey().key);
+        const signer = Convert.uint8ToHex(builder.getSignerPublicKey().publicKey);
         const networkType = builder.getNetwork().valueOf();
         const signature = Transaction.getSignatureFromPayload(payload, isEmbedded);
         const transaction = AccountOperationRestrictionTransaction.create(

src/model/transaction/AccountOperationRestrictionTransaction.ts

@@ -123,7 +123,7 @@ export class AddressAliasTransaction extends Transaction {
         const builder = isEmbedded
             ? EmbeddedAddressAliasTransactionBuilder.loadFromBinary(Convert.hexToUint8(payload))
             : AddressAliasTransactionBuilder.loadFromBinary(Convert.hexToUint8(payload));
-        const signerPublicKey = Convert.uint8ToHex(builder.getSignerPublicKey().key);
+        const signerPublicKey = Convert.uint8ToHex(builder.getSignerPublicKey().publicKey);
         const networkType = builder.getNetwork().valueOf();
         const signature = Transaction.getSignatureFromPayload(payload, isEmbedded);
         const transaction = AddressAliasTransaction.create(