fix(builder): script no overwrite (#1799)

Author: dbeal-eth

examples/sample-foundry-project/write-script-models/build-foundry-write-script.cast

@@ -15,8 +15,6 @@ export const DEFAULT_REGISTRY_CONFIG = [
     name: 'OP Mainnet',
     chainId: 10,
     rpcUrl: [
-      'frame',
-      'direct',
       'https://optimism-mainnet.infura.io/v3/9f7e95d07f4e42e7a54d4dc90f57fd5d',
       'https://opt-mainnet.g.alchemy.com/v2/2c6Mq72inJF0FBlKPMK8pe6TolJMar6G',
     ],
@@ -26,8 +24,6 @@ export const DEFAULT_REGISTRY_CONFIG = [
     name: 'Ethereum Mainnet',
     chainId: 1,
     rpcUrl: [
-      'frame',
-      'direct',
       'https://mainnet.infura.io/v3/9f7e95d07f4e42e7a54d4dc90f57fd5d',
       'https://eth-mainnet.g.alchemy.com/v2/2c6Mq72inJF0FBlKPMK8pe6TolJMar6G',
     ],

examples/sample-foundry-project/write-script-models/build-foundry-write-script.ethers

@@ -28,7 +28,7 @@ import { getChainById } from '../chains';
 import { filterSettings, saveToMetadataCache } from '../helpers';
 import { getMainLoader } from '../loader';
 import { listInstalledPlugins, loadPlugins } from '../plugins';
-import { createDefaultReadRegistry, createOnChainOnlyRegistry } from '../registry';
+import { createDefaultReadRegistry, createLocalOnlyRegistry, createOnChainOnlyRegistry } from '../registry';
 import { resolveCliSettings } from '../settings';
 import { PackageSpecification } from '../types';
 import { log, warn, error } from '../util/console';
@@ -140,6 +140,7 @@ export async function build({
   };
 
   const onChainOnlyResolver = await createOnChainOnlyRegistry(cliSettings);
+  const localOnlyResolver = await createLocalOnlyRegistry(cliSettings);
   const resolver = overrideResolver || (await createDefaultReadRegistry(cliSettings));
 
   const runtime = new ChainBuilderRuntime(runtimeOptions, resolver, getMainLoader(cliSettings), 'ipfs');
@@ -149,11 +150,14 @@ export async function build({
   let oldDeployData: DeploymentInfo | null = null;
 
   // before building, make sure that the name/version isnt already taken on the registry
-  const isPackageAlreadyPublished = await onChainOnlyResolver.getUrl(fullPackageRef, chainId);
-  if (isPackageAlreadyPublished.url) {
-    throw new Error(
-      'The package ${fullPackageRef} is already published on the registry. Please bump the `version` field in your cannonfile.'
-    );
+  const localPackageUrl = await localOnlyResolver.getUrl(fullPackageRef, chainId);
+  if (!localPackageUrl.url) {
+    const isPackageAlreadyPublished = await onChainOnlyResolver.getUrl(fullPackageRef, chainId);
+    if (isPackageAlreadyPublished.url) {
+      throw new Error(
+        'The package ${fullPackageRef} is already published on the registry. Please bump the `version` field in your cannonfile.'
+      );
+    }
   }
 
   if (!wipe) {

examples/sample-foundry-project/write-script-models/build-foundry-write-script.foundry

@@ -217,6 +217,10 @@ export async function createOnChainOnlyRegistry(cliSettings: CliSettings): Promi
   );
 }
 
+export async function createLocalOnlyRegistry(cliSettings: CliSettings): Promise<LocalRegistry> {
+  return new LocalRegistry(cliSettings.cannonDirectory);
+}
+
 export async function createDefaultReadRegistry(
   cliSettings: CliSettings,
   additionalRegistries: CannonRegistry[] = []

examples/sample-foundry-project/write-script-models/build-foundry-write-script.json

@@ -1,10 +1,9 @@
-import { createWriteStream } from 'node:fs';
-import { finished } from 'node:stream/promises';
 import { ChainBuilderRuntime } from '@usecannon/builder';
 import { ensureFileSync } from 'fs-extra';
-import * as viem from 'viem';
 import { createStepsStream } from './stream-steps';
 import { DumpRenderer } from './types';
+import { writeFile } from 'node:fs/promises';
+import * as logger from '../util/console';
 
 export const WRITE_SCRIPT_FORMATS = ['json', 'ethers', 'foundry', 'cast'] as const;
 
@@ -28,24 +27,38 @@ export async function createWriteScript(
   const createRenderer = (await import(`./render-${format}`)).createRenderer as DumpRenderer;
 
   const events = createStepsStream(runtime);
-
   const blockNumber = await runtime.provider.getBlockNumber();
+  const renderer = createRenderer(Number(blockNumber));
+
+  // Collect all events into an array
+  const eventsData: string[] = [];
+
+  // Set up the event processing pipeline
+  const pipeline = events.stream.pipe(events.fetchTransactions).pipe(renderer);
 
-  const stream = events.stream // Listen for step execution events
-    .pipe(events.fetchTransactions) // asynchronically add the executed transactions
-    .pipe(createRenderer(Number(blockNumber))) // render step lines into the desired format
-    .pipe(createWriteStream(targetFile)); // save to file
+  pipeline.on('data', (chunk: string) => {
+    eventsData.push(chunk);
+  });
 
   return {
     end: async () => {
-      // The runtime does not have an event to notify when the build has finished
-      // so, we have to manully stop listening to it and close the streams.
+      // Signal the start of the pipeline to end
       events.stream.end();
 
-      await viem.withTimeout(() => finished(stream), {
-        timeout: 10000,
-        errorInstance: new Error('stream timed out'),
+      // Wait for the entire pipeline to finish processing
+      await new Promise<void>((resolve, reject) => {
+        pipeline.on('end', () => {
+          resolve();
+        });
+
+        pipeline.on('error', (error: Error) => {
+          logger.error('Pipeline error:', error);
+          reject(error);
+        });
       });
+
+      // Write all collected data to file atomically
+      await writeFile(targetFile, eventsData.join(''));
     },
   };
 }

packages/builder/src/constants.ts

@@ -0,0 +1,11 @@
+$CANNON build \
+    $CANNON_REPO_DIR/examples/sample-foundry-project/cannonfile.toml \
+    --wipe \
+    --write-script-format $1 \
+    --write-script /tmp/build-foundry-write-script.${1}
+
+# make sure the outputted write script file matches the model file
+# check first 20 lines of the generated file against the model file
+head -n 20 /tmp/build-foundry-write-script.${1} > /tmp/generated-head.txt
+head -n 20 $CANNON_REPO_DIR/examples/sample-foundry-project/write-script-models/build-foundry-write-script.$1 > /tmp/model-head.txt
+cmp /tmp/generated-head.txt /tmp/model-head.txt

packages/cli/src/commands/build.ts

@@ -69,6 +69,15 @@ teardown() {
   assert_file_exists "$CANNON_DIRECTORY/tags/greeter-foundry-private-source_latest_13370-main.txt"
 }
 
+@test "Build - Write Scripts with Foundry" {
+  run build-foundry-write-script.sh cast
+  run build-foundry-write-script.sh ethers
+  run build-foundry-write-script.sh foundry
+  #run build-foundry-write-script.sh json # this is currently not stable
+  echo $output
+  assert_success
+}
+
 @test "Build - Building foundry greeter example live" {
   set_custom_config
   run build-foundry-live.sh