polkadot-js/api

View on GitHub
packages/types-codec/src/extended/U8aFixed.spec.ts

Summary

Maintainability
B
6 hrs
Test Coverage
// Copyright 2017-2024 @polkadot/types-codec authors & contributors
// SPDX-License-Identifier: Apache-2.0

/// <reference types="@polkadot/dev-test/globals.d.ts" />

import { TypeRegistry } from '@polkadot/types';
import { U8aFixed } from '@polkadot/types-codec';

describe('U8aFixed', (): void => {
  const registry = new TypeRegistry();

  describe('construction', (): void => {
    it('allows empty values', (): void => {
      expect(
        new U8aFixed(registry).toHex()
      ).toEqual('0x0000000000000000000000000000000000000000000000000000000000000000');
    });

    it('allows construction via with', (): void => {
      expect(
        new (U8aFixed.with(64))(registry).bitLength()
      ).toEqual(64);
    });

    it('constructs from hex', (): void => {
      expect(
        new (U8aFixed.with(32))(registry, '0x01020304').toU8a()
      ).toEqual(
        new Uint8Array([0x01, 0x02, 0x03, 0x04])
      );
    });

    it('constructs from number[]', (): void => {
      expect(
        new (U8aFixed.with(32))(registry, [0x02, 0x03, 0x00, 0x00]).toU8a()
      ).toEqual(
        new Uint8Array([0x02, 0x03, 0x00, 0x00])
      );
    });

    it('constructs when passed Uint8Array is >= length', (): void => {
      expect(
        new (U8aFixed.with(32))(registry, new Uint8Array([0x00, 0x01, 0x02, 0x03])).toU8a()
      ).toEqual(
        new Uint8Array([0x00, 0x01, 0x02, 0x03])
      );
      expect(
        new (U8aFixed.with(32))(registry, new Uint8Array([0x00, 0x01, 0x02, 0x03, 0x04, 0x05])).toU8a()
      ).toEqual(
        new Uint8Array([0x00, 0x01, 0x02, 0x03])
      );
    });

    it('constructs when passed string is === length', (): void => {
      expect(
        new (U8aFixed.with(32))(registry, '1234').toU8a()
      ).toEqual(
        new Uint8Array([49, 50, 51, 52])
      );
    });

    it('fails construction when passed string is > length', (): void => {
      expect(
        () => new (U8aFixed.with(32))(registry, '0x000102030405').toU8a()
      ).toThrow(/Expected input with 4 bytes/);
      expect(
        () => new (U8aFixed.with(256))(registry, '1363HWTPzDrzAQ6ChFiMU6mP4b6jmQid2ae55JQcKtZnpLGv')
      ).toThrow(/Expected input with 32 bytes/);
    });
  });

  describe('utils', (): void => {
    let u8a: U8aFixed;

    beforeEach((): void => {
      u8a = new U8aFixed(registry, [1, 2, 3, 4], 32);
    });

    it('limits the length', (): void => {
      expect(u8a.length).toEqual(4);
    });

    it('exposes the correct bitLength', (): void => {
      expect(u8a.bitLength()).toEqual(32);
    });

    it('allows wrapping of a pre-existing instance', (): void => {
      expect(
        u8a.toU8a()
      ).toEqual(new Uint8Array([1, 2, 3, 4]));
    });

    it('has a sane toRawType', (): void => {
      expect(u8a.toRawType()).toEqual('[u8;4]');
    });

    it('has a sane inspect', (): void => {
      expect(u8a.inspect()).toEqual({
        outer: [new Uint8Array([1, 2, 3, 4])]
      });
    });
  });

  describe('static with', (): void => {
    it('allows default toRawType', (): void => {
      expect(
        new (U8aFixed.with(64))(registry).toRawType()
      ).toEqual('[u8;8]');
    });

    it('allows toRawType override', (): void => {
      expect(
        new (U8aFixed.with(64, 'SomethingElse'))(registry).toRawType()
      ).toEqual('SomethingElse');
    });
  });
});