fix(address-hooks): use harden (or freeze)

packages/cosmic-proto/src/address-hooks.js

@@ -31,6 +31,10 @@
 import { bech32 } from 'bech32';
 import queryString from 'query-string';
 
+/* global globalThis */
+/** @type {<T>(x: T) => T} */
+const harden = globalThis.harden || Object.freeze;
+
 // ADDRESS_HOOK_VERSION is the version of the address hook format used in this
 // module.
 const ADDRESS_HOOK_VERSION = 0;
@@ -41,11 +45,12 @@ if ((ADDRESS_HOOK_VERSION & 0x0f) !== ADDRESS_HOOK_VERSION) {
 
 // AddressHookMagic is a magic byte prefix that identifies a hooked address.
 // Chosen to make bech32 address hooks that look like "agoric10rch..."
-const ADDRESS_HOOK_MAGIC = new Uint8Array([
+const ADDRESS_HOOK_MAGIC = [
   0x78,
   0xf1,
   0x70, // | ADDRESS_HOOK_VERSION
-]);
+];
+harden(ADDRESS_HOOK_MAGIC);
 
 /**
  * The default maximum number of characters in a bech32-encoded hooked address.
@@ -63,6 +68,9 @@ export const DEFAULT_HOOKED_ADDRESS_CHAR_LIMIT = 1024;
  *      { key: ['value1', null, 'value3'] } // '?key=value1&key&key=value3'
  */
 
+/**
+ * How many bytes are used to store the length of the base address.
+ */
 export const BASE_ADDRESS_LENGTH_BYTES = 2;
 
 /**
@@ -78,8 +86,9 @@ export const decodeBech32 = (
   const rawBytes = bech32.fromWords(words);
 
   const bytes = new Uint8Array(rawBytes);
-  return { prefix, bytes };
+  return harden({ prefix, bytes });
 };
+harden(decodeBech32);
 
 /**
  * @param {string} humanReadablePart
@@ -95,6 +104,7 @@ export const encodeBech32 = (
   const words = bech32.toWords(bytes);
   return bech32.encode(humanReadablePart, words, charLimit);
 };
+harden(encodeBech32);
 
 /**
  * Join raw base address bytes and hook data into a bech32-encoded hooked
@@ -162,6 +172,7 @@ export const joinHookedAddress = (
 
   return encodeBech32(prefix, hookBuf, charLimit);
 };
+harden(joinHookedAddress);
 
 /**
  * @param {string} baseAddress
@@ -175,6 +186,7 @@ export const encodeAddressHook = (baseAddress, query, charLimit) => {
   const hookData = te.encode(`?${queryStr}`);
   return joinHookedAddress(baseAddress, hookData, charLimit);
 };
+harden(encodeAddressHook);
 
 /**
  * @param {string} addressHook
@@ -190,8 +202,9 @@ export const decodeAddressHook = (addressHook, charLimit) => {
 
   /** @type {HookQuery} */
   const query = queryString.parse(hookStr);
-  return { baseAddress, query };
+  return harden({ baseAddress, query });
 };
+harden(decodeAddressHook);
 
 /**
  * @param {string} specimen
@@ -214,7 +227,7 @@ export const splitHookedAddressUnsafe = (
       maybeMagicByte &= 0xf0;
     }
     if (maybeMagicByte !== ADDRESS_HOOK_MAGIC[i]) {
-      return { baseAddress: specimen, hookData: new Uint8Array() };
+      return harden({ baseAddress: specimen, hookData: new Uint8Array() });
     }
   }
 
@@ -242,8 +255,9 @@ export const splitHookedAddressUnsafe = (
 
   const hookData = bytes.subarray(magicLength + b, -BASE_ADDRESS_LENGTH_BYTES);
 
-  return { baseAddress, hookData };
+  return harden({ baseAddress, hookData });
 };
+harden(splitHookedAddressUnsafe);
 
 /**
  * @param {string} specimen
@@ -260,3 +274,4 @@ export const splitHookedAddress = (specimen, charLimit) => {
   }
   throw Error(result);
 };
+harden(splitHookedAddress);