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 = Array< { [K in keyof T]: [K, Serializer]; }[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( fields: StructToSerializerTuple, options: StructSerializerOptions = {} ): Serializer { 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 = {}; fields.forEach(([key, serializer]) => { const [value, newOffset] = serializer.deserialize(bytes, offset); offset = newOffset; struct[key] = value; }); return [struct as U, offset]; }, }; }