@pezkuwi/keyring 14.0.6 → 14.0.10

package/src/suri.spec.ts

@@ -0,0 +1,109 @@
+// Copyright 2017-2025 @pezkuwi/keyring authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
+
+// From https://github.com/paritytech/substrate/wiki/Secret-URI-Test-Vectors
+
+import type { KeypairType } from '@pezkuwi/util-crypto/types';
+
+import { u8aToHex } from '@pezkuwi/util';
+import { cryptoWaitReady } from '@pezkuwi/util-crypto';
+
+import Keyring from './index.js';
+
+const PHRASE = 'bottom drive obey lake curtain smoke basket hold race lonely fit walk';
+const ETHEREUM_PHRASE = 'seed sock milk update focus rotate barely fade car face mechanic mercy';
+
+const TESTS = {
+  ecdsa: [
+    {
+      pk: '0x020a1091341fe5664bfa1782d5e04779689068c916b04cb365ec3153755684d9a1',
+      ss: '5C7C2Z5sWbytvHpuLTvzKunnnRwQxft1jiqrLD5rhucQ5S9X',
+      uri: `${PHRASE}//Alice`
+    }
+  ],
+  ethereum: [
+    {
+      pk: '0x0381351b1b46d2602b0992bb5d5531f9c1696b0812feb2534b6884adc47e2e1d8b',
+      ss: '0x31ea8795EE32D782C8ff41a5C68Dcbf0F5B27f6d',
+      uri: `${ETHEREUM_PHRASE}/m/44'/60'/0'/0/0`
+    },
+    {
+      pk: '0x02509540919faacf9ab52146c9aa40db68172d83777250b28e4679176e49ccdd9f',
+      ss: '0xf24FF3a9CF04c71Dbc94D0b566f7A27B94566cac',
+      uri: `${PHRASE}/m/44'/60'/0'/0/0`
+    },
+    {
+      pk: '0x033bc19e36ff1673910575b6727a974a9abd80c9a875d41ab3e2648dbfb9e4b518',
+      ss: '0x3Cd0A705a2DC65e5b1E1205896BaA2be8A07c6e0',
+      uri: `${PHRASE}/m/44'/60'/0'/0/1`
+    }
+  ],
+  sr25519: [
+    {
+      pk: '0x46ebddef8cd9bb167dc30878d7113b7e168e6f0646beffd77d69d39bad76b47a',
+      ss: '5DfhGyQdFobKM8NsWvEeAKk5EQQgYe9AydgJ7rMB6E1EqRzV',
+      uri: PHRASE
+    },
+    {
+      pk: '0xb69355deefa7a8f33e9297f5af22e680f03597a99d4f4b1c44be47e7a2275802',
+      ss: '5GC6LfpV352HtJPySfAecb5JdePtf4R9Vq49NUU8RhzgBqgq',
+      uri: `${PHRASE}///password`
+    },
+    {
+      pk: '0x40b9675df90efa6069ff623b0fdfcf706cd47ca7452a5056c7ad58194d23440a',
+      ss: '5DXZzrDxHbkQov4QBAY4TjpwnHCMrKXkomTnKSw8UArBEY5v',
+      uri: `${PHRASE}/foo`
+    },
+    {
+      pk: '0x547d4a55642ec7ebadc0bd29b6e570b8c926059b3c0655d4948075e9a7e6f31e',
+      ss: '5DyV6fZuvPemWrUqBgWwTSgoV86w6xms3KhkFU6cQcWxU8eP',
+      uri: `${PHRASE}//foo`
+    },
+    {
+      pk: '0x3841947ffcde6f5fef26fb68b59bb8665637e30e32ec2051f99cf6b9c674fe09',
+      ss: '5DLU27is5iViNopQb2KxsTyPx6j4vCu8X3sk3j3NNLkPCqKM',
+      uri: `${PHRASE}//foo/bar`
+    },
+    {
+      pk: '0xdc142f7476a7b0aa262aeccf207f1d18daa90762db393006741e8a31f39dbc53',
+      ss: '5H3GPTqDSpjkfDwbHy12PD6BWm8jvGSX4xYC8UMprHpTPcRg',
+      uri: `${PHRASE}/foo//bar`
+    },
+    {
+      pk: '0xa2e56b06407a6d1e819d2fc33fa0ec604b29c2e868b70b3696bb049b8725934b',
+      ss: '5FkHmNgbg64MwStgCyDi2Uw3ufFu11mqQgmWT9uwK4Lghvpv',
+      uri: `${PHRASE}//foo/bar//42/69`
+    },
+    {
+      pk: '0x0e0d24e3e1ff2c07f269c99e2e0df8681fda1851ac42fc846ca2daaa90cd8f14',
+      ss: '5CP8S23JBNXYNpJsL7ESPJBNnUZE6itcfM4EnDxEhaVEU6dT',
+      uri: `${PHRASE}//foo/bar//42/69///password`
+    },
+    {
+      pk: '0xd43593c715fdd31c61141abd04a99fd6822c8558854ccde39a5684e7a56da27d',
+      ss: '5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY',
+      uri: `${PHRASE}//Alice`
+    }
+  ]
+};
+
+await cryptoWaitReady();
+
+describe('keyring.addFromUri', (): void => {
+  for (const [type, tests] of Object.entries(TESTS)) {
+    const keyring = new Keyring({ type: type as KeypairType });
+
+    describe(`${type}`, (): void => {
+      tests.forEach(({ pk, ss, uri }): void => {
+        it(`creates ${uri}`, (): void => {
+          const pair = keyring.addFromUri(uri, {}, type as KeypairType);
+
+          expect(u8aToHex(pair.publicKey)).toEqual(pk);
+          expect(pair.address).toEqual(ss);
+        });
+      });
+    });
+  }
+});

package/src/testing.ts

@@ -0,0 +1,156 @@
+// Copyright 2017-2025 @pezkuwi/keyring authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type { HexString } from '@pezkuwi/util/types';
+import type { KeypairType } from '@pezkuwi/util-crypto/types';
+import type { KeyringInstance, KeyringOptions } from './types.js';
+
+import { hexToU8a } from '@pezkuwi/util';
+
+import { createPair } from './pair/index.js';
+import { Keyring } from './keyring.js';
+
+interface PairDef {
+  name?: string;
+  p: HexString;
+  s: HexString;
+  seed?: string;
+  type: KeypairType
+}
+
+// NOTE This is not great since we have the secretKey here explicitly, but a testing
+// keyring is for testing - what happens is that in most cases the keyring is initialises
+// before anything else. Since the sr25519 crypto is async, this creates problems with
+// adding the keys when only the keyring is used.
+export const PAIRSSR25519: PairDef[] = [
+  {
+    p: '0xd43593c715fdd31c61141abd04a99fd6822c8558854ccde39a5684e7a56da27d',
+    s: '0x98319d4ff8a9508c4bb0cf0b5a78d760a0b2082c02775e6e82370816fedfff48925a225d97aa00682d6a59b95b18780c10d7032336e88f3442b42361f4a66011', // nosemgrep
+    seed: 'Alice',
+    type: 'sr25519'
+  },
+  {
+    p: '0xbe5ddb1579b72e84524fc29e78609e3caf42e85aa118ebfe0b0ad404b5bdd25f',
+    s: '0xe8da6c9d810e020f5e3c7f5af2dea314cbeaa0d72bc6421e92c0808a0c584a6046ab28e97c3ffc77fe12b5a4d37e8cd4afbfebbf2391ffc7cb07c0f38c023efd', // nosemgrep
+    seed: 'Alice//stash',
+    type: 'sr25519'
+  },
+  {
+    p: '0x8eaf04151687736326c9fea17e25fc5287613693c912909cb226aa4794f26a48',
+    s: '0x081ff694633e255136bdb456c20a5fc8fed21f8b964c11bb17ff534ce80ebd5941ae88f85d0c1bfc37be41c904e1dfc01de8c8067b0d6d5df25dd1ac0894a325', // nosemgrep
+    seed: 'Bob',
+    type: 'sr25519'
+  },
+  {
+    p: '0xfe65717dad0447d715f660a0a58411de509b42e6efb8375f562f58a554d5860e',
+    s: '0xc006507cdfc267a21532394c49ca9b754ca71de21e15a1cdf807c7ceab6d0b6c3ed408d9d35311540dcd54931933e67cf1ea10d46f75408f82b789d9bd212fde', // nosemgrep
+    seed: 'Bob//stash',
+    type: 'sr25519'
+  },
+  {
+    p: '0x90b5ab205c6974c9ea841be688864633dc9ca8a357843eeacf2314649965fe22',
+    s: '0xa8f2d83016052e5d6d77b2f6fd5d59418922a09024cda701b3c34369ec43a7668faf12ff39cd4e5d92bb773972f41a7a5279ebc2ed92264bed8f47d344f8f18c', // nosemgrep
+    seed: 'Charlie',
+    type: 'sr25519'
+  },
+  {
+    p: '0x306721211d5404bd9da88e0204360a1a9ab8b87c66c1bc2fcdd37f3c2222cc20',
+    s: '0x20e05482ca4677e0edbc58ae9a3a59f6ed3b1a9484ba17e64d6fe8688b2b7b5d108c4487b9323b98b11fe36cb301b084e920f7b7895536809a6d62a451b25568', // nosemgrep
+    seed: 'Dave',
+    type: 'sr25519'
+  },
+  {
+    p: '0xe659a7a1628cdd93febc04a4e0646ea20e9f5f0ce097d9a05290d4a9e054df4e',
+    s: '0x683576abfd5dc35273e4264c23095a1bf21c14517bece57c7f0cc5c0ed4ce06a3dbf386b7828f348abe15d76973a72009e6ef86a5c91db2990cb36bb657c6587', // nosemgrep
+    seed: 'Eve',
+    type: 'sr25519'
+  },
+  {
+    p: '0x1cbd2d43530a44705ad088af313e18f80b53ef16b36177cd4b77b846f2a5f07c',
+    s: '0xb835c20f450079cf4f513900ae9faf8df06ad86c681884122c752a4b2bf74d4303e4f21bc6cc62bb4eeed5a9cce642c25e2d2ac1464093b50f6196d78e3a7426', // nosemgrep
+    seed: 'Ferdie',
+    type: 'sr25519'
+  }
+];
+
+export const PAIRSETHEREUM: PairDef[] = [
+  {
+    name: 'Alith',
+    p: '0x02509540919faacf9ab52146c9aa40db68172d83777250b28e4679176e49ccdd9f',
+    s: '0x5fb92d6e98884f76de468fa3f6278f8807c48bebc13595d45af5bdc4da702133', // nosemgrep
+    type: 'ethereum'
+  },
+  {
+    name: 'Baltathar',
+    p: '0x033bc19e36ff1673910575b6727a974a9abd80c9a875d41ab3e2648dbfb9e4b518',
+    s: '0x8075991ce870b93a8870eca0c0f91913d12f47948ca0fd25b49c6fa7cdbeee8b', // nosemgrep
+    type: 'ethereum'
+  },
+  {
+    name: 'Charleth',
+    p: '0x0234637bdc0e89b5d46543bcbf8edff329d2702bc995e27e9af4b1ba009a3c2a5e',
+    s: '0x0b6e18cafb6ed99687ec547bd28139cafdd2bffe70e6b688025de6b445aa5c5b', // nosemgrep
+    type: 'ethereum'
+  },
+  {
+    name: 'Dorothy',
+    p: '0x02a00d60b2b408c2a14c5d70cdd2c205db8985ef737a7e55ad20ea32cc9e7c417c',
+    s: '0x39539ab1876910bbf3a223d84a29e28f1cb4e2e456503e7e91ed39b2e7223d68', // nosemgrep
+    type: 'ethereum'
+  },
+  {
+    name: 'Ethan',
+    p: '0x025cdc005b752651cd3f728fb9192182acb3a9c89e19072cbd5b03f3ee1f1b3ffa',
+    s: '0x7dce9bc8babb68fec1409be38c8e1a52650206a7ed90ff956ae8a6d15eeaaef4', // nosemgrep
+    type: 'ethereum'
+  },
+  {
+    name: 'Faith',
+    p: '0x037964b6c9d546da4646ada28a99e34acaa1d14e7aba861a9055f9bd200c8abf74',
+    s: '0xb9d2ea9a615f3165812e8d44de0d24da9bbd164b65c4f0573e1ce2c8dbd9c8df', // nosemgrep
+    type: 'ethereum'
+  }
+];
+
+function createMeta (name?: string, seed?: string) {
+  if (!name && !seed) {
+    throw new Error('Testing pair should have either a name or a seed');
+  }
+
+  return {
+    isTesting: true,
+    name: name || seed?.replace('//', '_').toLowerCase()
+  };
+}
+
+/**
+ * @name testKeyring
+ * @summary Create an instance of Keyring pre-populated with locked test accounts
+ * @description The test accounts (i.e. alice, bob, dave, eve, ferdie)
+ * are available on the dev chain and each test account is initialized with DOT funds.
+ */
+export function createTestKeyring (options: KeyringOptions = {}, isDerived = true): KeyringInstance {
+  const keyring = new Keyring(options);
+  const pairs = options.type === 'ethereum'
+    ? PAIRSETHEREUM
+    : PAIRSSR25519;
+
+  for (const { name, p, s, seed, type } of pairs) {
+    const meta = createMeta(name, seed);
+    const pair = !isDerived && !name && seed
+      ? keyring.addFromUri(seed, meta, options.type)
+      : keyring.addPair(
+        createPair(
+          { toSS58: keyring.encodeAddress, type },
+          { publicKey: hexToU8a(p), secretKey: hexToU8a(s) },
+          meta
+        )
+      );
+
+    pair.lock = (): void => {
+      // we don't have lock/unlock functionality here
+    };
+  }
+
+  return keyring;
+}

package/src/testingPairs.spec.ts

@@ -0,0 +1,79 @@
+// Copyright 2017-2025 @pezkuwi/keyring authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
+
+import { u8aToHex } from '@pezkuwi/util';
+import { cryptoWaitReady } from '@pezkuwi/util-crypto';
+
+import Keyring from './index.js';
+import { createTestPairs } from './testingPairs.js';
+
+const TEST_ADD = '0xf24FF3a9CF04c71Dbc94D0b566f7A27B94566cac';
+
+await cryptoWaitReady();
+
+describe('testingPairs', (): void => {
+  it('creates without failing', (): void => {
+    expect(
+      Object.keys(createTestPairs())
+    ).toHaveLength(2 + 0 + 7); // stash, session, pairs
+  });
+
+  it('has the correct address for Alice (non-HDKD)', (): void => {
+    expect(
+      createTestPairs({ type: 'ed25519' }, false).alice.address
+    ).toEqual('5GoKvZWG5ZPYL1WUovuHW3zJBWBP5eT8CbqjdRY4Q6iMaQua');
+  });
+
+  it('has the correct address for Alice (HDKD)', (): void => {
+    expect(
+      createTestPairs({ type: 'ed25519' }).alice.address
+    ).toEqual('5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY');
+  });
+
+  it('has the correct address for Alith (Eth)', (): void => {
+    expect(
+      createTestPairs({ type: 'ethereum' }).Alith.address
+    ).toEqual(TEST_ADD);
+  });
+
+  it('has the correct address for Alith (Eth), same as obtained by createFromUri', (): void => {
+    const keyring = new Keyring({ type: 'ethereum' });
+    const pair = keyring.createFromUri('0x5fb92d6e98884f76de468fa3f6278f8807c48bebc13595d45af5bdc4da702133');
+
+    expect(pair?.address).toEqual(TEST_ADD);
+  });
+
+  describe('checks eth test addresses', (): void => {
+    const ring = createTestPairs({ type: 'ethereum' });
+    const keyring = new Keyring({ type: 'ethereum' });
+    // priv keys generated by  ganache-cli --mnemonic "bottom drive obey lake curtain smoke basket hold race lonely fit walk"
+    const privKeys: string[] = ['0x5fb92d6e98884f76de468fa3f6278f8807c48bebc13595d45af5bdc4da702133',
+      '0x8075991ce870b93a8870eca0c0f91913d12f47948ca0fd25b49c6fa7cdbeee8b',
+      '0x0b6e18cafb6ed99687ec547bd28139cafdd2bffe70e6b688025de6b445aa5c5b',
+      '0x39539ab1876910bbf3a223d84a29e28f1cb4e2e456503e7e91ed39b2e7223d68',
+      '0x7dce9bc8babb68fec1409be38c8e1a52650206a7ed90ff956ae8a6d15eeaaef4',
+      '0xb9d2ea9a615f3165812e8d44de0d24da9bbd164b65c4f0573e1ce2c8dbd9c8df',
+      '0x96b8a38e12e1a31dee1eab2fffdf9d9990045f5b37e44d8cc27766ef294acf18',
+      '0x0d6dcaaef49272a5411896be8ad16c01c35d6f8c18873387b71fbc734759b0ab',
+      '0x4c42532034540267bf568198ccec4cb822a025da542861fcb146a5fab6433ff8',
+      '0x94c49300a58d576011096bcb006aa06f5a91b34b4383891e8029c21dc39fbb8b'];
+
+    // @ts-expect-error We should not delete from the maps, however this is a test
+    delete ring.nobody;
+
+    Object
+      .keys(ring)
+      .filter((_, i) => i < 6)
+      .forEach((testKeyring, i) => {
+        it(`checks #${i}`, (): void => {
+          expect(
+            u8aToHex(ring[testKeyring].publicKey)
+          ).toEqual(
+            u8aToHex(keyring.createFromUri(privKeys[i]).publicKey)
+          );
+        });
+      });
+  });
+});

package/src/testingPairs.ts

@@ -0,0 +1,56 @@
+// Copyright 2017-2025 @pezkuwi/keyring authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type { KeypairType } from '@pezkuwi/util-crypto/types';
+import type { KeyringOptions, KeyringPair } from './types.js';
+
+import { nobody } from './pair/nobody.js';
+import { createTestKeyring } from './testing.js';
+
+export interface TestKeyringMap {
+  nobody: KeyringPair;
+
+  [index: string]: KeyringPair;
+}
+
+export interface TestKeyringMapBizinikiwi extends TestKeyringMap {
+  alice: KeyringPair;
+  bob: KeyringPair;
+  charlie: KeyringPair;
+  dave: KeyringPair;
+  eve: KeyringPair;
+  ferdie: KeyringPair;
+}
+
+export interface TestKeyringMapEthereum extends TestKeyringMap {
+  Alith: KeyringPair;
+  Baltathar: KeyringPair;
+  Charleth: KeyringPair;
+  Dorothy: KeyringPair;
+  Ethan: KeyringPair;
+  Faith: KeyringPair;
+}
+
+export type DetectMap<O extends KeyringOptions | undefined> = DetectPairType<O> extends 'ethereum'
+  ? TestKeyringMapEthereum
+  : TestKeyringMapBizinikiwi;
+
+export type DetectPairType<O extends KeyringOptions | undefined> = O extends KeyringOptions
+  ? O['type'] extends KeypairType
+    ? O['type']
+    : 'sr25519'
+  : 'sr25519';
+
+export function createTestPairs <O extends KeyringOptions, M = DetectMap<O>> (options?: O, isDerived = true): M {
+  const keyring = createTestKeyring(options, isDerived);
+  const pairs = keyring.getPairs();
+  const map: TestKeyringMap = { nobody: nobody() };
+
+  for (const p of pairs) {
+    if (p.meta.name) {
+      map[p.meta.name] = p;
+    }
+  }
+
+  return map as M;
+}

package/src/types.ts

@@ -0,0 +1,131 @@
+// Copyright 2017-2025 @pezkuwi/keyring authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type { HexString } from '@pezkuwi/util/types';
+import type { EncryptedJson, Keypair, KeypairType, Prefix } from '@pezkuwi/util-crypto/types';
+
+export interface KeyringOptions {
+  /** The ss58Format to use for address encoding (defaults to 42) */
+  ss58Format?: Prefix;
+  /** The type of keyring to create (defaults to ed25519) */
+  type?: KeypairType;
+}
+
+export interface KeyringPair$MetaHardware {
+  accountIndex?: number;
+  accountOffset?: number;
+  addressOffset?: number;
+  hardwareType?: 'ledger';
+}
+
+export interface KeyringPair$MetaFlags {
+  isDefaultAuthSelected?: boolean;
+  isExternal?: boolean;
+  isHardware?: boolean;
+  isHidden?: boolean;
+  isInjected?: boolean;
+  isMultisig?: boolean;
+  isProxied?: boolean;
+  isRecent?: boolean;
+  isTesting?: boolean;
+}
+
+export interface KeyringPair$MetaContract {
+  abi: string;
+  genesisHash?: HexString | null;
+}
+
+export interface KeyringPair$MetaExtension {
+  source?: string;
+}
+
+export interface KeyringPair$MetaMultisig {
+  threshold?: number;
+  who?: string[];
+}
+
+export interface KeyringPair$MetaParent {
+  parentAddress?: string;
+  parentName?: string;
+}
+
+export interface KeyringPair$Meta extends KeyringPair$MetaExtension, KeyringPair$MetaFlags, KeyringPair$MetaHardware, KeyringPair$MetaMultisig, KeyringPair$MetaParent {
+  address?: string;
+  contract?: KeyringPair$MetaContract;
+  genesisHash?: HexString | null;
+  name?: string;
+  suri?: string;
+  tags?: string[];
+  type?: KeypairType;
+  whenCreated?: number;
+  whenEdited?: number;
+  whenUsed?: number;
+
+  [key: string]: unknown;
+}
+
+export interface KeyringPair$Json extends EncryptedJson {
+  /** The ss58 encoded address or the hex-encoded version (the latter is for ETH-compat chains) */
+  address: string;
+  /** The underlying metadata associated with the keypair */
+  meta: KeyringPair$Meta;
+}
+
+export interface SignOptions {
+  /** Create a MultiSignature-compatible output with an indicator type */
+  withType?: boolean;
+}
+
+export interface KeyringPair {
+  readonly address: string;
+  readonly addressRaw: Uint8Array;
+  readonly meta: KeyringPair$Meta;
+  readonly isLocked: boolean;
+  readonly publicKey: Uint8Array;
+  readonly type: KeypairType;
+
+  decodePkcs8 (passphrase?: string, encoded?: Uint8Array): void;
+  derive (suri: string, meta?: KeyringPair$Meta): KeyringPair;
+  encodePkcs8 (passphrase?: string): Uint8Array;
+  lock (): void;
+  setMeta (meta: KeyringPair$Meta): void;
+  sign (message: string | Uint8Array, options?: SignOptions): Uint8Array;
+  toJson (passphrase?: string): KeyringPair$Json;
+  unlock (passphrase?: string): void;
+  verify (message: string | Uint8Array, signature: Uint8Array, signerPublic: string | Uint8Array): boolean;
+  vrfSign (message: string | Uint8Array, context?: string | Uint8Array, extra?: string | Uint8Array): Uint8Array;
+  vrfVerify (message: string | Uint8Array, vrfResult: Uint8Array, signerPublic: string | Uint8Array, context?: string | Uint8Array, extra?: string | Uint8Array): boolean;
+}
+
+export interface KeyringPairs {
+  add: (pair: KeyringPair) => KeyringPair;
+  all: () => KeyringPair[];
+  get: (address: string | Uint8Array) => KeyringPair;
+  remove: (address: string | Uint8Array) => void;
+}
+
+export interface KeyringInstance {
+  readonly pairs: KeyringPair[];
+  readonly publicKeys: Uint8Array[];
+  readonly type: KeypairType;
+
+  decodeAddress (encoded: string | Uint8Array, ignoreChecksum?: boolean, ss58Format?: Prefix): Uint8Array;
+  encodeAddress (key: Uint8Array | string, ss58Format?: Prefix): string;
+  setSS58Format (ss58Format: Prefix): void;
+
+  addPair (pair: KeyringPair): KeyringPair;
+  addFromAddress (address: string | Uint8Array, meta?: KeyringPair$Meta, encoded?: Uint8Array | null, type?: KeypairType, ignoreChecksum?: boolean): KeyringPair;
+  addFromJson (pair: KeyringPair$Json, ignoreChecksum?: boolean): KeyringPair;
+  addFromMnemonic (mnemonic: string, meta?: KeyringPair$Meta, type?: KeypairType, wordlist?: string[]): KeyringPair;
+  addFromPair (pair: Keypair, meta?: KeyringPair$Meta, type?: KeypairType): KeyringPair
+  addFromSeed (seed: Uint8Array, meta?: KeyringPair$Meta, type?: KeypairType): KeyringPair;
+  addFromUri (suri: string, meta?: KeyringPair$Meta, type?: KeypairType, wordlist?: string[]): KeyringPair;
+  createFromJson (json: KeyringPair$Json, ignoreChecksum?: boolean): KeyringPair;
+  createFromPair (pair: Keypair, meta: KeyringPair$Meta, type: KeypairType): KeyringPair
+  createFromUri (suri: string, meta?: KeyringPair$Meta, type?: KeypairType, wordlist?: string[]): KeyringPair;
+  getPair (address: string | Uint8Array): KeyringPair;
+  getPairs (): KeyringPair[];
+  getPublicKeys (): Uint8Array[];
+  removePair (address: string | Uint8Array): void;
+  toJson (address: string | Uint8Array, passphrase?: string): KeyringPair$Json;
+}

package/tsconfig.build.json

@@ -0,0 +1,16 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "baseUrl": "..",
+    "outDir": "./build",
+    "rootDir": "./src"
+  },
+  "exclude": [
+    "**/*.spec.ts",
+    "**/mod.ts"
+  ],
+  "references": [
+    { "path": "../util/tsconfig.build.json" },
+    { "path": "../util-crypto/tsconfig.build.json" }
+  ]
+}