fix: add KeyPairString type

near · Sep 27, 2022 · 6648797 · 6648797
1 parent 180f966
commit 6648797
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 6 deletions.
diff --git a/packages/near-api-js/src/key_stores/in_memory_key_store.ts b/packages/near-api-js/src/key_stores/in_memory_key_store.ts
@@ -1,5 +1,5 @@
 import { KeyStore } from './keystore';
-import { KeyPair } from '../utils/key_pair';
+import { KeyPair, KeyPairString } from '../utils/key_pair';
 
 /**
  * Simple in-memory keystore for mainly for testing purposes.
@@ -30,7 +30,7 @@ import { KeyPair } from '../utils/key_pair';
  */
 export class InMemoryKeyStore extends KeyStore {
     /** @hidden */
-    private keys: { [key: string]: string };
+    private keys: { [key: string]: KeyPairString };
 
     constructor() {
         super();

diff --git a/packages/near-api-js/src/utils/key_pair.ts b/packages/near-api-js/src/utils/key_pair.ts
@@ -95,10 +95,12 @@ export class PublicKey extends Assignable {
     }
 }
 
+export type KeyPairString = `ed25519:${string}` | `secp256k1:${string}`;
+
 export abstract class KeyPair {
     abstract sign(message: Uint8Array): Signature;
     abstract verify(message: Uint8Array, signature: Uint8Array): boolean;
-    abstract toString(): string;
+    abstract toString(): KeyPairString;
     abstract getPublicKey(): PublicKey;
 
     /**
@@ -113,7 +115,7 @@ export abstract class KeyPair {
         }
     }
 
-    static fromString(encodedKey: `${'secp256k1' | 'ed25519'}:${string}`): KeyPair {
+    static fromString(encodedKey: KeyPairString): KeyPair {
         const parts = encodedKey.split(':');
         //TODO: clarify what we must do here
         if (parts.length === 2) {
@@ -172,7 +174,7 @@ export class KeyPairEd25519 extends KeyPair {
         return this.publicKey.verify(message, signature);
     }
 
-    toString(): string {
+    toString(): KeyPairString {
         return `ed25519:${this.secretKey}`;
     }
 
@@ -236,7 +238,7 @@ export class KeyPairSecp256k1 extends KeyPair {
         return this.publicKey.verify(message, signature);
     }
 
-    toString(): string {
+    toString(): KeyPairString {
         return `secp256k1:${this.secretKey}`;
     }