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

A comprehensive set of serializers for the Umi framework

import {
  PUBLIC_KEY_LENGTH,
  PublicKey,
  PublicKeyInput,
  publicKeyBytes,
  publicKey as toPublicKey,
} from '@metaplex-foundation/umi-public-keys';
import {
  BaseSerializerOptions,
  DeserializingEmptyBufferError,
  NotEnoughBytesError,
  Serializer,
} from '@metaplex-foundation/umi-serializers-core';

/**
 * Defines the options for `PublicKey` serializers.
 * @category Serializers
 */
export type PublicKeySerializerOptions = BaseSerializerOptions;

/**
 * Creates a serializer for base58 encoded public keys.
 *
 * @param options - A set of options for the serializer.
 * @category Serializers
 */
export function publicKey(
  options: PublicKeySerializerOptions = {}
): Serializer<PublicKeyInput, PublicKey> {
  return {
    description: options.description ?? 'publicKey',
    fixedSize: 32,
    maxSize: 32,
    serialize: (value: PublicKeyInput) => publicKeyBytes(toPublicKey(value)),
    deserialize: (bytes: Uint8Array, offset = 0) => {
      const pubkeyBytes = bytes.slice(offset, offset + 32);
      if (pubkeyBytes.length === 0) {
        throw new DeserializingEmptyBufferError('publicKey');
      }
      if (pubkeyBytes.length < PUBLIC_KEY_LENGTH) {
        throw new NotEnoughBytesError(
          'publicKey',
          PUBLIC_KEY_LENGTH,
          pubkeyBytes.length
        );
      }
      return [toPublicKey(pubkeyBytes), offset + 32];
    },
  };
}