comment and constant name

Author: seebees

modules/encrypt-node/src/framed_encrypt_stream.ts

@@ -55,11 +55,11 @@ export function getFramedEncryptStream (getCipher: GetCipher, messageHeader: Mes
   let pathologicalDrain: Function = noop
   const { frameLength } = messageHeader
 
-  /* Precondition: plaintextLength must be withing bounds.
-   * The Maximum.BYTES_PER_CACHED_KEY_LIMIT is set to be within Number.MAX_SAFE_INTEGER
+  /* Precondition: plaintextLength must be within bounds.
+   * The Maximum.BYTES_PER_MESSAGE is set to be within Number.MAX_SAFE_INTEGER
    * See serialize/identifiers.ts enum Maximum for more details.
    */
-  needs(!plaintextLength || (plaintextLength >= 0 && Maximum.BYTES_PER_CACHED_KEY_LIMIT >= plaintextLength), 'plaintextLength out of bounds.')
+  needs(!plaintextLength || (plaintextLength >= 0 && Maximum.BYTES_PER_MESSAGE >= plaintextLength), 'plaintextLength out of bounds.')
 
   /* Keeping the messageHeader, accumulatingFrame and pathologicalDrain private is the intention here.
    * It is already unlikely that these values could be touched in the current composition of streams,

modules/encrypt-node/test/framed_encrypt_stream.test.ts

@@ -30,7 +30,7 @@ describe('getFramedEncryptStream', () => {
     expect(test._transform).is.a('function')
   })
 
-  it('Precondition: plaintextLength must be withing bounds.', () => {
+  it('Precondition: plaintextLength must be within bounds.', () => {
     const getCipher: any = () => {}
     expect(() => getFramedEncryptStream(getCipher, {} as any, () => {}, -1)).to.throw(Error, 'plaintextLength out of bounds.')
     expect(() => getFramedEncryptStream(getCipher, {} as any, () => {}, Number.MAX_SAFE_INTEGER + 1)).to.throw(Error, 'plaintextLength out of bounds.')

modules/serialize/src/identifiers.ts

@@ -80,6 +80,12 @@ export enum Maximum {
    * or some value larger 2 ** 63.
    */
   BYTES_PER_CACHED_KEY_LIMIT = 2 ** 53 - 1, // eslint-disable-line no-unused-vars
+  /* This value should be Maximum.FRAME_COUNT * Maximum.FRAME_SIZE.
+   * However this would be ~ 2 ** 64, much larger than Number.MAX_SAFE_INTEGER.
+   * For the same reasons outlined above in BYTES_PER_CACHED_KEY_LIMIT
+   * this value is set to 2 ** 53 - 1.
+   */
+  BYTES_PER_MESSAGE = 2 ** 53 - 1, // eslint-disable-line no-unused-vars
   // Maximum number of frames allowed in one message as defined in specification
   FRAME_COUNT = 2 ** 32 - 1, // eslint-disable-line no-unused-vars
   // Maximum bytes allowed in a single frame as defined in specification