refactor: rename reference script

vacuumlabs · Aug 12, 2022 · 8cd1915 · 8cd1915
1 parent 35c4e53
commit 8cd1915
Show file tree

Hide file tree

Showing 8 changed files with 28 additions and 28 deletions.
diff --git a/src/errors/invalidDataReason.ts b/src/errors/invalidDataReason.ts
@@ -23,9 +23,9 @@ export enum InvalidDataReason {
   OUTPUT_INVALID_ADDRESS_PARAMS = "change address must have path as payment part",
   OUTPUT_INVALID_DATUM_HASH = "invalid datum hash",
   OUTPUT_INVALID_INLINE_DATUM = "invalid inline datum",
-  OUTPUT_INVALID_REF_SCRIPT_HEX = "invalid script hex",
+  OUTPUT_INVALID_REFERENCE_SCRIPT_HEX = "invalid script hex",
   OUTPUT_INCONSISTENT_DATUM = "datum is not consistent with output type",
-  OUTPUT_INCONSISTENT_REF_SCRIPT = "reference script is not consistent with output type",
+  OUTPUT_INCONSISTENT_REFERENCE_SCRIPT = "reference script is not consistent with output type",
 
   MULTIASSET_INVALID_POLICY_NAME = "invalid policy id in a multiasset token bundle",
   MULTIASSET_INVALID_TOKEN_BUNDLE_NOT_ARRAY = "invalid multiasset token bundle - asset groups not an array",
@@ -149,7 +149,7 @@ export enum InvalidDataReason {
   REQUIRED_SIGNER_INVALID_PATH = "invalid path for required signer",
 
   COLLATERAL_INPUT_CONTAINS_DATUM = "collateral return output contains datum",
-  COLLATERAL_INPUT_CONTAINS_REF_SCRIPT = "collateral return output contains reference script",
+  COLLATERAL_INPUT_CONTAINS_REFERENCE_SCRIPT = "collateral return output contains reference script",
 
   TOTAL_COLLATERAL_NOT_VALID = "total collateral not valid",
 

diff --git a/src/interactions/serialization/txOutput.ts b/src/interactions/serialization/txOutput.ts
@@ -48,7 +48,7 @@ export function serializeTxOutputBasicParams(
         : Buffer.from([])
 
     const includeScriptBuffer = getCompatibility(version).supportsBabbage
-        ? serializeOptionFlag(output.refScriptHex != null)
+        ? serializeOptionFlag(output.referenceScriptHex != null)
         : Buffer.from([])
 
     return Buffer.concat([
@@ -104,15 +104,15 @@ export function serializeTxOutputDatum(
 }
 
 export function serializeTxOutputRefScript(
-    refScriptHex: HexString,
+    referenceScriptHex: HexString,
 ): Buffer {
-    const totalScriptSize = refScriptHex.length / 2
+    const totalScriptSize = referenceScriptHex.length / 2
     let chunkHex: HexString
 
     if (totalScriptSize > MAX_CHUNK_SIZE) {
-        chunkHex = refScriptHex.substring(0, MAX_CHUNK_SIZE * 2) as HexString
+        chunkHex = referenceScriptHex.substring(0, MAX_CHUNK_SIZE * 2) as HexString
     } else {
-        chunkHex = refScriptHex
+        chunkHex = referenceScriptHex
     }
     const chunkSize = chunkHex.length / 2
 

diff --git a/src/interactions/signTx.ts b/src/interactions/signTx.ts
@@ -208,16 +208,16 @@ function* signTx_addOutput(
     }
 
     // Reference Script
-    if (output.refScriptHex) {
+    if (output.referenceScriptHex) {
         yield send({
             p1: P1.STAGE_OUTPUTS,
             p2: P2.SCRIPT,
-            data: serializeTxOutputRefScript(output.refScriptHex),
+            data: serializeTxOutputRefScript(output.referenceScriptHex),
             expectedResponseLength: 0,
         })
         // Script chunks
-        if (output.refScriptHex.length / 2 > MAX_CHUNK_SIZE) {
-            yield* signTx_addOutput_sendChunks(output.refScriptHex, P2.SCRIPT_CHUNK)
+        if (output.referenceScriptHex.length / 2 > MAX_CHUNK_SIZE) {
+            yield* signTx_addOutput_sendChunks(output.referenceScriptHex, P2.SCRIPT_CHUNK)
         }
     }
 

diff --git a/src/parsing/transaction.ts b/src/parsing/transaction.ts
@@ -232,7 +232,7 @@ export function parseTransaction(tx: Transaction): ParsedTransaction {
         ? null
         : parseTxOutput(tx.collateralOutput, tx.network)
     validate(collateralOutput?.datum == null, InvalidDataReason.COLLATERAL_INPUT_CONTAINS_DATUM)
-    validate(collateralOutput?.refScriptHex == null, InvalidDataReason.COLLATERAL_INPUT_CONTAINS_REF_SCRIPT)
+    validate(collateralOutput?.referenceScriptHex == null, InvalidDataReason.COLLATERAL_INPUT_CONTAINS_REFERENCE_SCRIPT)
 
     // total collateral
     const totalCollateral = tx.totalCollateral == null
@@ -328,11 +328,11 @@ function parseTxOutput(
         validate(output.format === TxOutputFormat.MAP_BABBAGE, InvalidDataReason.OUTPUT_INCONSISTENT_DATUM)
     }
 
-    const refScriptHex = output.format === TxOutputFormat.MAP_BABBAGE && output.refScriptHex
-        ? parseHexString(output.refScriptHex, InvalidDataReason.OUTPUT_INVALID_REF_SCRIPT_HEX)
+    const referenceScriptHex = output.format === TxOutputFormat.MAP_BABBAGE && output.referenceScriptHex
+        ? parseHexString(output.referenceScriptHex, InvalidDataReason.OUTPUT_INVALID_REFERENCE_SCRIPT_HEX)
         : null
-    if (refScriptHex != null) {
-        validate(output.format === TxOutputFormat.MAP_BABBAGE, InvalidDataReason.OUTPUT_INCONSISTENT_REF_SCRIPT)
+    if (referenceScriptHex != null) {
+        validate(output.format === TxOutputFormat.MAP_BABBAGE, InvalidDataReason.OUTPUT_INCONSISTENT_REFERENCE_SCRIPT)
     }
 
     return {
@@ -341,7 +341,7 @@ function parseTxOutput(
         tokenBundle,
         destination,
         datum,
-        refScriptHex,
+        referenceScriptHex,
     }
 }
 
@@ -524,7 +524,7 @@ export function parseSignTransactionRequest(request: SignTransactionRequest): Pa
         )
         // no reference script in outputs
         validate(
-            tx.outputs.every(out => (out.refScriptHex == null)),
+            tx.outputs.every(out => (out.referenceScriptHex == null)),
             InvalidDataReason.SIGN_MODE_POOL_OWNER__REFERENCE_SCRIPT_NOT_ALLOWED
         )
 
@@ -612,7 +612,7 @@ export function parseSignTransactionRequest(request: SignTransactionRequest): Pa
         )
         // no reference script in outputs
         validate(
-            tx.outputs.every(out => (out.refScriptHex == null)),
+            tx.outputs.every(out => (out.referenceScriptHex == null)),
             InvalidDataReason.SIGN_MODE_POOL_OPERATOR__REFERENCE_SCRIPT_NOT_ALLOWED
         )
 

diff --git a/src/types/internal.ts b/src/types/internal.ts
@@ -380,7 +380,7 @@ export type ParsedOutput = {
     tokenBundle: ParsedAssetGroup<Uint64_str>[];
     destination: OutputDestination;
     datum: ParsedDatum | null;
-    refScriptHex: HexString | null;
+    referenceScriptHex: HexString | null;
 }
 
 export const ASSET_NAME_LENGTH_MAX = 32

diff --git a/src/types/public.ts b/src/types/public.ts
@@ -374,7 +374,7 @@ export type TxOutputBabbage = {
      * Optional reference script
      * (without the #6.24 tag)
      */
-    refScriptHex?: string | null;
+    referenceScriptHex?: string | null;
 };
 
 /**

diff --git a/test/integration/__fixtures__/signTxRejects.ts b/test/integration/__fixtures__/signTxRejects.ts
@@ -1822,6 +1822,6 @@ export const collateralOutputRejectTestcases: TestcaseRejectShelley[] = [
         signingMode: TransactionSigningMode.PLUTUS_TRANSACTION,
         errCls: DeviceStatusError,
         errMsg: DeviceStatusMessages[DeviceStatusCodes.ERR_REJECTED_BY_POLICY],
-        rejectReason: InvalidDataReason.COLLATERAL_INPUT_CONTAINS_REF_SCRIPT,
+        rejectReason: InvalidDataReason.COLLATERAL_INPUT_CONTAINS_REFERENCE_SCRIPT,
     },
 ]
diff --git a/test/integration/__fixtures__/txElements.ts b/test/integration/__fixtures__/txElements.ts
@@ -792,7 +792,7 @@ export const outputs: Record<
             type: DatumType.INLINE,
             datumHex: "5579657420616e6f746865722063686f636f6c617465",
         } ,
-        refScriptHex: "0080f9e2c88e6c817008f3a812ed889b4a4da8e0bd103f86e7335422aa122a946b9ad3d2ddf029d3a828f0468aece76895f15c9efbd69b4277",
+        referenceScriptHex: "0080f9e2c88e6c817008f3a812ed889b4a4da8e0bd103f86e7335422aa122a946b9ad3d2ddf029d3a828f0468aece76895f15c9efbd69b4277",
     },
     datumHashInternal: {
         destination: destinations.internalBaseWithStakingScript,
@@ -887,7 +887,7 @@ export const outputs: Record<
         format: TxOutputFormat.MAP_BABBAGE,
         destination: destinations.externalShelleyBaseScripthashKeyhash,
         amount: 7120787,
-        refScriptHex: "deadbeefdeadbeefdeadbeefdeadbeefdeadbeef",
+        referenceScriptHex: "deadbeefdeadbeefdeadbeefdeadbeefdeadbeef",
     },
     datumHashRefScriptExternalMap: {
         format: TxOutputFormat.MAP_BABBAGE,
@@ -897,7 +897,7 @@ export const outputs: Record<
             type: DatumType.HASH,
             datumHashHex:"ffd4d009f554ba4fd8ed1f1d703244819861a9d34fd4753bcf3ff32f043ce188",
         },
-        refScriptHex: "deadbeefdeadbeefdeadbeefdeadbeefdeadbeef",
+        referenceScriptHex: "deadbeefdeadbeefdeadbeefdeadbeefdeadbeef",
     },
     datumHashRefScript240ExternalMap: {
         format: TxOutputFormat.MAP_BABBAGE,
@@ -907,7 +907,7 @@ export const outputs: Record<
             type: DatumType.HASH,
             datumHashHex:"ffd4d009f554ba4fd8ed1f1d703244819861a9d34fd4753bcf3ff32f043ce188",
         },
-        refScriptHex: "4784392787cc567ac21d7b5346a4a89ae112b7ff7610e402284042aa4e6efca7956a53c3f5cb3ec6745f5e21150f2a77bd71a2adc3f8b9539e9bab41934b477f60a8b302584d1a619ed9b178b5ce6fcad31adc0d6fc17023ede474c09f29fdbfb290a5b30b5240fae5de71168036201772c0d272ae90220181f9bf8c3198e79fc2ae32b076abf4d0e10d3166923ce56994b25c00909e3faab8ef1358c136cd3b197488efc883a7c6cfa3ac63ca9cebc62121c6e22f594420c2abd54e78282adec20ee7dba0e6de65554adb8ee8314f23f86cf7cf0906d4b6c643966baf6c54240c19f4131374e298f38a626a4ad63e61",
+        referenceScriptHex: "4784392787cc567ac21d7b5346a4a89ae112b7ff7610e402284042aa4e6efca7956a53c3f5cb3ec6745f5e21150f2a77bd71a2adc3f8b9539e9bab41934b477f60a8b302584d1a619ed9b178b5ce6fcad31adc0d6fc17023ede474c09f29fdbfb290a5b30b5240fae5de71168036201772c0d272ae90220181f9bf8c3198e79fc2ae32b076abf4d0e10d3166923ce56994b25c00909e3faab8ef1358c136cd3b197488efc883a7c6cfa3ac63ca9cebc62121c6e22f594420c2abd54e78282adec20ee7dba0e6de65554adb8ee8314f23f86cf7cf0906d4b6c643966baf6c54240c19f4131374e298f38a626a4ad63e61",
     },
     datumHashRefScript304ExternalMap: {
         format: TxOutputFormat.MAP_BABBAGE,
@@ -917,7 +917,7 @@ export const outputs: Record<
             type: DatumType.HASH,
             datumHashHex:"ffd4d009f554ba4fd8ed1f1d703244819861a9d34fd4753bcf3ff32f043ce188",
         },
-        refScriptHex: "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeaddeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeaddeadbeef",
+        referenceScriptHex: "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeaddeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeaddeadbeef",
     },
     datumHashWithTokensMap: {
         format: TxOutputFormat.MAP_BABBAGE,