Feature | graph init Add support to download spkg files from spkg.io

.changeset/early-walls-talk.md

@@ -0,0 +1,5 @@
+---
+'@graphprotocol/graph-cli': patch
+---
+
+Order list of evm chains in graph init command

packages/cli/src/command-helpers/download.ts

@@ -0,0 +1,13 @@
+import { createWriteStream } from 'fs';
+import { http } from 'gluegun';
+
+export async function downloadFile(fileUrl: string, outputLocationPath: string) {
+  const writer = createWriteStream(outputLocationPath);
+  const api = http.create({
+    baseURL: fileUrl,
+  });
+  return api.get('', {}, { responseType: 'stream' }).then((response: any) => {
+    response.data.pipe(writer);
+    return Promise.resolve(outputLocationPath);
+  });
+}

packages/cli/src/command-helpers/spkg.test.ts

@@ -0,0 +1,41 @@
+import path from 'path';
+import { describe, expect, it } from 'vitest';
+import { getSpkgFilePath, isSpkgUrl } from '../../src/command-helpers/spkg';
+
+describe('getSpkgFilePath', () => {
+  it('should return the correct file path', () => {
+    const spkgUrl = 'https://example.com/package.spkg';
+    const directory = '/home/testuser/development/testgraph';
+    const expectedFilePath = path.join(directory, 'package.spkg');
+
+    const filePath = getSpkgFilePath(spkgUrl, directory);
+
+    expect(filePath).to.equal(expectedFilePath);
+  });
+
+  it('should throw an error for invalid spkg url', () => {
+    const spkgUrl = '';
+    const directory = '/home/joshua/development/graphprotocol/graph-tooling/packages/cli';
+
+    expect(() => getSpkgFilePath(spkgUrl, directory)).to.throw('Invalid spkg url');
+  });
+});
+
+describe('isSpkgUrl', () => {
+  it('should return true for valid spkg url', () => {
+    const spkgUrl = 'https://spkg.io/streamingfast/package.spkg';
+    const result = isSpkgUrl(spkgUrl);
+    expect(result).toBe(true);
+  });
+
+  it('should return false for invalid spkg url', () => {
+    const spkgUrl = 'https://example.com/package.spkg';
+    const result = isSpkgUrl(spkgUrl);
+    expect(result).toBe(false);
+  });
+  it('should return false for non-url string', () => {
+    const spkgUrl = 'streamingfast/package.spkg';
+    const result = isSpkgUrl(spkgUrl);
+    expect(result).toBe(false);
+  });
+});

packages/cli/src/command-helpers/spkg.ts

@@ -0,0 +1,18 @@
+// validator that checks if spkg exists or is valid url
+
+import path from 'path';
+import { filesystem } from 'gluegun';
+
+export const isSpkgUrl = (value: string) => {
+  return value.startsWith('https://spkg.io/streamingfast');
+};
+
+export const validateSpkg = (value: string) => {
+  return filesystem.exists(value) || isSpkgUrl(value);
+};
+
+export const getSpkgFilePath = (spkgUrl: string, directory: string) => {
+  const spkgFileName = spkgUrl.split('/').pop();
+  if (!spkgFileName) throw new Error('Invalid spkg url');
+  return path.join(directory, spkgFileName);
+};

packages/cli/src/commands/init.ts

@@ -9,11 +9,13 @@
   loadAbiFromEtherscan,
   loadStartBlockForContract,
 } from '../command-helpers/abi';
+import { downloadFile } from '../command-helpers/download';
 import { initNetworksConfig } from '../command-helpers/network';
 import { chooseNodeUrl, SUBGRAPH_STUDIO_URL } from '../command-helpers/node';
 import { generateScaffold, writeScaffold } from '../command-helpers/scaffold';
 import { sortWithPriority } from '../command-helpers/sort';
 import { withSpinner } from '../command-helpers/spinner';
+import { getSpkgFilePath, isSpkgUrl, validateSpkg } from '../command-helpers/spkg';
 import { getSubgraphBasename, validateSubgraphName } from '../command-helpers/subgraph';
 import { GRAPH_CLI_SHARED_HEADERS } from '../constants';
 import debugFactory from '../debug';
@@ -726,11 +728,10 @@
       {
         type: 'input',
         name: 'spkg',
-        message: 'SPKG file (path)',
+        message: 'SPKG file (path or spkg.io url)',
         initial: () => initSpkgPath,
         skip: () => !isSubstreams || !!initSpkgPath,
-        validate: value =>
-          filesystem.exists(initSpkgPath || value) ? true : 'SPKG file does not exist',
+        validate: value => validateSpkg(value) || 'Invalid SPKG file',
       },
     ]);
 
@@ -1206,6 +1207,16 @@
     this.error(`ABI does not contain any events`, { exit: 1 });
   }
 
+  let spkgFilePath = spkgPath;
+  // if url let's overwrite with the file path
+  if (spkgPath && isSpkgUrl(spkgPath)) {
+    try {
+      spkgFilePath = await getSpkgFilePath(spkgPath, directory);
+    } catch (e) {
+      this.error(e.message, { exit: 1 });
+    }
+  }
+
   // Scaffold subgraph
   const scaffold = await withSpinner(
     `Create subgraph scaffold`,
@@ -1223,11 +1234,14 @@
           contractName,
           startBlock,
           node,
-          spkgPath,
+          spkgPath: spkgFilePath,
         },
         spinner,
       );
       await writeScaffold(scaffold, directory, spinner);
+      if (spkgPath && spkgFilePath && isSpkgUrl(spkgPath)) {
+        await downloadFile(spkgPath, spkgFilePath);
+      }
       return true;
     },
   );
@@ -1237,7 +1251,7 @@
   }
 
   if (protocolInstance.hasContract()) {
     const identifierName = protocolInstance.getContract()!.identifierName();
     const networkConf = await initNetworksConfig(directory, identifierName);
     if (networkConf !== true) {
       process.exitCode = 1;
@@ -1300,7 +1314,7 @@
   const addContractConfirmation = addContractAnswer.toLowerCase() === 'y';
 
   if (addContractConfirmation) {
     const ProtocolContract = protocolInstance.getContract()!;
 
     let contract = '';
     for (;;) {