Page MenuHomePhabricator
Differential D13916 Diff 40411 apps/alias-server/test/utilsTests.js

Changeset View

Standalone View

View Options

apps/alias-server/test/utilsTests.js

// Copyright (c) 2023 The Bitcoin developers // Copyright (c) 2023 The Bitcoin developers
// Distributed under the MIT software license, see the accompanying // Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php. // file COPYING or http://www.opensource.org/licenses/mit-license.php.
'use strict'; 'use strict';
const assert = require('assert'); const assert = require('assert');
const { const {
getAliasFromHex, getAliasFromHex,
getHexFromAlias, getHexFromAlias,
getAliasBytecount, getAliasBytecount,
isValidAliasString, isValidAliasString,
removeUnconfirmedTxsFromTxHistory, removeUnconfirmedTxsFromTxHistory,
consume,
} = require('../src/utils'); } = require('../src/utils');
const unconfirmedAliasTxs = require('./mocks/unconfirmedAliasTxs');
const { const {
aliasHexConversions, aliasHexConversions,
validAliasStrings, validAliasStrings,
invalidAliasStrings, invalidAliasStrings,
} = require('./mocks/utilsMocks'); } = require('./mocks/utilsMocks');
const { testAddressAliases } = require('./mocks/aliasMocks'); const { generated } = require('./mocks/aliasMocks');
describe('alias-server utils.js', function () { describe('alias-server utils.js', function () {
it('Hexadecimal to utf8 encoding functions work forward and backward. Byte counts match hexadecimal bytes.', function () { it('Hexadecimal to utf8 encoding functions work forward and backward. Byte counts match hexadecimal bytes.', function () {
for (let i = 0; i < aliasHexConversions.length; i += 1) { for (let i = 0; i < aliasHexConversions.length; i += 1) {
const { alias, aliasHex, aliasByteCount } = aliasHexConversions[i]; const { alias, aliasHex, aliasByteCount } = aliasHexConversions[i];
assert.deepEqual(getHexFromAlias(alias), aliasHex); assert.deepEqual(getHexFromAlias(alias), aliasHex);
assert.deepEqual(getAliasFromHex(aliasHex), alias); assert.deepEqual(getAliasFromHex(aliasHex), alias);
assert.deepEqual(getAliasBytecount(alias), aliasByteCount); assert.deepEqual(getAliasBytecount(alias), aliasByteCount);
} }
}); });
it('Recognizes lower case alphanumeric strings as valid alias strings', function () { it('Recognizes lower case alphanumeric strings as valid alias strings', function () {
for (let i = 0; i < validAliasStrings.length; i += 1) { for (let i = 0; i < validAliasStrings.length; i += 1) {
const validAliasString = validAliasStrings[i]; const validAliasString = validAliasStrings[i];
assert.deepEqual(isValidAliasString(validAliasString), true); assert.deepEqual(isValidAliasString(validAliasString), true);
} }
}); });
it('Recognizes strings with characters other than lower case a-z or numbers 0-9 as invalid alias strings', function () { it('Recognizes strings with characters other than lower case a-z or numbers 0-9 as invalid alias strings', function () {
for (let i = 0; i < invalidAliasStrings.length; i += 1) { for (let i = 0; i < invalidAliasStrings.length; i += 1) {
const invalidAliasString = invalidAliasStrings[i]; const invalidAliasString = invalidAliasStrings[i];
assert.deepEqual(isValidAliasString(invalidAliasString), false); assert.deepEqual(isValidAliasString(invalidAliasString), false);
} }
}); });
it('removeUnconfirmedTxsFromTxHistory removes unconfirmed txs from an array of chronik tx history', function () { it('removeUnconfirmedTxsFromTxHistory removes unconfirmed txs from an array of chronik tx history', function () {
// First, clone the mock so that you are not modifying it in place
const txHistoryWithSomeUnconfirmedTxs = JSON.parse(
JSON.stringify(generated.txHistory),
);
// Then, delete the 'block' key of the most recent 3 txs
// NB these do not include valid alias registrations
delete txHistoryWithSomeUnconfirmedTxs[0].block; // db09c578d38f37bd9f2bb69eeb8ecb2e24c5be01aa2914f17d94759aadf71386
delete txHistoryWithSomeUnconfirmedTxs[1].block; // c040ccdc46df2951b2ab0cd6d48cf9db7c518068d1f871e60379ee8ccd1caa0e
delete txHistoryWithSomeUnconfirmedTxs[2].block; // 828201e4680e6617636193d3f2a319daab80a8cc5772b9a5b6e068de639f2d9c
// Manually delete these txs from your expected result
let expectedResult = JSON.parse(JSON.stringify(generated.txHistory));
expectedResult.splice(0, 3);
assert.deepEqual( assert.deepEqual(
removeUnconfirmedTxsFromTxHistory( removeUnconfirmedTxsFromTxHistory(txHistoryWithSomeUnconfirmedTxs),
unconfirmedAliasTxs.concat(testAddressAliases.txHistory), expectedResult,
), );
testAddressAliases.txHistory, });
it('consume returns a string of the requested hex byteCount and modifies the stack for both number and hexString type inputs for byteCount', function () {
const testHexString =
'6a042e78656300154361706974616c4c6574746572735f416e645f2b21150076458db0ed96fe9863fc1ccec9fa2cfab884b0f6';
const stack = { remainingHex: testHexString };
const byteCount = 1;
const opReturnTest = consume(stack, byteCount);
// consume returns the first byte of testHexString
assert.strictEqual(opReturnTest, '6a');
// Verify stack has been modified in place
assert.deepEqual(stack, {
remainingHex:
'042e78656300154361706974616c4c6574746572735f416e645f2b21150076458db0ed96fe9863fc1ccec9fa2cfab884b0f6',
});
// Get prefix length using byteCount type Number input
const prefixLength = consume(stack, 1);
assert.strictEqual(prefixLength, '04');
// Verify stack has been modified in place
assert.deepEqual(stack, {
remainingHex:
'2e78656300154361706974616c4c6574746572735f416e645f2b21150076458db0ed96fe9863fc1ccec9fa2cfab884b0f6',
});
// Get prefix using previous result, a hex string
const prefix = consume(stack, prefixLength);
assert.strictEqual(prefix, '2e786563');
// Verify stack has been modified in place
assert.deepEqual(stack, {
remainingHex:
'00154361706974616c4c6574746572735f416e645f2b21150076458db0ed96fe9863fc1ccec9fa2cfab884b0f6',
});
// Get alias registration version byte
const aliasTxVersionByte = consume(stack, 1);
assert.strictEqual(aliasTxVersionByte, '00');
// Verify stack has been modified in place
assert.deepEqual(stack, {
remainingHex:
'154361706974616c4c6574746572735f416e645f2b21150076458db0ed96fe9863fc1ccec9fa2cfab884b0f6',
});
// Get the alias length
const aliasLength = consume(stack, 1);
assert.strictEqual(aliasLength, '15');
// Verify stack has been modified in place
assert.deepEqual(stack, {
remainingHex:
'4361706974616c4c6574746572735f416e645f2b21150076458db0ed96fe9863fc1ccec9fa2cfab884b0f6',
});
// Get the alias
const aliasHex = consume(stack, aliasLength);
assert.strictEqual(
aliasHex,
'4361706974616c4c6574746572735f416e645f2b21',
);
// Verify stack has been modified in place
assert.deepEqual(stack, {
remainingHex: '150076458db0ed96fe9863fc1ccec9fa2cfab884b0f6',
});
// Get the address length
const addressTypeAndHashLengthHex = consume(stack, 1);
assert.strictEqual(addressTypeAndHashLengthHex, '15');
// Verify stack has been modified in place
assert.deepEqual(stack, {
remainingHex: '0076458db0ed96fe9863fc1ccec9fa2cfab884b0f6',
});
// Get the address type and hash
const addressTypeAndHashHex = consume(
stack,
addressTypeAndHashLengthHex,
);
assert.strictEqual(
addressTypeAndHashHex,
'0076458db0ed96fe9863fc1ccec9fa2cfab884b0f6',
); );
// Verify stack has been modified in place
assert.deepEqual(stack, {
remainingHex: '',
});
}); });
}); });