@metaplex-foundation/umi-serializers/src/struct.ts

A comprehensive set of serializers for the Umi framework

import {
  BaseSerializerOptions,
  Serializer,
  mergeBytes,
} from '@metaplex-foundation/umi-serializers-core';
import { sumSerializerSizes } from './sumSerializerSizes';

/**
 * Get the name and serializer of each field in a struct.
 * @category Serializers
 */
export type StructToSerializerTuple<T extends object, U extends T> = Array<
  {
    [K in keyof T]: [K, Serializer<T[K], U[K]>];
  }[keyof T]
>;

/**
 * Defines the options for struct serializers.
 * @category Serializers
 */
export type StructSerializerOptions = BaseSerializerOptions;

/**
 * Creates a serializer for a custom object.
 *
 * @param fields - The name and serializer of each field.
 * @param options - A set of options for the serializer.
 * @category Serializers
 */
export function struct<T extends object, U extends T = T>(
  fields: StructToSerializerTuple<T, U>,
  options: StructSerializerOptions = {}
): Serializer<T, U> {
  const fieldDescriptions = fields
    .map(([name, serializer]) => `${String(name)}: ${serializer.description}`)
    .join(', ');
  return {
    description: options.description ?? `struct(${fieldDescriptions})`,
    fixedSize: sumSerializerSizes(fields.map(([, field]) => field.fixedSize)),
    maxSize: sumSerializerSizes(fields.map(([, field]) => field.maxSize)),
    serialize: (struct: T) => {
      const fieldBytes = fields.map(([key, serializer]) =>
        serializer.serialize(struct[key])
      );
      return mergeBytes(fieldBytes);
    },
    deserialize: (bytes: Uint8Array, offset = 0) => {
      const struct: Partial<U> = {};
      fields.forEach(([key, serializer]) => {
        const [value, newOffset] = serializer.deserialize(bytes, offset);
        offset = newOffset;
        struct[key] = value;
      });
      return [struct as U, offset];
    },
  };
}