fix: clarify endianness of outpointTransactionHash around library

src/lib/compiler/compiler-defaults.ts

@@ -30,7 +30,7 @@ export enum CompilerDefaults {
   /**
    * The default `outpointTransactionHash` of inputs in scenarios.
    */
-  defaultScenarioInputOutpointTransactionHash = '0000000000000000000000000000000000000000000000000000000000000000',
+  defaultScenarioInputOutpointTransactionHash = '0000000000000000000000000000000000000000000000000000000000000001',
   /**
    * The default `sequenceNumber` of inputs in scenarios.
    */

src/lib/compiler/scenarios.spec.ts

@@ -535,11 +535,11 @@ test(
           {
             outpointIndex: 0,
             outpointTransactionHash: hexToBin(
-              '0000000000000000000000000000000000000000000000000000000000000000'
+              '0000000000000000000000000000000000000000000000000000000000000001'
             ),
             sequenceNumber: 0,
             unlockingBytecode: hexToBin(
-              '4130389ff5dbd624dae23cc61e74dbdf51ac34952a2ab1591fc1266e7bb0cc4d232c885b7b181cb9a2996e490895e0297e88c808c7bad8eb2c74bc4ba71f9f759b41'
+              '41d1851c0a464c5d6b5b15452327e187f5c19d0805a2ce821b00b239dcc2de2112335cf481bed0f69c780adf9eda30c3e0706b893b53e0a58fa9fad0628e30d0da41'
             ),
           },
         ],
@@ -591,7 +591,7 @@ test(
   'Cannot generate scenario "does_not_exist": a scenario definition with the identifier does_not_exist is not included in this compiler configuration.'
 );
 
-test.failing(
+test(
   'generateScenario: invalid bytecode value',
   expectScenarioGenerationResult,
   'a',
@@ -601,7 +601,7 @@ test.failing(
       a: { data: { bytecode: { var1: 'invalid' } } },
     },
   },
-  'Cannot generate scenario "a": Compilation error while generating bytecode for "var1": [1, 1] Unknown identifier "invalid".'
+  'Cannot generate scenario "a". Compilation error while generating bytecode for "var1": [1, 1] Unknown identifier "invalid".'
 );
 
 test.failing(
@@ -703,7 +703,7 @@ test(
           {
             outpointIndex: 0,
             outpointTransactionHash: hexToBin(
-              '0000000000000000000000000000000000000000000000000000000000000000'
+              '0000000000000000000000000000000000000000000000000000000000000001'
             ),
             sequenceNumber: 0,
             unlockingBytecode: hexToBin(''),
@@ -722,8 +722,8 @@ test(
   }
 );
 
-test.failing(
-  'generateScenario: unknown locking bytecode script',
+test(
+  'generateScenario: mismatched source outputs and transaction inputs',
   expectScenarioGenerationResult,
   'a',
   'unlock',
@@ -732,10 +732,10 @@ test.failing(
       a: { transaction: { inputs: [{}, {}] } },
     },
   },
-  'Cannot generate scenario "a": the specific input under test in this scenario is ambiguous – "transaction.inputs" must include exactly one input that has "unlockingBytecode" set to "null".'
+  'Cannot generate scenario "a": could not match source outputs with inputs – "sourceOutputs" must be the same length as "transaction.inputs".'
 );
 
-test.failing(
+test(
   'generateScenario: ambiguous input under test',
   expectScenarioGenerationResult,
   'a',
@@ -747,10 +747,10 @@ test.failing(
       },
     },
   },
-  'Cannot generate scenario "a": Cannot generate locking bytecode for output 0: [0, 0] No script with an ID of "unknown" was provided in the compiler configuration.'
+  'Cannot generate scenario "a": Failed compilation of source output at index 0: Cannot resolve "var1" – the "bytecode" property was not provided in the compilation data. Failed compilation of transaction output at index 0: No script with an ID of "unknown" was provided in the compiler configuration.'
 );
 
-test.failing(
+test(
   'generateScenario: no locking script',
   expectScenarioGenerationResult,
   'a',
@@ -762,7 +762,7 @@ test.failing(
       },
     },
   },
-  'Cannot generate scenario "a": Cannot generate locking bytecode for output 0: the locking script unlocked by "unlock" is not provided in this compiler configuration.',
+  'Cannot generate scenario "a" using unlocking script "unlock": the locking script unlocked by "unlock" is not provided in this compiler configuration.',
   {
     unlockingScripts: undefined,
   }

src/lib/compiler/template-types.ts

@@ -318,8 +318,8 @@ export interface AuthenticationTemplateScenarioInput {
    * seen in block explorers and user interfaces (as opposed to little-endian
    * byte order, which is used in standard P2P network messages).
    *
-   * If undefined, this defaults to the "empty" hash:
-   * `0000000000000000000000000000000000000000000000000000000000000000`
+   * If undefined, this defaults to the value:
+   * `0000000000000000000000000000000000000000000000000000000000000001`
    *
    * A.K.A. Outpoint `Transaction ID`
    */

src/lib/message/transaction-encoding.ts

@@ -344,8 +344,8 @@ export const cloneTransactionCommon = <Transaction extends TransactionCommon>(
 /**
  * Compute a transaction hash (A.K.A. "transaction ID" or "TXID") from an
  * encoded transaction in P2P network message order. This is the byte order
- * produced by most sha256 libraries and used in most P2P network messages. It
- * is also the byte order produced by `OP_SHA256` and `OP_HASH256` in the
+ * produced by most sha256 libraries and used by encoded P2P network messages.
+ * It is also the byte order produced by `OP_SHA256` and `OP_HASH256` in the
  * virtual machine.
  *
  * @returns the transaction hash in P2P network message byte order

src/lib/message/transaction-types.ts

@@ -14,9 +14,9 @@ export interface Input<Bytecode = Uint8Array, HashRepresentation = Uint8Array> {
   outpointIndex: number;
   /**
    * The hash of the raw transaction from which this input is spent in
-   * big-endian byte order. This is the byte order typically seen in block
-   * explorers and user interfaces (as opposed to little-endian byte order,
-   * which is used in standard P2P network messages).
+   * user interface byte order ({@link hashTransactionUiOrder}). This is the
+   * byte order typically seen in wallets and block explorers (the reverse of
+   * that used by P2P network messages, the VM, and most SHA-256 libraries).
    *
    * A.K.A. `Transaction ID`
    *

src/lib/schema/ajv/validate-authentication-template.js

@@ -367,7 +367,7 @@ const schema22 = {
         },
         outpointTransactionHash: {
           description:
-            'A 32-byte, hexadecimal-encoded hash of the transaction from which this input is spent in big-endian byte order. This is the byte order typically seen in block explorers and user interfaces (as opposed to little-endian byte order, which is used in standard P2P network messages).\n\nIf undefined, this defaults to the "empty" hash: `0000000000000000000000000000000000000000000000000000000000000000`\n\nA.K.A. Outpoint `Transaction ID`',
+            'A 32-byte, hexadecimal-encoded hash of the transaction from which this input is spent in big-endian byte order. This is the byte order typically seen in block explorers and user interfaces (as opposed to little-endian byte order, which is used in standard P2P network messages).\n\nIf undefined, this defaults to the value: `0000000000000000000000000000000000000000000000000000000000000001`\n\nA.K.A. Outpoint `Transaction ID`',
           type: 'string',
         },
         sequenceNumber: {
@@ -3101,7 +3101,7 @@ const schema35 = {
     },
     outpointTransactionHash: {
       description:
-        'A 32-byte, hexadecimal-encoded hash of the transaction from which this input is spent in big-endian byte order. This is the byte order typically seen in block explorers and user interfaces (as opposed to little-endian byte order, which is used in standard P2P network messages).\n\nIf undefined, this defaults to the "empty" hash: `0000000000000000000000000000000000000000000000000000000000000000`\n\nA.K.A. Outpoint `Transaction ID`',
+        'A 32-byte, hexadecimal-encoded hash of the transaction from which this input is spent in big-endian byte order. This is the byte order typically seen in block explorers and user interfaces (as opposed to little-endian byte order, which is used in standard P2P network messages).\n\nIf undefined, this defaults to the value: `0000000000000000000000000000000000000000000000000000000000000001`\n\nA.K.A. Outpoint `Transaction ID`',
       type: 'string',
     },
     sequenceNumber: {

src/lib/schema/authentication-template.schema.json

@@ -337,7 +337,7 @@
           "type": "number"
         },
         "outpointTransactionHash": {
-          "description": "A 32-byte, hexadecimal-encoded hash of the transaction from which this input is spent in big-endian byte order. This is the byte order typically seen in block explorers and user interfaces (as opposed to little-endian byte order, which is used in standard P2P network messages).\n\nIf undefined, this defaults to the \"empty\" hash: `0000000000000000000000000000000000000000000000000000000000000000`\n\nA.K.A. Outpoint `Transaction ID`",
+          "description": "A 32-byte, hexadecimal-encoded hash of the transaction from which this input is spent in big-endian byte order. This is the byte order typically seen in block explorers and user interfaces (as opposed to little-endian byte order, which is used in standard P2P network messages).\n\nIf undefined, this defaults to the value: `0000000000000000000000000000000000000000000000000000000000000001`\n\nA.K.A. Outpoint `Transaction ID`",
           "type": "string"
         },
         "sequenceNumber": {

src/lib/vm/instruction-sets/common/inspection.ts

@@ -112,7 +112,10 @@ export const opOutpointTxHash = <
   state: State
 ) =>
   useTransactionInput(state, (nextState, [input]) =>
-    pushToStackChecked(nextState, input.outpointTransactionHash.slice())
+    pushToStackChecked(
+      nextState,
+      input.outpointTransactionHash.slice().reverse()
+    )
   );
 
 export const opOutpointIndex = <State extends AuthenticationProgramStateCommon>(

src/lib/vmb-tests/bch-vmb-test-utils.spec.ts

@@ -5,7 +5,7 @@ import { stringifyTestVector, vmbTestGroupToVmbTests } from '../lib.js';
 /* spell-checker: disable */
 test('vmbTestGroupToVmbTests', (t) => {
   const result = vmbTestGroupToVmbTests([
-    'Basic push operations',
+    'Test set',
     [
       [
         'OP_0',
@@ -31,65 +31,65 @@ test('vmbTestGroupToVmbTests', (t) => {
     [
       [
         [
-          '606em',
-          'Basic push operations: OP_0 (A.K.A. OP_PUSHBYTES_0, OP_FALSE): zero is represented by an empty stack item (nonP2SH)',
+          'lqhcn',
+          'Test set: OP_0 (A.K.A. OP_PUSHBYTES_0, OP_FALSE): zero is represented by an empty stack item (nonP2SH)',
           'OP_0',
           'OP_SIZE <0> OP_EQUAL',
-          '02000000020000000000000000000000000000000000000000000000000000000000000000000000006441016bef010b024a4ac48b0d37b6d68866fd5d878cf85e6778e913a43cece4e0c4a176f874b8d092619d67857d189f4b9542576b010687310490c538985edbb94cc32103a524f43d6166ad3567f18b0a5c769c6ab4dc02149f4d5095ccf4e8ffa293e785000000000000000000000000000000000000000000000000000000000000000000000000010000000100000000000100000000000000000a6a08766d625f7465737400000000',
+          '020000000201000000000000000000000000000000000000000000000000000000000000000000000064417dfb529d352908ee0a88a0074c216b09793d6aa8c94c7640bb4ced51eaefc75d0aef61f7685d0307491e2628da3d4f91e86329265a4a58ca27a41ec0b8910779c32103a524f43d6166ad3567f18b0a5c769c6ab4dc02149f4d5095ccf4e8ffa293e785000000000100000000000000000000000000000000000000000000000000000000000000010000000100000000000100000000000000000a6a08766d625f7465737400000000',
           '0210270000000000001976a91460011c6bf3f1dd98cff576437b9d85de780f497488ac102700000000000003820087',
           ['2021_valid', '2022_valid'],
           1,
         ],
         [
-          'm5vzq',
-          'Basic push operations: OP_0 (A.K.A. OP_PUSHBYTES_0, OP_FALSE): zero is represented by an empty stack item (P2SH20)',
+          'y0ql2',
+          'Test set: OP_0 (A.K.A. OP_PUSHBYTES_0, OP_FALSE): zero is represented by an empty stack item (P2SH20)',
           'OP_0',
           'OP_SIZE <0> OP_EQUAL',
-          '02000000020000000000000000000000000000000000000000000000000000000000000000000000006441016bef010b024a4ac48b0d37b6d68866fd5d878cf85e6778e913a43cece4e0c4a176f874b8d092619d67857d189f4b9542576b010687310490c538985edbb94cc32103a524f43d6166ad3567f18b0a5c769c6ab4dc02149f4d5095ccf4e8ffa293e78500000000000000000000000000000000000000000000000000000000000000000000000001000000050003820087000000000100000000000000000a6a08766d625f7465737400000000',
+          '020000000201000000000000000000000000000000000000000000000000000000000000000000000064417dfb529d352908ee0a88a0074c216b09793d6aa8c94c7640bb4ced51eaefc75d0aef61f7685d0307491e2628da3d4f91e86329265a4a58ca27a41ec0b8910779c32103a524f43d6166ad3567f18b0a5c769c6ab4dc02149f4d5095ccf4e8ffa293e78500000000010000000000000000000000000000000000000000000000000000000000000001000000050003820087000000000100000000000000000a6a08766d625f7465737400000000',
           '0210270000000000001976a91460011c6bf3f1dd98cff576437b9d85de780f497488ac102700000000000017a9146b14122b4b3cb280c9ec66f8e2827cf3384010a387',
           ['2021_standard', '2022_standard'],
           1,
         ],
       ],
       [
         [
-          'cjtdh',
-          'Basic push operations: OP_PUSHBYTES_1 with missing bytes (nonP2SH)',
+          '7j2u2',
+          'Test set: OP_PUSHBYTES_1 with missing bytes (nonP2SH)',
           'OP_PUSHBYTES_1',
           'OP_SIZE <1> OP_EQUAL',
-          '02000000020000000000000000000000000000000000000000000000000000000000000000000000006441016bef010b024a4ac48b0d37b6d68866fd5d878cf85e6778e913a43cece4e0c4a176f874b8d092619d67857d189f4b9542576b010687310490c538985edbb94cc32103a524f43d6166ad3567f18b0a5c769c6ab4dc02149f4d5095ccf4e8ffa293e785000000000000000000000000000000000000000000000000000000000000000000000000010000000101000000000100000000000000000a6a08766d625f7465737400000000',
+          '020000000201000000000000000000000000000000000000000000000000000000000000000000000064417dfb529d352908ee0a88a0074c216b09793d6aa8c94c7640bb4ced51eaefc75d0aef61f7685d0307491e2628da3d4f91e86329265a4a58ca27a41ec0b8910779c32103a524f43d6166ad3567f18b0a5c769c6ab4dc02149f4d5095ccf4e8ffa293e785000000000100000000000000000000000000000000000000000000000000000000000000010000000101000000000100000000000000000a6a08766d625f7465737400000000',
           '0210270000000000001976a91460011c6bf3f1dd98cff576437b9d85de780f497488ac102700000000000003825187',
           ['2021_invalid', '2022_invalid'],
           1,
         ],
         [
-          'urv4v',
-          'Basic push operations: OP_PUSHBYTES_1 with missing bytes (P2SH20)',
+          'aqcq3',
+          'Test set: OP_PUSHBYTES_1 with missing bytes (P2SH20)',
           'OP_PUSHBYTES_1',
           'OP_SIZE <1> OP_EQUAL',
-          '02000000020000000000000000000000000000000000000000000000000000000000000000000000006441016bef010b024a4ac48b0d37b6d68866fd5d878cf85e6778e913a43cece4e0c4a176f874b8d092619d67857d189f4b9542576b010687310490c538985edbb94cc32103a524f43d6166ad3567f18b0a5c769c6ab4dc02149f4d5095ccf4e8ffa293e78500000000000000000000000000000000000000000000000000000000000000000000000001000000050103825187000000000100000000000000000a6a08766d625f7465737400000000',
+          '020000000201000000000000000000000000000000000000000000000000000000000000000000000064417dfb529d352908ee0a88a0074c216b09793d6aa8c94c7640bb4ced51eaefc75d0aef61f7685d0307491e2628da3d4f91e86329265a4a58ca27a41ec0b8910779c32103a524f43d6166ad3567f18b0a5c769c6ab4dc02149f4d5095ccf4e8ffa293e78500000000010000000000000000000000000000000000000000000000000000000000000001000000050103825187000000000100000000000000000a6a08766d625f7465737400000000',
           '0210270000000000001976a91460011c6bf3f1dd98cff576437b9d85de780f497488ac102700000000000017a914348babd902f9237b6d28ad1ee00bf6941bc9bddc87',
           ['2021_invalid', '2022_invalid'],
           1,
         ],
       ],
       [
         [
-          '30lcr',
-          'Basic push operations: OP_TXINPUTCOUNT operation exists (nonP2SH)',
+          '536z8',
+          'Test set: OP_TXINPUTCOUNT operation exists (nonP2SH)',
           '<0>',
           'OP_DROP OP_TXINPUTCOUNT <1> OP_EQUAL',
-          '02000000020000000000000000000000000000000000000000000000000000000000000000000000006441016bef010b024a4ac48b0d37b6d68866fd5d878cf85e6778e913a43cece4e0c4a176f874b8d092619d67857d189f4b9542576b010687310490c538985edbb94cc32103a524f43d6166ad3567f18b0a5c769c6ab4dc02149f4d5095ccf4e8ffa293e785000000000000000000000000000000000000000000000000000000000000000000000000010000000100000000000100000000000000000a6a08766d625f7465737400000000',
+          '020000000201000000000000000000000000000000000000000000000000000000000000000000000064417dfb529d352908ee0a88a0074c216b09793d6aa8c94c7640bb4ced51eaefc75d0aef61f7685d0307491e2628da3d4f91e86329265a4a58ca27a41ec0b8910779c32103a524f43d6166ad3567f18b0a5c769c6ab4dc02149f4d5095ccf4e8ffa293e785000000000100000000000000000000000000000000000000000000000000000000000000010000000100000000000100000000000000000a6a08766d625f7465737400000000',
           '0210270000000000001976a91460011c6bf3f1dd98cff576437b9d85de780f497488ac10270000000000000475c35187',
           ['2021_invalid', '2022_valid'],
           1,
         ],
         [
-          '3gtat',
-          'Basic push operations: OP_TXINPUTCOUNT operation exists (P2SH20)',
+          'xw35p',
+          'Test set: OP_TXINPUTCOUNT operation exists (P2SH20)',
           '<0>',
           'OP_DROP OP_TXINPUTCOUNT <1> OP_EQUAL',
-          '02000000020000000000000000000000000000000000000000000000000000000000000000000000006441016bef010b024a4ac48b0d37b6d68866fd5d878cf85e6778e913a43cece4e0c4a176f874b8d092619d67857d189f4b9542576b010687310490c538985edbb94cc32103a524f43d6166ad3567f18b0a5c769c6ab4dc02149f4d5095ccf4e8ffa293e7850000000000000000000000000000000000000000000000000000000000000000000000000100000006000475c35187000000000100000000000000000a6a08766d625f7465737400000000',
+          '020000000201000000000000000000000000000000000000000000000000000000000000000000000064417dfb529d352908ee0a88a0074c216b09793d6aa8c94c7640bb4ced51eaefc75d0aef61f7685d0307491e2628da3d4f91e86329265a4a58ca27a41ec0b8910779c32103a524f43d6166ad3567f18b0a5c769c6ab4dc02149f4d5095ccf4e8ffa293e7850000000001000000000000000000000000000000000000000000000000000000000000000100000006000475c35187000000000100000000000000000a6a08766d625f7465737400000000',
           '0210270000000000001976a91460011c6bf3f1dd98cff576437b9d85de780f497488ac102700000000000017a914e57b1d9d4512a857ac3c1623bceacfd2356463d187',
           ['2021_invalid', '2022_standard'],
           1,