Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: various lint fixes #38

Merged
merged 3 commits into from
Mar 27, 2024
Merged

chore: various lint fixes #38

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5bd9e75
ref: replace VERSION and magic '3' with CURRENT_VERSION
coolaj86 Mar 27, 2024
d16585c
chore: satisfy type checker, remove old ignores, add some necessary c…
coolaj86 Mar 27, 2024
ddc0bb4
doc: use correct 'txId' and 'outputIndex' in error message
coolaj86 Mar 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 54 additions & 50 deletions dashtx.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
* @prop {Function} _createKeyUtils
* @prop {Function} _hash
* @prop {Function} _hashAndSignAll
* @prop {Function} _createMemoScript
*/

/**
Expand Down Expand Up @@ -65,7 +66,7 @@ var DashTx = ("object" === typeof module && exports) || {};

let TxUtils = {};

const VERSION = 3;
const CURRENT_VERSION = 3;
const SATOSHIS = 100000000;

const MAX_U8 = Math.pow(2, 8) - 1;
Expand Down Expand Up @@ -214,10 +215,9 @@ var DashTx = ("object" === typeof module && exports) || {};
* the smallest coin that is bigger or equal to the amount sent + fees,
* or the largest available coins until that total is met.
*/
//@ts-ignore
Tx.createLegacyTx = async function (coins, outputs, changeOutput) {
// TODO bump to 4 for DIP: enforce tx hygiene
let version = 3;
let version = CURRENT_VERSION;

coins = coins.slice(0);
outputs = outputs.slice(0);
Expand All @@ -234,7 +234,6 @@ var DashTx = ("object" === typeof module && exports) || {};
// requires at least one input
taxes += Tx.MAX_INPUT_SIZE;

//@ts-ignore
let subtotal = Tx.sum(outputs);
let total = subtotal + taxes;

Expand All @@ -251,7 +250,6 @@ var DashTx = ("object" === typeof module && exports) || {};
}

if (biggerOrEqual.length) {
//@ts-ignore - not undefined because we just length
input = biggerOrEqual.pop();
}

Expand Down Expand Up @@ -311,7 +309,7 @@ var DashTx = ("object" === typeof module && exports) || {};

return txInfo;
};
//@ts-ignore
//@ts-ignore - old usage - TODO REMOVE for v1
Tx.legacyCreateTx = Tx.createLegacyTx;

Tx.sortBySatsAsc = function (a, b) {
Expand Down Expand Up @@ -481,16 +479,16 @@ var DashTx = ("object" === typeof module && exports) || {};
/** @type {TxGetPublicKey} */
async function getPublicKey(txInput, i, txInputs) {
let privKey = keys[i];
//@ts-ignore
if (!myUtils.toPublicKey) {
throw new Error("type assert: missing 'toPublicKey'");
}
let pubKey = myUtils.toPublicKey(privKey);
if ("string" === typeof pubKey) {
console.warn(
"oops, you gave a publicKey as hex (deprecated) rather than a buffer",
);
//@ts-ignore
pubKey = Tx.utils.hexToBytes(pubKey);
}
//@ts-ignore
return pubKey;
}

Expand Down Expand Up @@ -533,12 +531,15 @@ var DashTx = ("object" === typeof module && exports) || {};
}
}

/** @type {TxInfoSigned} */
let txInfoSigned = {
/** @type {Array<TxInputHashable|TxInputSigned>} */
/** @type {Array<TxInputSigned>} */
inputs: [],
outputs: txInfo.outputs,
version: txInfo.version,
version: txInfo.version || CURRENT_VERSION,
//@ts-ignore - debug only
_DANGER_donate: txInfo._DANGER_donate,
//@ts-ignore
_donation_memo: txInfo._donation_memo,
};

Expand All @@ -549,11 +550,14 @@ var DashTx = ("object" === typeof module && exports) || {};

// temp shim
if (!myUtils.getPublicKey) {
//@ts-ignore
myUtils.getPublicKey = async function (txInput, i, inputs) {
//@ts-ignore
if (!myUtils.getPrivateKey) {
throw new Error("type assert: missing 'getPrivateKey'");
}
let privKey = await myUtils.getPrivateKey(txInput, i, inputs);
//@ts-ignore
if (!myUtils.toPublicKey) {
throw new Error("type assert: missing 'toPublicKey'");
}
let pubKey = await myUtils.toPublicKey(privKey);
if ("string" === typeof pubKey) {
throw new Error("publicKey must be given as a Uint8Array");
Expand All @@ -569,7 +573,6 @@ var DashTx = ("object" === typeof module && exports) || {};
let _sigHashType = txInput.sigHashType ?? sigHashType;
let txHashable = Tx.createHashable(txInfo, i);
let txHashBuf = await Tx.hashPartial(txHashable, _sigHashType);
//@ts-ignore
let privKey = await myUtils.getPrivateKey(txInput, i, txInfo.inputs);

let sigBuf = await myUtils.sign(privKey, txHashBuf);
Expand All @@ -581,7 +584,6 @@ var DashTx = ("object" === typeof module && exports) || {};

let pubKeyHex = txInput.publicKey;
if (!pubKeyHex) {
//@ts-ignore
let pubKey = await myUtils.getPublicKey(txInput, i, txInfo.inputs);
pubKeyHex = Tx.utils.bytesToHex(pubKey);
}
Expand All @@ -594,6 +596,7 @@ var DashTx = ("object" === typeof module && exports) || {};
pubKeyHex = Tx.utils.bytesToHex(pubKeyHex);
}

/** @type TxInputSigned */
let txInputSigned = {
txId: txInput.txId,
outputIndex: txInput.outputIndex,
Expand All @@ -604,23 +607,26 @@ var DashTx = ("object" === typeof module && exports) || {};

// expose _actual_ values used, for debugging
let txHashHex = Tx.utils.bytesToHex(txHashBuf);
txInput._hash = txHashHex;
txInput._signature = sigHex.toString();
txInput._lockScript = txInfo.inputs[i].script;
txInput._publicKey = pubKeyHex;
txInput._sigHashType = _sigHashType;
Object.assign({
_hash: txHashHex,
_signature: sigHex.toString(),
_lockScript: txInfo.inputs[i].script,
_publicKey: pubKeyHex,
_sigHashType: _sigHashType,
});

txInfoSigned.inputs[i] = txInputSigned;
}

let transaction = Tx.createSigned(txInfoSigned);

return {
//@ts-ignore - tsc doesn't support an enum here
inputs: txInfo.inputs,
locktime: txInfo.locktime || 0x0,
outputs: txInfo.outputs,
transaction: transaction,
version: txInfo.version,
version: txInfo.version || CURRENT_VERSION,
};
};

Expand All @@ -640,7 +646,6 @@ var DashTx = ("object" === typeof module && exports) || {};
Tx.createHashable = function (txInfo, inputIndex) {
let txInfoHashable = Object.assign({}, txInfo);
/** @type {Array<TxInputRaw|TxInputHashable>} */
//@ts-ignore
txInfoHashable.inputs = txInfo.inputs.map(function (input, i) {
if (inputIndex !== i) {
return {
Expand Down Expand Up @@ -685,13 +690,15 @@ var DashTx = ("object" === typeof module && exports) || {};
* @param {Boolean} [opts._debug] - bespoke debug output
*/
Tx._create = function ({
version = VERSION,
version = CURRENT_VERSION,
inputs,
locktime = 0x0,
outputs,
/* maxFee = 10000, */
_debug = false,
//@ts-ignore - debug only
_DANGER_donate = false,
//@ts-ignore
_donation_memo,
}) {
let sep = "";
Expand All @@ -716,11 +723,9 @@ var DashTx = ("object" === typeof module && exports) || {};
let inputHex = [];
// txMap.inputs.push(inputHex);

//@ts-ignore
let txId = input.txId;

if (!txId) {
throw new Error("missing required utxo property 'txid'");
throw new Error("missing required utxo property 'txId'");
}

if (64 !== txId.length) {
Expand All @@ -734,29 +739,36 @@ var DashTx = ("object" === typeof module && exports) || {};
let reverseTxId = Tx.utils.reverseHex(txId);
inputHex.push(reverseTxId);

//@ts-ignore
let voutIndex = input.outputIndex;
if (isNaN(voutIndex)) {
throw new Error(
"expected utxo property 'vout' to be an integer representing this input's previous output index",
"expected utxo property 'outputIndex' to be an integer representing this input's previous output index",
);
}
let reverseVout = toUint32LE(voutIndex);
inputHex.push(reverseVout);

//@ts-ignore - enum types not handled properly here
if (input.signature) {
//@ts-ignore
let sigHashTypeVar = Tx.utils.toVarInt(input.sigHashType);
//@ts-ignore
let sig = `${input.signature}${sigHashTypeVar}`;
let sigSize = Tx.utils.toVarInt(sig.length / 2);

//@ts-ignore
let keySize = Tx.utils.toVarInt(input.publicKey.length / 2);
//@ts-ignore
let sigScript = `${sigSize}${sig}${keySize}${input.publicKey}`;
let sigScriptLen = sigScript.length / 2;
let sigScriptLenSize = Tx.utils.toVarInt(sigScriptLen);
inputHex.push(sigScriptLenSize);
inputHex.push(sigScript);
//@ts-ignore
} else if (input.script) {
//@ts-ignore
let lockScript = input.script;
//@ts-ignore
let lockScriptLen = input.script.length / 2;
let lockScriptLenSize = Tx.utils.toVarInt(lockScriptLen);
inputHex.push(lockScriptLenSize);
Expand Down Expand Up @@ -867,7 +879,6 @@ var DashTx = ("object" === typeof module && exports) || {};
* @param {String} memoHex - the memo bytes, in hex
* @returns {Array<String>} - memo script hex
*/
//@ts-ignore
Tx._createMemoScript = function (memoHex, i = 0) {
let outputHex = [];
let satoshis = toUint64LE(0);
Expand Down Expand Up @@ -1079,10 +1090,7 @@ var DashTx = ("object" === typeof module && exports) || {};
return sigBuf;
};

/**
* @param {Uint8Array} privateKey
* @returns {String} - pubKeyHash in the raw (hex)
*/
/** @type TxToPublicKey */
TxUtils.toPublicKey = function (privateKey) {
let Secp256k1 =
//@ts-ignore
Expand All @@ -1093,6 +1101,7 @@ var DashTx = ("object" === typeof module && exports) || {};
return pubKeyBuf;
};

/** @type TxToVarInt */
TxUtils.toVarInt = function (n) {
//@ts-ignore - see https://github.com/microsoft/TypeScript/issues/57953
if (n < 253) {
Expand All @@ -1119,8 +1128,7 @@ var DashTx = ("object" === typeof module && exports) || {};

if ("bigint" !== typeof n) {
let err = new Error(E_LITTLE_INT);
//@ts-ignore
err.code = "E_LITTLE_INT";
Object.assign(err, { code: "E_LITTLE_INT" });
throw err;
}

Expand All @@ -1129,8 +1137,7 @@ var DashTx = ("object" === typeof module && exports) || {};
}

let err = new Error(E_TOO_BIG_INT);
//@ts-ignore
err.code = "E_TOO_BIG_INT";
Object.assign(err, { code: "E_TOO_BIG_INT" });
throw err;
};

Expand Down Expand Up @@ -1182,6 +1189,7 @@ var DashTx = ("object" === typeof module && exports) || {};
return hex;
}

/** @type TxToVarIntSize */
TxUtils.toVarIntSize = function (n) {
//@ts-ignore - see https://github.com/microsoft/TypeScript/issues/57953
if (n < 253) {
Expand All @@ -1204,16 +1212,11 @@ var DashTx = ("object" === typeof module && exports) || {};
}

let err = new Error(E_TOO_BIG_INT);
//@ts-ignore
err.code = "E_TOO_BIG_INT";
Object.assign(err, { code: "E_TOO_BIG_INT" });
throw err;
};

/**
* @param {Uint8Array} u8
* @returns {String} hex
*/
//@ts-ignore
/** @type {TxBytesToHex} */
TxUtils.bytesToHex = function (u8) {
/** @type {Array<String>} */
let hex = [];
Expand All @@ -1227,6 +1230,7 @@ var DashTx = ("object" === typeof module && exports) || {};
};
TxUtils.u8ToHex = TxUtils.bytesToHex;

/** @type {TxStringToHex} */
TxUtils.strToHex = function (str) {
let encoder = new TextEncoder();
let bytes = encoder.encode(str);
Expand Down Expand Up @@ -1259,7 +1263,7 @@ if ("object" === typeof module) {
/**
* @typedef TxDeps
* @prop {TxSign} sign
* @prop {TxToPublicKey} [toPublicKey] - deprecated
* @prop {TxToPublicKey} [toPublicKey]
* @prop {TxGetPrivateKey} [getPrivateKey]
* @prop {TxGetPublicKey} [getPublicKey]
*/
Expand Down Expand Up @@ -1425,15 +1429,15 @@ if ("object" === typeof module) {
* @param {TxInputHashable} txInput
* @param {Uint53} i
* @param {Array<TxInputRaw|TxInputHashable>} txInputs
* @returns {Uint8Array} - private key Uint8Array
* @returns {Promise<TxPrivateKey>} - private key Uint8Array
*/

/**
* @callback TxGetPublicKey
* @param {TxInputHashable} txInput
* @param {Uint53} i
* @param {Array<TxInputRaw|TxInputHashable>} txInputs
* @returns {Uint8Array} - public key Uint8Array
* @returns {Promise<TxPublicKey>} - public key Uint8Array
*/

/**
Expand All @@ -1460,7 +1464,7 @@ if ("object" === typeof module) {
* @param {Array<TxInputUnspent>} coins
* @param {Array<TxOutput>} outputs
* @param {TxOutput} changeOutput - object with 0 satoshis and change address, pubKeyHash, or script
* @returns {TxInfo}
* @returns {Promise<TxInfo>}
*/

/**
Expand All @@ -1473,7 +1477,7 @@ if ("object" === typeof module) {
* @callback TxSign
* @param {TxPrivateKey} privateKey
* @param {Uint8Array} txHashBytes
* @returns {TxSignature} - buf
* @returns {Promise<TxSignature>} - buf
*/

/**
Expand Down
Loading