change exports

README.md

@@ -34,7 +34,7 @@
 ## Quickstart
 
 ```js
-import Substreams from "substreams";
+import { Substreams, download } from "substreams";
 
 // User input
 const host = "eos.firehose.eosnation.io:9001";
@@ -52,11 +52,10 @@ const substreams = new Substreams(host, {
 });
 
 (async () => {
-    // download Substream from IPFS
-    const modules = await Substreams.downloadSubstream(substream);
+    // download Substream & Protobuf from IPFS
+    const [modules, root] = await download(substream, proto);
 
-    // download Protobuf from IPFS
-    const root = await Substreams.downloadProto(proto);
+    // Protobuf types
     const Action = root.lookupType("Action");
 
     substreams.on("block", block => {

examples/example.ts

@@ -1,4 +1,4 @@
-import Substreams from "../";
+import { Substreams, download } from "../";
 
 // User input
 const host = "eos.firehose.eosnation.io:9001";
@@ -16,11 +16,10 @@ const substreams = new Substreams(host, {
 });
 
 (async () => {
-    // download Substream from IPFS
-    const modules = await Substreams.downloadSubstream(substream);
+    // download Substream & Protobuf from IPFS
+    const [modules, root] = await download(substream, proto);
 
-    // download protobuf from IPFS
-    const root = await Substreams.downloadProto(proto);
+    // Protobuf types
     const Action = root.lookupType("Action");
 
     substreams.on("block", block => {

index.ts

@@ -6,7 +6,6 @@ import { GrpcTransport } from '@protobuf-ts/grpc-transport';
 // Substream generated code
 // $ buf generate buf.build/fubhy/substreams
 import { StreamClient } from './src/generated/sf/substreams/v1/substreams.client';
-import { Package } from './src/generated/sf/substreams/v1/package';
 import { Modules } from './src/generated/sf/substreams/v1/modules';
 import { BlockScopedData, ForkStep, Request } from './src/generated/sf/substreams/v1/substreams';
 import { StoreDeltas } from "./src/generated/sf/substreams/v1/substreams";
@@ -20,7 +19,7 @@ export * from "./src/generated/sf/substreams/v1/substreams"
 export * from "./src/utils";
 
 // Utils
-import { downloadPackage, downloadProto, parseBlockData } from './src/utils';
+import { parseBlockData } from './src/utils';
 
 // Create Substream
 export function createStream(client: StreamClient, modules?: Modules, options: {
@@ -43,13 +42,6 @@ export function createStream(client: StreamClient, modules?: Modules, options: {
     }));
 }
 
-async function downloadSubstream( ipfs: string ) {
-    const binary = await downloadPackage(ipfs);
-    const { modules } = Package.fromBinary(binary);
-    if ( !modules ) throw new Error(`No modules found in Substream: ${ipfs}`);
-    return modules;
-}
-
 interface ModuleOutput {
     name: string;
     logs: string[];
@@ -76,7 +68,7 @@ type MessageEvents = {
     storeDeltas: (output: StoreDelta) => void;
 }
 
-export default class Substreams extends (EventEmitter as new () => TypedEmitter<MessageEvents>) {
+export class Substreams extends (EventEmitter as new () => TypedEmitter<MessageEvents>) {
     // internal
     public client: StreamClient;
 
@@ -113,14 +105,6 @@ export default class Substreams extends (EventEmitter as new () => TypedEmitter<
         );
     }
 
-    static async downloadSubstream( ipfs: string ) {
-        return downloadSubstream(ipfs);
-    }
-
-    static async downloadProto( ipfs: string ) {
-        return downloadProto(ipfs);
-    }
-
     public async start(modules: Modules) {    
         // Setup Substream
         const stream = createStream(this.client, modules, {
@@ -150,4 +134,4 @@ export default class Substreams extends (EventEmitter as new () => TypedEmitter<
             }
         }
     }
-}
+}

package.json

@@ -1,7 +1,7 @@
 {
   "name": "substreams",
   "description": "Substreams Node.js consumer",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "main": "dist/index.js",
   "types": "dist/index.d.js",
   "license": "MIT",

src/generated/google/protobuf/timestamp.ts

@@ -1,3 +1,4 @@
+/* @ts-nocheck */
 /* eslint-disable */
 // @generated by protobuf-ts 2.8.2 with parameter generate_dependencies,long_type_string,eslint_disable,client_generic
 // @generated from protobuf file "google/protobuf/timestamp.proto" (package "google.protobuf", syntax proto3)

src/utils.ts

@@ -6,6 +6,7 @@ import { importer } from 'ipfs-unixfs-importer';
 import { MemoryBlockstore } from 'blockstore-core/memory';
 
 // Substream auto-generated
+import { Package } from './generated/sf/substreams/v1/package';
 import { Clock } from "./generated/sf/substreams/v1/clock";
 import { BlockScopedData, Response } from "./generated/sf/substreams/v1/substreams";
 
@@ -41,11 +42,22 @@ export function tmpFilepath(ipfs: string) {
     return path.join(os.tmpdir(), ipfs);
 }
 
+export async function download(substream: string, proto: string) {
+    return Promise.all([downloadSubstream(substream), downloadProto(proto)]);
+}
+
 export async function downloadProto(ipfs: string) {
     await downloadToFile(ipfs);
     return protobuf.loadSync(tmpFilepath(ipfs));
 }
 
+export async function downloadSubstream( ipfs: string ) {
+    const binary = await downloadPackage(ipfs);
+    const { modules } = Package.fromBinary(binary);
+    if ( !modules ) throw new Error(`No modules found in Substream: ${ipfs}`);
+    return modules;
+}
+
 export function readFileToBuffer(ipfs: string) {
     console.log(`Reading from file system: ${ipfs}`);
     const filepath = path.isAbsolute(ipfs) ? ipfs : path.resolve(process.cwd(), ipfs);

tsconfig.json

@@ -10,11 +10,10 @@
 
     /* Module Resolution Options */
     "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
-    "allowSyntheticDefaultImports": true,     /* Allow 'import x from y' when a module doesn't have a default export. */
 
     /* Additional Checks */
-    // "noUnusedLocals": true,                /* Report errors on unused locals. */
-    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
+    "noUnusedLocals": true,                /* Report errors on unused locals. */
+    "noUnusedParameters": true,            /* Report errors on unused parameters. */
     "noImplicitReturns": true,                /* Report error when not all code paths in function return a value. */
     "noFallthroughCasesInSwitch": true,       /* Report errors for fallthrough cases in switch statement. */