@apibara/protocol 0.4.9 → 2.0.0-beta.0

package/src/common.test.ts

@@ -0,0 +1,67 @@
+import { describe, expect, it } from "vitest";
+import { createCursor, cursorFromProto, cursorToProto } from "./common";
+
+describe("Cursor", () => {
+  describe("proto", () => {
+    it("should encode and decode (with uniqueKey)", () => {
+      const cursor = createCursor({
+        orderKey: 123n,
+        uniqueKey: "0xcafecafe",
+      });
+
+      const proto = cursorToProto(cursor);
+      expect(proto).toMatchInlineSnapshot(`
+        {
+          "orderKey": 123n,
+          "uniqueKey": Uint8Array [
+            202,
+            254,
+            202,
+            254,
+          ],
+        }
+      `);
+      const back = cursorFromProto(proto);
+      expect(back).toEqual(cursor);
+    });
+
+    it("should encode and decode (without uniqueKey)", () => {
+      const cursor = createCursor({
+        orderKey: 123n,
+      });
+
+      const proto = cursorToProto(cursor);
+      expect(proto).toMatchInlineSnapshot(`
+        {
+          "orderKey": 123n,
+          "uniqueKey": Uint8Array [],
+        }
+      `);
+      const back = cursorFromProto(proto);
+      expect(back).toEqual(cursor);
+    });
+  });
+
+  describe("bytes", () => {
+    it("should encode and decode (with uniqueKey)", () => {
+      const cursor = createCursor({
+        orderKey: 123n,
+        uniqueKey: "0xcafecafe",
+      });
+
+      const proto = cursorToProto(cursor);
+      const back = cursorFromProto(proto);
+      expect(back).toEqual(cursor);
+    });
+
+    it("should encode and decode (without uniqueKey)", () => {
+      const cursor = createCursor({
+        orderKey: 123n,
+      });
+
+      const proto = cursorToProto(cursor);
+      const back = cursorFromProto(proto);
+      expect(back).toEqual(cursor);
+    });
+  });
+});

package/src/common.ts

@@ -0,0 +1,65 @@
+import { Schema } from "@effect/schema";
+import { Option } from "effect";
+import { hexToBytes, toHex } from "viem";
+
+import * as proto from "./proto";
+
+/** Bytes encoded as a 0x-prefixed hex string. */
+export const Bytes = Schema.TemplateLiteral(
+  Schema.Literal("0x"),
+  Schema.String,
+);
+
+export type Bytes = typeof Bytes.Type;
+
+export const BytesFromUint8Array = Schema.requiredToOptional(
+  Schema.Uint8ArrayFromSelf,
+  Bytes,
+  {
+    decode(value) {
+      if (value.length === 0) {
+        return Option.none();
+      }
+      return Option.some(toHex(value));
+    },
+    encode(value) {
+      return value.pipe(
+        Option.map(hexToBytes),
+        Option.getOrElse(() => new Uint8Array(0)),
+      );
+    },
+  },
+);
+
+/** Represent a position in the stream. */
+export const _Cursor = Schema.Struct({
+  /** The block number. */
+  orderKey: Schema.BigIntFromSelf,
+  /** The block hash, if any. */
+  uniqueKey: BytesFromUint8Array,
+});
+
+/** The Cursor protobuf representation. */
+export interface CursorProto extends Schema.Schema.Encoded<typeof _Cursor> {}
+export interface Cursor extends Schema.Schema.Type<typeof _Cursor> {}
+export const Cursor: Schema.Schema<Cursor, CursorProto> = _Cursor;
+export const createCursor = (props: Cursor) => props;
+
+export const cursorToProto = Schema.encodeSync(Cursor);
+export const cursorFromProto = Schema.decodeSync(Cursor);
+
+export const CursorFromBytes = Schema.transform(
+  Schema.Uint8ArrayFromSelf,
+  Cursor,
+  {
+    decode(value) {
+      return proto.common.Cursor.decode(value);
+    },
+    encode(value) {
+      return proto.common.Cursor.encode(value).finish();
+    },
+  },
+);
+
+export const cursorToBytes = Schema.encodeSync(CursorFromBytes);
+export const cursorFromBytes = Schema.decodeSync(CursorFromBytes);

package/src/config.ts

@@ -0,0 +1,38 @@
+import type { Schema } from "@effect/schema";
+
+import { StreamDataRequest, StreamDataResponse } from "./stream";
+
+/** Configure a DNA stream. */
+export class StreamConfig<TFilter, TBlock> {
+  private request;
+  private response;
+
+  constructor(
+    private filter: Schema.Schema<TFilter, Uint8Array, never>,
+    private block: Schema.Schema<TBlock | null, Uint8Array, never>,
+    public mergeFilter: (a: TFilter, b: TFilter) => TFilter,
+  ) {
+    this.request = StreamDataRequest(this.filter);
+    this.response = StreamDataResponse(this.block);
+  }
+
+  /** Filter schema. */
+  get Filter() {
+    return this.filter;
+  }
+
+  /** Block schema. */
+  get Block() {
+    return this.block;
+  }
+
+  /** Stream data request schema. */
+  get Request() {
+    return this.request;
+  }
+
+  /** Stream data response schema. */
+  get Response() {
+    return this.response;
+  }
+}

package/src/index.ts

@@ -1,4 +1,11 @@
-export * from "./proto";
+export * as proto from "./proto";
+export { type DnaStreamClient, DnaStreamDefinition } from "./proto/stream";
+
+export * from "./common";
+export * from "./status";
+export * from "./stream";
+
+export * from "./config";
 export * from "./client";
-export * from "./request";
-export * from "./cursor";
+
+export * from "./rate";

package/src/proto/common.ts

@@ -0,0 +1,279 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.176.0
+//   protoc               unknown
+// source: common.proto
+
+/* eslint-disable */
+import Long from "long";
+import _m0 from "protobufjs/minimal";
+
+export const protobufPackage = "dna.v2.common";
+
+/** A cursor over the stream content. */
+export interface Cursor {
+  /** Key used for ordering messages in the stream. */
+  readonly orderKey: bigint;
+  /** Key used to discriminate branches in the stream. */
+  readonly uniqueKey: Uint8Array;
+}
+
+/** Request for the `Status` method. */
+export interface StatusRequest {
+}
+
+/** Response for the `Status` method. */
+export interface StatusResponse {
+  /** The current head of the chain. */
+  readonly currentHead?:
+    | Cursor
+    | undefined;
+  /** The last cursor that was ingested by the node. */
+  readonly lastIngested?: Cursor | undefined;
+}
+
+function createBaseCursor(): Cursor {
+  return { orderKey: BigInt("0"), uniqueKey: new Uint8Array(0) };
+}
+
+export const Cursor = {
+  encode(message: Cursor, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
+    if (message.orderKey !== BigInt("0")) {
+      if (BigInt.asUintN(64, message.orderKey) !== message.orderKey) {
+        throw new globalThis.Error("value provided for field message.orderKey of type uint64 too large");
+      }
+      writer.uint32(8).uint64(message.orderKey.toString());
+    }
+    if (message.uniqueKey.length !== 0) {
+      writer.uint32(18).bytes(message.uniqueKey);
+    }
+    return writer;
+  },
+
+  decode(input: _m0.Reader | Uint8Array, length?: number): Cursor {
+    const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBaseCursor() as any;
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1:
+          if (tag !== 8) {
+            break;
+          }
+
+          message.orderKey = longToBigint(reader.uint64() as Long);
+          continue;
+        case 2:
+          if (tag !== 18) {
+            break;
+          }
+
+          message.uniqueKey = reader.bytes();
+          continue;
+      }
+      if ((tag & 7) === 4 || tag === 0) {
+        break;
+      }
+      reader.skipType(tag & 7);
+    }
+    return message;
+  },
+
+  fromJSON(object: any): Cursor {
+    return {
+      orderKey: isSet(object.orderKey) ? BigInt(object.orderKey) : BigInt("0"),
+      uniqueKey: isSet(object.uniqueKey) ? bytesFromBase64(object.uniqueKey) : new Uint8Array(0),
+    };
+  },
+
+  toJSON(message: Cursor): unknown {
+    const obj: any = {};
+    if (message.orderKey !== BigInt("0")) {
+      obj.orderKey = message.orderKey.toString();
+    }
+    if (message.uniqueKey.length !== 0) {
+      obj.uniqueKey = base64FromBytes(message.uniqueKey);
+    }
+    return obj;
+  },
+
+  create(base?: DeepPartial<Cursor>): Cursor {
+    return Cursor.fromPartial(base ?? {});
+  },
+  fromPartial(object: DeepPartial<Cursor>): Cursor {
+    const message = createBaseCursor() as any;
+    message.orderKey = object.orderKey ?? BigInt("0");
+    message.uniqueKey = object.uniqueKey ?? new Uint8Array(0);
+    return message;
+  },
+};
+
+function createBaseStatusRequest(): StatusRequest {
+  return {};
+}
+
+export const StatusRequest = {
+  encode(_: StatusRequest, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
+    return writer;
+  },
+
+  decode(input: _m0.Reader | Uint8Array, length?: number): StatusRequest {
+    const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBaseStatusRequest() as any;
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+      }
+      if ((tag & 7) === 4 || tag === 0) {
+        break;
+      }
+      reader.skipType(tag & 7);
+    }
+    return message;
+  },
+
+  fromJSON(_: any): StatusRequest {
+    return {};
+  },
+
+  toJSON(_: StatusRequest): unknown {
+    const obj: any = {};
+    return obj;
+  },
+
+  create(base?: DeepPartial<StatusRequest>): StatusRequest {
+    return StatusRequest.fromPartial(base ?? {});
+  },
+  fromPartial(_: DeepPartial<StatusRequest>): StatusRequest {
+    const message = createBaseStatusRequest() as any;
+    return message;
+  },
+};
+
+function createBaseStatusResponse(): StatusResponse {
+  return { currentHead: undefined, lastIngested: undefined };
+}
+
+export const StatusResponse = {
+  encode(message: StatusResponse, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
+    if (message.currentHead !== undefined) {
+      Cursor.encode(message.currentHead, writer.uint32(10).fork()).ldelim();
+    }
+    if (message.lastIngested !== undefined) {
+      Cursor.encode(message.lastIngested, writer.uint32(18).fork()).ldelim();
+    }
+    return writer;
+  },
+
+  decode(input: _m0.Reader | Uint8Array, length?: number): StatusResponse {
+    const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBaseStatusResponse() as any;
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1:
+          if (tag !== 10) {
+            break;
+          }
+
+          message.currentHead = Cursor.decode(reader, reader.uint32());
+          continue;
+        case 2:
+          if (tag !== 18) {
+            break;
+          }
+
+          message.lastIngested = Cursor.decode(reader, reader.uint32());
+          continue;
+      }
+      if ((tag & 7) === 4 || tag === 0) {
+        break;
+      }
+      reader.skipType(tag & 7);
+    }
+    return message;
+  },
+
+  fromJSON(object: any): StatusResponse {
+    return {
+      currentHead: isSet(object.currentHead) ? Cursor.fromJSON(object.currentHead) : undefined,
+      lastIngested: isSet(object.lastIngested) ? Cursor.fromJSON(object.lastIngested) : undefined,
+    };
+  },
+
+  toJSON(message: StatusResponse): unknown {
+    const obj: any = {};
+    if (message.currentHead !== undefined) {
+      obj.currentHead = Cursor.toJSON(message.currentHead);
+    }
+    if (message.lastIngested !== undefined) {
+      obj.lastIngested = Cursor.toJSON(message.lastIngested);
+    }
+    return obj;
+  },
+
+  create(base?: DeepPartial<StatusResponse>): StatusResponse {
+    return StatusResponse.fromPartial(base ?? {});
+  },
+  fromPartial(object: DeepPartial<StatusResponse>): StatusResponse {
+    const message = createBaseStatusResponse() as any;
+    message.currentHead = (object.currentHead !== undefined && object.currentHead !== null)
+      ? Cursor.fromPartial(object.currentHead)
+      : undefined;
+    message.lastIngested = (object.lastIngested !== undefined && object.lastIngested !== null)
+      ? Cursor.fromPartial(object.lastIngested)
+      : undefined;
+    return message;
+  },
+};
+
+function bytesFromBase64(b64: string): Uint8Array {
+  if ((globalThis as any).Buffer) {
+    return Uint8Array.from(globalThis.Buffer.from(b64, "base64"));
+  } else {
+    const bin = globalThis.atob(b64);
+    const arr = new Uint8Array(bin.length);
+    for (let i = 0; i < bin.length; ++i) {
+      arr[i] = bin.charCodeAt(i);
+    }
+    return arr;
+  }
+}
+
+function base64FromBytes(arr: Uint8Array): string {
+  if ((globalThis as any).Buffer) {
+    return globalThis.Buffer.from(arr).toString("base64");
+  } else {
+    const bin: string[] = [];
+    arr.forEach((byte) => {
+      bin.push(globalThis.String.fromCharCode(byte));
+    });
+    return globalThis.btoa(bin.join(""));
+  }
+}
+
+type Builtin = Date | Function | Uint8Array | string | number | boolean | bigint | undefined;
+
+export type DeepPartial<T> = T extends Builtin ? T
+  : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>>
+  : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>>
+  : T extends { readonly $case: string }
+    ? { [K in keyof Omit<T, "$case">]?: DeepPartial<T[K]> } & { readonly $case: T["$case"] }
+  : T extends {} ? { [K in keyof T]?: DeepPartial<T[K]> }
+  : Partial<T>;
+
+function longToBigint(long: Long) {
+  return BigInt(long.toString());
+}
+
+if (_m0.util.Long !== Long) {
+  _m0.util.Long = Long as any;
+  _m0.configure();
+}
+
+function isSet(value: any): boolean {
+  return value !== null && value !== undefined;
+}

package/src/proto/index.ts

@@ -1 +1,3 @@
-export * as v1alpha2 from "./v1alpha2";
+export * as common from "./common";
+export * as stream from "./stream";
+export * as testing from "./testing";