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

fix doc and access order of txid #59

Merged
merged 3 commits into from
Apr 27, 2024
Merged

fix doc and access order of txid #59

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d47a2fc
doc(types): remove docs for previously removed type
coolaj86 Apr 27, 2024
917ad95
doc(types): update @types/node to latest
coolaj86 Apr 27, 2024
d2d194b
doc+ref: fully deprecate .txId in favor of .txid
coolaj86 Apr 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
40 changes: 23 additions & 17 deletions dashtx.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -627,8 +627,8 @@ var DashTx = ("object" === typeof module && exports) || {};
* - ASC `outputIndex` (a.k.a. `output_index`, `vout`)
*/
Tx.sortInputs = function (a, b) {
let aTxid = a.txid || a.txId;
let bTxid = b.txid || b.txId;
let aTxid = a.txId || a.txid;
let bTxid = b.txId || b.txid;
// Ascending Lexicographical on TxId (prev-hash) in-memory (not wire) byte order
if (aTxid > bTxid) {
return 1;
Expand Down Expand Up @@ -988,8 +988,8 @@ var DashTx = ("object" === typeof module && exports) || {};

/** @type TxInputSigned */
let txInputSigned = {
txId: txInput.txId || txInput.txid,
txid: txInput.txId || txInput.txid,
txId: txInput.txId || txInput.txid,
outputIndex: txInput.outputIndex,
signature: sigHex,
publicKey: pubKeyHex,
Expand Down Expand Up @@ -1027,6 +1027,7 @@ var DashTx = ("object" === typeof module && exports) || {};
return {
//@ts-ignore - workaround for txId (insight) vs txid (dashcore rpc utxo) issue
// (picking 'txId' over 'txid' may have been a mistake in a recent update)
txid: input.txId || input.txid,
txId: input.txId || input.txid,
outputIndex: input.outputIndex,
};
Expand All @@ -1042,8 +1043,8 @@ var DashTx = ("object" === typeof module && exports) || {};
txInfoHashable.inputs = txInfo.inputs.map(function (input, i) {
if (inputIndex !== i) {
return {
txId: input.txId || input.txid,
txid: input.txId || input.txid,
txId: input.txId || input.txid,
outputIndex: input.outputIndex,
};
}
Expand Down Expand Up @@ -1127,20 +1128,20 @@ var DashTx = ("object" === typeof module && exports) || {};
for (let input of inputs) {
let inputHex = [];

let txId = input.txId || input.txid;
if (!txId) {
throw new Error("missing required utxo property 'txId'");
let txid = input.txId || input.txid;
if (!txid) {
throw new Error("missing required utxo property 'txid'");
}

if (64 !== txId.length) {
if (64 !== txid.length) {
throw new Error(
`expected uxto property 'txId' to be a valid 64-character (32-byte) hex string, but got '${txId}' (size ${txId.length})`,
`expected uxto property 'txid' to be a valid 64-character (32-byte) hex string, but got '${txid}' (size ${txid.length})`,
);
}

assertHex(txId, "txId");
assertHex(txid, "txid");

let reverseTxId = Tx.utils.reverseHex(txId);
let reverseTxId = Tx.utils.reverseHex(txid);
inputHex.push(reverseTxId);

let voutIndex = input.outputIndex;
Expand Down Expand Up @@ -1619,7 +1620,8 @@ if ("object" === typeof module) {

/**
* @typedef CoreUtxo
* @property {String} txId
* @property {String} [txId] - deprecated
* @property {String} txid
* @property {Number} outputIndex
* @property {String} address
* @property {String} script
Expand Down Expand Up @@ -1685,7 +1687,8 @@ if ("object" === typeof module) {
/**
* @typedef TxInput
* @prop {String} [address] - BaseCheck58-encoded pubKeyHash
* @prop {String} txId - hex (not pre-reversed)
* @prop {String} [txId] - deprecated
* @prop {String} txid - hex (not pre-reversed)
* @prop {Uint32} outputIndex - index in previous tx's output (vout index)
* @prop {String} signature - hex-encoded ASN.1 (DER) signature (starts with 0x30440220 or 0x30440221)
* @prop {String} [script] - the previous lock script (default: derived from public key as p2pkh)
Expand All @@ -1712,21 +1715,24 @@ if ("object" === typeof module) {
* @typedef TxInputRaw
* @prop {String} [address] - BaseCheck58-encoded pubKeyHash
* @prop {Uint53} [satoshis] - for convenience
* @prop {String} txId - hex (not pre-reversed)
* @prop {String} [txId] - deprecated
* @prop {String} txid - hex (not pre-reversed)
* @prop {Uint32} outputIndex - index in previous tx's output (vout index)
*/

/**
* @typedef TxInputUnspent
* @prop {String} [address] - BaseCheck58-encoded pubKeyHash
* @prop {Uint53} satoshis
* @prop {String} txId - hex (not pre-reversed)
* @prop {String} [txId] - deprecated
* @prop {String} txid - hex (not pre-reversed)
* @prop {Uint32} outputIndex - index in previous tx's output (vout index)
*/

/**
* @typedef TxInputSortable
* @prop {String} txId
* @prop {String} [txId] - deprecated
* @prop {String} txid
* @prop {Uint32} outputIndex
*/

Expand All @@ -1736,7 +1742,7 @@ if ("object" === typeof module) {
*/

/**
* @typedef {Pick<TxInput, "txId"|"outputIndex"|"signature"|"publicKey"|"sigHashType">} TxInputSigned
* @typedef {Pick<TxInput, "txId"|"txid"|"outputIndex"|"signature"|"publicKey"|"sigHashType">} TxInputSigned
*/

/**
Expand Down
1 change: 0 additions & 1 deletion index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,4 @@ module.exports = require("./dashtx.js");
* @typedef {import('./dashtx.js').TxInputSigned} TxInputSigned
* @typedef {import('./dashtx.js').TxOutput} TxOutput
* @typedef {import('./dashtx.js').TxOutputSortable} TxOutputSortable
* @typedef {import('./dashtx.js').TxSignOptions} TxSignOptions
*/
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
"homepage": "https://github.com/dashhive/dashtx.js#readme",
"devDependencies": {
"@dashincubator/secp256k1": "^1.7.1-5",
"@types/node": "^20.11.30",
"@types/node": "^20.12.7",
"dashkeys": "^1.1.0",
"zora": "^5.2.0"
}
Expand Down
Loading