diff --git a/cashtab/src/components/Common/Ticker.js b/cashtab/src/components/Common/Ticker.js
--- a/cashtab/src/components/Common/Ticker.js
+++ b/cashtab/src/components/Common/Ticker.js
@@ -84,45 +84,6 @@
notificationDurationShort: 3,
notificationDurationLong: 5,
localStorageMaxCharacters: 24,
- opReturn: {
- opReturnPrefixHex: '6a',
- opReturnPrefixDec: '106',
- opReturnAppPrefixLengthHex: '04',
- opPushDataOne: '4c',
- appPrefixesHex: {
- eToken: '534c5000',
- cashtab: '00746162',
- cashtabEncrypted: '65746162',
- airdrop: '64726f70',
- aliasRegistration: '2e786563',
- },
- /* encryptedMsgByteLimit context:
- As per `convertToEncryptStruct()` in cashMethods.js which breaks down the ecies-lite library's encryption logic, the encrypted OP_RETURN message that follows pushdata1 (4c) and pushdata (d1) prefixes is 209 bytes, based on a 127 byte message supplied via the frontend.
- These 209 bytes can be broken down into the following:
- - ivbufParam: 16 bytes
- - publicKey: 33 bytes
- - ctbufParam: 128 bytes
- - macParam: 32 bytes
- These byte sizes can be verified via debug logs in `convertToEncryptStruct`.
- The `ctbufParam` is the cipher text buffer, which is the encrypted message content. The other params (ivbuf, pubkey, mac) are all there to validate that the encryption has not been tampered with and facilitate the decryption.
- Based on testing, adding one more character to the message input (127+ bytes in cashtab frontend) will translate to an encryption output message (ivbuf + pubkey + ctbuf + mac) that is larger than 215 bytes (`unencryptedMsgByteLimit`).
- Therefore this encrypted bytesize limit is not derived as a constant delta from `unencryptedMsgByteLimit` like the airdrop message limit.
- */
- encryptedMsgByteLimit: 127,
- /* The max payload per spec is 220 bytes (or 223 bytes including +1 for OP_RETURN and +2 for pushdata opcodes)
- Within this 223 bytes, transaction building will take up 8 bytes, hence unencryptedMsgByteLimit is set to 215 bytes
- i.e.
- 6a
- 04
- [prefix byte]
- [prefix byte]
- [prefix byte]
- [prefix byte]
- 4c [next byte is pushdata byte]
- [pushdata byte] (d7 for 215 on a max-size Cashtab msg)
- */
- unencryptedMsgByteLimit: 215,
- },
settingsValidation: {
fiatCurrency: [
'usd',
diff --git a/cashtab/src/components/Send/Send.js b/cashtab/src/components/Send/Send.js
--- a/cashtab/src/components/Send/Send.js
+++ b/cashtab/src/components/Send/Send.js
@@ -53,6 +53,7 @@
import styled from 'styled-components';
import WalletLabel from 'components/Common/WalletLabel.js';
import { getAddressFromAlias } from 'utils/chronik';
+import { opReturn as opreturnConfig } from 'config/opreturn';
const { TextArea } = Input;
@@ -183,7 +184,7 @@
// Show a confirmation modal on transactions created by populating form from web page button
const [isModalVisible, setIsModalVisible] = useState(false);
- // Airdrop transactions embed the additional tokenId (32 bytes), along with prefix (4 bytes) and two pushdata (2 bytes)// hence setting airdrop tx message limit to 38 bytes less than currency.opReturn.unencryptedMsgByteLimit
+ // Airdrop transactions embed the additional tokenId (32 bytes), along with prefix (4 bytes) and two pushdata (2 bytes)// hence setting airdrop tx message limit to 38 bytes less than opreturnConfig.unencryptedMsgByteLimit
const pushDataByteCount = 1;
const prefixByteCount = 4;
const tokenIdByteCount = 32;
@@ -425,7 +426,7 @@
if (isEncryptedOptionalOpReturnMsg) {
optionalOpReturnMsg = opReturnMsg.substring(
0,
- currency.opReturn.encryptedMsgByteLimit,
+ opreturnConfig.encryptedMsgByteLimit,
);
} else {
optionalOpReturnMsg = opReturnMsg;
@@ -627,11 +628,11 @@
const maxSize =
location && location.state && location.state.airdropTokenId
- ? currency.opReturn.unencryptedMsgByteLimit -
+ ? opreturnConfig.unencryptedMsgByteLimit -
localAirdropTxAddedBytes
: isEncryptedOptionalOpReturnMsg
- ? currency.opReturn.encryptedMsgByteLimit
- : currency.opReturn.unencryptedMsgByteLimit;
+ ? opreturnConfig.encryptedMsgByteLimit
+ : opreturnConfig.unencryptedMsgByteLimit;
if (msgByteSize > maxSize) {
msgError = `Message can not exceed ${maxSize} bytes`;
}
@@ -1045,24 +1046,22 @@
name="opReturnMsg"
placeholder={
isEncryptedOptionalOpReturnMsg
- ? `(max ${currency.opReturn.encryptedMsgByteLimit} bytes)`
+ ? `(max ${opreturnConfig.encryptedMsgByteLimit} bytes)`
: location &&
location.state &&
location.state.airdropTokenId
? `(max ${
- currency.opReturn
- .unencryptedMsgByteLimit -
+ opreturnConfig.unencryptedMsgByteLimit -
localAirdropTxAddedBytes
} bytes)`
- : `(max ${currency.opReturn.unencryptedMsgByteLimit} bytes)`
+ : `(max ${opreturnConfig.unencryptedMsgByteLimit} bytes)`
}
value={
opReturnMsg
? isEncryptedOptionalOpReturnMsg
? opReturnMsg.substring(
0,
- currency.opReturn
- .encryptedMsgByteLimit +
+ opreturnConfig.encryptedMsgByteLimit +
1,
)
: opReturnMsg
diff --git a/cashtab/src/config/opreturn.js b/cashtab/src/config/opreturn.js
new file mode 100644
--- /dev/null
+++ b/cashtab/src/config/opreturn.js
@@ -0,0 +1,44 @@
+// Copyright (c) 2023 The Bitcoin developers
+// Distributed under the MIT software license, see the accompanying
+// file COPYING or http://www.opensource.org/licenses/mit-license.php.
+
+'use strict';
+
+export const opReturn = {
+ opReturnPrefixHex: '6a',
+ opReturnPrefixDec: '106',
+ opPushDataOne: '4c',
+ appPrefixesHex: {
+ eToken: '534c5000',
+ cashtab: '00746162',
+ cashtabEncrypted: '65746162',
+ airdrop: '64726f70',
+ aliasRegistration: '2e786563',
+ },
+ /* encryptedMsgByteLimit context:
+ As per `convertToEncryptStruct()` in cashMethods.js which breaks down the ecies-lite library's encryption logic, the encrypted OP_RETURN message that follows pushdata1 (4c) and pushdata (d1) prefixes is 209 bytes, based on a 127 byte message supplied via the frontend.
+ These 209 bytes can be broken down into the following:
+ - ivbufParam: 16 bytes
+ - publicKey: 33 bytes
+ - ctbufParam: 128 bytes
+ - macParam: 32 bytes
+ These byte sizes can be verified via debug logs in `convertToEncryptStruct`.
+ The `ctbufParam` is the cipher text buffer, which is the encrypted message content. The other params (ivbuf, pubkey, mac) are all there to validate that the encryption has not been tampered with and facilitate the decryption.
+ Based on testing, adding one more character to the message input (127+ bytes in cashtab frontend) will translate to an encryption output message (ivbuf + pubkey + ctbuf + mac) that is larger than 215 bytes (`unencryptedMsgByteLimit`).
+ Therefore this encrypted bytesize limit is not derived as a constant delta from `unencryptedMsgByteLimit` like the airdrop message limit.
+ */
+ encryptedMsgByteLimit: 127,
+ /* The max payload per spec is 220 bytes (or 223 bytes including +1 for OP_RETURN and +2 for pushdata opcodes)
+ Within this 223 bytes, transaction building will take up 8 bytes, hence unencryptedMsgByteLimit is set to 215 bytes
+ i.e.
+ 6a
+ 04
+ [prefix byte]
+ [prefix byte]
+ [prefix byte]
+ [prefix byte]
+ 4c [next byte is pushdata byte]
+ [pushdata byte] (d7 for 215 on a max-size Cashtab msg)
+ */
+ unencryptedMsgByteLimit: 215,
+};
diff --git a/cashtab/src/utils/__mocks__/mockOpReturnParsedArray.js b/cashtab/src/utils/__mocks__/mockOpReturnParsedArray.js
--- a/cashtab/src/utils/__mocks__/mockOpReturnParsedArray.js
+++ b/cashtab/src/utils/__mocks__/mockOpReturnParsedArray.js
@@ -1,4 +1,4 @@
-import { currency } from 'components/Common/Ticker';
+import { opReturn as opreturnConfig } from 'config/opreturn';
export const shortCashtabMessageInputHex = '6a04007461620461736466';
export const longCashtabMessageInputHex =
'6a04007461624ca054657374696e672074686520323535206c696d69742054657374696e672074686520323535206c696d69742054657374696e672074686520323535206c696d69742054657374696e672074686520323535206c696d69742054657374696e672074686520323535206c696d69742054657374696e672074686520323535206c696d69742054657374696e672074686520323535206c696d69742054657374696e';
@@ -48,7 +48,7 @@
];
export const mockParsedETokenOutputArray = [
- currency.opReturn.appPrefixesHex.eToken,
+ opreturnConfig.appPrefixesHex.eToken,
];
export const mockAirdropHexOutput =
diff --git a/cashtab/src/utils/__tests__/cashMethods.test.js b/cashtab/src/utils/__tests__/cashMethods.test.js
--- a/cashtab/src/utils/__tests__/cashMethods.test.js
+++ b/cashtab/src/utils/__tests__/cashMethods.test.js
@@ -114,6 +114,7 @@
mockMultipleOutputs,
} from '../__mocks__/mockTxBuilderData';
import createTokenMock from '../__mocks__/createToken';
+import { opReturn as opreturnConfig } from 'config/opreturn';
it(`OP_RETURN msg byte length matches for an encrypted msg input with a single emoji`, () => {
const msgInput = '🙈';
@@ -1669,9 +1670,9 @@
// verify airdrop hex prefix is contained in the array returned from parseOpReturn()
expect(
result.find(
- element => element === currency.opReturn.appPrefixesHex.airdrop,
+ element => element === opreturnConfig.appPrefixesHex.airdrop,
),
- ).toStrictEqual(currency.opReturn.appPrefixesHex.airdrop);
+ ).toStrictEqual(opreturnConfig.appPrefixesHex.airdrop);
});
test('convertEtokenToEcashAddr successfully converts a valid eToken address to eCash', async () => {
diff --git a/cashtab/src/utils/cashMethods.js b/cashtab/src/utils/cashMethods.js
--- a/cashtab/src/utils/cashMethods.js
+++ b/cashtab/src/utils/cashMethods.js
@@ -10,6 +10,7 @@
import bs58 from 'bs58';
import * as slpMdm from 'slp-mdm';
import * as utxolib from '@bitgo/utxo-lib';
+import { opReturn as opreturnConfig } from 'config/opreturn';
export const getMessageByteSize = (
msgInputStr,
@@ -665,11 +666,11 @@
// utxolib.script.compile(script) will not add pushdata bytes for raw data
// Initialize script array with OP_RETURN byte (6a) as rawdata (i.e. you want compiled result of 6a, not 016a)
- let script = [currency.opReturn.opReturnPrefixDec];
+ let script = [opreturnConfig.opReturnPrefixDec];
// Push alias protocol identifier
script.push(
- Buffer.from(currency.opReturn.appPrefixesHex.aliasRegistration, 'hex'), // '.xec'
+ Buffer.from(opreturnConfig.appPrefixesHex.aliasRegistration, 'hex'), // '.xec'
);
// Push alias protocol tx version to stack
@@ -718,10 +719,10 @@
throw new Error('Invalid OP RETURN script input');
}
- // Note: script.push(Buffer.from(currency.opReturn.opReturnPrefixHex, 'hex')); actually evaluates to '016a'
+ // Note: script.push(Buffer.from(opreturnConfig.opReturnPrefixHex, 'hex')); actually evaluates to '016a'
// instead of keeping the hex string intact. This behavour is specific to the initial script array element.
// To get around this, the bch-js approach of directly using the opReturn prefix in decimal form for the initial entry is used here.
- let script = [currency.opReturn.opReturnPrefixDec]; // initialize script with the OP_RETURN op code (6a) in decimal form (106)
+ let script = [opreturnConfig.opReturnPrefixDec]; // initialize script with the OP_RETURN op code (6a) in decimal form (106)
try {
if (encryptionFlag) {
@@ -730,7 +731,7 @@
// add the encrypted cashtab messaging prefix and encrypted msg to script
script.push(
Buffer.from(
- currency.opReturn.appPrefixesHex.cashtabEncrypted,
+ opreturnConfig.appPrefixesHex.cashtabEncrypted,
'hex',
), // 65746162
);
@@ -744,10 +745,7 @@
// if this was routed from the airdrop component
// add the airdrop prefix to script
script.push(
- Buffer.from(
- currency.opReturn.appPrefixesHex.airdrop,
- 'hex',
- ), // drop
+ Buffer.from(opreturnConfig.appPrefixesHex.airdrop, 'hex'), // drop
);
// add the airdrop token ID to script
script.push(Buffer.from(airdropTokenId, 'hex'));
@@ -756,17 +754,14 @@
if (optionalAliasRegistrationFlag) {
script.push(
Buffer.from(
- currency.opReturn.appPrefixesHex.aliasRegistration,
+ opreturnConfig.appPrefixesHex.aliasRegistration,
'hex',
), // '.xec'
);
} else {
// add the cashtab prefix to script
script.push(
- Buffer.from(
- currency.opReturn.appPrefixesHex.cashtab,
- 'hex',
- ), // 00746162
+ Buffer.from(opreturnConfig.appPrefixesHex.cashtab, 'hex'), // 00746162
);
}
// add the un-encrypted message to script if supplied
@@ -876,7 +871,7 @@
if (
!hexStr ||
typeof hexStr !== 'string' ||
- hexStr.substring(0, 2) !== currency.opReturn.opReturnPrefixHex
+ hexStr.substring(0, 2) !== opreturnConfig.opReturnPrefixHex
) {
return false;
}
@@ -897,7 +892,7 @@
// part 1: check the preceding byte value for the subsequent message
let byteValue = hexStr.substring(0, 2);
let msgByteSize = 0;
- if (byteValue === currency.opReturn.opPushDataOne) {
+ if (byteValue === opreturnConfig.opPushDataOne) {
// if this byte is 4c then the next byte is the message byte size - retrieve the message byte size only
msgByteSize = parseInt(hexStr.substring(2, 4), 16); // hex base 16 to decimal base 10
hexStr = hexStr.slice(4); // strip the 4c + message byte size info
@@ -910,30 +905,28 @@
// part 2: parse the subsequent message based on bytesize
const msgCharLength = 2 * msgByteSize;
message = hexStr.substring(0, msgCharLength);
- if (i === 0 && message === currency.opReturn.appPrefixesHex.eToken) {
+ if (i === 0 && message === opreturnConfig.appPrefixesHex.eToken) {
// add the extracted eToken prefix to array then exit loop
- resultArray[i] = currency.opReturn.appPrefixesHex.eToken;
+ resultArray[i] = opreturnConfig.appPrefixesHex.eToken;
break;
} else if (
i === 0 &&
- message === currency.opReturn.appPrefixesHex.cashtab
+ message === opreturnConfig.appPrefixesHex.cashtab
) {
// add the extracted Cashtab prefix to array
- resultArray[i] = currency.opReturn.appPrefixesHex.cashtab;
+ resultArray[i] = opreturnConfig.appPrefixesHex.cashtab;
} else if (
i === 0 &&
- message === currency.opReturn.appPrefixesHex.cashtabEncrypted
+ message === opreturnConfig.appPrefixesHex.cashtabEncrypted
) {
// add the Cashtab encryption prefix to array
- resultArray[i] = currency.opReturn.appPrefixesHex.cashtabEncrypted;
+ resultArray[i] = opreturnConfig.appPrefixesHex.cashtabEncrypted;
} else if (
i === 0 &&
- message === currency.opReturn.appPrefixesHex.airdrop
+ message === opreturnConfig.appPrefixesHex.airdrop
) {
// add the airdrop prefix to array
- resultArray[i] = currency.opReturn.appPrefixesHex.airdrop;
- // TODO: if i === 1 and message === currency.opReturn.appPrefixesHex.aliasRegistration
- // flag accordingly
+ resultArray[i] = opreturnConfig.appPrefixesHex.airdrop;
} else {
// this is either an external message or a subsequent cashtab message loop to extract the message
resultArray[i] = message;
diff --git a/cashtab/src/utils/chronik.js b/cashtab/src/utils/chronik.js
--- a/cashtab/src/utils/chronik.js
+++ b/cashtab/src/utils/chronik.js
@@ -13,6 +13,7 @@
import ecies from 'ecies-lite';
import wif from 'wif';
import { getPendingAliases } from 'utils/aliasUtils';
+import { opReturn as opreturnConfig } from 'config/opreturn';
export const getTxHistoryPage = async (chronik, hash160, page = 0) => {
let txHistoryPage;
@@ -647,7 +648,7 @@
let message = '';
let txType = parsedOpReturnArray[0];
- if (txType === currency.opReturn.appPrefixesHex.airdrop) {
+ if (txType === opreturnConfig.appPrefixesHex.airdrop) {
// this is to facilitate special Cashtab-specific cases of airdrop txs, both with and without msgs
// The UI via Tx.js can check this airdropFlag attribute in the parsedTx object to conditionally render airdrop-specific formatting if it's true
airdropFlag = true;
@@ -660,7 +661,7 @@
// index 0 now becomes msg prefix, 1 becomes the msg
}
- if (txType === currency.opReturn.appPrefixesHex.cashtab) {
+ if (txType === opreturnConfig.appPrefixesHex.cashtab) {
// if this is an alias registration, render accordingly
// isAliasRegistration = true;
@@ -680,7 +681,7 @@
);
}
} else if (
- txType === currency.opReturn.appPrefixesHex.cashtabEncrypted
+ txType === opreturnConfig.appPrefixesHex.cashtabEncrypted
) {
if (!incoming) {
// outgoing encrypted messages currently can not be decrypted by sender's wallet since the message is encrypted with the recipient's pub key
@@ -740,7 +741,7 @@
isEncryptedMessage = true;
opReturnMessage = decryptedMessage;
} else if (
- txType === currency.opReturn.appPrefixesHex.aliasRegistration
+ txType === opreturnConfig.appPrefixesHex.aliasRegistration
) {
// if this is an alias registration transaction
aliasFlag = true;