@apibara/protocol 0.3.0 → 0.4.0-next.1

package/dist/client.d.ts

@@ -1,28 +1,119 @@
-import { ClientOptions, ChannelCredentials } from '@grpc/grpc-js';
-import { Retry, StreamMessagesStream } from './stream';
-import { NodeClient as GrpcNodeClient } from './proto/apibara/node/v1alpha1/Node';
-import { StatusResponse__Output } from './proto/apibara/node/v1alpha1/StatusResponse';
-import { StreamMessagesRequest } from './proto/apibara/node/v1alpha1/StreamMessagesRequest';
-export declare const Node: (new (address: string, credentials: ChannelCredentials, options?: ClientOptions | undefined) => GrpcNodeClient) & {
-    service: import("./proto/apibara/node/v1alpha1/Node").NodeDefinition;
+import { ChannelCredentials, ClientDuplexStream, ClientOptions, StatusObject } from '@grpc/grpc-js';
+import { v1alpha2 } from './proto';
+export { ChannelCredentials, StatusObject } from '@grpc/grpc-js';
+export declare type DataStream = ClientDuplexStream<v1alpha2.IStreamDataRequest, v1alpha2.IStreamDataResponse>;
+export declare type ConfigureArgs = {
+    /**
+     * Stream filter, encoded.
+     */
+    filter: Uint8Array;
+    /**
+     * How much data in a single message.
+     */
+    batchSize?: number;
+    /**
+     * Starting cursor. This cursor is stream-specific.
+     */
+    cursor?: v1alpha2.ICursor | null;
+    /**
+     * Data finality, e.g. finalized or accepted.
+     */
+    finality?: v1alpha2.DataFinality | null;
 };
-export declare const credentials: {
-    combineChannelCredentials: (channelCredentials: ChannelCredentials, ...callCredentials: import("@grpc/grpc-js").CallCredentials[]) => ChannelCredentials;
-    combineCallCredentials: (first: import("@grpc/grpc-js").CallCredentials, ...additional: import("@grpc/grpc-js").CallCredentials[]) => import("@grpc/grpc-js").CallCredentials;
-    createInsecure: typeof ChannelCredentials.createInsecure;
-    createSsl: typeof ChannelCredentials.createSsl;
-    createFromSecureContext: typeof ChannelCredentials.createFromSecureContext;
-    createFromMetadataGenerator: typeof import("@grpc/grpc-js").CallCredentials.createFromMetadataGenerator;
-    createFromGoogleCredential: typeof import("@grpc/grpc-js").CallCredentials.createFromGoogleCredential;
-    createEmpty: typeof import("@grpc/grpc-js").CallCredentials.createEmpty;
+/**
+ * Reconnect callback return value.
+ */
+export declare type OnReconnectResult = {
+    /**
+     * If `true`, reconnects to the stream.
+     */
+    reconnect: boolean;
+    /**
+     * Stream configuration used when reconnecting.
+     *
+     * By default, the client uses the last configuration passed to
+     * `configure` and updates the `cursor` with the most recent one.
+     */
+    args?: ConfigureArgs;
 };
-export interface StreamMessagesOptions {
-    reconnect?: boolean;
-    onRetry?: (retryCount: number) => Retry;
-}
-export declare class NodeClient {
-    private readonly client;
-    constructor(address: string, credentials: ChannelCredentials, options?: ClientOptions);
-    status(): Promise<StatusResponse__Output | undefined>;
-    streamMessages(args: StreamMessagesRequest, options?: StreamMessagesOptions): StreamMessagesStream;
+/**
+ * Reconnect callback.
+ */
+export declare type OnReconnect = (err: StatusObject, retryCount: number) => Promise<OnReconnectResult> | OnReconnectResult;
+export declare type StreamClientArgs = {
+    /**
+     * The stream url.
+     */
+    url: string;
+    /**
+     * Grpc credentials.
+     *
+     * Use `ChannelCredentials.createInsecure()` to disable SSL.
+     */
+    credentials?: ChannelCredentials;
+    /**
+     * Grpc client options.
+     */
+    clientOptions?: ClientOptions;
+    /**
+     * Callback to control reconnection after receiving an error from the stream.
+     *
+     * By default uses `defaultOnReconnect`, which only reconnects on internal grpc errors.
+     */
+    onReconnect?: OnReconnect;
+};
+/**
+ * A client to configure and stream data.
+ */
+export declare class StreamClient {
+    private readonly inner;
+    private stream?;
+    private stream_id;
+    private onReconnect;
+    private configuration?;
+    /**
+     * Create a new `StreamClient`.
+     *
+     * Notice that the stream is not connected until you start iterating over it.
+     * The stream should be used as an _async iterator_.
+     *
+     * @example
+     * ```ts
+     * import { StreamClient } from '@apibara/protocol'
+     *
+     * const client = new StreamClient({ url })
+     *
+     * client.configure({ filter, cursor })
+     *
+     * for await (const message of client) {
+     *   // use message
+     * }
+     * ```
+     */
+    constructor({ url, credentials, clientOptions, onReconnect }: StreamClientArgs);
+    /**
+     * Async iterator over messages in the stream.
+     */
+    [Symbol.asyncIterator](): AsyncIterator<v1alpha2.IStreamDataResponse>;
+    /**
+     * Configure the stream to return the requested data.
+     *
+     * The stream can be reconfigured while streaming data, the client will
+     * take care of returning only data for the new configuration even if there
+     * are old messages in-flight.
+     */
+    configure(args: ConfigureArgs): void;
+    private _configure;
+    private connect;
 }
+/**
+ * A `onReconnect` callback that never reconnects.
+ */
+export declare function neverReconnect(_err: StatusObject, _retryCount: number): OnReconnectResult;
+/**
+ * A `onReconnect` callback that retries to reconnect up to 5 times.
+ *
+ * If the error is not an internal error, then it will not reconnect.
+ * This callback awaits for `1s * retryCount` before returning.
+ */
+export declare function defaultOnReconnect(err: StatusObject, retryCount: number): Promise<OnReconnectResult>;

package/dist/client.js

@@ -1,46 +1,170 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NodeClient = exports.credentials = exports.Node = void 0;
-const util_1 = require("util");
+exports.defaultOnReconnect = exports.neverReconnect = exports.StreamClient = exports.ChannelCredentials = void 0;
 const grpc_js_1 = require("@grpc/grpc-js");
-const proto_loader_1 = require("@grpc/proto-loader");
-const stream_1 = require("./stream");
-const __NODE_PROTO_PATH = __dirname + '/proto/node.proto';
-const packageDefinition = (0, proto_loader_1.loadSync)(__NODE_PROTO_PATH, {});
-const protoDescriptor = (0, grpc_js_1.loadPackageDefinition)(packageDefinition);
-exports.Node = protoDescriptor.apibara.node.v1alpha1.Node;
-exports.credentials = grpc_js_1.credentials;
-class NodeClient {
-    constructor(address, credentials, options) {
-        this.client = new exports.Node(address, credentials, options);
-    }
-    status() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return (0, util_1.promisify)(this.client.Status.bind(this.client, {}))();
+const proto_1 = require("./proto");
+const request_1 = require("./request");
+var grpc_js_2 = require("@grpc/grpc-js");
+Object.defineProperty(exports, "ChannelCredentials", { enumerable: true, get: function () { return grpc_js_2.ChannelCredentials; } });
+const StreamService = proto_1.v1alpha2.protoDescriptor.apibara.node.v1alpha2.Stream;
+/**
+ * A client to configure and stream data.
+ */
+class StreamClient {
+    /**
+     * Create a new `StreamClient`.
+     *
+     * Notice that the stream is not connected until you start iterating over it.
+     * The stream should be used as an _async iterator_.
+     *
+     * @example
+     * ```ts
+     * import { StreamClient } from '@apibara/protocol'
+     *
+     * const client = new StreamClient({ url })
+     *
+     * client.configure({ filter, cursor })
+     *
+     * for await (const message of client) {
+     *   // use message
+     * }
+     * ```
+     */
+    constructor({ url, credentials, clientOptions, onReconnect }) {
+        this.inner = new StreamService(url, credentials ?? grpc_js_1.ChannelCredentials.createSsl(), {
+            'grpc.keepalive_timeout_ms': 3600000,
+            ...clientOptions,
         });
+        this.stream_id = 0;
+        this.onReconnect = onReconnect ?? defaultOnReconnect;
     }
-    streamMessages(args, options) {
-        // only reconnect if user has opted-in
-        let onRetry = stream_1.neverRetry;
-        if (options === null || options === void 0 ? void 0 : options.reconnect) {
-            if (options.onRetry) {
-                onRetry = options.onRetry;
+    /**
+     * Async iterator over messages in the stream.
+     */
+    async *[Symbol.asyncIterator]() {
+        if (!this.configuration) {
+            throw new Error('StreamClient must be configured');
+        }
+        // connect if not connected.
+        if (!this.stream) {
+            this.connect();
+            this._configure(this.configuration);
+        }
+        while (true) {
+            let retryCount = 1;
+            let cursor = null;
+            try {
+                // this check is to make ts happy
+                if (!this.stream) {
+                    throw new Error('Stream disconnected unexpectedly');
+                }
+                for await (const message of this.stream) {
+                    const messageTyped = message;
+                    // only return messages if they are with the most recently configured stream
+                    if (messageTyped.streamId?.toString() == this.stream_id.toString()) {
+                        // reset retry count on new message
+                        retryCount = 1;
+                        // keep cursor updated for use when reconnecting
+                        if (messageTyped.data) {
+                            cursor = messageTyped.data.cursor;
+                        }
+                        else if (messageTyped.invalidate) {
+                            cursor = messageTyped.invalidate.cursor;
+                        }
+                        yield messageTyped;
+                    }
+                }
             }
-            else {
-                onRetry = stream_1.defaultOnRetry;
+            catch (err) {
+                const isGrpcError = err.hasOwnProperty('code') &&
+                    err.hasOwnProperty('details') &&
+                    err.hasOwnProperty('metadata');
+                // non-grpc error, so just bubble it up
+                if (!isGrpcError) {
+                    throw err;
+                }
+                const { reconnect, args } = await Promise.resolve(this.onReconnect(err, retryCount));
+                retryCount += 1;
+                if (!reconnect) {
+                    break;
+                }
+                this.connect();
+                if (args) {
+                    this._configure(args);
+                }
+                else {
+                    // use same configuration specified by user, restarting from the
+                    // latest ingested batch.
+                    const configuration = {
+                        ...this.configuration,
+                        cursor: cursor ?? this.configuration.cursor,
+                    };
+                    this._configure(configuration);
+                }
             }
         }
-        return new stream_1.StreamMessagesStream({ args, onRetry, client: this.client });
     }
+    /**
+     * Configure the stream to return the requested data.
+     *
+     * The stream can be reconfigured while streaming data, the client will
+     * take care of returning only data for the new configuration even if there
+     * are old messages in-flight.
+     */
+    configure(args) {
+        this.configuration = args;
+        this._configure(args);
+    }
+    _configure(args) {
+        const { filter, batchSize, cursor, finality } = args;
+        this.stream_id++;
+        // only send configuration if connected
+        if (this.stream) {
+            const builder = request_1.StreamDataRequest.create().withStreamId(this.stream_id).withFilter(filter);
+            if (batchSize) {
+                builder.withBatchSize(batchSize);
+            }
+            if (cursor) {
+                builder.withStartingCursor(cursor);
+            }
+            if (finality) {
+                builder.withFinality(finality);
+            }
+            const request = builder.encode();
+            this.stream?.write(request);
+        }
+    }
+    connect() {
+        this.stream = this.inner.streamData();
+        return this;
+    }
+}
+exports.StreamClient = StreamClient;
+/**
+ * A `onReconnect` callback that never reconnects.
+ */
+function neverReconnect(_err, _retryCount) {
+    return {
+        reconnect: false,
+    };
+}
+exports.neverReconnect = neverReconnect;
+/**
+ * A `onReconnect` callback that retries to reconnect up to 5 times.
+ *
+ * If the error is not an internal error, then it will not reconnect.
+ * This callback awaits for `1s * retryCount` before returning.
+ */
+async function defaultOnReconnect(err, retryCount) {
+    if (err.code != 13) {
+        return {
+            reconnect: false,
+        };
+    }
+    await new Promise((resolve) => setTimeout(resolve, retryCount * 1000));
+    return {
+        reconnect: retryCount < 5,
+    };
 }
-exports.NodeClient = NodeClient;
+exports.defaultOnReconnect = defaultOnReconnect;
 //# sourceMappingURL=client.js.map

package/dist/client.js.map

@@ -1 +1 @@
-{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,+BAAgC;AAChC,2CAKsB;AACtB,qDAA6C;AAC7C,qCAAkF;AAMlF,MAAM,iBAAiB,GAAG,SAAS,GAAG,mBAAmB,CAAA;AAEzD,MAAM,iBAAiB,GAAG,IAAA,uBAAQ,EAAC,iBAAiB,EAAE,EAAE,CAAC,CAAA;AACzD,MAAM,eAAe,GAAG,IAAA,+BAAqB,EAAC,iBAAiB,CAA6B,CAAA;AAE/E,QAAA,IAAI,GAAG,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAA;AAEjD,QAAA,WAAW,GAAG,qBAAe,CAAA;AAO1C,MAAa,UAAU;IAGrB,YAAY,OAAe,EAAE,WAA+B,EAAE,OAAuB;QACnF,IAAI,CAAC,MAAM,GAAG,IAAI,YAAI,CAAC,OAAO,EAAE,WAAW,EAAE,OAAO,CAAC,CAAA;IACvD,CAAC;IAEY,MAAM;;YACjB,OAAO,IAAA,gBAAS,EAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,EAAE,CAAA;QAC9D,CAAC;KAAA;IAEM,cAAc,CACnB,IAA2B,EAC3B,OAA+B;QAE/B,sCAAsC;QACtC,IAAI,OAAO,GAAG,mBAAU,CAAA;QACxB,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,EAAE;YACtB,IAAI,OAAO,CAAC,OAAO,EAAE;gBACnB,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;aAC1B;iBAAM;gBACL,OAAO,GAAG,uBAAc,CAAA;aACzB;SACF;QAED,OAAO,IAAI,6BAAoB,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAA;IACzE,CAAC;CACF;AA3BD,gCA2BC"}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;AAAA,2CAAmG;AACnG,mCAAkC;AAClC,uCAA6C;AAE7C,yCAAgE;AAAvD,6GAAA,kBAAkB,OAAA;AAE3B,MAAM,aAAa,GAAG,gBAAQ,CAAC,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAA;AAgF3E;;GAEG;AACH,MAAa,YAAY;IAQvB;;;;;;;;;;;;;;;;;;OAkBG;IACH,YAAY,EAAE,GAAG,EAAE,WAAW,EAAE,aAAa,EAAE,WAAW,EAAoB;QAC5E,IAAI,CAAC,KAAK,GAAG,IAAI,aAAa,CAAC,GAAG,EAAE,WAAW,IAAI,4BAAkB,CAAC,SAAS,EAAE,EAAE;YACjF,2BAA2B,EAAE,OAAS;YACtC,GAAG,aAAa;SACjB,CAAC,CAAA;QACF,IAAI,CAAC,SAAS,GAAG,CAAC,CAAA;QAClB,IAAI,CAAC,WAAW,GAAG,WAAW,IAAI,kBAAkB,CAAA;IACtD,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC;QAC3B,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE;YACvB,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAA;SACnD;QAED,4BAA4B;QAC5B,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YAChB,IAAI,CAAC,OAAO,EAAE,CAAA;YACd,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;SACpC;QAED,OAAO,IAAI,EAAE;YACX,IAAI,UAAU,GAAG,CAAC,CAAA;YAClB,IAAI,MAAM,GAAG,IAAI,CAAA;YACjB,IAAI;gBACF,iCAAiC;gBACjC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;oBAChB,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAA;iBACpD;gBAED,IAAI,KAAK,EAAE,MAAM,OAAO,IAAI,IAAI,CAAC,MAAM,EAAE;oBACvC,MAAM,YAAY,GAAG,OAAuC,CAAA;oBAE5D,4EAA4E;oBAC5E,IAAI,YAAY,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE;wBAClE,mCAAmC;wBACnC,UAAU,GAAG,CAAC,CAAA;wBAEd,gDAAgD;wBAChD,IAAI,YAAY,CAAC,IAAI,EAAE;4BACrB,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,MAAM,CAAA;yBAClC;6BAAM,IAAI,YAAY,CAAC,UAAU,EAAE;4BAClC,MAAM,GAAG,YAAY,CAAC,UAAU,CAAC,MAAM,CAAA;yBACxC;wBAED,MAAM,YAAY,CAAA;qBACnB;iBACF;aACF;YAAC,OAAO,GAAQ,EAAE;gBACjB,MAAM,WAAW,GACf,GAAG,CAAC,cAAc,CAAC,MAAM,CAAC;oBAC1B,GAAG,CAAC,cAAc,CAAC,SAAS,CAAC;oBAC7B,GAAG,CAAC,cAAc,CAAC,UAAU,CAAC,CAAA;gBAEhC,uCAAuC;gBACvC,IAAI,CAAC,WAAW,EAAE;oBAChB,MAAM,GAAG,CAAA;iBACV;gBAED,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC,CAAA;gBACpF,UAAU,IAAI,CAAC,CAAA;gBACf,IAAI,CAAC,SAAS,EAAE;oBACd,MAAK;iBACN;gBAED,IAAI,CAAC,OAAO,EAAE,CAAA;gBAEd,IAAI,IAAI,EAAE;oBACR,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;iBACtB;qBAAM;oBACL,gEAAgE;oBAChE,yBAAyB;oBACzB,MAAM,aAAa,GAAG;wBACpB,GAAG,IAAI,CAAC,aAAa;wBACrB,MAAM,EAAE,MAAM,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM;qBAC5C,CAAA;oBACD,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,CAAA;iBAC/B;aACF;SACF;IACH,CAAC;IAED;;;;;;OAMG;IACH,SAAS,CAAC,IAAmB;QAC3B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAA;QACzB,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;IACvB,CAAC;IAEO,UAAU,CAAC,IAAmB;QACpC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAA;QACpD,IAAI,CAAC,SAAS,EAAE,CAAA;QAEhB,uCAAuC;QACvC,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,MAAM,OAAO,GAAG,2BAAiB,CAAC,MAAM,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;YAE1F,IAAI,SAAS,EAAE;gBACb,OAAO,CAAC,aAAa,CAAC,SAAS,CAAC,CAAA;aACjC;YACD,IAAI,MAAM,EAAE;gBACV,OAAO,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAA;aACnC;YACD,IAAI,QAAQ,EAAE;gBACZ,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAA;aAC/B;YAED,MAAM,OAAO,GAAG,OAAO,CAAC,MAAM,EAAE,CAAA;YAChC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,CAAA;SAC5B;IACH,CAAC;IAEO,OAAO;QACb,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,CAAA;QACrC,OAAO,IAAI,CAAA;IACb,CAAC;CACF;AAtJD,oCAsJC;AAED;;GAEG;AACH,SAAgB,cAAc,CAAC,IAAkB,EAAE,WAAmB;IACpE,OAAO;QACL,SAAS,EAAE,KAAK;KACjB,CAAA;AACH,CAAC;AAJD,wCAIC;AAED;;;;;GAKG;AACI,KAAK,UAAU,kBAAkB,CACtC,GAAiB,EACjB,UAAkB;IAElB,IAAI,GAAG,CAAC,IAAI,IAAI,EAAE,EAAE;QAClB,OAAO;YACL,SAAS,EAAE,KAAK;SACjB,CAAA;KACF;IAED,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,UAAU,GAAG,IAAI,CAAC,CAAC,CAAA;IACtE,OAAO;QACL,SAAS,EAAE,UAAU,GAAG,CAAC;KAC1B,CAAA;AACH,CAAC;AAdD,gDAcC"}

package/dist/cursor.d.ts

@@ -0,0 +1,22 @@
+import Long from 'long';
+import { ICursor } from './proto/v1alpha2';
+export declare const Cursor: {
+    /**
+     * Creates a new cursor with only the `orderKey` set.
+     *
+     * Notice that this cursor does not uniquely identify a message in the stream
+     * and may result in missing information.
+     */
+    createWithOrderKey: (order: string | number | Long) => ICursor;
+    /**
+     * Creates a new cursor with both order and unique keys.
+     *
+     * This cursor uniquely identifies a message in the stream, even if it has
+     * been invalidated.
+     */
+    create: (order: string | number | Long, unique: Uint8Array) => ICursor;
+    /**
+     * Returns the cursor string representation.
+     */
+    toString: (cursor?: ICursor | null) => string | undefined;
+};

package/dist/cursor.js

@@ -0,0 +1,43 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Cursor = void 0;
+const long_1 = __importDefault(require("long"));
+exports.Cursor = {
+    /**
+     * Creates a new cursor with only the `orderKey` set.
+     *
+     * Notice that this cursor does not uniquely identify a message in the stream
+     * and may result in missing information.
+     */
+    createWithOrderKey: (order) => {
+        return {
+            orderKey: long_1.default.fromValue(order),
+            uniqueKey: new Uint8Array(),
+        };
+    },
+    /**
+     * Creates a new cursor with both order and unique keys.
+     *
+     * This cursor uniquely identifies a message in the stream, even if it has
+     * been invalidated.
+     */
+    create: (order, unique) => {
+        return {
+            orderKey: long_1.default.fromValue(order),
+            uniqueKey: unique,
+        };
+    },
+    /**
+     * Returns the cursor string representation.
+     */
+    toString: (cursor) => {
+        if (!cursor)
+            return;
+        let hash = Buffer.from(cursor.uniqueKey).toString('hex');
+        return `${cursor.orderKey.toString()}/0x${hash}`;
+    },
+};
+//# sourceMappingURL=cursor.js.map

package/dist/cursor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cursor.js","sourceRoot":"","sources":["../src/cursor.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAuB;AAGV,QAAA,MAAM,GAAG;IACpB;;;;;OAKG;IACH,kBAAkB,EAAE,CAAC,KAA6B,EAAW,EAAE;QAC7D,OAAO;YACL,QAAQ,EAAE,cAAI,CAAC,SAAS,CAAC,KAAK,CAAC;YAC/B,SAAS,EAAE,IAAI,UAAU,EAAE;SAC5B,CAAA;IACH,CAAC;IAED;;;;;OAKG;IACH,MAAM,EAAE,CAAC,KAA6B,EAAE,MAAkB,EAAW,EAAE;QACrE,OAAO;YACL,QAAQ,EAAE,cAAI,CAAC,SAAS,CAAC,KAAK,CAAC;YAC/B,SAAS,EAAE,MAAM;SAClB,CAAA;IACH,CAAC;IAED;;OAEG;IACH,QAAQ,EAAE,CAAC,MAAuB,EAAsB,EAAE;QACxD,IAAI,CAAC,MAAM;YAAE,OAAM;QACnB,IAAI,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;QACxD,OAAO,GAAG,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,IAAI,EAAE,CAAA;IAClD,CAAC;CACF,CAAA"}

package/dist/index.d.ts

@@ -1,4 +1,4 @@
+export * from './proto';
 export * from './client';
-export * from './buffer';
-export * from './stream';
-export * as proto from './proto';
+export * from './request';
+export * from './cursor';

package/dist/index.js

@@ -10,25 +10,12 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
 }));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.proto = void 0;
+__exportStar(require("./proto"), exports);
 __exportStar(require("./client"), exports);
-__exportStar(require("./buffer"), exports);
-__exportStar(require("./stream"), exports);
-exports.proto = __importStar(require("./proto"));
+__exportStar(require("./request"), exports);
+__exportStar(require("./cursor"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2CAAwB;AACxB,2CAAwB;AACxB,2CAAwB;AACxB,iDAAgC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAuB;AACvB,2CAAwB;AACxB,4CAAyB;AACzB,2CAAwB"}

package/dist/proto/apibara/node/v1alpha2/Cursor.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="node" />
+import type { Long } from '@grpc/proto-loader';
+export interface Cursor {
+    'orderKey'?: (number | string | Long);
+    'uniqueKey'?: (Buffer | Uint8Array | string);
+}
+export interface Cursor__Output {
+    'orderKey': (Long);
+    'uniqueKey': (Uint8Array);
+}

package/dist/proto/apibara/node/{v1alpha1/Node.js → v1alpha2/Cursor.js}

@@ -1,4 +1,4 @@
 "use strict";
-// Original file: src/proto/node.proto
+// Original file: src/proto/stream.proto
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=Node.js.map
+//# sourceMappingURL=Cursor.js.map

package/dist/proto/apibara/node/v1alpha2/Cursor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Cursor.js","sourceRoot":"","sources":["../../../../../src/proto/apibara/node/v1alpha2/Cursor.ts"],"names":[],"mappings":";AAAA,wCAAwC"}

package/dist/proto/apibara/node/v1alpha2/Data.d.ts

@@ -0,0 +1,15 @@
+/// <reference types="node" />
+import type { Cursor as _apibara_node_v1alpha2_Cursor, Cursor__Output as _apibara_node_v1alpha2_Cursor__Output } from '../../../apibara/node/v1alpha2/Cursor';
+import type { DataFinality as _apibara_node_v1alpha2_DataFinality } from '../../../apibara/node/v1alpha2/DataFinality';
+export interface Data {
+    'endCursor'?: (_apibara_node_v1alpha2_Cursor | null);
+    'finality'?: (_apibara_node_v1alpha2_DataFinality | keyof typeof _apibara_node_v1alpha2_DataFinality);
+    'data'?: (Buffer | Uint8Array | string)[];
+    'cursor'?: (_apibara_node_v1alpha2_Cursor | null);
+}
+export interface Data__Output {
+    'endCursor': (_apibara_node_v1alpha2_Cursor__Output | null);
+    'finality': (keyof typeof _apibara_node_v1alpha2_DataFinality);
+    'data': (Uint8Array)[];
+    'cursor': (_apibara_node_v1alpha2_Cursor__Output | null);
+}

package/dist/proto/apibara/node/{v1alpha1 → v1alpha2}/Data.js

@@ -1,4 +1,4 @@
 "use strict";
-// Original file: src/proto/node.proto
+// Original file: src/proto/stream.proto
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=Data.js.map

package/dist/proto/apibara/node/v1alpha2/Data.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Data.js","sourceRoot":"","sources":["../../../../../src/proto/apibara/node/v1alpha2/Data.ts"],"names":[],"mappings":";AAAA,wCAAwC"}

package/dist/proto/apibara/node/v1alpha2/DataFinality.d.ts

@@ -0,0 +1,6 @@
+export declare enum DataFinality {
+    DATA_STATUS_UNKNOWN = 0,
+    DATA_STATUS_PENDING = 1,
+    DATA_STATUS_ACCEPTED = 2,
+    DATA_STATUS_FINALIZED = 3
+}

package/dist/proto/apibara/node/v1alpha2/DataFinality.js

@@ -0,0 +1,12 @@
+"use strict";
+// Original file: src/proto/stream.proto
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DataFinality = void 0;
+var DataFinality;
+(function (DataFinality) {
+    DataFinality[DataFinality["DATA_STATUS_UNKNOWN"] = 0] = "DATA_STATUS_UNKNOWN";
+    DataFinality[DataFinality["DATA_STATUS_PENDING"] = 1] = "DATA_STATUS_PENDING";
+    DataFinality[DataFinality["DATA_STATUS_ACCEPTED"] = 2] = "DATA_STATUS_ACCEPTED";
+    DataFinality[DataFinality["DATA_STATUS_FINALIZED"] = 3] = "DATA_STATUS_FINALIZED";
+})(DataFinality = exports.DataFinality || (exports.DataFinality = {}));
+//# sourceMappingURL=DataFinality.js.map

package/dist/proto/apibara/node/v1alpha2/DataFinality.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DataFinality.js","sourceRoot":"","sources":["../../../../../src/proto/apibara/node/v1alpha2/DataFinality.ts"],"names":[],"mappings":";AAAA,wCAAwC;;;AAExC,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,6EAAuB,CAAA;IACvB,6EAAuB,CAAA;IACvB,+EAAwB,CAAA;IACxB,iFAAyB,CAAA;AAC3B,CAAC,EALW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAKvB"}

package/dist/proto/apibara/node/v1alpha2/Heartbeat.js

@@ -0,0 +1,4 @@
+"use strict";
+// Original file: src/proto/stream.proto
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Heartbeat.js.map

package/dist/proto/apibara/node/v1alpha2/Heartbeat.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Heartbeat.js","sourceRoot":"","sources":["../../../../../src/proto/apibara/node/v1alpha2/Heartbeat.ts"],"names":[],"mappings":";AAAA,wCAAwC"}

package/dist/proto/apibara/node/v1alpha2/Invalidate.d.ts

@@ -0,0 +1,7 @@
+import type { Cursor as _apibara_node_v1alpha2_Cursor, Cursor__Output as _apibara_node_v1alpha2_Cursor__Output } from '../../../apibara/node/v1alpha2/Cursor';
+export interface Invalidate {
+    'cursor'?: (_apibara_node_v1alpha2_Cursor | null);
+}
+export interface Invalidate__Output {
+    'cursor': (_apibara_node_v1alpha2_Cursor__Output | null);
+}

package/dist/proto/apibara/node/v1alpha2/Invalidate.js

@@ -0,0 +1,4 @@
+"use strict";
+// Original file: src/proto/stream.proto
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Invalidate.js.map

package/dist/proto/apibara/node/v1alpha2/Invalidate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Invalidate.js","sourceRoot":"","sources":["../../../../../src/proto/apibara/node/v1alpha2/Invalidate.ts"],"names":[],"mappings":";AAAA,wCAAwC"}

package/dist/proto/apibara/node/v1alpha2/Stream.d.ts

@@ -0,0 +1,16 @@
+import type * as grpc from '@grpc/grpc-js';
+import type { MethodDefinition } from '@grpc/proto-loader';
+import type { StreamDataRequest as _apibara_node_v1alpha2_StreamDataRequest, StreamDataRequest__Output as _apibara_node_v1alpha2_StreamDataRequest__Output } from '../../../apibara/node/v1alpha2/StreamDataRequest';
+import type { StreamDataResponse as _apibara_node_v1alpha2_StreamDataResponse, StreamDataResponse__Output as _apibara_node_v1alpha2_StreamDataResponse__Output } from '../../../apibara/node/v1alpha2/StreamDataResponse';
+export interface StreamClient extends grpc.Client {
+    StreamData(metadata: grpc.Metadata, options?: grpc.CallOptions): grpc.ClientDuplexStream<_apibara_node_v1alpha2_StreamDataRequest, _apibara_node_v1alpha2_StreamDataResponse__Output>;
+    StreamData(options?: grpc.CallOptions): grpc.ClientDuplexStream<_apibara_node_v1alpha2_StreamDataRequest, _apibara_node_v1alpha2_StreamDataResponse__Output>;
+    streamData(metadata: grpc.Metadata, options?: grpc.CallOptions): grpc.ClientDuplexStream<_apibara_node_v1alpha2_StreamDataRequest, _apibara_node_v1alpha2_StreamDataResponse__Output>;
+    streamData(options?: grpc.CallOptions): grpc.ClientDuplexStream<_apibara_node_v1alpha2_StreamDataRequest, _apibara_node_v1alpha2_StreamDataResponse__Output>;
+}
+export interface StreamHandlers extends grpc.UntypedServiceImplementation {
+    StreamData: grpc.handleBidiStreamingCall<_apibara_node_v1alpha2_StreamDataRequest__Output, _apibara_node_v1alpha2_StreamDataResponse>;
+}
+export interface StreamDefinition extends grpc.ServiceDefinition {
+    StreamData: MethodDefinition<_apibara_node_v1alpha2_StreamDataRequest, _apibara_node_v1alpha2_StreamDataResponse, _apibara_node_v1alpha2_StreamDataRequest__Output, _apibara_node_v1alpha2_StreamDataResponse__Output>;
+}

package/dist/proto/{google/protobuf/Any.js → apibara/node/v1alpha2/Stream.js}

@@ -1,4 +1,4 @@
 "use strict";
-// Original file: null
+// Original file: src/proto/stream.proto
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=Any.js.map
+//# sourceMappingURL=Stream.js.map

package/dist/proto/apibara/node/v1alpha2/Stream.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Stream.js","sourceRoot":"","sources":["../../../../../src/proto/apibara/node/v1alpha2/Stream.ts"],"names":[],"mappings":";AAAA,wCAAwC"}