refactor(utxo-lib): rename getChainAndIndex to getScriptIdFromPath

Introduce ScriptId type alias and rename function for better semantic clarity.
The new name better reflects that the function extracts script identifiers
from BIP32 paths, improving code readability and type safety.

Issue: BTC-1966

Co-authored-by: llm-git <[email protected]>

Author: OttoAllmendinger

modules/utxo-lib/src/bitgo/wallet/ScriptId.ts

@@ -1,9 +1,16 @@
 import { ChainCode, isChainCode } from './chains';
 
-export function getChainAndIndexFromPath(path: string): {
+export type ScriptId = {
   chain: ChainCode;
   index: number;
-} {
+};
+
+/**
+ * Get the chain and index from a bip32 path.
+ *
+ * @param path
+ */
+export function getScriptIdFromPath(path: string): ScriptId {
   const parts = path.split('/');
   if (parts.length <= 2) {
     throw new Error(`invalid path "${path}"`);
@@ -19,3 +26,6 @@ export function getChainAndIndexFromPath(path: string): {
 
   return { chain, index };
 }
+
+/** @deprecated use getScriptId */
+export const getChainAndIndexFromPath = getScriptIdFromPath;

modules/utxo-lib/test/bitgo/wallet/ScriptId.ts

@@ -1,26 +1,26 @@
 import * as assert from 'assert';
 
-import { getChainAndIndexFromPath } from '../../../src/bitgo/wallet/ScriptId';
+import { getScriptIdFromPath } from '../../../src/bitgo/wallet/ScriptId';
 
-describe('getChainAndIndexFromPath', function () {
+describe('getScriptId', function () {
   it('should throw if path is not the right length', function () {
-    assert.throws(() => getChainAndIndexFromPath('/'), /invalid path/);
-    assert.throws(() => getChainAndIndexFromPath('m0000ssss'), /invalid path/);
+    assert.throws(() => getScriptIdFromPath('/'), /invalid path/);
+    assert.throws(() => getScriptIdFromPath('m0000ssss'), /invalid path/);
   });
 
   it('should throw if the path is not a number', function () {
     const invalidChain = [-1, 2, 'lol'];
     const invalidIndex = [-1, 'lol'];
     for (const chain of invalidChain) {
-      assert.throws(() => getChainAndIndexFromPath(`m/${chain}/0`), /invalid chain/);
+      assert.throws(() => getScriptIdFromPath(`m/${chain}/0`), /invalid chain/);
     }
     for (const index of invalidIndex) {
-      assert.throws(() => getChainAndIndexFromPath(`m/0/${index}`), /invalid index/);
+      assert.throws(() => getScriptIdFromPath(`m/0/${index}`), /invalid index/);
     }
   });
 
   it('should set the chain and index correctly', function () {
-    assert.deepStrictEqual(getChainAndIndexFromPath('m/1/2'), { chain: 1, index: 2 });
-    assert.deepStrictEqual(getChainAndIndexFromPath('m/1/2/3/4/5/10/20'), { chain: 10, index: 20 });
+    assert.deepStrictEqual(getScriptIdFromPath('m/1/2'), { chain: 1, index: 2 });
+    assert.deepStrictEqual(getScriptIdFromPath('m/1/2/3/4/5/10/20'), { chain: 10, index: 20 });
   });
 });