fix: add duplicate of keyToImplicitAddress to @near-js/crypto

Author: denbite

.changeset/grumpy-numbers-find.md

@@ -0,0 +1,7 @@
+---
+"@near-js/crypto": patch
+"@near-js/utils": patch
+"near-api-js": patch
+---
+
+Add duplicate of `keyToImplicitAddress` to `@near-js/crypto` to prevent cycle dependency between packages

packages/crypto/src/index.ts

@@ -4,4 +4,4 @@ export { KeyPair } from './key_pair';
 export type { Signature } from './key_pair_base';
 export { KeyPairEd25519 } from './key_pair_ed25519';
 export { KeyPairSecp256k1 } from './key_pair_secp256k1';
-export { PublicKey } from './public_key';
+export { PublicKey, keyToImplicitAddress } from './public_key';

packages/crypto/src/public_key.ts

@@ -151,3 +151,19 @@ export class PublicKey extends Enum {
         return this.keyPair.data;
     }
 }
+
+export function keyToImplicitAddress(publicKey: string | PublicKey): string {
+    const pk = PublicKey.from(publicKey);
+
+    const publicKeyWithoutPrefix = pk.toString().replace(/^ed25519:/, '');
+  
+    const decoded = baseDecode(publicKeyWithoutPrefix);
+    // Converting to hex string is implemented manually 
+    // to avoid issues with environments that do not support Buffer
+    let result = '';
+    for (let i = 0; i < decoded.length; i++) {
+        const hex = decoded[i].toString(16);
+        result += hex.length === 1 ? '0' + hex : hex;
+    }
+    return result;
+}

packages/crypto/test/public_key.test.ts

@@ -0,0 +1,43 @@
+import { expect, test } from '@jest/globals';
+import { PublicKey, keyToImplicitAddress } from '../src';
+
+test.each`
+    publicKey                                                 | expected
+    ${'ed25519:DcA2MzgpJbrUATQLLceocVckhhAqrkingax4oJ9kZ847'} | ${'bb4dc639b212e075a751685b26bdcea5920a504181ff2910e8549742127092a0'}
+    ${'DcA2MzgpJbrUATQLLceocVckhhAqrkingax4oJ9kZ847'}         | ${'bb4dc639b212e075a751685b26bdcea5920a504181ff2910e8549742127092a0'}
+    ${'ed25519:6E8sCci9badyRkXb3JoRpBj5p8C6Tw41ELDZoiihKEtp'} | ${'4da7e0f4096aaf2ce55e371657cd3089ba1e9f59f4d6e27bd02e472a16a61dc1'}
+    ${'6E8sCci9badyRkXb3JoRpBj5p8C6Tw41ELDZoiihKEtp'}         | ${'4da7e0f4096aaf2ce55e371657cd3089ba1e9f59f4d6e27bd02e472a16a61dc1'}
+    ${'ed25519:5TdhJVkBRc9YWQdRZJXjYkfNNb8FYhPnJbGJk4zE5kDN'} | ${'424156f9ae27087a5de6b42f44d7f96db75d73ff6f3b9aa45f4cbe1259234829'}
+`(
+    'keyToImplicitAddress($publicKey) returns $expected',
+    ({ publicKey, expected }) => {
+        expect(keyToImplicitAddress(publicKey)).toEqual(expected);
+    }
+);
+
+test('keyToImplicitAddress accepts object with toString method', () => {
+    const pk = PublicKey.fromString('ed25519:DcA2MzgpJbrUATQLLceocVckhhAqrkingax4oJ9kZ847');
+
+    const result = keyToImplicitAddress(pk);
+    expect(result).toEqual(
+        'bb4dc639b212e075a751685b26bdcea5920a504181ff2910e8549742127092a0'
+    );
+});
+
+test('keyToImplicitAddress handles object with toString returning key without prefix', () => {
+    const pk = PublicKey.fromString('DcA2MzgpJbrUATQLLceocVckhhAqrkingax4oJ9kZ847');
+
+    const result = keyToImplicitAddress(pk);
+    expect(result).toEqual(
+        'bb4dc639b212e075a751685b26bdcea5920a504181ff2910e8549742127092a0'
+    );
+});
+
+test('keyToImplicitAddress returns hex string with proper padding', () => {
+    const result = keyToImplicitAddress(
+        'ed25519:DcA2MzgpJbrUATQLLceocVckhhAqrkingax4oJ9kZ847'
+    );
+
+    expect(result.length).toEqual(64);
+    expect(result).toMatch(/^[0-9a-f]+$/);
+});

packages/utils/src/utils.ts

@@ -1,16 +1,14 @@
 import { baseDecode } from './format';
-import type { PublicKey } from "../../crypto/src/public_key";
-
 
 export function sortBigIntAsc(a: bigint, b: bigint) {
     return (a < b ? -1 : a > b ? 1 : 0)
 }
 
-
-export function keyToImplicitAddress(publicKey: string | PublicKey): string {
-    const publicKeyStr = typeof publicKey === 'string' ? publicKey : publicKey.toString();
-
-    const publicKeyWithoutPrefix = publicKeyStr.replace(/^ed25519:/, '');
+/**
+ * @deprecated use {@link keyToImplicitAddress} exported from `@near-js/crypto` instead
+ */
+export function keyToImplicitAddress(publicKey: string): string {
+    const publicKeyWithoutPrefix = publicKey.toString().replace(/^ed25519:/, '');
 
     const decoded = baseDecode(publicKeyWithoutPrefix);
     let result = '';

packages/utils/test/utils.test.ts

@@ -1,6 +1,5 @@
 import { expect, test } from '@jest/globals';
 import { keyToImplicitAddress } from '../src/utils';
-import { PublicKey } from '../../crypto/src/public_key';
 
 test.each`
     publicKey                                                          | expected
@@ -13,17 +12,13 @@ test.each`
     expect(keyToImplicitAddress(publicKey)).toEqual(expected);
 });
 
-test('keyToImplicitAddress accepts object with toString method', () => {
-    const publicKeyObject = PublicKey.fromString('ed25519:DcA2MzgpJbrUATQLLceocVckhhAqrkingax4oJ9kZ847');
-    
-    const result = keyToImplicitAddress(publicKeyObject);
+test('keyToImplicitAddress accepts object with toString method', () => {   
+    const result = keyToImplicitAddress('ed25519:DcA2MzgpJbrUATQLLceocVckhhAqrkingax4oJ9kZ847');
     expect(result).toEqual('bb4dc639b212e075a751685b26bdcea5920a504181ff2910e8549742127092a0');
 });
 
 test('keyToImplicitAddress handles object with toString returning key without prefix', () => {
-    const publicKeyObject =  PublicKey.fromString('DcA2MzgpJbrUATQLLceocVckhhAqrkingax4oJ9kZ847');
-    
-    const result = keyToImplicitAddress(publicKeyObject);
+    const result = keyToImplicitAddress('DcA2MzgpJbrUATQLLceocVckhhAqrkingax4oJ9kZ847');
     expect(result).toEqual('bb4dc639b212e075a751685b26bdcea5920a504181ff2910e8549742127092a0');
 });