Merge pull request #6399 from BitGo/BTC-2143.btc-staking-ts-103-vendor-with-cherry-pick

feat(babylonlabs-io-btc-staking-ts): update vendor script

Author: OttoAllmendinger

modules/babylonlabs-io-btc-staking-ts/CHANGELOG.md

@@ -1 +1 @@
-BitGo Fork of https://github.com/babylonlabs-io/btc-staking-ts/tree/v0.4.0-rc.2
+BitGo Fork of https://github.com/babylonlabs-io/btc-staking-ts/tree/v1.0.3

modules/babylonlabs-io-btc-staking-ts/README.md

@@ -1,13 +1,21 @@
-export { StakingScriptData, Staking } from './staking';
-export type { StakingScripts } from './staking';
-export { ObservableStaking, ObservableStakingScriptData } from './staking/observable';
-export * from './staking/transactions';
-export * from './types';
-export * from './utils/btc';
-export * from './utils/babylon';
-export * from './utils/staking';
-export * from './utils/utxo/findInputUTXO';
-export * from './utils/utxo/getPsbtInputFields';
-export * from './utils/utxo/getScriptType';
-export { getBabylonParamByBtcHeight, getBabylonParamByVersion } from './utils/staking/param';
-export * from './staking/manager';
+export { StakingScriptData, Staking } from "./staking";
+export type { StakingScripts } from "./staking";
+export {
+  ObservableStaking,
+  ObservableStakingScriptData,
+} from "./staking/observable";
+export * from "./staking/transactions";
+export * from "./types";
+export * from "./utils/btc";
+export * from "./utils/utxo/findInputUTXO";
+export * from "./utils/utxo/getPsbtInputFields";
+export * from "./utils/utxo/getScriptType";
+export {
+  getBabylonParamByBtcHeight,
+  getBabylonParamByVersion,
+} from "./utils/staking/param";
+export * from "./staking/manager";
+
+// BitGo-specific exports
+export * from "./utils/babylon";
+export * from "./utils/staking";

modules/babylonlabs-io-btc-staking-ts/src/index.ts

@@ -19,9 +19,6 @@
     },
     {
       "path": "../utxo-core"
-    },
-    {
-      "path": "../babylonlabs-io-btc-staking-ts"
     }
   ]
 }

modules/utxo-staking/tsconfig.json

@@ -1,28 +1,61 @@
-import { ChildProcess, execFile } from 'child_process';
+import { execa, ResultPromise } from 'execa';
 import * as fs from 'fs/promises';
 import * as tmp from 'tmp';
 import * as yargs from 'yargs';
 
-function isErrorExists(e: NodeJS.ErrnoException): boolean {
-  return e.code === 'EEXIST';
-}
-
 type GithubSource = {
   org: string;
   repo: string;
 } & ({ tag: string } | { ref: string });
 
-async function wait(p: ChildProcess): Promise<void> {
-  p.stderr?.pipe(process.stderr);
-  p.stdout?.pipe(process.stdout);
-  return new Promise((resolve, reject) => {
-    p.on('exit', (code) => {
-      if (code === 0) {
-        resolve();
-      } else {
-        reject(new Error(`Process exited with code ${code}`));
-      }
-    });
+export function getDescription(source: GithubSource): string {
+  if ('tag' in source) {
+    return `${source.org}/${source.repo}#${source.tag}`;
+  } else if ('ref' in source) {
+    return `${source.org}/${source.repo}#${source.ref}`;
+  } else {
+    throw new Error('Invalid GithubSource, must have either tag or ref');
+  }
+}
+
+export type VendorConfig = GithubSource & {
+  targetDir: string;
+  removeFiles: string[];
+  /** Git commit range with patches */
+  cherryPick: {
+    start: string;
+    end: string;
+  } | null;
+};
+
+function isErrorExists(e: NodeJS.ErrnoException): boolean {
+  return e.code === 'EEXIST';
+}
+
+async function gitCommit({ path, title, message }: { path: string; title: string; message: string }): Promise<void> {
+  await execa('git', ['add', path]);
+  await execa('git', ['commit', path, '-m', title, '-m', message, '--no-verify'], {
+    stdio: 'inherit',
+  });
+}
+
+async function gitCherryPick(revRange: { start: string; end: string }): Promise<void> {
+  const range = `${revRange.start}^..${revRange.end}`;
+  await execa('git', ['cherry-pick', range], {
+    stdio: 'inherit',
+  });
+}
+
+async function removeDevAndTestFiles(removePaths: string[], targetDir: string): Promise<void> {
+  for (const path of removePaths) {
+    console.log(`Removing dev/test file: ${path}`);
+    const fullPath = `${targetDir}/${path}`;
+    await fs.rm(fullPath, { recursive: true, force: true });
+  }
+  await gitCommit({
+    path: targetDir,
+    title: 'chore: remove dev and test files',
+    message: 'This commit removes unnecessary development and test files from the vendor directory.',
   });
 }
 
@@ -58,6 +91,12 @@ async function fetchArchive(lib: GithubSource, outfile: string): Promise<void> {
   await fs.writeFile(outfile, Buffer.from(await result.arrayBuffer()));
 }
 
+function pipe(cmd: ResultPromise): ResultPromise {
+  cmd.stdout?.pipe(process.stdout);
+  cmd.stderr?.pipe(process.stderr);
+  return cmd;
+}
+
 async function extractArchive(archivePath: string, targetDir: string): Promise<void> {
   try {
     await fs.mkdir(targetDir, { recursive: true });
@@ -66,18 +105,42 @@ async function extractArchive(archivePath: string, targetDir: string): Promise<v
       throw e;
     }
   }
-  await wait(execFile('tar', ['-C', targetDir, '--strip-components', '1', '-xzf', archivePath]));
+  await pipe(execa('tar', ['-C', targetDir, '--strip-components', '1', '-xzf', archivePath]));
 }
 
-type VendorConfig = GithubSource & {
-  targetDir: string;
-};
-
-async function main(cfgs: VendorConfig[]) {
+async function cmdVendor(
+  cfgs: VendorConfig[],
+  opts: {
+    removeFiles: boolean;
+    cherryPick: boolean;
+  }
+) {
   for (const cfg of cfgs) {
+    const desc = getDescription(cfg);
     const archivePath = getArchivePath(cfg);
     await fetchArchive(cfg, archivePath);
     await extractArchive(archivePath, cfg.targetDir);
+    await gitCommit({
+      path: cfg.targetDir,
+      title: `chore: vendor ${desc}`,
+      message: `This commit was generated by the vendor-github-repo script.`,
+    });
+
+    if (cfg.removeFiles.length === 0) {
+      console.log('No files to remove for', cfg.repo);
+    } else if (opts.removeFiles) {
+      await removeDevAndTestFiles(cfg.removeFiles, cfg.targetDir);
+    } else {
+      console.log(`Skipping removal of dev/test files for ${cfg.repo}, use --removeFiles to enable.`);
+    }
+
+    if (cfg.cherryPick === null) {
+      console.log(`No patch set defined for ${cfg.repo}, skipping rebase.`);
+    } else if (opts.removeFiles) {
+      await gitCherryPick(cfg.cherryPick);
+    } else {
+      console.log(`Skipping cherry-pick for ${cfg.repo}, use --cherryPick to enable.`);
+    }
   }
 }
 
@@ -87,24 +150,77 @@ const vendorConfigs: VendorConfig[] = [
     repo: 'btc-staking-ts',
     tag: 'v1.0.3',
     targetDir: 'modules/babylonlabs-io-btc-staking-ts',
+    removeFiles: [
+      '.eslintrc.json',
+      '.github/',
+      '.husky/',
+      '.npmrc',
+      '.nvmrc',
+      '.prettierignore',
+      '.prettierrc.json',
+      'docs/',
+      'tests/',
+      'README.md',
+    ],
+    cherryPick: {
+      start: '8b8261b8b639d09cbe1223615797c18a2788cd89',
+      end: '06110dd3e892df326261cd79ead158c28370add7',
+    },
   },
 ];
 
+function getMatches(name: string, version: string | undefined): VendorConfig[] {
+  const matches = vendorConfigs.filter((cfg) => {
+    if (name !== cfg.repo) {
+      return false;
+    }
+    if ('tag' in cfg && version !== undefined) {
+      return cfg.tag === version;
+    }
+    return true;
+  });
+  if (matches.length === 0) {
+    throw new Error(`no such vendor config ${name} version ${version}`);
+  }
+  if (matches.length > 1) {
+    throw new Error(`ambiguous vendor config ${name}`);
+  }
+  return matches;
+}
+
+const optName = {
+  type: 'string',
+  demand: true,
+  describe: 'Name of the vendor config to use, e.g. btc-staking-ts',
+} as const;
+
+const optVersion = {
+  type: 'string',
+  describe: 'Version of the vendor config to use, e.g. v2.3.4',
+} as const;
+
 yargs
   .command({
     command: 'vendor',
+    describe: 'Vendor a github repo',
     builder(a) {
-      return a.options({ name: { type: 'string' } });
+      return a.options({
+        name: optName,
+        pkgVersion: optVersion,
+        removeFiles: {
+          type: 'boolean',
+          default: true,
+          describe: 'Remove dev/test files after extracting the archive',
+        },
+        cherryPick: {
+          type: 'boolean',
+          default: true,
+          describe: 'Apply cherry-pick patches after extracting the archive',
+        },
+      });
     },
     async handler(a) {
-      const matches = vendorConfigs.filter((cfg) => a.name === cfg.repo);
-      if (matches.length === 0) {
-        throw new Error(`no such vendor config ${a.name}`);
-      }
-      if (matches.length > 1) {
-        throw new Error(`ambiguous vendor config ${a.name}`);
-      }
-      await main(matches);
+      await cmdVendor(getMatches(a.name, a.pkgVersion), a);
     },
   })
   .help()