fix: base32 address formatting (#611)

symbol · Oct 5, 2021 · cea4282 · cea4282
1 parent 27ffcc9
commit cea4282
Show file tree

Hide file tree

Showing 22 changed files with 125 additions and 46 deletions.
diff --git a/catapult-sdk/src/model/ModelSchemaBuilder.js b/catapult-sdk/src/model/ModelSchemaBuilder.js
@@ -57,7 +57,7 @@ class ModelSchemaBuilder {
 				transactionsHash: ModelType.binary,
 				receiptsHash: ModelType.binary,
 				stateHash: ModelType.binary,
-				beneficiaryAddress: ModelType.binary,
+				beneficiaryAddress: ModelType.encodedAddress,
 				feeMultiplier: ModelType.uint32,
 				// optional. How to create subclasses?
 				votingEligibleAccountsCount: ModelType.uint32,
@@ -171,7 +171,7 @@ class ModelSchemaBuilder {
 			},
 			account: {
 				version: ModelType.uint16,
-				address: ModelType.binary,
+				address: ModelType.encodedAddress,
 				addressHeight: ModelType.uint64,
 				publicKey: ModelType.binary,
 				publicKeyHeight: ModelType.uint64,

diff --git a/catapult-sdk/src/model/ModelType.js b/catapult-sdk/src/model/ModelType.js
@@ -59,10 +59,13 @@ const ModelType = {
 	int: SchemaType.max + 10,
 
 	/** Schema property type indicating a boolean value. */
-	boolean: SchemaType.max + 11
+	boolean: SchemaType.max + 11,
+
+	/** Schema property type indicating a binary value as base32Address. */
+	encodedAddress: SchemaType.max + 12
 };
 
 Object.assign(ModelType, SchemaType);
-ModelType.max = ModelType.boolean;
+ModelType.max = ModelType.encodedAddress;
 
 module.exports = ModelType;
diff --git a/catapult-sdk/src/plugins/lockHash.js b/catapult-sdk/src/plugins/lockHash.js
@@ -38,7 +38,7 @@ const lockHashPlugin = {
 		});
 		builder.addSchema('hashLockInfo.lock', {
 			version: ModelType.uint16,
-			ownerAddress: ModelType.binary,
+			ownerAddress: ModelType.encodedAddress,
 			mosaicId: ModelType.uint64HexIdentifier,
 			amount: ModelType.uint64,
 			endHeight: ModelType.uint64,

diff --git a/catapult-sdk/src/plugins/lockSecret.js b/catapult-sdk/src/plugins/lockSecret.js
@@ -38,19 +38,19 @@ const lockSecretPlugin = {
 		});
 		builder.addSchema('secretLockInfo.lock', {
 			version: ModelType.uint16,
-			ownerAddress: ModelType.binary,
+			ownerAddress: ModelType.encodedAddress,
 			mosaicId: ModelType.uint64HexIdentifier,
 			amount: ModelType.uint64,
 			endHeight: ModelType.uint64,
 			status: ModelType.uint8,
 			hashAlgorithm: ModelType.uint8,
 			secret: ModelType.binary,
-			recipientAddress: ModelType.binary,
+			recipientAddress: ModelType.encodedAddress,
 			compositeHash: ModelType.binary
 		});
 
 		builder.addTransactionSupport(EntityType.secretLock, {
-			recipientAddress: ModelType.binary,
+			recipientAddress: ModelType.encodedAddress,
 			secret: ModelType.binary,
 			mosaicId: ModelType.uint64HexIdentifier,
 			amount: ModelType.uint64,
@@ -59,7 +59,7 @@ const lockSecretPlugin = {
 		});
 		builder.addTransactionSupport(EntityType.secretProof, {
 			secret: ModelType.binary,
-			recipientAddress: ModelType.binary,
+			recipientAddress: ModelType.encodedAddress,
 			proof: ModelType.binary,
 			hashAlgorithm: ModelType.uint8
 		});

diff --git a/catapult-sdk/src/plugins/metadata.js b/catapult-sdk/src/plugins/metadata.js
@@ -34,15 +34,15 @@ const constants = { sizes };
 const metadataPlugin = {
 	registerSchema: builder => {
 		builder.addTransactionSupport(EntityType.accountMetadata, {
-			targetAddress: ModelType.binary,
+			targetAddress: ModelType.encodedAddress,
 			scopedMetadataKey: ModelType.uint64HexIdentifier,
 			valueSizeDelta: ModelType.int,
 			valueSize: ModelType.uint16,
 			value: ModelType.binary
 		});
 
 		builder.addTransactionSupport(EntityType.mosaicMetadata, {
-			targetAddress: ModelType.binary,
+			targetAddress: ModelType.encodedAddress,
 			scopedMetadataKey: ModelType.uint64HexIdentifier,
 			targetMosaicId: ModelType.uint64HexIdentifier,
 			valueSizeDelta: ModelType.int,
@@ -51,7 +51,7 @@ const metadataPlugin = {
 		});
 
 		builder.addTransactionSupport(EntityType.namespaceMetadata, {
-			targetAddress: ModelType.binary,
+			targetAddress: ModelType.encodedAddress,
 			scopedMetadataKey: ModelType.uint64HexIdentifier,
 			targetNamespaceId: ModelType.uint64HexIdentifier,
 			valueSizeDelta: ModelType.int,
@@ -67,8 +67,8 @@ const metadataPlugin = {
 		builder.addSchema('metadataEntry', {
 			version: ModelType.uint16,
 			compositeHash: ModelType.binary,
-			sourceAddress: ModelType.binary,
-			targetAddress: ModelType.binary,
+			sourceAddress: ModelType.encodedAddress,
+			targetAddress: ModelType.encodedAddress,
 			scopedMetadataKey: ModelType.uint64HexIdentifier,
 			targetId: ModelType.uint64HexIdentifier,
 			metadataType: ModelType.int,

diff --git a/catapult-sdk/src/plugins/mosaic.js b/catapult-sdk/src/plugins/mosaic.js
@@ -53,7 +53,7 @@ const mosaicPlugin = {
 			id: ModelType.uint64HexIdentifier,
 			supply: ModelType.uint64,
 			startHeight: ModelType.uint64,
-			ownerAddress: ModelType.binary,
+			ownerAddress: ModelType.encodedAddress,
 			revision: ModelType.int,
 			flags: ModelType.uint8,
 			divisibility: ModelType.uint8,

diff --git a/catapult-sdk/src/plugins/multisig.js b/catapult-sdk/src/plugins/multisig.js
@@ -36,20 +36,20 @@ const multisigPlugin = {
 		builder.addTransactionSupport(EntityType.modifyMultisigAccount, {
 			minRemovalDelta: ModelType.int,
 			minApprovalDelta: ModelType.int,
-			addressAdditions: { type: ModelType.array, schemaName: ModelType.binary },
-			addressDeletions: { type: ModelType.array, schemaName: ModelType.binary }
+			addressAdditions: { type: ModelType.array, schemaName: ModelType.encodedAddress },
+			addressDeletions: { type: ModelType.array, schemaName: ModelType.encodedAddress }
 		});
 
 		builder.addSchema('multisigEntry', {
 			multisig: { type: ModelType.object, schemaName: 'multisigEntry.multisig' }
 		});
 		builder.addSchema('multisigEntry.multisig', {
 			version: ModelType.uint16,
-			accountAddress: ModelType.binary,
+			accountAddress: ModelType.encodedAddress,
 			minApproval: ModelType.int,
 			minRemoval: ModelType.int,
-			multisigAddresses: { type: ModelType.array, schemaName: ModelType.binary },
-			cosignatoryAddresses: { type: ModelType.array, schemaName: ModelType.binary }
+			multisigAddresses: { type: ModelType.array, schemaName: ModelType.encodedAddress },
+			cosignatoryAddresses: { type: ModelType.array, schemaName: ModelType.encodedAddress }
 		});
 		builder.addSchema('multisigGraph', {
 			level: ModelType.none,

diff --git a/catapult-sdk/src/plugins/namespace.js b/catapult-sdk/src/plugins/namespace.js
@@ -47,7 +47,7 @@ const namespacePlugin = {
 	registerSchema: builder => {
 		builder.addTransactionSupport(EntityType.aliasAddress, {
 			namespaceId: ModelType.uint64HexIdentifier,
-			address: ModelType.binary,
+			address: ModelType.encodedAddress,
 			aliasAction: ModelType.uint8
 		});
 
@@ -91,7 +91,7 @@ const namespacePlugin = {
 			alias: { type: ModelType.object, schemaName: entity => getAliasBasicType(entity.type) },
 
 			parentId: ModelType.uint64HexIdentifier,
-			ownerAddress: ModelType.binary,
+			ownerAddress: ModelType.encodedAddress,
 
 			startHeight: ModelType.uint64,
 			endHeight: ModelType.uint64
@@ -104,7 +104,7 @@ const namespacePlugin = {
 
 		builder.addSchema('namespaceDescriptor.alias.address', {
 			type: ModelType.uint8,
-			address: ModelType.binary
+			address: ModelType.encodedAddress
 		});
 
 		builder.addSchema('namespaceDescriptor.alias.empty', {
@@ -131,7 +131,7 @@ const namespacePlugin = {
 		});
 
 		builder.addSchema('accountNamesTuple', {
-			address: ModelType.binary,
+			address: ModelType.encodedAddress,
 			names: { type: ModelType.array, schemaName: ModelType.string }
 		});
 	},

diff --git a/catapult-sdk/src/plugins/receipts.js b/catapult-sdk/src/plugins/receipts.js
@@ -51,7 +51,7 @@ const receiptsPlugin = {
 
 		addStatementSchema('addressResolution', {
 			height: ModelType.uint64,
-			unresolved: ModelType.binary,
+			unresolved: ModelType.encodedAddress,
 			resolutionEntries: { type: ModelType.array, schemaName: 'receipts.entry.address' }
 		});
 		addStatementSchema('mosaicResolution', {
@@ -72,7 +72,7 @@ const receiptsPlugin = {
 		// addressResolution statements
 		builder.addSchema('receipts.entry.address', {
 			source: { type: ModelType.object, schemaName: 'receipts.source' },
-			resolved: ModelType.binary
+			resolved: ModelType.encodedAddress
 		});
 
 		// mosaicResolution statements
@@ -85,16 +85,16 @@ const receiptsPlugin = {
 		builder.addSchema('receipts.balanceChange', {
 			version: ModelType.int,
 			type: ModelType.int,
-			targetAddress: ModelType.binary,
+			targetAddress: ModelType.encodedAddress,
 			mosaicId: ModelType.uint64HexIdentifier,
 			amount: ModelType.uint64
 		});
 
 		builder.addSchema('receipts.balanceTransfer', {
 			version: ModelType.int,
 			type: ModelType.int,
-			senderAddress: ModelType.binary,
-			recipientAddress: ModelType.binary,
+			senderAddress: ModelType.encodedAddress,
+			recipientAddress: ModelType.encodedAddress,
 			mosaicId: ModelType.uint64HexIdentifier,
 			amount: ModelType.uint64
 		});

diff --git a/catapult-sdk/src/plugins/restrictions.js b/catapult-sdk/src/plugins/restrictions.js
@@ -126,7 +126,7 @@ const restrictionsPlugin = {
 		});
 		builder.addSchema('accountRestriction.restrictions', {
 			version: ModelType.uint16,
-			address: ModelType.binary,
+			address: ModelType.encodedAddress,
 			restrictions: {
 				type: ModelType.array,
 				schemaName: entity => {
@@ -148,7 +148,7 @@ const restrictionsPlugin = {
 		builder.addTransactionSupport(EntityType.mosaicRestrictionAddress, {
 			mosaicId: ModelType.uint64HexIdentifier,
 			restrictionKey: ModelType.uint64HexIdentifier,
-			targetAddress: ModelType.binary,
+			targetAddress: ModelType.encodedAddress,
 			previousRestrictionValue: ModelType.uint64,
 			newRestrictionValue: ModelType.uint64
 		});
@@ -174,7 +174,7 @@ const restrictionsPlugin = {
 			compositeHash: ModelType.binary,
 			entryType: ModelType.uint32,
 			mosaicId: ModelType.uint64HexIdentifier,
-			targetAddress: ModelType.binary,
+			targetAddress: ModelType.encodedAddress,
 			restrictions: { type: ModelType.array, schemaName: 'mosaicRestrictions.entry.restrictions' }
 		});
 		builder.addSchema('mosaicRestrictions.entry.restrictions', {

diff --git a/catapult-sdk/src/plugins/transfer.js b/catapult-sdk/src/plugins/transfer.js
@@ -33,7 +33,7 @@ const constants = { sizes };
 const transferPlugin = {
 	registerSchema: builder => {
 		builder.addTransactionSupport(EntityType.transfer, {
-			recipientAddress: ModelType.binary,
+			recipientAddress: ModelType.encodedAddress,
 			message: ModelType.binary,
 			mosaics: { type: ModelType.array, schemaName: 'mosaic' }
 		});

diff --git a/catapult-sdk/test/model/ModelFormatterBuilder_spec.js b/catapult-sdk/test/model/ModelFormatterBuilder_spec.js
@@ -35,7 +35,8 @@ const formattingRules = {
 	[ModelType.uint64HexIdentifier]: () => 'uint64HexIdentifier',
 	[ModelType.objectId]: () => 'objectId',
 	[ModelType.string]: () => 'string',
-	[ModelType.int]: () => 'int'
+	[ModelType.int]: () => 'int',
+	[ModelType.encodedAddress]: () => 'encodedAddress'
 };
 
 describe('model formatter builder', () => {
@@ -171,7 +172,7 @@ describe('model formatter builder', () => {
 					transactionsHash: 'binary',
 					receiptsHash: 'binary',
 					stateHash: 'binary',
-					beneficiaryAddress: 'binary'
+					beneficiaryAddress: 'encodedAddress'
 				}
 			});
 		});
@@ -202,7 +203,7 @@ describe('model formatter builder', () => {
 			expect(result).to.deep.equal({
 				id: 'objectId',
 				account: {
-					address: 'binary',
+					address: 'encodedAddress',
 					addressHeight: 'uint64',
 					publicKey: 'binary',
 					publicKeyHeight: 'uint64',

diff --git a/catapult-sdk/test/model/ModelSchemaBuilder_spec.js b/catapult-sdk/test/model/ModelSchemaBuilder_spec.js
@@ -223,7 +223,6 @@ describe('model schema builder', () => {
 				'blockHeader.transactionsHash',
 				'blockHeader.receiptsHash',
 				'blockHeader.stateHash',
-				'blockHeader.beneficiaryAddress',
 				'blockHeader.previousImportanceBlockHash',
 				'blockHeader.signature',
 				'blockHeader.signerPublicKey',
@@ -245,7 +244,6 @@ describe('model schema builder', () => {
 
 				'transactionStatus.hash',
 
-				'account.address',
 				'account.publicKey',
 				'accountLinkPublicKey.publicKey',
 				'votingPublicKey.publicKey',
@@ -416,6 +414,17 @@ describe('model schema builder', () => {
 			]);
 		});
 
+		it('exposes correct encodedAddress properties', () => {
+			// Act:
+			const matchingProperties = extractSchemaPropertiesWithType('encodedAddress');
+
+			// Assert:
+			expect(matchingProperties).to.deep.equal([
+				'blockHeader.beneficiaryAddress',
+				'account.address'
+			]);
+		});
+
 		// endregion
 	});
 

diff --git a/catapult-sdk/test/model/ModelType_spec.js b/catapult-sdk/test/model/ModelType_spec.js
@@ -41,7 +41,8 @@ describe('model type enumeration', () => {
 			uint64HexIdentifier: 12,
 			int: 13,
 			boolean: 14,
-			max: 14
+			encodedAddress: 15,
+			max: 15
 		});
 	});
 });
diff --git a/catapult-sdk/test/plugins/namespace_spec.js b/catapult-sdk/test/plugins/namespace_spec.js
@@ -146,7 +146,8 @@ describe('namespace plugin', () => {
 					[ModelType.uint64HexIdentifier]: () => 'uint64HexIdentifier',
 					[ModelType.objectId]: () => 'objectId',
 					[ModelType.string]: () => 'string',
-					[ModelType.int]: () => 'int'
+					[ModelType.int]: () => 'int',
+					[ModelType.encodedAddress]: () => 'encodedAddress'
 				};
 				const namespaceDescriptorNamespace = {
 					registrationType: null,
@@ -213,7 +214,7 @@ describe('namespace plugin', () => {
 				expect(formattedAlias).to.contain.all.keys(['type', 'address']);
 				expect(formattedAlias).deep.equal({
 					type: 'uint8',
-					address: 'binary'
+					address: 'encodedAddress'
 				});
 			});
 

diff --git a/catapult-sdk/test/plugins/receipts_spec.js b/catapult-sdk/test/plugins/receipts_spec.js
@@ -151,7 +151,8 @@ describe('receipts plugin', () => {
 					[ModelType.uint64HexIdentifier]: () => 'uint64HexIdentifier',
 					[ModelType.objectId]: () => 'objectId',
 					[ModelType.string]: () => 'string',
-					[ModelType.int]: () => 'int'
+					[ModelType.int]: () => 'int',
+					[ModelType.encodedAddress]: () => 'encodedAddress'
 				};
 				const transactionStatement = {
 					statement: {

diff --git a/rest/src/db/dbFormattingRules.js b/rest/src/db/dbFormattingRules.js
@@ -19,7 +19,7 @@
  * along with Catapult.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-const { longToUint64 } = require('./dbUtils');
+const { longToUint64, bufferToUnresolvedAddress } = require('./dbUtils');
 const catapult = require('catapult-sdk');
 const { Binary } = require('mongodb');
 
@@ -49,5 +49,6 @@ module.exports = {
 	// `uint64HexIdentifier` requires branching accountRestrictions->restrictionAdditions provides uint64 as binary
 	[ModelType.uint64HexIdentifier]: value => uint64.toHex(value instanceof Binary ? uint64.fromBytes(value.buffer) : longToUint64(value)),
 	[ModelType.int]: value => value.valueOf(),
-	[ModelType.boolean]: value => value
+	[ModelType.boolean]: value => value,
+	[ModelType.encodedAddress]: value => bufferToUnresolvedAddress(value)
 };