feat: typed attachment version identifiers

Author: ohager

examples/nodejs/basic/listMessages.js

@@ -1,5 +1,5 @@
 const {
-    isAttachmentVersion,
+    hasAttachment,
     TransactionType,
     TransactionArbitrarySubtype, Address
 } = require('@signumjs/core');
@@ -8,7 +8,7 @@ const {api, askAccount, handleError } = require('../helper');
 
 // here we check for a certain attachment type, and get the text message if not encrypted
 const getMessageText = transaction =>
-    isAttachmentVersion(transaction, 'EncryptedMessage')
+    hasAttachment(transaction, 'EncryptedMessage')
         ? '<encrypted>'
         : transaction.attachment.message;
 

packages/core/src/api/__tests__/e2e/messageApi.spec.e2e.ts

@@ -1,13 +1,15 @@
+import {describe, it, beforeAll, expect} from  "vitest"
 import {loadEnvironment} from './helpers/environment';
 import {ChainService} from '../../../service/chainService';
-import {decryptMessage, generateMasterKeys, getAccountIdFromPublicKey, SignKeys} from '@signumjs/crypto';
+import {decryptMessage, generateSignKeys, getAccountIdFromPublicKey, SignKeys} from '@signumjs/crypto';
 import {getTransaction} from '../../factories/transaction/getTransaction';
-import {isAttachmentVersion} from '../../../attachment';
+import {getAttachmentVersion} from '../../../attachment';
 import {sendEncryptedMessage, sendMessage} from '../../factories/message';
 import {FeeQuantPlanck} from '@signumjs/util';
 import {TransactionId} from '../../../typings/transactionId';
 
 
+
 describe('[E2E] Message Api', () => {
 
     let environment;
@@ -22,10 +24,9 @@ describe('[E2E] Message Api', () => {
             nodeHost: environment.testNetHost,
             apiRootUrl: environment.testNetApiPath
         });
-        vi.setTimeout(environment.timeout);
 
-        senderKeys = generateMasterKeys(environment.testPassphrase);
-        recipientKeys = generateMasterKeys(environment.testRecipientPassphrase);
+        senderKeys = generateSignKeys(environment.testPassphrase);
+        recipientKeys = generateSignKeys(environment.testRecipientPassphrase);
         recipientId = getAccountIdFromPublicKey(recipientKeys.publicKey);
     });
 
@@ -45,7 +46,7 @@ describe('[E2E] Message Api', () => {
         expect(transactionId).not.toBeUndefined();
 
         const transaction = await getTransaction(service)(transactionId.transaction);
-        expect(isAttachmentVersion(transaction, 'PublicKeyAnnouncement')).toBeTruthy();
+        expect(getAttachmentVersion(transaction, 'PublicKeyAnnouncement')).toBeTruthy();
 
     });
 
@@ -65,7 +66,7 @@ describe('[E2E] Message Api', () => {
         expect(transactionId).not.toBeUndefined();
 
         const transaction = await getTransaction(service)(transactionId.transaction);
-        expect(isAttachmentVersion(transaction, 'PublicKeyAnnouncement')).toBeTruthy();
+        expect(getAttachmentVersion(transaction, 'PublicKeyAnnouncement')).toBe(1);
 
     });
 
@@ -88,11 +89,11 @@ describe('[E2E] Message Api', () => {
     it('should get a transaction from BRS with encrypted message and decrypt successfully', async () => {
         const transaction = await getTransaction(service)(environment.testEncryptedMessageTransactionId);
         expect(transaction).not.toBeUndefined();
-        isAttachmentVersion(transaction, 'EncryptedMessage');
         const {encryptedMessage} = transaction.attachment;
-
         const recipientsMessage = decryptMessage(encryptedMessage, transaction.senderPublicKey, recipientKeys.agreementPrivateKey);
+
         const sendersMessage = decryptMessage(encryptedMessage, recipientKeys.publicKey, senderKeys.agreementPrivateKey);
+        expect(getAttachmentVersion(transaction, 'EncryptedMessage')).toBe(1);
         expect(recipientsMessage).toEqual('[E2E] sendEncryptedTextMessage TEST (encrypted)');
         expect(recipientsMessage).toEqual(sendersMessage);
 

packages/core/src/attachment/__tests__/getAttachmentVersion.spec.ts

@@ -1,31 +1,31 @@
+import {describe, it, expect} from "vitest"
 import {getAttachmentVersion} from '../getAttachmentVersion';
+import {Transaction} from '../../typings/transaction';
+
 describe('getAttachmentVersion', () => {
 
     it('return the correct version string', () => {
         const transaction = {
             transaction: '123',
-            attachment: {'version.CustomVersionId': 1, foo: 1}
-        };
+            attachment: {'version.AliasAssignment': 1, foo: 1}
+        } as Transaction;
 
-        const result = getAttachmentVersion(transaction);
-        expect(result).toBe('CustomVersionId');
+        expect( getAttachmentVersion(transaction, "AliasAssignment")).toBe(1);
 
     });
 
     it('returns undefined in case of not existing attachment', () => {
         const transaction = {
             transaction: '123'
-        };
-        const result = getAttachmentVersion(transaction);
-        expect(result).not.toBeDefined();
+        } as Transaction;
+        expect(getAttachmentVersion(transaction, "AliasAssignment")).toBe(0);
     });
 
     it('return undefined in case of not existing version', () => {
         const transaction = {
             transaction: '123',
             attachment: {foo: 123}
-        };
-        const result = getAttachmentVersion(transaction);
-        expect(result).not.toBeDefined();
+        } as Transaction;
+        expect(getAttachmentVersion(transaction, "AliasAssignment")).toBe(0);
     });
 });

packages/core/src/attachment/__tests__/isAttachmentVersion.spec.ts

@@ -1,21 +1,13 @@
 import {Transaction} from '../typings/transaction';
+import {AttachmentVersionIdentifier} from '../typings/attachmentVersionIdentifier';
 
 /**
- * Get the transaction attachment version identifier
- *
- * Attachment types are identified by a field _version.<Identifier>_
- *
+ * Gets the attachment version
  * @param transaction The transaction to be checked
- * @return return _Identifier_, if exists, otherwise `undefined`
+ * @param versionIdentifier The versionIdentifier string, i.e. MultiOutCreation
+ * @return 0 if not existent, or version number
  *
  */
-export function getAttachmentVersion(transaction: Transaction): string {
-    const {attachment} = transaction;
-    if (!attachment) { return undefined; }
-
-    const versionIdentifier = Object.keys(attachment).filter(k => k.startsWith('version'));
-    if (versionIdentifier.length === 0) { return undefined; }
-
-    const identifier = versionIdentifier[0];
-    return identifier.substr(identifier.indexOf('.') + 1);
+export function getAttachmentVersion(transaction: Transaction, versionIdentifier: AttachmentVersionIdentifier): number {
+    return transaction?.attachment?.[`version.${versionIdentifier}`] ?? 0;
 }

packages/core/src/attachment/getAttachmentVersion.ts

@@ -1,9 +1,3 @@
-import {isAttachmentVersion} from './isAttachmentVersion';
-import {getAttachmentVersion} from './getAttachmentVersion';
+export {getAttachmentVersion} from './getAttachmentVersion';
 
-// TODO: create a value object for Attachment
-export {
-    isAttachmentVersion,
-    getAttachmentVersion,
-};
 

packages/core/src/attachment/index.ts

@@ -33,6 +33,7 @@ export * from './typings/assetAccount';
 export * from './typings/assetAccountList';
 export * from './typings/assetBalance';
 export * from './typings/attachment';
+export * from './typings/attachmentVersionIdentifier';
 export * from './typings/balance';
 export * from './typings/block';
 export * from './typings/blockId';

packages/core/src/attachment/isAttachmentVersion.ts

@@ -0,0 +1,45 @@
+export type AttachmentVersionIdentifier = string |
+    "OrdinaryPayment" |
+    "AssetAddTreasuryAccount" |
+    "MultiOutCreation" |
+    "ArbitraryMessage" |
+    "AT Payment" |
+    "AliasAssignment" |
+    "TLDAssignment" |
+    "AliasSell" |
+    "AliasBuy" |
+    "AccountInfo" |
+    "AssetIssuance" |
+    "AssetTransfer" |
+    "AssetMultiTransfer" |
+    "AssetTransferOwnership" |
+    "AssetMint" |
+    "AssetDistributeToHolders" |
+    "AskOrderPlacement" |
+    "BidOrderPlacement" |
+    "AskOrderCancellation" |
+    "BidOrderCancellation" |
+    "DigitalGoodsListing" |
+    "DigitalGoodsDelisting" |
+    "DigitalGoodsPriceChange" |
+    "DigitalGoodsQuantityChange" |
+    "DigitalGoodsPurchase" |
+    "DigitalGoodsDelivery" |
+    "DigitalGoodsFeedback" |
+    "DigitalGoodsRefund" |
+    "EffectiveBalanceLeasing" |
+    "RewardRecipientAssignment" |
+    "CommitmentAdd" |
+    "CommitmentRemove" |
+    "EscrowCreation" |
+    "EscrowSign" |
+    "EscrowResult" |
+    "SubscriptionSubscribe" |
+    "SubscriptionCancel" |
+    "SubscriptionPayment" |
+    "AutomatedTransactionsCreation" |
+    "PublicKeyAnnouncement" |
+    "Message" |
+    "EncryptedMessage" |
+    "EncryptToSelfMessage"
+