@solana/codecs-data-structures 8.3.0 → 8.4.0-canary-20260918134912

package/dist/index.browser.mjs

@@ -1,6 +1,6 @@
-import { createEncoder, getEncodedSize, createDecoder, combineCodec, assertByteArrayHasEnoughBytesForCodec, transformEncoder, transformDecoder, containsBytes, isFixedSize, assertIsFixedSize, fixEncoderSize, fixDecoderSize } from '@solana/codecs-core';
+import { createEncoder, getEncodedSize, createDecoder, containsBytes, combineCodec, assertByteArrayHasEnoughBytesForCodec, transformEncoder, transformDecoder, isFixedSize, assertIsFixedSize, fixEncoderSize, fixDecoderSize } from '@solana/codecs-core';
 import { getU32Encoder, getU32Decoder, getU8Encoder, getU8Decoder } from '@solana/codecs-numbers';
-import { SolanaError, SOLANA_ERROR__CODECS__INVALID_NUMBER_OF_ITEMS, SOLANA_ERROR__CODECS__INVALID_CONSTANT, SOLANA_ERROR__CODECS__UNION_VARIANT_OUT_OF_RANGE, SOLANA_ERROR__CODECS__INVALID_DISCRIMINATED_UNION_VARIANT, SOLANA_ERROR__CODECS__CANNOT_USE_LEXICAL_VALUES_AS_ENUM_DISCRIMINATORS, SOLANA_ERROR__CODECS__INVALID_ENUM_VARIANT, SOLANA_ERROR__CODECS__ENUM_DISCRIMINATOR_OUT_OF_RANGE, SOLANA_ERROR__CODECS__INVALID_LITERAL_UNION_VARIANT, SOLANA_ERROR__CODECS__LITERAL_UNION_DISCRIMINATOR_OUT_OF_RANGE, SOLANA_ERROR__CODECS__INVALID_PATTERN_MATCH_VALUE, SOLANA_ERROR__CODECS__INVALID_PATTERN_MATCH_BYTES } from '@solana/errors';
+import { SolanaError, SOLANA_ERROR__CODECS__INVALID_NUMBER_OF_ITEMS, SOLANA_ERROR__CODECS__SENTINEL_MISSING_AT_END_OF_BYTES, SOLANA_ERROR__CODECS__SENTINEL_MUST_NOT_BE_EMPTY, SOLANA_ERROR__CODECS__INVALID_CONSTANT, SOLANA_ERROR__CODECS__UNION_VARIANT_OUT_OF_RANGE, SOLANA_ERROR__CODECS__INVALID_DISCRIMINATED_UNION_VARIANT, SOLANA_ERROR__CODECS__CANNOT_USE_LEXICAL_VALUES_AS_ENUM_DISCRIMINATORS, SOLANA_ERROR__CODECS__INVALID_ENUM_VARIANT, SOLANA_ERROR__CODECS__ENUM_DISCRIMINATOR_OUT_OF_RANGE, SOLANA_ERROR__CODECS__INVALID_LITERAL_UNION_VARIANT, SOLANA_ERROR__CODECS__LITERAL_UNION_DISCRIMINATOR_OUT_OF_RANGE, SOLANA_ERROR__CODECS__INVALID_PATTERN_MATCH_VALUE, SOLANA_ERROR__CODECS__INVALID_PATTERN_MATCH_BYTES } from '@solana/errors';
 
 // src/array.ts
 function assertValidNumberOfItemsForCodec(codecDescription, expected, actual) {
@@ -31,13 +31,15 @@ function getMaxSize(codec) {
 // src/array.ts
 function getArrayEncoder(item, config = {}) {
   const size = config.size ?? getU32Encoder();
+  assertValidSize(size);
   const fixedSize = computeArrayLikeCodecSize(size, getFixedSize(item));
   const maxSize = computeArrayLikeCodecSize(size, getMaxSize(item)) ?? void 0;
   return createEncoder({
     ...fixedSize !== null ? { fixedSize } : {
       getSizeFromValue: (array) => {
-        const prefixSize = typeof size === "object" ? getEncodedSize(array.length, size) : 0;
-        return prefixSize + [...array].reduce((all, value) => all + getEncodedSize(value, item), 0);
+        const prefixSize = isPrefixSize(size) ? getEncodedSize(array.length, size) : 0;
+        const suffixSize = isSentinelSize(size) && size.strategy !== "omitted" ? size.sentinel.length : 0;
+        return prefixSize + suffixSize + [...array].reduce((all, value) => all + getEncodedSize(value, item), 0);
       },
       maxSize
     },
@@ -45,18 +47,23 @@ function getArrayEncoder(item, config = {}) {
       if (typeof size === "number") {
         assertValidNumberOfItemsForCodec(config.description ?? "array", size, array.length);
       }
-      if (typeof size === "object") {
+      if (isPrefixSize(size)) {
         offset = size.write(array.length, bytes, offset);
       }
       array.forEach((value) => {
         offset = item.write(value, bytes, offset);
       });
+      if (isSentinelSize(size) && size.strategy !== "omitted") {
+        bytes.set(size.sentinel, offset);
+        offset += size.sentinel.length;
+      }
       return offset;
     }
   });
 }
 function getArrayDecoder(item, config = {}) {
   const size = config.size ?? getU32Decoder();
+  assertValidSize(size);
   const itemSize = getFixedSize(item);
   const fixedSize = computeArrayLikeCodecSize(size, itemSize);
   const maxSize = computeArrayLikeCodecSize(size, getMaxSize(item)) ?? void 0;
@@ -64,7 +71,7 @@ function getArrayDecoder(item, config = {}) {
     ...fixedSize !== null ? { fixedSize } : { maxSize },
     read: (bytes, offset) => {
       const array = [];
-      if (typeof size === "object" && !config.requireSizePrefix && offset >= bytes.length) {
+      if (isPrefixSize(size) && !config.requireSizePrefix && offset >= bytes.length) {
         return [array, offset];
       }
       if (size === "remainder") {
@@ -75,6 +82,29 @@ function getArrayDecoder(item, config = {}) {
         }
         return [array, offset];
       }
+      if (isSentinelSize(size)) {
+        const { sentinel, strategy = "required" } = size;
+        while (true) {
+          if (offset + sentinel.length > bytes.length) {
+            if (strategy === "required") {
+              throw new SolanaError(SOLANA_ERROR__CODECS__SENTINEL_MISSING_AT_END_OF_BYTES, {
+                codecDescription: config.description ?? "array",
+                hexSentinel: hexBytes(sentinel),
+                sentinel
+              });
+            }
+            break;
+          }
+          if (containsBytes(bytes, sentinel, offset)) {
+            offset += sentinel.length;
+            break;
+          }
+          const [value, newOffset2] = item.read(bytes, offset);
+          offset = newOffset2;
+          array.push(value);
+        }
+        return [array, offset];
+      }
       const [resolvedSize, newOffset] = typeof size === "number" ? [size, offset] : size.read(bytes, offset);
       offset = newOffset;
       for (let i = 0; i < resolvedSize; i += 1) {
@@ -94,6 +124,20 @@ function computeArrayLikeCodecSize(size, itemSize) {
   if (size === 0) return 0;
   return itemSize === null ? null : itemSize * size;
 }
+function isPrefixSize(size) {
+  return typeof size === "object" && size !== null && !isSentinelSize(size);
+}
+function isSentinelSize(size) {
+  return typeof size === "object" && size !== null && "__kind" in size && size.__kind === "sentinel";
+}
+function assertValidSize(size) {
+  if (isSentinelSize(size) && size.sentinel.length === 0) {
+    throw new SolanaError(SOLANA_ERROR__CODECS__SENTINEL_MUST_NOT_BE_EMPTY);
+  }
+}
+function hexBytes(bytes) {
+  return bytes.reduce((str, byte) => str + byte.toString(16).padStart(2, "0"), "");
+}
 function getBitArrayEncoder(size, config = {}) {
   const parsedConfig = typeof config === "boolean" ? { backward: config } : config;
   const backward = parsedConfig.backward ?? false;