@subsquid/util-internal-data-source 0.0.1-portal-api.6f7a57

package/lib/index.d.ts

@@ -0,0 +1,36 @@
+import { Range } from '@subsquid/util-internal-range';
+export interface BlockRef {
+    number: number;
+    hash: string;
+}
+export interface DataSourceStreamOptions {
+    range?: Range;
+    stopOnHead?: boolean;
+    parentHash?: string;
+}
+export interface BlockBatch<B> {
+    blocks: B[];
+    finalizedHead?: BlockRef;
+}
+export type DataSourceStream<B> = AsyncIterable<BlockBatch<B>>;
+export interface DataSource<B> {
+    getHead(): Promise<BlockRef | undefined>;
+    getFinalizedHead(): Promise<BlockRef | undefined>;
+    getFinalizedStream(req: DataSourceStreamOptions): DataSourceStream<B>;
+    getStream(req: DataSourceStreamOptions): DataSourceStream<B>;
+}
+export declare class ForkException extends Error {
+    readonly prevBlocks: BlockRef[];
+    readonly isSqdForkException = true;
+    constructor(expectedParentHash: string, nextBlock: number, prevBlocks: BlockRef[]);
+    get name(): string;
+}
+export declare function isForkException(err: unknown): err is ForkException;
+export declare class DataConsistencyError extends Error {
+    readonly isSqdDataConsistencyError = true;
+}
+export declare class BlockConsistencyError extends DataConsistencyError {
+    constructor(ref: BlockRef, errorMsg?: string);
+}
+export declare function isDataConsistencyError(err: unknown): err is Error;
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,KAAK,EAAC,MAAM,+BAA+B,CAAA;AAGnD,MAAM,WAAW,QAAQ;IACrB,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;CACf;AAGD,MAAM,WAAW,uBAAuB;IACpC,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,UAAU,CAAC,EAAE,MAAM,CAAA;CACtB;AAGD,MAAM,WAAW,UAAU,CAAC,CAAC;IACzB,MAAM,EAAE,CAAC,EAAE,CAAA;IACX,aAAa,CAAC,EAAE,QAAQ,CAAA;CAC3B;AAGD,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI,aAAa,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAA;AAG9D,MAAM,WAAW,UAAU,CAAC,CAAC;IACzB,OAAO,IAAI,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC,CAAA;IAExC,gBAAgB,IAAI,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC,CAAA;IAGjD,kBAAkB,CAAC,GAAG,EAAE,uBAAuB,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAA;IAErE,SAAS,CAAC,GAAG,EAAE,uBAAuB,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAA;CAC/D;AAGD,qBAAa,aAAc,SAAQ,KAAK;aAMhB,UAAU,EAAE,QAAQ,EAAE;IAL1C,QAAQ,CAAC,kBAAkB,QAAO;gBAG9B,kBAAkB,EAAE,MAAM,EAC1B,SAAS,EAAE,MAAM,EACD,UAAU,EAAE,QAAQ,EAAE;IAO1C,IAAI,IAAI,IAAI,MAAM,CAEjB;CACJ;AAGD,wBAAgB,eAAe,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,aAAa,CAElE;AAGD,qBAAa,oBAAqB,SAAQ,KAAK;IAC3C,QAAQ,CAAC,yBAAyB,QAAO;CAC5C;AAGD,qBAAa,qBAAsB,SAAQ,oBAAoB;gBAC/C,GAAG,EAAE,QAAQ,EAAE,QAAQ,CAAC,EAAE,MAAM;CAO/C;AAGD,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,KAAK,CAEjE"}

package/lib/index.js

@@ -0,0 +1,46 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BlockConsistencyError = exports.DataConsistencyError = exports.ForkException = void 0;
+exports.isForkException = isForkException;
+exports.isDataConsistencyError = isDataConsistencyError;
+const assert_1 = __importDefault(require("assert"));
+class ForkException extends Error {
+    constructor(expectedParentHash, nextBlock, prevBlocks) {
+        (0, assert_1.default)(prevBlocks.length > 0);
+        let last = prevBlocks[prevBlocks.length - 1];
+        super(`expected ${nextBlock} to have parent ${last.number}#${expectedParentHash}, but got ${last.number}#${last.hash}`);
+        this.prevBlocks = prevBlocks;
+        this.isSqdForkException = true;
+    }
+    get name() {
+        return 'ForkException';
+    }
+}
+exports.ForkException = ForkException;
+function isForkException(err) {
+    return err instanceof Error && !!err.isSqdForkException;
+}
+class DataConsistencyError extends Error {
+    constructor() {
+        super(...arguments);
+        this.isSqdDataConsistencyError = true;
+    }
+}
+exports.DataConsistencyError = DataConsistencyError;
+class BlockConsistencyError extends DataConsistencyError {
+    constructor(ref, errorMsg) {
+        let msg = `Failed to fetch block ${ref.number}#${ref.hash}`;
+        if (errorMsg) {
+            msg += ': ' + errorMsg;
+        }
+        super(msg);
+    }
+}
+exports.BlockConsistencyError = BlockConsistencyError;
+function isDataConsistencyError(err) {
+    return err instanceof Error && !!err.isSqdDataConsistencyError;
+}
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAyDA,0CAEC;AAmBD,wDAEC;AAhFD,oDAA2B;AAsC3B,MAAa,aAAc,SAAQ,KAAK;IAGpC,YACI,kBAA0B,EAC1B,SAAiB,EACD,UAAsB;QAEtC,IAAA,gBAAM,EAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAC7B,IAAI,IAAI,GAAG,UAAU,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAC5C,KAAK,CAAC,YAAY,SAAS,mBAAmB,IAAI,CAAC,MAAM,IAAI,kBAAkB,aAAa,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,CAAA;QAJvG,eAAU,GAAV,UAAU,CAAY;QALjC,uBAAkB,GAAG,IAAI,CAAA;IAUlC,CAAC;IAED,IAAI,IAAI;QACJ,OAAO,eAAe,CAAA;IAC1B,CAAC;CACJ;AAhBD,sCAgBC;AAGD,SAAgB,eAAe,CAAC,GAAY;IACxC,OAAO,GAAG,YAAY,KAAK,IAAI,CAAC,CAAE,GAAW,CAAC,kBAAkB,CAAA;AACpE,CAAC;AAGD,MAAa,oBAAqB,SAAQ,KAAK;IAA/C;;QACa,8BAAyB,GAAG,IAAI,CAAA;IAC7C,CAAC;CAAA;AAFD,oDAEC;AAGD,MAAa,qBAAsB,SAAQ,oBAAoB;IAC3D,YAAY,GAAa,EAAE,QAAiB;QACxC,IAAI,GAAG,GAAG,yBAAyB,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,IAAI,EAAE,CAAA;QAC3D,IAAI,QAAQ,EAAE,CAAC;YACX,GAAG,IAAI,IAAI,GAAG,QAAQ,CAAA;QAC1B,CAAC;QACD,KAAK,CAAC,GAAG,CAAC,CAAA;IACd,CAAC;CACJ;AARD,sDAQC;AAGD,SAAgB,sBAAsB,CAAC,GAAY;IAC/C,OAAO,GAAG,YAAY,KAAK,IAAI,CAAC,CAAE,GAAW,CAAC,yBAAyB,CAAA;AAC3E,CAAC"}

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@subsquid/util-internal-data-source",
+  "version": "0.0.1-portal-api.6f7a57",
+  "description": "Definition of DataSource abstraction",
+  "license": "GPL-3.0-or-later",
+  "repository": "git@github.com:subsquid/squid.git",
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "lib/index.js",
+  "files": [
+    "lib",
+    "src"
+  ],
+  "dependencies": {
+    "@subsquid/util-internal-range": "^0.3.0"
+  },
+  "devDependencies": {
+    "@types/node": "^18.18.14",
+    "typescript": "5.5.4"
+  },
+  "scripts": {
+    "build": "rm -rf lib && tsc"
+  }
+}

package/src/index.ts

@@ -0,0 +1,81 @@
+import assert from 'assert'
+import {Range} from '@subsquid/util-internal-range'
+
+
+export interface BlockRef {
+    number: number
+    hash: string
+}
+
+
+export interface DataSourceStreamOptions {
+    range?: Range
+    stopOnHead?: boolean
+    parentHash?: string
+}
+
+
+export interface BlockBatch<B> {
+    blocks: B[]
+    finalizedHead?: BlockRef
+}
+
+
+export type DataSourceStream<B> = AsyncIterable<BlockBatch<B>>
+
+
+export interface DataSource<B> {
+    getHead(): Promise<BlockRef | undefined>
+
+    getFinalizedHead(): Promise<BlockRef | undefined>
+
+    // FIXME: maybe it's better to pass it ias an option to `getStream`
+    getFinalizedStream(req: DataSourceStreamOptions): DataSourceStream<B>
+
+    getStream(req: DataSourceStreamOptions): DataSourceStream<B>
+}
+
+
+export class ForkException extends Error {
+    readonly isSqdForkException = true
+
+    constructor(
+        expectedParentHash: string,
+        nextBlock: number,
+        public readonly prevBlocks: BlockRef[]
+    ) {
+        assert(prevBlocks.length > 0)
+        let last = prevBlocks[prevBlocks.length - 1]
+        super(`expected ${nextBlock} to have parent ${last.number}#${expectedParentHash}, but got ${last.number}#${last.hash}`)
+    }
+
+    get name(): string {
+        return 'ForkException'
+    }
+}
+
+
+export function isForkException(err: unknown): err is ForkException {
+    return err instanceof Error && !!(err as any).isSqdForkException
+}
+
+
+export class DataConsistencyError extends Error {
+    readonly isSqdDataConsistencyError = true
+}
+
+
+export class BlockConsistencyError extends DataConsistencyError {
+    constructor(ref: BlockRef, errorMsg?: string) {
+        let msg = `Failed to fetch block ${ref.number}#${ref.hash}`
+        if (errorMsg) {
+            msg += ': ' + errorMsg
+        }
+        super(msg)
+    }
+}
+
+
+export function isDataConsistencyError(err: unknown): err is Error {
+    return err instanceof Error && !!(err as any).isSqdDataConsistencyError
+}