@pezkuwi/util-crypto 14.0.13 → 14.0.14

package/src/address/index.ts

@@ -1,21 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util-crypto authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-export { addressToEvm } from './addressToEvm.js';
-export { checkAddress } from './check.js';
-export { checkAddressChecksum } from './checksum.js';
-export { decodeAddress } from './decode.js';
-export { deriveAddress } from './derive.js';
-export { encodeAddress } from './encode.js';
-export { encodeDerivedAddress } from './encodeDerived.js';
-export { encodeMultiAddress } from './encodeMulti.js';
-export { addressEq } from './eq.js';
-export { evmToAddress } from './evmToAddress.js';
-export { isAddress } from './is.js';
-export { createKeyDerived } from './keyDerived.js';
-export { createKeyMulti } from './keyMulti.js';
-export { sortAddresses } from './sort.js';
-export { validateAddress } from './validate.js';
-
-// eslint-disable-next-line deprecation/deprecation
-export { setSS58Format } from './setSS58Format.js';

package/src/address/is.spec.ts

@@ -1,113 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util-crypto authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
-
-import { isAddress } from './index.js';
-
-describe('isAddress', (): void => {
-  it('decodes an address', (): void => {
-    expect(
-      isAddress('5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY')
-    ).toEqual(true);
-  });
-
-  it('decodes the council address', (): void => {
-    expect(
-      isAddress('F3opxRbN5ZbjJNU511Kj2TLuzFcDq9BGduA9TgiECafpg29')
-    ).toEqual(true);
-  });
-
-  it('converts a publicKey (hex) as-is', (): void => {
-    expect(
-      isAddress('0x01020304')
-    ).toEqual(true);
-  });
-
-  it('decodes a short address', (): void => {
-    expect(
-      isAddress('F7NZ')
-    ).toEqual(true);
-  });
-
-  it('decodes a 1-byte accountId (with prefix)', (): void => {
-    expect(
-      isAddress('g4b', false, 2)
-    ).toEqual(true);
-  });
-
-  it('decodes a 2-byte accountId', (): void => {
-    expect(
-      isAddress('3xygo', false, 2)
-    ).toEqual(true);
-  });
-
-  it('encodes a 4-byte address', (): void => {
-    expect(
-      isAddress('zswfoZa', false, 2)
-    ).toEqual(true);
-  });
-
-  it('decodes a 8-byte address', (): void => {
-    expect(
-      isAddress('848Gh2GcGaZia', false, 2)
-    ).toEqual(true);
-  });
-
-  it('decodes a 33-byte address', (): void => {
-    expect(
-      isAddress('KWCv1L3QX9LDPwY4VzvLmarEmXjVJidUzZcinvVnmxAJJCBou')
-    ).toEqual(true);
-  });
-
-  it('decodes a 2-byte prefix (65)', (): void => {
-    expect(
-      isAddress('cLtA6nCDyvwKcEHH4QkZDSHMhS9s78BvUJUsKUbUAn1Jc2SCF')
-    ).toEqual(true);
-  });
-
-  it('decodes a 2-byte prefix (69)', (): void => {
-    expect(
-      isAddress('cnUaoo5wodnTVA4bnr4woSweto8hWZADUvLFXkR9Q6U7BRsbF')
-    ).toEqual(true);
-  });
-
-  it('decodes a 2-byte prefix (252)', (): void => {
-    expect(
-      isAddress('xw9Hca4RJTmBRgzJT4ieJBh7XCK9gE3NXBDSEmgGHd4TCrbnG')
-    ).toEqual(true);
-  });
-
-  it('decodes a 2-byte prefix (255)', (): void => {
-    expect(
-      isAddress('yGHU8YKprxHbHdEv7oUK4rzMZXtsdhcXVG2CAMyC9WhzhjH2k')
-    ).toEqual(true);
-  });
-
-  it('decodes a 2-byte prefix (ecdsa, from Substrate)', (): void => {
-    expect(
-      isAddress('4pbsSkWcBaYoFHrKJZp5fDVUKbqSYD9dhZZGvpp3vQ5ysVs5ybV')
-    ).toEqual(true);
-  });
-
-  it('fails when length is invalid', (): void => {
-    expect(
-      isAddress('y9EMHt34JJo4rWLSaxoLGdYXvjgSXEd4zHUnQgfNzwES8b')
-    ).toEqual(false);
-  });
-
-  it('fails when the checksum does not match', (): void => {
-    expect(
-      isAddress('5GoKvZWG5ZPYL1WUovuHW3zJBWBP5eT8CbqjdRY4Q6iMa9cj')
-    ).toEqual(false);
-    expect(
-      isAddress('5GoKvZWG5ZPYL1WUovuHW3zJBWBP5eT8CbqjdRY4Q6iMaDwU')
-    ).toEqual(false);
-  });
-
-  it('fails when invalid base58 encoded address is found', (): void => {
-    expect(
-      isAddress('F3opIRbN5ZbjJNU511Kj2TLuzFcDq9BGduA9TgiECafpg29')
-    ).toEqual(false);
-  });
-});

package/src/address/is.ts

@@ -1,14 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util-crypto authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { Prefix } from './types.js';
-
-import { validateAddress } from './validate.js';
-
-export function isAddress (address?: string | null, ignoreChecksum?: boolean, ss58Format?: Prefix): address is string {
-  try {
-    return validateAddress(address, ignoreChecksum, ss58Format);
-  } catch {
-    return false;
-  }
-}

package/src/address/keyDerived.spec.ts

@@ -1,24 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util-crypto authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
-
-import { createKeyDerived } from './index.js';
-
-describe('createKeyDerived', (): void => {
-  it('matches sub accounts with Rust', (): void => {
-    expect(
-      createKeyDerived(new Uint8Array([1, 0, 0, 0, 0, 0, 0, 0]), 0)
-    ).toEqual(
-      new Uint8Array([234, 236, 28, 96, 177, 168, 152, 193, 71, 179, 226, 102, 179, 155, 188, 240, 90, 182, 21, 175, 47, 47, 250, 179, 178, 0, 81, 222, 70, 56, 52, 234])
-    );
-  });
-
-  it('creates a valid subkey', (): void => {
-    expect(
-      createKeyDerived('5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY', 1)
-    ).toEqual(
-      new Uint8Array([248, 19, 86, 209, 254, 89, 84, 48, 54, 128, 166, 239, 153, 212, 143, 34, 191, 60, 210, 50, 39, 77, 122, 71, 29, 60, 247, 198, 95, 101, 246, 83])
-    );
-  });
-});

package/src/address/keyDerived.ts

@@ -1,22 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util-crypto authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { BN } from '@pezkuwi/util';
-
-import { bnToU8a, stringToU8a, u8aConcat } from '@pezkuwi/util';
-
-import { blake2AsU8a } from '../blake2/asU8a.js';
-import { BN_LE_16_OPTS } from '../bn.js';
-import { decodeAddress } from './decode.js';
-
-const PREFIX = stringToU8a('modlpy/utilisuba');
-
-export function createKeyDerived (who: string | Uint8Array, index: bigint | BN | number): Uint8Array {
-  return blake2AsU8a(
-    u8aConcat(
-      PREFIX,
-      decodeAddress(who),
-      bnToU8a(index, BN_LE_16_OPTS)
-    )
-  );
-}

package/src/address/keyMulti.spec.ts

@@ -1,20 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util-crypto authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
-
-import { createKeyMulti } from './index.js';
-
-describe('createKeyMulti', (): void => {
-  it('creates a valid multikey (aligning with Rust, needs sorting)', (): void => {
-    expect(
-      createKeyMulti([
-        new Uint8Array([1, 0, 0, 0, 0, 0, 0, 0]),
-        new Uint8Array([3, 0, 0, 0, 0, 0, 0, 0]),
-        new Uint8Array([2, 0, 0, 0, 0, 0, 0, 0])
-      ], 2)
-    ).toEqual(
-      new Uint8Array([67, 151, 196, 155, 179, 207, 47, 123, 90, 2, 35, 54, 162, 111, 241, 226, 88, 148, 54, 193, 252, 195, 93, 101, 16, 5, 93, 101, 186, 186, 254, 79])
-    );
-  });
-});

package/src/address/keyMulti.ts

@@ -1,23 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util-crypto authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { BN } from '@pezkuwi/util';
-
-import { bnToU8a, compactToU8a, stringToU8a, u8aConcat, u8aSorted } from '@pezkuwi/util';
-
-import { blake2AsU8a } from '../blake2/asU8a.js';
-import { BN_LE_16_OPTS } from '../bn.js';
-import { addressToU8a } from './util.js';
-
-const PREFIX = stringToU8a('modlpy/utilisuba');
-
-export function createKeyMulti (who: (string | Uint8Array)[], threshold: bigint | BN | number): Uint8Array {
-  return blake2AsU8a(
-    u8aConcat(
-      PREFIX,
-      compactToU8a(who.length),
-      ...u8aSorted(who.map(addressToU8a)),
-      bnToU8a(threshold, BN_LE_16_OPTS)
-    )
-  );
-}

package/src/address/setSS58Format.spec.ts

@@ -1,21 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util-crypto authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
-
-import { encodeAddress, setSS58Format } from './index.js';
-
-describe('setSS58Format', (): void => {
-  beforeEach((): void => {
-    // eslint-disable-next-line deprecation/deprecation
-    setSS58Format(2);
-  });
-
-  it('sets and allows encoding using', (): void => {
-    expect(
-      encodeAddress(
-        new Uint8Array([1])
-      )
-    ).toEqual('g4b');
-  });
-});

package/src/address/setSS58Format.ts

@@ -1,20 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util-crypto authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { Prefix } from './types.js';
-
-import { logger } from '@pezkuwi/util';
-
-import { defaults } from './defaults.js';
-
-const l = logger('setSS58Format');
-
-/**
- * @description Sets the global SS58 format to use for address encoding
- * @deprecated Use keyring.setSS58Format
- */
-export function setSS58Format (prefix: Prefix): void {
-  l.warn('Global setting of the ss58Format is deprecated and not recommended. Set format on the keyring (if used) or as part of the address encode function');
-
-  defaults.prefix = prefix;
-}

package/src/address/sort.spec.ts

@@ -1,22 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util-crypto authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
-
-import { sortAddresses } from './index.js';
-
-describe('sortAddresses', (): void => {
-  it('sorts addresses by the publicKeys', (): void => {
-    expect(
-      sortAddresses([
-        '5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY',
-        '5FHneW46xGXgs5mUiveU4sbTyGBzmstUspZC92UhjJM694ty',
-        '5FLSigC9HGRKVhB9FiEo4Y3koPsNmBmLJbpXg2mp1hXcS59Y'
-      ])
-    ).toEqual([
-      '5FHneW46xGXgs5mUiveU4sbTyGBzmstUspZC92UhjJM694ty',
-      '5FLSigC9HGRKVhB9FiEo4Y3koPsNmBmLJbpXg2mp1hXcS59Y',
-      '5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY'
-    ]);
-  });
-});

package/src/address/sort.ts

@@ -1,17 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { Prefix } from './types.js';
-
-import { u8aSorted } from '@pezkuwi/util';
-
-import { encodeAddress } from './encode.js';
-import { addressToU8a } from './util.js';
-
-export function sortAddresses (addresses: (string | Uint8Array)[], ss58Format?: Prefix): string[] {
-  const u8aToAddress = (u8a: Uint8Array) => encodeAddress(u8a, ss58Format);
-
-  return u8aSorted(
-    addresses.map(addressToU8a)
-  ).map(u8aToAddress);
-}

package/src/address/sshash.ts

@@ -1,12 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util-crypto authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { stringToU8a, u8aConcat } from '@pezkuwi/util';
-
-import { blake2AsU8a } from '../blake2/asU8a.js';
-
-const SS58_PREFIX = stringToU8a('SS58PRE');
-
-export function sshash (key: Uint8Array): Uint8Array {
-  return blake2AsU8a(u8aConcat(SS58_PREFIX, key), 512);
-}

package/src/address/types.ts

@@ -1,6 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util-crypto authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-// FIXME we really want this to map with what is in the allowedSS58 array... i.e. the
-// values there. As of now, we just map to number.
-export type Prefix = number;

package/src/address/util.ts

@@ -1,8 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util-crypto authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { decodeAddress } from './decode.js';
-
-export function addressToU8a (who: string | Uint8Array): Uint8Array {
-  return decodeAddress(who);
-}

package/src/address/validate.spec.ts

@@ -1,113 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util-crypto authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
-
-import { validateAddress } from './index.js';
-
-describe('validateAddress', (): void => {
-  it('decodes an address', (): void => {
-    expect(
-      validateAddress('5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY')
-    ).toEqual(true);
-  });
-
-  it('decodes the council address', (): void => {
-    expect(
-      validateAddress('F3opxRbN5ZbjJNU511Kj2TLuzFcDq9BGduA9TgiECafpg29')
-    ).toEqual(true);
-  });
-
-  it('converts a publicKey (hex) as-is', (): void => {
-    expect(
-      validateAddress('0x01020304')
-    ).toEqual(true);
-  });
-
-  it('decodes a short address', (): void => {
-    expect(
-      validateAddress('F7NZ')
-    ).toEqual(true);
-  });
-
-  it('decodes a 1-byte accountId (with prefix)', (): void => {
-    expect(
-      validateAddress('g4b', false, 2)
-    ).toEqual(true);
-  });
-
-  it('decodes a 2-byte accountId', (): void => {
-    expect(
-      validateAddress('3xygo', false, 2)
-    ).toEqual(true);
-  });
-
-  it('encodes a 4-byte address', (): void => {
-    expect(
-      validateAddress('zswfoZa', false, 2)
-    ).toEqual(true);
-  });
-
-  it('decodes a 8-byte address', (): void => {
-    expect(
-      validateAddress('848Gh2GcGaZia', false, 2)
-    ).toEqual(true);
-  });
-
-  it('decodes a 33-byte address', (): void => {
-    expect(
-      validateAddress('KWCv1L3QX9LDPwY4VzvLmarEmXjVJidUzZcinvVnmxAJJCBou')
-    ).toEqual(true);
-  });
-
-  it('decodes a 2-byte prefix (65)', (): void => {
-    expect(
-      validateAddress('cLtA6nCDyvwKcEHH4QkZDSHMhS9s78BvUJUsKUbUAn1Jc2SCF')
-    ).toEqual(true);
-  });
-
-  it('decodes a 2-byte prefix (69)', (): void => {
-    expect(
-      validateAddress('cnUaoo5wodnTVA4bnr4woSweto8hWZADUvLFXkR9Q6U7BRsbF')
-    ).toEqual(true);
-  });
-
-  it('decodes a 2-byte prefix (252)', (): void => {
-    expect(
-      validateAddress('xw9Hca4RJTmBRgzJT4ieJBh7XCK9gE3NXBDSEmgGHd4TCrbnG')
-    ).toEqual(true);
-  });
-
-  it('decodes a 2-byte prefix (255)', (): void => {
-    expect(
-      validateAddress('yGHU8YKprxHbHdEv7oUK4rzMZXtsdhcXVG2CAMyC9WhzhjH2k')
-    ).toEqual(true);
-  });
-
-  it('decodes a 2-byte prefix (ecdsa, from Substrate)', (): void => {
-    expect(
-      validateAddress('4pbsSkWcBaYoFHrKJZp5fDVUKbqSYD9dhZZGvpp3vQ5ysVs5ybV')
-    ).toEqual(true);
-  });
-
-  it('fails when length is invalid', (): void => {
-    expect(
-      () => validateAddress('y9EMHt34JJo4rWLSaxoLGdYXvjgSXEd4zHUnQgfNzwES8b')
-    ).toThrow(/address length/);
-  });
-
-  it('fails when the checksum does not match', (): void => {
-    expect(
-      () => validateAddress('5GoKvZWG5ZPYL1WUovuHW3zJBWBP5eT8CbqjdRY4Q6iMa9cj')
-    ).toThrow(/address checksum/);
-    expect(
-      () => validateAddress('5GoKvZWG5ZPYL1WUovuHW3zJBWBP5eT8CbqjdRY4Q6iMaDwU')
-    ).toThrow(/address checksum/);
-  });
-
-  it('fails when invalid base58 encoded address is found', (): void => {
-    expect(
-      () => validateAddress('F3opIRbN5ZbjJNU511Kj2TLuzFcDq9BGduA9TgiECafpg29')
-    ).toThrow(/Decoding F3opIRbN5ZbjJNU511Kj2TLuzFcDq9BGduA9TgiECafpg29: Invalid base58 character "I" \(0x49\) at index 4/);
-  });
-});

package/src/address/validate.ts

@@ -1,10 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util-crypto authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { Prefix } from './types.js';
-
-import { decodeAddress } from './decode.js';
-
-export function validateAddress (encoded?: string | null, ignoreChecksum?: boolean, ss58Format?: Prefix): encoded is string {
-  return !!decodeAddress(encoded, ignoreChecksum, ss58Format);
-}

package/src/base32/bs32.ts

@@ -1,53 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util-crypto authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { utils } from '@scure/base';
-
-import { createDecode, createEncode, createIs, createValidate } from './helpers.js';
-
-const chars = 'abcdefghijklmnopqrstuvwxyz234567';
-
-const config = {
-  chars,
-  coder: utils.chain(
-    // We define our own chain, the default base32 has padding
-    utils.radix2(5),
-    utils.alphabet(chars),
-    {
-      decode: (input: string) => input.split(''),
-      encode: (input: string[]) => input.join('')
-    }
-  ),
-  ipfs: 'b',
-  type: 'base32'
-};
-
-/**
- * @name base32Validate
- * @summary Validates a base32 value.
- * @description
- * Validates that the supplied value is valid base32, throwing exceptions if not
- */
-export const base32Validate = /*#__PURE__*/ createValidate(config);
-
-/**
-* @name isBase32
-* @description Checks if the input is in base32, returning true/false
-*/
-export const isBase32 = /*#__PURE__*/ createIs(base32Validate);
-
-/**
- * @name base32Decode
- * @summary Delookup a base32 value.
- * @description
- * From the provided input, decode the base32 and return the result as an `Uint8Array`.
- */
-export const base32Decode = /*#__PURE__*/ createDecode(config, base32Validate);
-
-/**
-* @name base32Encode
-* @summary Creates a base32 value.
-* @description
-* From the provided input, create the base32 and return the result as a string.
-*/
-export const base32Encode = /*#__PURE__*/ createEncode(config);

package/src/base32/decode.spec.ts

@@ -1,34 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util-crypto authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
-
-import { u8aToString } from '@pezkuwi/util';
-
-import { base32Decode } from './index.js';
-
-describe('base32Decode', (): void => {
-  it('decodes an empty string)', (): void => {
-    expect(
-      u8aToString(
-        base32Decode('')
-      )
-    ).toEqual('');
-  });
-
-  it('decodes a base32', (): void => {
-    expect(
-      u8aToString(
-        base32Decode('irswgzloorzgc3djpjssazlwmvzhs5dinfxgoijb')
-      )
-    ).toEqual('Decentralize everything!!');
-  });
-
-  it('decodes a base32 (ipfsCompat)', (): void => {
-    expect(
-      u8aToString(
-        base32Decode('birswgzloorzgc3djpjssazlwmvzhs5dinfxgoijb', true)
-      )
-    ).toEqual('Decentralize everything!!');
-  });
-});

package/src/base32/encode.spec.ts

@@ -1,30 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util-crypto authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
-
-import { base58Decode } from '../base58/index.js';
-import { base32Encode } from './index.js';
-
-describe('base32Encode', (): void => {
-  it('encodes to a base32', (): void => {
-    expect(
-      base32Encode('Decentralize everything!!')
-    ).toEqual('irswgzloorzgc3djpjssazlwmvzhs5dinfxgoijb');
-  });
-
-  it('encodes to a base32 (ipfs-compat)', (): void => {
-    expect(
-      base32Encode('Decentralize everything!!', true)
-    ).toEqual('birswgzloorzgc3djpjssazlwmvzhs5dinfxgoijb');
-  });
-
-  it('encodes a base58 to a base32', (): void => {
-    expect(
-      base32Encode(
-        base58Decode('zb2rhk6GMPQF3hfzwXTaNYFLKomMeC6UXdUt6jZKPpeVirLtV', true),
-        true
-      )
-    ).toEqual('bafkreigh2akiscaildcqabsyg3dfr6chu3fgpregiymsck7e7aqa4s52zy');
-  });
-});