@keetanetwork/anchor 0.0.38 → 0.0.40

package/client/index.d.ts

@@ -6,6 +6,8 @@ import * as lib from '../lib/index.js';
 import * as KeetaNet from '@keetanetwork/keetanet-client';
 import type { KeetaAssetMovementClientConfig } from '../services/asset-movement/client.ts';
 import KeetaAssetMovementAnchorClient from '../services/asset-movement/client.js';
+import type { KeetaUsernameAnchorClientConfig } from '../services/username/client.ts';
+import KeetaUsernameAnchorClient from '../services/username/client.js';
 export declare namespace KYC {
     type ClientConfig = KeetaKYCAnchorClientConfig;
     const Client: typeof KeetaKYCAnchorClient;
@@ -18,5 +20,9 @@ export declare namespace AssetMovement {
     type ClientConfig = KeetaAssetMovementClientConfig;
     const Client: typeof KeetaAssetMovementAnchorClient;
 }
+export declare namespace Username {
+    type ClientConfig = KeetaUsernameAnchorClientConfig;
+    const Client: typeof KeetaUsernameAnchorClient;
+}
 export { lib, KeetaNet };
 //# sourceMappingURL=index.d.ts.map

package/client/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,0BAA0B,EAC1B,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EACX,yBAAyB,EACzB,MAAM,0BAA0B,CAAC;AAClC,OAAO,oBAAoB,MAAM,2BAA2B,CAAC;AAC7D,OAAO,mBAAmB,MAAM,0BAA0B,CAAC;AAC3D,OAAO,KAAK,GAAG,MAAM,iBAAiB,CAAC;AACvC,OAAO,KAAK,QAAQ,MAAM,+BAA+B,CAAC;AAC1D,OAAO,KAAK,EACX,8BAA8B,EAC9B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,8BAA8B,MAAM,sCAAsC,CAAC;AAIlF,yBAAiB,GAAG,CAAC;IACpB,KAAY,YAAY,GAAG,0BAA0B,CAAC;IAC/C,MAAM,MAAM,EAAE,OAAO,oBAA2C,CAAC;CACxE;AAGD,yBAAiB,EAAE,CAAC;IACnB,KAAY,YAAY,GAAG,yBAAyB,CAAC;IAC9C,MAAM,MAAM,EAAE,OAAO,mBAAyC,CAAC;CACtE;AAGD,yBAAiB,aAAa,CAAC;IAC9B,KAAY,YAAY,GAAG,8BAA8B,CAAC;IACnD,MAAM,MAAM,EAAE,OAAO,8BAA+D,CAAC;CAC5F;AAED,OAAO,EACN,GAAG,EACH,QAAQ,EACR,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,0BAA0B,EAC1B,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EACX,yBAAyB,EACzB,MAAM,0BAA0B,CAAC;AAClC,OAAO,oBAAoB,MAAM,2BAA2B,CAAC;AAC7D,OAAO,mBAAmB,MAAM,0BAA0B,CAAC;AAC3D,OAAO,KAAK,GAAG,MAAM,iBAAiB,CAAC;AACvC,OAAO,KAAK,QAAQ,MAAM,+BAA+B,CAAC;AAC1D,OAAO,KAAK,EACX,8BAA8B,EAC9B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,8BAA8B,MAAM,sCAAsC,CAAC;AAClF,OAAO,KAAK,EACX,+BAA+B,EAC/B,MAAM,gCAAgC,CAAC;AACxC,OAAO,yBAAyB,MAAM,gCAAgC,CAAC;AAIvE,yBAAiB,GAAG,CAAC;IACpB,KAAY,YAAY,GAAG,0BAA0B,CAAC;IAC/C,MAAM,MAAM,EAAE,OAAO,oBAA2C,CAAC;CACxE;AAGD,yBAAiB,EAAE,CAAC;IACnB,KAAY,YAAY,GAAG,yBAAyB,CAAC;IAC9C,MAAM,MAAM,EAAE,OAAO,mBAAyC,CAAC;CACtE;AAGD,yBAAiB,aAAa,CAAC;IAC9B,KAAY,YAAY,GAAG,8BAA8B,CAAC;IACnD,MAAM,MAAM,EAAE,OAAO,8BAA+D,CAAC;CAC5F;AAGD,yBAAiB,QAAQ,CAAC;IACzB,KAAY,YAAY,GAAG,+BAA+B,CAAC;IACpD,MAAM,MAAM,EAAE,OAAO,yBAAqD,CAAC;CAClF;AAED,OAAO,EACN,GAAG,EACH,QAAQ,EACR,CAAC"}

package/client/index.js

@@ -3,6 +3,7 @@ import KeetaFXAnchorClient from '../services/fx/client.js';
 import * as lib from '../lib/index.js';
 import * as KeetaNet from '@keetanetwork/keetanet-client';
 import KeetaAssetMovementAnchorClient from '../services/asset-movement/client.js';
+import KeetaUsernameAnchorClient from '../services/username/client.js';
 // TODO: Determine how we want to export the client
 // eslint-disable-next-line @typescript-eslint/no-namespace
 export var KYC;
@@ -21,5 +22,11 @@ export var AssetMovement;
 (function (AssetMovement) {
     AssetMovement.Client = KeetaAssetMovementAnchorClient;
 })(AssetMovement || (AssetMovement = {}));
+// TODO: Determine how we want to export the client
+// eslint-disable-next-line @typescript-eslint/no-namespace
+export var Username;
+(function (Username) {
+    Username.Client = KeetaUsernameAnchorClient;
+})(Username || (Username = {}));
 export { lib, KeetaNet };
 //# sourceMappingURL=index.js.map

package/client/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAMA,OAAO,oBAAoB,MAAM,2BAA2B,CAAC;AAC7D,OAAO,mBAAmB,MAAM,0BAA0B,CAAC;AAC3D,OAAO,KAAK,GAAG,MAAM,iBAAiB,CAAC;AACvC,OAAO,KAAK,QAAQ,MAAM,+BAA+B,CAAC;AAI1D,OAAO,8BAA8B,MAAM,sCAAsC,CAAC;AAElF,mDAAmD;AACnD,2DAA2D;AAC3D,MAAM,KAAW,GAAG,CAGnB;AAHD,WAAiB,GAAG;IAEN,UAAM,GAAgC,oBAAoB,CAAC;AACzE,CAAC,EAHgB,GAAG,KAAH,GAAG,QAGnB;AACD,mDAAmD;AACnD,2DAA2D;AAC3D,MAAM,KAAW,EAAE,CAGlB;AAHD,WAAiB,EAAE;IAEL,SAAM,GAA+B,mBAAmB,CAAC;AACvE,CAAC,EAHgB,EAAE,KAAF,EAAE,QAGlB;AACD,mDAAmD;AACnD,2DAA2D;AAC3D,MAAM,KAAW,aAAa,CAG7B;AAHD,WAAiB,aAAa;IAEhB,oBAAM,GAA0C,8BAA8B,CAAC;AAC7F,CAAC,EAHgB,aAAa,KAAb,aAAa,QAG7B;AAED,OAAO,EACN,GAAG,EACH,QAAQ,EACR,CAAC","sourcesContent":["import type {\n\tKeetaKYCAnchorClientConfig\n} from '../services/kyc/client.ts';\nimport type {\n\tKeetaFXAnchorClientConfig\n} from '../services/fx/client.ts';\nimport KeetaKYCAnchorClient from '../services/kyc/client.js';\nimport KeetaFXAnchorClient from '../services/fx/client.js';\nimport * as lib from '../lib/index.js';\nimport * as KeetaNet from '@keetanetwork/keetanet-client';\nimport type {\n\tKeetaAssetMovementClientConfig\n} from '../services/asset-movement/client.ts';\nimport KeetaAssetMovementAnchorClient from '../services/asset-movement/client.js';\n\n// TODO: Determine how we want to export the client\n// eslint-disable-next-line @typescript-eslint/no-namespace\nexport namespace KYC {\n\texport type ClientConfig = KeetaKYCAnchorClientConfig;\n\texport const Client: typeof KeetaKYCAnchorClient = KeetaKYCAnchorClient;\n}\n// TODO: Determine how we want to export the client\n// eslint-disable-next-line @typescript-eslint/no-namespace\nexport namespace FX {\n\texport type ClientConfig = KeetaFXAnchorClientConfig;\n\texport const Client: typeof KeetaFXAnchorClient = KeetaFXAnchorClient;\n}\n// TODO: Determine how we want to export the client\n// eslint-disable-next-line @typescript-eslint/no-namespace\nexport namespace AssetMovement {\n\texport type ClientConfig = KeetaAssetMovementClientConfig;\n\texport const Client: typeof KeetaAssetMovementAnchorClient = KeetaAssetMovementAnchorClient;\n}\n\nexport {\n\tlib,\n\tKeetaNet\n};\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAMA,OAAO,oBAAoB,MAAM,2BAA2B,CAAC;AAC7D,OAAO,mBAAmB,MAAM,0BAA0B,CAAC;AAC3D,OAAO,KAAK,GAAG,MAAM,iBAAiB,CAAC;AACvC,OAAO,KAAK,QAAQ,MAAM,+BAA+B,CAAC;AAI1D,OAAO,8BAA8B,MAAM,sCAAsC,CAAC;AAIlF,OAAO,yBAAyB,MAAM,gCAAgC,CAAC;AAEvE,mDAAmD;AACnD,2DAA2D;AAC3D,MAAM,KAAW,GAAG,CAGnB;AAHD,WAAiB,GAAG;IAEN,UAAM,GAAgC,oBAAoB,CAAC;AACzE,CAAC,EAHgB,GAAG,KAAH,GAAG,QAGnB;AACD,mDAAmD;AACnD,2DAA2D;AAC3D,MAAM,KAAW,EAAE,CAGlB;AAHD,WAAiB,EAAE;IAEL,SAAM,GAA+B,mBAAmB,CAAC;AACvE,CAAC,EAHgB,EAAE,KAAF,EAAE,QAGlB;AACD,mDAAmD;AACnD,2DAA2D;AAC3D,MAAM,KAAW,aAAa,CAG7B;AAHD,WAAiB,aAAa;IAEhB,oBAAM,GAA0C,8BAA8B,CAAC;AAC7F,CAAC,EAHgB,aAAa,KAAb,aAAa,QAG7B;AACD,mDAAmD;AACnD,2DAA2D;AAC3D,MAAM,KAAW,QAAQ,CAGxB;AAHD,WAAiB,QAAQ;IAEX,eAAM,GAAqC,yBAAyB,CAAC;AACnF,CAAC,EAHgB,QAAQ,KAAR,QAAQ,QAGxB;AAED,OAAO,EACN,GAAG,EACH,QAAQ,EACR,CAAC","sourcesContent":["import type {\n\tKeetaKYCAnchorClientConfig\n} from '../services/kyc/client.ts';\nimport type {\n\tKeetaFXAnchorClientConfig\n} from '../services/fx/client.ts';\nimport KeetaKYCAnchorClient from '../services/kyc/client.js';\nimport KeetaFXAnchorClient from '../services/fx/client.js';\nimport * as lib from '../lib/index.js';\nimport * as KeetaNet from '@keetanetwork/keetanet-client';\nimport type {\n\tKeetaAssetMovementClientConfig\n} from '../services/asset-movement/client.ts';\nimport KeetaAssetMovementAnchorClient from '../services/asset-movement/client.js';\nimport type {\n\tKeetaUsernameAnchorClientConfig\n} from '../services/username/client.ts';\nimport KeetaUsernameAnchorClient from '../services/username/client.js';\n\n// TODO: Determine how we want to export the client\n// eslint-disable-next-line @typescript-eslint/no-namespace\nexport namespace KYC {\n\texport type ClientConfig = KeetaKYCAnchorClientConfig;\n\texport const Client: typeof KeetaKYCAnchorClient = KeetaKYCAnchorClient;\n}\n// TODO: Determine how we want to export the client\n// eslint-disable-next-line @typescript-eslint/no-namespace\nexport namespace FX {\n\texport type ClientConfig = KeetaFXAnchorClientConfig;\n\texport const Client: typeof KeetaFXAnchorClient = KeetaFXAnchorClient;\n}\n// TODO: Determine how we want to export the client\n// eslint-disable-next-line @typescript-eslint/no-namespace\nexport namespace AssetMovement {\n\texport type ClientConfig = KeetaAssetMovementClientConfig;\n\texport const Client: typeof KeetaAssetMovementAnchorClient = KeetaAssetMovementAnchorClient;\n}\n// TODO: Determine how we want to export the client\n// eslint-disable-next-line @typescript-eslint/no-namespace\nexport namespace Username {\n\texport type ClientConfig = KeetaUsernameAnchorClientConfig;\n\texport const Client: typeof KeetaUsernameAnchorClient = KeetaUsernameAnchorClient;\n}\n\nexport {\n\tlib,\n\tKeetaNet\n};\n"]}

package/lib/block-listener.d.ts

@@ -0,0 +1,93 @@
+import type { Client } from "@keetanetwork/keetanet-client";
+import type { Logger } from "./log/index.js";
+import type { Block, BlockHash } from "@keetanetwork/keetanet-client/lib/block/index.js";
+import type { BlockOperations } from "@keetanetwork/keetanet-client/lib/block/operations.js";
+import { KeetaAnchorQueueRunner } from "./queue/index.js";
+import type { KeetaAnchorQueueEntryExtra, KeetaAnchorQueueRequestID } from "./queue/index.js";
+import type { JSONSerializable } from "./utils/json.js";
+import type { KeetaAnchorQueueRunOptions } from "./queue/common.js";
+interface BlockListenerConfig {
+    client: Client;
+    logger?: Logger;
+}
+interface BlockListenerContext {
+    block: Block;
+}
+interface NetworkListenerArguments {
+    'block': {
+        callback: (data: BlockListenerContext) => (Promise<{
+            requiresWork?: boolean;
+        }> | {
+            requiresWork?: boolean;
+        });
+    };
+}
+interface BlockListenerScanOptions {
+    searchTo?: {
+        extended: true;
+    } | number | undefined;
+}
+export declare class BlockListener {
+    #private;
+    constructor(config: BlockListenerConfig);
+    get logger(): Logger | undefined;
+    scan(options?: BlockListenerScanOptions): Promise<{
+        listenersHaveWork: boolean;
+    }>;
+    on<K extends keyof NetworkListenerArguments>(_ignore_type: K, args: NetworkListenerArguments[K]): {
+        remove: () => void;
+    };
+}
+type BlockQueueRunnerRequest = {
+    blockHash: BlockHash;
+};
+type BlockQueueRunnerRequestSerialized = {
+    blockHash: string;
+};
+interface BaseBlockOperationQueueRunnerScanOptionsRequired {
+    scanWhenRunning: true;
+    extendedScanIntervalMs: number;
+    regularScanIntervalMs: number;
+}
+type BlockOperationQueueRunnerConfig<Request, Result, RequestSerialized extends JSONSerializable, ResultSerialized extends JSONSerializable | null> = ConstructorParameters<typeof KeetaAnchorQueueRunner<Request, Result, RequestSerialized, ResultSerialized>>[0] & {
+    listener: BlockListener | BlockListenerConfig;
+    scanOptions?: Partial<BaseBlockOperationQueueRunnerScanOptionsRequired> | {
+        scanWhenRunning: false;
+    };
+};
+declare abstract class BaseBlockOperationQueueRunner<Request, Result = null, RequestSerialized extends JSONSerializable = JSONSerializable, ResultSerialized extends JSONSerializable = null> extends KeetaAnchorQueueRunner<Request, Result, RequestSerialized, ResultSerialized> {
+    #private;
+    constructor(config: BlockOperationQueueRunnerConfig<Request, Result, RequestSerialized, ResultSerialized>);
+    protected abstract onBlockSeen(block: Block): Promise<boolean>;
+    protected decodeResponse(response: ResultSerialized): Result | null;
+    protected encodeResponse(response: Result): ResultSerialized;
+    run(options?: KeetaAnchorQueueRunOptions): Promise<boolean>;
+    [Symbol.dispose](): void;
+}
+export declare abstract class BlockQueueRunner<UserResult = null, QueueResult extends JSONSerializable = null> extends BaseBlockOperationQueueRunner<BlockQueueRunnerRequest, UserResult, BlockQueueRunnerRequestSerialized, QueueResult> {
+    protected abstract filterBlock(block: Block): (boolean | Promise<boolean>);
+    protected decodeRequest(request: BlockQueueRunnerRequestSerialized): BlockQueueRunnerRequest;
+    protected encodeRequest(request: BlockQueueRunnerRequest): BlockQueueRunnerRequestSerialized;
+    protected onBlockSeen(block: Block): Promise<boolean>;
+    add(request: BlockQueueRunnerRequest, info?: KeetaAnchorQueueEntryExtra): Promise<KeetaAnchorQueueRequestID>;
+}
+type OperationQueueRunnerRequest = {
+    blockHash: BlockHash;
+    operationIndex: number;
+};
+type OperationQueueRunnerRequestSerialized = {
+    blockHash: string;
+    operationIndex: number;
+};
+export declare abstract class OperationQueueRunner<UserResult = null, QueueResult extends JSONSerializable = null> extends BaseBlockOperationQueueRunner<OperationQueueRunnerRequest, UserResult, OperationQueueRunnerRequestSerialized, QueueResult> {
+    protected abstract filterOperation(operation: BlockOperations, context: {
+        block: Block;
+        operationIndex: number;
+    }): (boolean | Promise<boolean>);
+    protected decodeRequest(request: OperationQueueRunnerRequestSerialized): OperationQueueRunnerRequest;
+    protected encodeRequest(request: OperationQueueRunnerRequest): OperationQueueRunnerRequestSerialized;
+    protected onBlockSeen(block: Block): Promise<boolean>;
+    add(request: OperationQueueRunnerRequest, info?: KeetaAnchorQueueEntryExtra): Promise<KeetaAnchorQueueRequestID>;
+}
+export {};
+//# sourceMappingURL=block-listener.d.ts.map

package/lib/block-listener.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"block-listener.d.ts","sourceRoot":"","sources":["../../src/lib/block-listener.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,kDAAkD,CAAC;AACzF,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uDAAuD,CAAC;AAE7F,OAAO,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAC1D,OAAO,KAAK,EAAE,0BAA0B,EAAE,yBAAyB,EAAE,MAAM,kBAAkB,CAAC;AAC9F,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAGxD,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,mBAAmB,CAAC;AAEpE,UAAU,mBAAmB;IAC5B,MAAM,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,UAAU,oBAAoB;IAC7B,KAAK,EAAE,KAAK,CAAC;CACb;AAED,UAAU,wBAAwB;IACjC,OAAO,EAAE;QACR,QAAQ,EAAE,CAAC,IAAI,EAAE,oBAAoB,KAAK,CAAC,OAAO,CAAC;YAAE,YAAY,CAAC,EAAE,OAAO,CAAC;SAAE,CAAC,GAAG;YAAE,YAAY,CAAC,EAAE,OAAO,CAAC;SAAE,CAAC,CAAC;KAC/G,CAAA;CACD;AAED,UAAU,wBAAwB;IACjC,QAAQ,CAAC,EAAE;QAAE,QAAQ,EAAE,IAAI,CAAC;KAAE,GAAG,MAAM,GAAG,SAAS,CAAC;CACpD;AAED,qBAAa,aAAa;;gBAKb,MAAM,EAAE,mBAAmB;IAQvC,IAAI,MAAM,IAAI,MAAM,GAAG,SAAS,CAE/B;IA4BK,IAAI,CAAC,OAAO,CAAC,EAAE,wBAAwB,GAAG,OAAO,CAAC;QAAE,iBAAiB,EAAE,OAAO,CAAC;KAAE,CAAC;IAgFxF,EAAE,CAAC,CAAC,SAAS,MAAM,wBAAwB,EAAE,YAAY,EAAE,CAAC,EAAE,IAAI,EAAE,wBAAwB,CAAC,CAAC,CAAC,GAAG;QAAE,MAAM,EAAE,MAAM,IAAI,CAAC;KAAE;CAczH;AAED,KAAK,uBAAuB,GAAG;IAAE,SAAS,EAAE,SAAS,CAAC;CAAE,CAAC;AACzD,KAAK,iCAAiC,GAAG;IAAE,SAAS,EAAE,MAAM,CAAC;CAAE,CAAC;AAEhE,UAAU,gDAAgD;IACzD,eAAe,EAAE,IAAI,CAAC;IACtB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,qBAAqB,EAAE,MAAM,CAAC;CAC9B;AAED,KAAK,+BAA+B,CAAC,OAAO,EAAE,MAAM,EAAE,iBAAiB,SAAS,gBAAgB,EAAE,gBAAgB,SAAS,gBAAgB,GAAG,IAAI,IACjJ,qBAAqB,CAAC,OAAO,sBAAsB,CAAC,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,GAC7G;IACC,QAAQ,EAAE,aAAa,GAAG,mBAAmB,CAAC;IAE9C,WAAW,CAAC,EAAE,OAAO,CAAC,gDAAgD,CAAC,GAAG;QACzE,eAAe,EAAE,KAAK,CAAC;KACvB,CAAA;CACD,CAAC;AAEH,uBAAe,6BAA6B,CAC3C,OAAO,EACP,MAAM,GAAG,IAAI,EACb,iBAAiB,SAAS,gBAAgB,GAAG,gBAAgB,EAC7D,gBAAgB,SAAS,gBAAgB,GAAG,IAAI,CAC/C,SAAQ,sBAAsB,CAAC,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,gBAAgB,CAAC;;gBAUzE,MAAM,EAAE,+BAA+B,CAAC,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,gBAAgB,CAAC;IAgCzG,SAAS,CAAC,QAAQ,CAAC,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC;IAE9D,SAAS,CAAC,cAAc,CAAC,QAAQ,EAAE,gBAAgB,GAAG,MAAM,GAAG,IAAI;IAQnE,SAAS,CAAC,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,gBAAgB;IAS7C,GAAG,CAAC,OAAO,CAAC,EAAE,0BAA0B,GAAG,OAAO,CAAC,OAAO,CAAC;IAwC1E,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,IAAI;CAGxB;AAED,8BAAsB,gBAAgB,CAAC,UAAU,GAAG,IAAI,EAAE,WAAW,SAAS,gBAAgB,GAAG,IAAI,CAAE,SAAQ,6BAA6B,CAAC,uBAAuB,EAAE,UAAU,EAAE,iCAAiC,EAAE,WAAW,CAAC;IAChO,SAAS,CAAC,QAAQ,CAAC,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAE1E,SAAS,CAAC,aAAa,CAAC,OAAO,EAAE,iCAAiC,GAAG,uBAAuB;IAI5F,SAAS,CAAC,aAAa,CAAC,OAAO,EAAE,uBAAuB,GAAG,iCAAiC;cAI5E,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC;IAQlD,GAAG,CAAC,OAAO,EAAE,uBAAuB,EAAE,IAAI,CAAC,EAAE,0BAA0B,GAAG,OAAO,CAAC,yBAAyB,CAAC;CASrH;AAED,KAAK,2BAA2B,GAAG;IAAE,SAAS,EAAE,SAAS,CAAC;IAAC,cAAc,EAAE,MAAM,CAAC;CAAE,CAAC;AACrF,KAAK,qCAAqC,GAAG;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,cAAc,EAAE,MAAM,CAAC;CAAE,CAAC;AAE5F,8BAAsB,oBAAoB,CAAC,UAAU,GAAG,IAAI,EAAE,WAAW,SAAS,gBAAgB,GAAG,IAAI,CAAE,SAAQ,6BAA6B,CAAC,2BAA2B,EAAE,UAAU,EAAE,qCAAqC,EAAE,WAAW,CAAC;IAC5O,SAAS,CAAC,QAAQ,CAAC,eAAe,CAAC,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE;QAAE,KAAK,EAAE,KAAK,CAAC;QAAC,cAAc,EAAE,MAAM,CAAC;KAAE,GAAG,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEhJ,SAAS,CAAC,aAAa,CAAC,OAAO,EAAE,qCAAqC,GAAG,2BAA2B;IAIpG,SAAS,CAAC,aAAa,CAAC,OAAO,EAAE,2BAA2B,GAAG,qCAAqC;cAIpF,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC;IAyBlD,GAAG,CAAC,OAAO,EAAE,2BAA2B,EAAE,IAAI,CAAC,EAAE,0BAA0B,GAAG,OAAO,CAAC,yBAAyB,CAAC;CASzH"}

package/lib/block-listener.js

@@ -0,0 +1,259 @@
+import { KeetaAnchorQueueRunner } from "./queue/index.js";
+import { KeetaNet } from "../client/index.js";
+import { ConvertStringToRequestID } from "./queue/internal.js";
+export class BlockListener {
+    #config;
+    #blockListeners = [];
+    constructor(config) {
+        this.#config = config;
+    }
+    get #client() {
+        return (this.#config.client);
+    }
+    get logger() {
+        return (this.#config.logger);
+    }
+    async #runWithLog(label, func) {
+        try {
+            await func();
+        }
+        catch (error) {
+            this.logger?.error(`BlockListener::${label}`, `Received Error running`, error);
+        }
+    }
+    async #processBlockListeners(block) {
+        let listenersHaveWork = false;
+        const promises = [];
+        for (const listener of this.#blockListeners) {
+            promises.push(this.#runWithLog('block callback', async function () {
+                const response = await listener.callback({ block });
+                if (response.requiresWork) {
+                    listenersHaveWork = true;
+                }
+            }));
+        }
+        await Promise.allSettled(promises);
+        return ({ listenersHaveWork });
+    }
+    async scan(options) {
+        let listenersHaveWork = false;
+        try {
+            let reachedEndOfTime = false;
+            let startBlocksHash;
+            let pageCount = 0;
+            /*
+             * Either perform an extended
+             * scan (30 days) or a short
+             * scan (4 hours) to find
+             * relevant operations
+             */
+            const now = Date.now();
+            let oldestVoteStapleToCheck = now - (4 * 60 * 60 * 1000); // 4 hours ago
+            if (options?.searchTo) {
+                if (typeof options.searchTo === 'number') {
+                    if (options.searchTo >= now || options.searchTo <= 0) {
+                        throw (new Error('BlockListener::scan: When providing searchTo as a number, it must be a timestamp in the past'));
+                    }
+                    oldestVoteStapleToCheck = options.searchTo;
+                }
+                else if ('extended' in options.searchTo) {
+                    oldestVoteStapleToCheck = now - (30 * 24 * 60 * 60 * 1000); // 30 days ago
+                }
+                else {
+                    throw (new Error('BlockListener::scan: Invalid searchTo option provided'));
+                }
+            }
+            while (!reachedEndOfTime) {
+                pageCount++;
+                const historyOptions = { depth: 20, ...(startBlocksHash ? { startBlocksHash } : {}) };
+                this.logger?.debug('BlockListener::poll', `Fetching history page ${pageCount}`, { ...historyOptions });
+                const history = await this.#client.getHistory(null, historyOptions);
+                if (history.length === 0) {
+                    this.logger?.debug('BlockListener::poll', `No more history found, ending discovery`);
+                    break;
+                }
+                const processBlocksPromises = [];
+                for (const { voteStaple } of history) {
+                    if (voteStaple.timestamp().valueOf() < oldestVoteStapleToCheck) {
+                        this.logger?.debug('BlockListener::poll', 'Reached vote staple older than scanning time, ending discovery for this run', { voteStapleTime: voteStaple.timestamp(), oldestVoteStapleToCheck: new Date(oldestVoteStapleToCheck) });
+                        reachedEndOfTime = true;
+                        break;
+                    }
+                    for (const block of voteStaple.blocks) {
+                        processBlocksPromises.push(this.#processBlockListeners(block));
+                    }
+                }
+                const processBlockPromiseResults = await Promise.all(processBlocksPromises);
+                if (processBlockPromiseResults.some(result => result.listenersHaveWork)) {
+                    listenersHaveWork = true;
+                }
+                // Set up for next page
+                const lastVoteStaple = history[history.length - 1]?.voteStaple;
+                if (lastVoteStaple) {
+                    startBlocksHash = lastVoteStaple.blocksHash;
+                }
+                else {
+                    break;
+                }
+            }
+        }
+        catch (error) {
+            this.logger?.error('BlockListener::poll', 'Error during discovery:', error);
+        }
+        return ({ listenersHaveWork });
+    }
+    on(_ignore_type, args) {
+        const id = String(Math.random());
+        this.#blockListeners.push({ ...args, id });
+        return ({
+            remove: () => {
+                const index = this.#blockListeners.findIndex(listener => listener.id === id);
+                if (index !== -1) {
+                    this.#blockListeners.splice(index, 1);
+                }
+            }
+        });
+    }
+}
+class BaseBlockOperationQueueRunner extends KeetaAnchorQueueRunner {
+    #listener;
+    #lastExtendedScanTime = null;
+    #lastScanTime = null;
+    #scanOptions;
+    #removeListenerCallback;
+    constructor(config) {
+        const { listener, ...restConfig } = config;
+        super(restConfig);
+        if (listener instanceof BlockListener) {
+            this.#listener = listener;
+        }
+        else {
+            this.#listener = new BlockListener(listener);
+        }
+        const addedListener = this.#listener.on('block', {
+            callback: async ({ block }) => {
+                return ({ requiresWork: await this.onBlockSeen(block) });
+            }
+        });
+        this.#removeListenerCallback = addedListener.remove;
+        if (!config.scanOptions || config.scanOptions?.scanWhenRunning || config.scanOptions?.scanWhenRunning === undefined) {
+            this.#scanOptions = {
+                scanWhenRunning: true,
+                extendedScanIntervalMs: 60 * 60 * 1000, // 1 hour
+                regularScanIntervalMs: 5 * 60 * 1000, // 5 minutes
+                ...config.scanOptions
+            };
+        }
+        else {
+            this.#scanOptions = { scanWhenRunning: false };
+        }
+    }
+    decodeResponse(response) {
+        if (response === null) {
+            return (null);
+        }
+        else {
+            throw (new Error('BlockQueueRunner::decodeResponse: Not implemented when response is not null, you must override this method in your subclass'));
+        }
+    }
+    encodeResponse(response) {
+        if (response === null) {
+            // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+            return null;
+        }
+        else {
+            throw (new Error('BlockQueueRunner::encodeResponse: Not implemented when response is not null, you must override this method in your subclass'));
+        }
+    }
+    async run(options) {
+        let scanYieldedWork = false;
+        if (this.#scanOptions.scanWhenRunning) {
+            const now = Date.now();
+            let extendedScanDue = false;
+            let dueForScan = false;
+            if (!this.#lastScanTime || (now - this.#lastScanTime > this.#scanOptions.regularScanIntervalMs)) {
+                dueForScan = true;
+            }
+            if (!this.#lastExtendedScanTime || (now - this.#lastExtendedScanTime > this.#scanOptions.extendedScanIntervalMs)) {
+                extendedScanDue = true;
+            }
+            if (extendedScanDue || dueForScan) {
+                let searchTo;
+                if (extendedScanDue) {
+                    searchTo = { extended: true };
+                }
+                else if (this.#lastScanTime) {
+                    searchTo = this.#lastScanTime;
+                }
+                const scanResult = await this.#listener.scan({ searchTo });
+                this.#lastScanTime = now;
+                if (extendedScanDue) {
+                    this.#lastExtendedScanTime = now;
+                }
+                scanYieldedWork = scanResult.listenersHaveWork;
+            }
+        }
+        const moreRunWork = await super.run(options);
+        return (moreRunWork || scanYieldedWork);
+    }
+    [Symbol.dispose]() {
+        this.#removeListenerCallback();
+    }
+}
+export class BlockQueueRunner extends BaseBlockOperationQueueRunner {
+    decodeRequest(request) {
+        return ({ blockHash: new KeetaNet.lib.Block.Hash(request.blockHash) });
+    }
+    encodeRequest(request) {
+        return ({ blockHash: request.blockHash.toString() });
+    }
+    async onBlockSeen(block) {
+        const shouldInclude = await this.filterBlock(block);
+        if (shouldInclude) {
+            await this.add({ blockHash: block.hash });
+        }
+        return (shouldInclude);
+    }
+    add(request, info) {
+        const requestIdString = ConvertStringToRequestID(request.blockHash.toString().toLowerCase());
+        if (info?.id && String(info.id) !== String(requestIdString)) {
+            throw (new Error(`OperationQueueRunner::add: When providing an "id" in info, it must match the blockHash of the request. Expected ${String(requestIdString)}, got ${String(info.id)}`));
+        }
+        return (super.add(request, { ...info, id: requestIdString }));
+    }
+}
+export class OperationQueueRunner extends BaseBlockOperationQueueRunner {
+    decodeRequest(request) {
+        return ({ blockHash: new KeetaNet.lib.Block.Hash(request.blockHash), operationIndex: request.operationIndex });
+    }
+    encodeRequest(request) {
+        return ({ blockHash: request.blockHash.toString(), operationIndex: Number(request.operationIndex) });
+    }
+    async onBlockSeen(block) {
+        const addPromises = [];
+        let anyShouldInclude = false;
+        for (let operationIndex = 0; operationIndex < block.operations.length; operationIndex++) {
+            const operation = block.operations[operationIndex];
+            if (!operation) {
+                continue;
+            }
+            addPromises.push((async () => {
+                const shouldInclude = await this.filterOperation(operation, { block, operationIndex });
+                if (shouldInclude) {
+                    anyShouldInclude = true;
+                    await this.add({ blockHash: block.hash, operationIndex });
+                }
+            })());
+        }
+        await Promise.all(addPromises);
+        return (anyShouldInclude);
+    }
+    add(request, info) {
+        const requestIdString = ConvertStringToRequestID(`${request.blockHash.toString()}-${String(request.operationIndex)}`.toLowerCase());
+        if (info?.id && String(info.id) !== String(requestIdString)) {
+            throw (new Error(`OperationQueueRunner::add: When providing an "id" in info, it must match the blockHash and operationIndex of the request. Expected ${String(requestIdString)}, got ${String(info.id)}`));
+        }
+        return (super.add(request, { ...info, id: requestIdString }));
+    }
+}
+//# sourceMappingURL=block-listener.js.map

package/lib/block-listener.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"block-listener.js","sourceRoot":"","sources":["../../src/lib/block-listener.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAG1D,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AAuB/D,MAAM,OAAO,aAAa;IACzB,OAAO,CAAsB;IAE7B,eAAe,GAA4D,EAAE,CAAC;IAE9E,YAAY,MAA2B;QACtC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,IAAI,OAAO;QACV,OAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC7B,CAAC;IAED,IAAI,MAAM;QACT,OAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC7B,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,KAAa,EAAE,IAAyB;QACzD,IAAI,CAAC;YACJ,MAAM,IAAI,EAAE,CAAC;QACd,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,kBAAkB,KAAK,EAAE,EAAE,wBAAwB,EAAE,KAAK,CAAC,CAAC;QAChF,CAAC;IACF,CAAC;IAED,KAAK,CAAC,sBAAsB,CAAC,KAAY;QACxC,IAAI,iBAAiB,GAAG,KAAK,CAAC;QAE9B,MAAM,QAAQ,GAAG,EAAE,CAAC;QACpB,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;YAC7C,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,gBAAgB,EAAE,KAAK;gBACrD,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;gBACpD,IAAI,QAAQ,CAAC,YAAY,EAAE,CAAC;oBAC3B,iBAAiB,GAAG,IAAI,CAAC;gBAC1B,CAAC;YACF,CAAC,CAAC,CAAC,CAAC;QACL,CAAC;QAED,MAAM,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAEnC,OAAM,CAAC,EAAE,iBAAiB,EAAE,CAAC,CAAC;IAC/B,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,OAAkC;QAC5C,IAAI,iBAAiB,GAAG,KAAK,CAAC;QAE9B,IAAI,CAAC;YACJ,IAAI,gBAAgB,GAAG,KAAK,CAAC;YAC7B,IAAI,eAA0C,CAAC;YAC/C,IAAI,SAAS,GAAG,CAAC,CAAC;YAElB;;;;;eAKG;YACH,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAEvB,IAAI,uBAAuB,GAAG,GAAG,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,cAAc;YAExE,IAAI,OAAO,EAAE,QAAQ,EAAE,CAAC;gBACvB,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;oBAC1C,IAAI,OAAO,CAAC,QAAQ,IAAI,GAAG,IAAI,OAAO,CAAC,QAAQ,IAAI,CAAC,EAAE,CAAC;wBACtD,MAAK,CAAC,IAAI,KAAK,CAAC,8FAA8F,CAAC,CAAC,CAAC;oBAClH,CAAC;oBAED,uBAAuB,GAAG,OAAO,CAAC,QAAQ,CAAC;gBAC5C,CAAC;qBAAM,IAAI,UAAU,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;oBAC3C,uBAAuB,GAAG,GAAG,GAAG,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,cAAc;gBAC3E,CAAC;qBAAM,CAAC;oBACP,MAAK,CAAC,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC,CAAC;gBAC3E,CAAC;YACF,CAAC;YAED,OAAO,CAAC,gBAAgB,EAAE,CAAC;gBAC1B,SAAS,EAAE,CAAC;gBAEZ,MAAM,cAAc,GAAG,EAAE,KAAK,EAAE,EAAE,EAAE,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,eAAe,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;gBAEtF,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,qBAAqB,EAAE,yBAAyB,SAAS,EAAE,EAAE,EAAE,GAAG,cAAc,EAAE,CAAC,CAAC;gBAEvG,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;gBAEpE,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBAC1B,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,qBAAqB,EAAE,yCAAyC,CAAC,CAAC;oBACrF,MAAM;gBACP,CAAC;gBAED,MAAM,qBAAqB,GAAG,EAAE,CAAC;gBACjC,KAAK,MAAM,EAAE,UAAU,EAAE,IAAI,OAAO,EAAE,CAAC;oBACtC,IAAI,UAAU,CAAC,SAAS,EAAE,CAAC,OAAO,EAAE,GAAG,uBAAuB,EAAE,CAAC;wBAChE,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,qBAAqB,EAAE,6EAA6E,EAAE,EAAE,cAAc,EAAE,UAAU,CAAC,SAAS,EAAE,EAAE,uBAAuB,EAAE,IAAI,IAAI,CAAC,uBAAuB,CAAC,EAAE,CAAC,CAAC;wBACjO,gBAAgB,GAAG,IAAI,CAAC;wBACxB,MAAM;oBACP,CAAC;oBAED,KAAK,MAAM,KAAK,IAAI,UAAU,CAAC,MAAM,EAAE,CAAC;wBACvC,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC,CAAC;oBAChE,CAAC;gBACF,CAAC;gBAED,MAAM,0BAA0B,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;gBAE5E,IAAI,0BAA0B,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE,CAAC;oBACzE,iBAAiB,GAAG,IAAI,CAAC;gBAC1B,CAAC;gBAED,uBAAuB;gBACvB,MAAM,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,UAAU,CAAC;gBAC/D,IAAI,cAAc,EAAE,CAAC;oBACpB,eAAe,GAAG,cAAc,CAAC,UAAU,CAAC;gBAC7C,CAAC;qBAAM,CAAC;oBACP,MAAM;gBACP,CAAC;YACF,CAAC;QACF,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,qBAAqB,EAAE,yBAAyB,EAAE,KAAK,CAAC,CAAC;QAC7E,CAAC;QAED,OAAM,CAAC,EAAE,iBAAiB,EAAE,CAAC,CAAC;IAC/B,CAAC;IAED,EAAE,CAA2C,YAAe,EAAE,IAAiC;QAC9F,MAAM,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QAEjC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;QAE3C,OAAM,CAAC;YACN,MAAM,EAAE,GAAG,EAAE;gBACZ,MAAM,KAAK,GAAG,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;gBAC7E,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;oBAClB,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;gBACvC,CAAC;YACF,CAAC;SACD,CAAC,CAAA;IACH,CAAC;CACD;AAqBD,MAAe,6BAKb,SAAQ,sBAA4E;IACrF,SAAS,CAAgB;IAEzB,qBAAqB,GAAkB,IAAI,CAAC;IAC5C,aAAa,GAAkB,IAAI,CAAC;IAEpC,YAAY,CAAiF;IAE7F,uBAAuB,CAAe;IAEtC,YAAY,MAA6F;QACxG,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,EAAE,GAAG,MAAM,CAAC;QAE3C,KAAK,CAAC,UAAU,CAAC,CAAC;QAElB,IAAI,QAAQ,YAAY,aAAa,EAAE,CAAC;YACvC,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC3B,CAAC;aAAM,CAAC;YACP,IAAI,CAAC,SAAS,GAAG,IAAI,aAAa,CAAC,QAAQ,CAAC,CAAC;QAC9C,CAAC;QAED,MAAM,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE;YAChD,QAAQ,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE;gBAC7B,OAAM,CAAC,EAAE,YAAY,EAAE,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YACzD,CAAC;SACD,CAAC,CAAC;QAEH,IAAI,CAAC,uBAAuB,GAAG,aAAa,CAAC,MAAM,CAAC;QAEpD,IAAI,CAAC,MAAM,CAAC,WAAW,IAAI,MAAM,CAAC,WAAW,EAAE,eAAe,IAAI,MAAM,CAAC,WAAW,EAAE,eAAe,KAAK,SAAS,EAAE,CAAC;YACrH,IAAI,CAAC,YAAY,GAAG;gBACnB,eAAe,EAAE,IAAI;gBACrB,sBAAsB,EAAE,EAAE,GAAG,EAAE,GAAG,IAAI,EAAE,SAAS;gBACjD,qBAAqB,EAAE,CAAC,GAAG,EAAE,GAAG,IAAI,EAAE,YAAY;gBAClD,GAAG,MAAM,CAAC,WAAW;aACrB,CAAC;QACH,CAAC;aAAM,CAAC;YACP,IAAI,CAAC,YAAY,GAAG,EAAE,eAAe,EAAE,KAAK,EAAE,CAAC;QAChD,CAAC;IAEF,CAAC;IAIS,cAAc,CAAC,QAA0B;QAClD,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;YACvB,OAAM,CAAC,IAAI,CAAC,CAAC;QACd,CAAC;aAAM,CAAC;YACP,MAAK,CAAC,IAAI,KAAK,CAAC,6HAA6H,CAAC,CAAC,CAAC;QACjJ,CAAC;IACF,CAAC;IAES,cAAc,CAAC,QAAgB;QACxC,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;YACvB,yEAAyE;YACzE,OAAO,IAAyB,CAAC;QAClC,CAAC;aAAM,CAAC;YACP,MAAK,CAAC,IAAI,KAAK,CAAC,6HAA6H,CAAC,CAAC,CAAC;QACjJ,CAAC;IACF,CAAC;IAEQ,KAAK,CAAC,GAAG,CAAC,OAAoC;QACtD,IAAI,eAAe,GAAG,KAAK,CAAC;QAC5B,IAAI,IAAI,CAAC,YAAY,CAAC,eAAe,EAAE,CAAC;YACvC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAEvB,IAAI,eAAe,GAAG,KAAK,CAAC;YAC5B,IAAI,UAAU,GAAG,KAAK,CAAC;YACvB,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,YAAY,CAAC,qBAAqB,CAAC,EAAE,CAAC;gBACjG,UAAU,GAAG,IAAI,CAAC;YACnB,CAAC;YAED,IAAI,CAAC,IAAI,CAAC,qBAAqB,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,YAAY,CAAC,sBAAsB,CAAC,EAAE,CAAC;gBAClH,eAAe,GAAG,IAAI,CAAC;YACxB,CAAC;YAGD,IAAI,eAAe,IAAI,UAAU,EAAE,CAAC;gBACnC,IAAI,QAA8C,CAAC;gBACnD,IAAI,eAAe,EAAE,CAAC;oBACrB,QAAQ,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;gBAC/B,CAAC;qBAAM,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;oBAC/B,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC;gBAC/B,CAAC;gBAED,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;gBAE3D,IAAI,CAAC,aAAa,GAAG,GAAG,CAAC;gBACzB,IAAI,eAAe,EAAE,CAAC;oBACrB,IAAI,CAAC,qBAAqB,GAAG,GAAG,CAAC;gBAClC,CAAC;gBAED,eAAe,GAAG,UAAU,CAAC,iBAAiB,CAAC;YAChD,CAAC;QACF,CAAC;QAED,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAE7C,OAAM,CAAC,WAAW,IAAI,eAAe,CAAC,CAAC;IACxC,CAAC;IAED,CAAC,MAAM,CAAC,OAAO,CAAC;QACf,IAAI,CAAC,uBAAuB,EAAE,CAAC;IAChC,CAAC;CACD;AAED,MAAM,OAAgB,gBAAiF,SAAQ,6BAAkH;IAGtN,aAAa,CAAC,OAA0C;QACjE,OAAM,CAAC,EAAE,SAAS,EAAE,IAAI,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IACvE,CAAC;IAES,aAAa,CAAC,OAAgC;QACvD,OAAM,CAAC,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IACrD,CAAC;IAES,KAAK,CAAC,WAAW,CAAC,KAAY;QACvC,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QACpD,IAAI,aAAa,EAAE,CAAC;YACnB,MAAM,IAAI,CAAC,GAAG,CAAC,EAAE,SAAS,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;QAC3C,CAAC;QACD,OAAM,CAAC,aAAa,CAAC,CAAC;IACvB,CAAC;IAEQ,GAAG,CAAC,OAAgC,EAAE,IAAiC;QAC/E,MAAM,eAAe,GAAG,wBAAwB,CAAC,OAAO,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,WAAW,EAAE,CAAC,CAAA;QAE5F,IAAI,IAAI,EAAE,EAAE,IAAI,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,MAAM,CAAC,eAAe,CAAC,EAAE,CAAC;YAC7D,MAAK,CAAC,IAAI,KAAK,CAAC,mHAAmH,MAAM,CAAC,eAAe,CAAC,SAAS,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QACxL,CAAC;QAED,OAAM,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE,eAAe,EAAE,CAAC,CAAC,CAAC;IAC9D,CAAC;CACD;AAKD,MAAM,OAAgB,oBAAqF,SAAQ,6BAA0H;IAGlO,aAAa,CAAC,OAA8C;QACrE,OAAM,CAAC,EAAE,SAAS,EAAE,IAAI,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,cAAc,EAAE,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IAC/G,CAAC;IAES,aAAa,CAAC,OAAoC;QAC3D,OAAM,CAAC,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE,cAAc,EAAE,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;IACrG,CAAC;IAES,KAAK,CAAC,WAAW,CAAC,KAAY;QACvC,MAAM,WAAW,GAAG,EAAE,CAAC;QAEvB,IAAI,gBAAgB,GAAG,KAAK,CAAC;QAC7B,KAAK,IAAI,cAAc,GAAG,CAAC,EAAE,cAAc,GAAG,KAAK,CAAC,UAAU,CAAC,MAAM,EAAE,cAAc,EAAE,EAAE,CAAC;YACzF,MAAM,SAAS,GAAG,KAAK,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;YAEnD,IAAI,CAAC,SAAS,EAAE,CAAC;gBAChB,SAAS;YACV,CAAC;YAED,WAAW,CAAC,IAAI,CAAC,CAAC,KAAK,IAAI,EAAE;gBAC5B,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC,CAAC;gBACvF,IAAI,aAAa,EAAE,CAAC;oBACnB,gBAAgB,GAAG,IAAI,CAAC;oBACxB,MAAM,IAAI,CAAC,GAAG,CAAC,EAAE,SAAS,EAAE,KAAK,CAAC,IAAI,EAAE,cAAc,EAAE,CAAC,CAAC;gBAC3D,CAAC;YACF,CAAC,CAAC,EAAE,CAAC,CAAC;QACP,CAAC;QAED,MAAM,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAE/B,OAAM,CAAC,gBAAgB,CAAC,CAAC;IAC1B,CAAC;IAEQ,GAAG,CAAC,OAAoC,EAAE,IAAiC;QACnF,MAAM,eAAe,GAAG,wBAAwB,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;QAEpI,IAAI,IAAI,EAAE,EAAE,IAAI,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,MAAM,CAAC,eAAe,CAAC,EAAE,CAAC;YAC7D,MAAK,CAAC,IAAI,KAAK,CAAC,sIAAsI,MAAM,CAAC,eAAe,CAAC,SAAS,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAC3M,CAAC;QAED,OAAM,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE,eAAe,EAAE,CAAC,CAAC,CAAA;IAC7D,CAAC;CACD","sourcesContent":["import type { Client } from \"@keetanetwork/keetanet-client\";\nimport type { Logger } from \"./log/index.js\";\nimport type { Block, BlockHash } from \"@keetanetwork/keetanet-client/lib/block/index.js\";\nimport type { BlockOperations } from \"@keetanetwork/keetanet-client/lib/block/operations.js\";\nimport type { VoteBlockHash } from \"@keetanetwork/keetanet-client/lib/vote.js\";\nimport { KeetaAnchorQueueRunner } from \"./queue/index.js\";\nimport type { KeetaAnchorQueueEntryExtra, KeetaAnchorQueueRequestID } from \"./queue/index.js\";\nimport type { JSONSerializable } from \"./utils/json.js\";\nimport { KeetaNet } from \"../client/index.js\";\nimport { ConvertStringToRequestID } from \"./queue/internal.js\";\nimport type { KeetaAnchorQueueRunOptions } from \"./queue/common.js\";\n\ninterface BlockListenerConfig {\n\tclient: Client;\n\n\tlogger?: Logger;\n}\n\ninterface BlockListenerContext {\n\tblock: Block;\n}\n\ninterface NetworkListenerArguments {\n\t'block': {\n\t\tcallback: (data: BlockListenerContext) => (Promise<{ requiresWork?: boolean; }> | { requiresWork?: boolean; });\n\t}\n}\n\ninterface BlockListenerScanOptions {\n\tsearchTo?: { extended: true; } | number | undefined;\n}\n\nexport class BlockListener {\n\t#config: BlockListenerConfig;\n\n\t#blockListeners: (NetworkListenerArguments['block'] & { id: string; })[] = [];\n\n\tconstructor(config: BlockListenerConfig) {\n\t\tthis.#config = config;\n\t}\n\n\tget #client(): Client {\n\t\treturn(this.#config.client);\n\t}\n\n\tget logger(): Logger | undefined {\n\t\treturn(this.#config.logger);\n\t}\n\n\tasync #runWithLog(label: string, func: () => Promise<void>) {\n\t\ttry {\n\t\t\tawait func();\n\t\t} catch (error) {\n\t\t\tthis.logger?.error(`BlockListener::${label}`, `Received Error running`, error);\n\t\t}\n\t}\n\n\tasync #processBlockListeners(block: Block) {\n\t\tlet listenersHaveWork = false;\n\n\t\tconst promises = [];\n\t\tfor (const listener of this.#blockListeners) {\n\t\t\tpromises.push(this.#runWithLog('block callback', async function() {\n\t\t\t\tconst response = await listener.callback({ block });\n\t\t\t\tif (response.requiresWork) {\n\t\t\t\t\tlistenersHaveWork = true;\n\t\t\t\t}\n\t\t\t}));\n\t\t}\n\n\t\tawait Promise.allSettled(promises);\n\n\t\treturn({ listenersHaveWork });\n\t}\n\n\tasync scan(options?: BlockListenerScanOptions): Promise<{ listenersHaveWork: boolean; }> {\n\t\tlet listenersHaveWork = false;\n\n\t\ttry {\n\t\t\tlet reachedEndOfTime = false;\n\t\t\tlet startBlocksHash: VoteBlockHash | undefined;\n\t\t\tlet pageCount = 0;\n\n\t\t\t/*\n\t\t\t * Either perform an extended\n\t\t\t * scan (30 days) or a short\n\t\t\t * scan (4 hours) to find\n\t\t\t * relevant operations\n\t\t\t */\n\t\t\tconst now = Date.now();\n\n\t\t\tlet oldestVoteStapleToCheck = now - (4 * 60 * 60 * 1000); // 4 hours ago\n\n\t\t\tif (options?.searchTo) {\n\t\t\t\tif (typeof options.searchTo === 'number') {\n\t\t\t\t\tif (options.searchTo >= now || options.searchTo <= 0) {\n\t\t\t\t\t\tthrow(new Error('BlockListener::scan: When providing searchTo as a number, it must be a timestamp in the past'));\n\t\t\t\t\t}\n\n\t\t\t\t\toldestVoteStapleToCheck = options.searchTo;\n\t\t\t\t} else if ('extended' in options.searchTo) {\n\t\t\t\t\toldestVoteStapleToCheck = now - (30 * 24 * 60 * 60 * 1000); // 30 days ago\n\t\t\t\t} else {\n\t\t\t\t\tthrow(new Error('BlockListener::scan: Invalid searchTo option provided'));\n\t\t\t\t}\n\t\t\t}\n\n\t\t\twhile (!reachedEndOfTime) {\n\t\t\t\tpageCount++;\n\n\t\t\t\tconst historyOptions = { depth: 20, ...(startBlocksHash ? { startBlocksHash } : {}) };\n\n\t\t\t\tthis.logger?.debug('BlockListener::poll', `Fetching history page ${pageCount}`, { ...historyOptions });\n\n\t\t\t\tconst history = await this.#client.getHistory(null, historyOptions);\n\n\t\t\t\tif (history.length === 0) {\n\t\t\t\t\tthis.logger?.debug('BlockListener::poll', `No more history found, ending discovery`);\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\n\t\t\t\tconst processBlocksPromises = [];\n\t\t\t\tfor (const { voteStaple } of history) {\n\t\t\t\t\tif (voteStaple.timestamp().valueOf() < oldestVoteStapleToCheck) {\n\t\t\t\t\t\tthis.logger?.debug('BlockListener::poll', 'Reached vote staple older than scanning time, ending discovery for this run', { voteStapleTime: voteStaple.timestamp(), oldestVoteStapleToCheck: new Date(oldestVoteStapleToCheck) });\n\t\t\t\t\t\treachedEndOfTime = true;\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\n\t\t\t\t\tfor (const block of voteStaple.blocks) {\n\t\t\t\t\t\tprocessBlocksPromises.push(this.#processBlockListeners(block));\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\tconst processBlockPromiseResults = await Promise.all(processBlocksPromises);\n\n\t\t\t\tif (processBlockPromiseResults.some(result => result.listenersHaveWork)) {\n\t\t\t\t\tlistenersHaveWork = true;\n\t\t\t\t}\n\n\t\t\t\t// Set up for next page\n\t\t\t\tconst lastVoteStaple = history[history.length - 1]?.voteStaple;\n\t\t\t\tif (lastVoteStaple) {\n\t\t\t\t\tstartBlocksHash = lastVoteStaple.blocksHash;\n\t\t\t\t} else {\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t}\n\t\t} catch (error) {\n\t\t\tthis.logger?.error('BlockListener::poll', 'Error during discovery:', error);\n\t\t}\n\n\t\treturn({ listenersHaveWork });\n\t}\n\n\ton<K extends keyof NetworkListenerArguments>(_ignore_type: K, args: NetworkListenerArguments[K]): { remove: () => void; } {\n\t\tconst id = String(Math.random());\n\n\t\tthis.#blockListeners.push({ ...args, id });\n\n\t\treturn({\n\t\t\tremove: () => {\n\t\t\t\tconst index = this.#blockListeners.findIndex(listener => listener.id === id);\n\t\t\t\tif (index !== -1) {\n\t\t\t\t\tthis.#blockListeners.splice(index, 1);\n\t\t\t\t}\n\t\t\t}\n\t\t})\n\t}\n}\n\ntype BlockQueueRunnerRequest = { blockHash: BlockHash; };\ntype BlockQueueRunnerRequestSerialized = { blockHash: string; };\n\ninterface BaseBlockOperationQueueRunnerScanOptionsRequired {\n\tscanWhenRunning: true;\n\textendedScanIntervalMs: number;\n\tregularScanIntervalMs: number;\n}\n\ntype BlockOperationQueueRunnerConfig<Request, Result, RequestSerialized extends JSONSerializable, ResultSerialized extends JSONSerializable | null> =\n\tConstructorParameters<typeof KeetaAnchorQueueRunner<Request, Result, RequestSerialized, ResultSerialized>>[0] &\n\t{\n\t\tlistener: BlockListener | BlockListenerConfig;\n\n\t\tscanOptions?: Partial<BaseBlockOperationQueueRunnerScanOptionsRequired> | {\n\t\t\tscanWhenRunning: false;\n\t\t}\n\t};\n\nabstract class BaseBlockOperationQueueRunner<\n\tRequest,\n\tResult = null,\n\tRequestSerialized extends JSONSerializable = JSONSerializable,\n\tResultSerialized extends JSONSerializable = null\n> extends KeetaAnchorQueueRunner<Request, Result, RequestSerialized, ResultSerialized> {\n\t#listener: BlockListener;\n\n\t#lastExtendedScanTime: number | null = null;\n\t#lastScanTime: number | null = null;\n\n\t#scanOptions: BaseBlockOperationQueueRunnerScanOptionsRequired | { scanWhenRunning: false; };\n\n\t#removeListenerCallback: (() => void);\n\n\tconstructor(config: BlockOperationQueueRunnerConfig<Request, Result, RequestSerialized, ResultSerialized>) {\n\t\tconst { listener, ...restConfig } = config;\n\n\t\tsuper(restConfig);\n\n\t\tif (listener instanceof BlockListener) {\n\t\t\tthis.#listener = listener;\n\t\t} else {\n\t\t\tthis.#listener = new BlockListener(listener);\n\t\t}\n\n\t\tconst addedListener = this.#listener.on('block', {\n\t\t\tcallback: async ({ block }) => {\n\t\t\t\treturn({ requiresWork: await this.onBlockSeen(block) });\n\t\t\t}\n\t\t});\n\n\t\tthis.#removeListenerCallback = addedListener.remove;\n\n\t\tif (!config.scanOptions || config.scanOptions?.scanWhenRunning || config.scanOptions?.scanWhenRunning === undefined) {\n\t\t\tthis.#scanOptions = {\n\t\t\t\tscanWhenRunning: true,\n\t\t\t\textendedScanIntervalMs: 60 * 60 * 1000, // 1 hour\n\t\t\t\tregularScanIntervalMs: 5 * 60 * 1000, // 5 minutes\n\t\t\t\t...config.scanOptions\n\t\t\t};\n\t\t} else {\n\t\t\tthis.#scanOptions = { scanWhenRunning: false };\n\t\t}\n\n\t}\n\n\tprotected abstract onBlockSeen(block: Block): Promise<boolean>;\n\n\tprotected decodeResponse(response: ResultSerialized): Result | null {\n\t\tif (response === null) {\n\t\t\treturn(null);\n\t\t} else {\n\t\t\tthrow(new Error('BlockQueueRunner::decodeResponse: Not implemented when response is not null, you must override this method in your subclass'));\n\t\t}\n\t}\n\n\tprotected encodeResponse(response: Result): ResultSerialized {\n\t\tif (response === null) {\n\t\t\t// eslint-disable-next-line @typescript-eslint/consistent-type-assertions\n\t\t\treturn(null as ResultSerialized);\n\t\t} else {\n\t\t\tthrow(new Error('BlockQueueRunner::encodeResponse: Not implemented when response is not null, you must override this method in your subclass'));\n\t\t}\n\t}\n\n\toverride async run(options?: KeetaAnchorQueueRunOptions): Promise<boolean> {\n\t\tlet scanYieldedWork = false;\n\t\tif (this.#scanOptions.scanWhenRunning) {\n\t\t\tconst now = Date.now();\n\n\t\t\tlet extendedScanDue = false;\n\t\t\tlet dueForScan = false;\n\t\t\tif (!this.#lastScanTime || (now - this.#lastScanTime > this.#scanOptions.regularScanIntervalMs)) {\n\t\t\t\tdueForScan = true;\n\t\t\t}\n\n\t\t\tif (!this.#lastExtendedScanTime || (now - this.#lastExtendedScanTime > this.#scanOptions.extendedScanIntervalMs)) {\n\t\t\t\textendedScanDue = true;\n\t\t\t}\n\n\n\t\t\tif (extendedScanDue || dueForScan) {\n\t\t\t\tlet searchTo: BlockListenerScanOptions['searchTo'];\n\t\t\t\tif (extendedScanDue) {\n\t\t\t\t\tsearchTo = { extended: true };\n\t\t\t\t} else if (this.#lastScanTime) {\n\t\t\t\t\tsearchTo = this.#lastScanTime;\n\t\t\t\t}\n\n\t\t\t\tconst scanResult = await this.#listener.scan({ searchTo });\n\n\t\t\t\tthis.#lastScanTime = now;\n\t\t\t\tif (extendedScanDue) {\n\t\t\t\t\tthis.#lastExtendedScanTime = now;\n\t\t\t\t}\n\n\t\t\t\tscanYieldedWork = scanResult.listenersHaveWork;\n\t\t\t}\n\t\t}\n\n\t\tconst moreRunWork = await super.run(options);\n\n\t\treturn(moreRunWork || scanYieldedWork);\n\t}\n\n\t[Symbol.dispose](): void {\n\t\tthis.#removeListenerCallback();\n\t}\n}\n\nexport abstract class BlockQueueRunner<UserResult = null, QueueResult extends JSONSerializable = null> extends BaseBlockOperationQueueRunner<BlockQueueRunnerRequest, UserResult, BlockQueueRunnerRequestSerialized, QueueResult> {\n\tprotected abstract filterBlock(block: Block): (boolean | Promise<boolean>);\n\n\tprotected decodeRequest(request: BlockQueueRunnerRequestSerialized): BlockQueueRunnerRequest {\n\t\treturn({ blockHash: new KeetaNet.lib.Block.Hash(request.blockHash) });\n\t}\n\n\tprotected encodeRequest(request: BlockQueueRunnerRequest): BlockQueueRunnerRequestSerialized {\n\t\treturn({ blockHash: request.blockHash.toString() });\n\t}\n\n\tprotected async onBlockSeen(block: Block): Promise<boolean> {\n\t\tconst shouldInclude = await this.filterBlock(block);\n\t\tif (shouldInclude) {\n\t\t\tawait this.add({ blockHash: block.hash });\n\t\t}\n\t\treturn(shouldInclude);\n\t}\n\n\toverride add(request: BlockQueueRunnerRequest, info?: KeetaAnchorQueueEntryExtra): Promise<KeetaAnchorQueueRequestID> {\n\t\tconst requestIdString = ConvertStringToRequestID(request.blockHash.toString().toLowerCase())\n\n\t\tif (info?.id && String(info.id) !== String(requestIdString)) {\n\t\t\tthrow(new Error(`OperationQueueRunner::add: When providing an \"id\" in info, it must match the blockHash of the request. Expected ${String(requestIdString)}, got ${String(info.id)}`));\n\t\t}\n\n\t\treturn(super.add(request, { ...info, id: requestIdString }));\n\t}\n}\n\ntype OperationQueueRunnerRequest = { blockHash: BlockHash; operationIndex: number; };\ntype OperationQueueRunnerRequestSerialized = { blockHash: string; operationIndex: number; };\n\nexport abstract class OperationQueueRunner<UserResult = null, QueueResult extends JSONSerializable = null> extends BaseBlockOperationQueueRunner<OperationQueueRunnerRequest, UserResult, OperationQueueRunnerRequestSerialized, QueueResult> {\n\tprotected abstract filterOperation(operation: BlockOperations, context: { block: Block; operationIndex: number; }): (boolean | Promise<boolean>);\n\n\tprotected decodeRequest(request: OperationQueueRunnerRequestSerialized): OperationQueueRunnerRequest {\n\t\treturn({ blockHash: new KeetaNet.lib.Block.Hash(request.blockHash), operationIndex: request.operationIndex });\n\t}\n\n\tprotected encodeRequest(request: OperationQueueRunnerRequest): OperationQueueRunnerRequestSerialized {\n\t\treturn({ blockHash: request.blockHash.toString(), operationIndex: Number(request.operationIndex) });\n\t}\n\n\tprotected async onBlockSeen(block: Block): Promise<boolean> {\n\t\tconst addPromises = [];\n\n\t\tlet anyShouldInclude = false;\n\t\tfor (let operationIndex = 0; operationIndex < block.operations.length; operationIndex++) {\n\t\t\tconst operation = block.operations[operationIndex];\n\n\t\t\tif (!operation) {\n\t\t\t\tcontinue;\n\t\t\t}\n\n\t\t\taddPromises.push((async () => {\n\t\t\t\tconst shouldInclude = await this.filterOperation(operation, { block, operationIndex });\n\t\t\t\tif (shouldInclude) {\n\t\t\t\t\tanyShouldInclude = true;\n\t\t\t\t\tawait this.add({ blockHash: block.hash, operationIndex });\n\t\t\t\t}\n\t\t\t})());\n\t\t}\n\n\t\tawait Promise.all(addPromises);\n\n\t\treturn(anyShouldInclude);\n\t}\n\n\toverride add(request: OperationQueueRunnerRequest, info?: KeetaAnchorQueueEntryExtra): Promise<KeetaAnchorQueueRequestID> {\n\t\tconst requestIdString = ConvertStringToRequestID(`${request.blockHash.toString()}-${String(request.operationIndex)}`.toLowerCase());\n\n\t\tif (info?.id && String(info.id) !== String(requestIdString)) {\n\t\t\tthrow(new Error(`OperationQueueRunner::add: When providing an \"id\" in info, it must match the blockHash and operationIndex of the request. Expected ${String(requestIdString)}, got ${String(info.id)}`));\n\t\t}\n\n\t\treturn(super.add(request, { ...info, id: requestIdString }))\n\t}\n}\n"]}

package/lib/encrypted-container.d.ts

@@ -1,7 +1,42 @@
 import { lib as KeetaNetLib } from '@keetanetwork/keetanet-client';
 import { Buffer } from './utils/buffer.js';
+import { KeetaAnchorError } from './error.js';
+/**
+ * Error codes for EncryptedContainer operations
+ */
+export declare const EncryptedContainerErrorCodes: readonly ["MALFORMED_BASE_FORMAT", "MALFORMED_VERSION", "MALFORMED_DATA_STRUCTURE", "MALFORMED_KEY_INFO", "MALFORMED_SIGNER_INFO", "UNSUPPORTED_VERSION", "UNSUPPORTED_CIPHER_ALGORITHM", "UNSUPPORTED_DIGEST_ALGORITHM", "UNSUPPORTED_SIGNATURE_ALGORITHM", "UNSUPPORTED_KEY_TYPE", "NO_KEYS_PROVIDED", "NO_MATCHING_KEY", "DECRYPTION_FAILED", "DECOMPRESSION_FAILED", "SIGNER_REQUIRES_PRIVATE_KEY", "NOT_SIGNED", "SIGNATURE_VERIFICATION_FAILED", "NO_PLAINTEXT_AVAILABLE", "NO_ENCODED_DATA_AVAILABLE", "PLAINTEXT_DISABLED", "ENCRYPTION_REQUIRED", "INVALID_PRINCIPALS", "ACCESS_MANAGEMENT_NOT_ALLOWED", "INTERNAL_ERROR"];
+/**
+ * Error code type
+ */
+export type EncryptedContainerErrorCode = typeof EncryptedContainerErrorCodes[number];
+/**
+ * Error class for EncryptedContainer operations
+ */
+export declare class EncryptedContainerError extends KeetaAnchorError {
+    static readonly name: string;
+    private readonly encryptedContainerErrorObjectTypeID;
+    private static readonly encryptedContainerErrorObjectTypeID;
+    readonly code: EncryptedContainerErrorCode;
+    /**
+     * Check if a string is a valid EncryptedContainerErrorCode
+     */
+    static isValidCode(code: string): code is EncryptedContainerErrorCode;
+    constructor(code: EncryptedContainerErrorCode, message: string);
+    static isInstance(input: unknown): input is EncryptedContainerError;
+    toJSON(): ReturnType<KeetaAnchorError['toJSON']> & {
+        code: EncryptedContainerErrorCode;
+    };
+    static fromJSON(input: unknown): Promise<EncryptedContainerError>;
+}
 declare const Account: typeof KeetaNetLib.Account;
 type Account = InstanceType<typeof KeetaNetLib.Account>;
+/**
+ * Options for creating an EncryptedContainer from plaintext
+ */
+export type FromPlaintextOptions = {
+    locked?: boolean;
+    signer?: Account;
+};
 type CipherOptions = {
     /**
      * The symmetric cipher key (if any)
@@ -35,7 +70,7 @@ export declare class EncryptedContainer {
      * Encryption details
      */
     protected _internalState: EncryptedContainerInfo | UnencryptedContainerInfo;
-    constructor(principals: Account[] | null);
+    constructor(principals: Account[] | null, signer?: Account);
     get encrypted(): boolean;
     /**
      * Create an instance of the EncryptedContainer from an encrypted blob,
@@ -54,10 +89,10 @@ export declare class EncryptedContainer {
      *
      * @param data The plaintext data to encrypt or encode
      * @param principals The list of principals who can access the data if it is null then the data is not encrypted
-     * @param locked If true, the plaintext data will not be accessible from this instance; otherwise it will be -- default depends on principals
+     * @param options Options including locked (plaintext accessibility) and signer (for RFC 5652 signing). For backward compatibility, can also be a boolean for locked.
      * @returns The EncryptedContainer instance with the plaintext data and principals set
      */
-    static fromPlaintext(data: string | ArrayBuffer | Buffer, principals: Account[] | null, locked?: boolean): EncryptedContainer;
+    static fromPlaintext(data: string | ArrayBuffer | Buffer, principals: Account[] | null, options?: boolean | FromPlaintextOptions): EncryptedContainer;
     /**
      * Set the plaintext buffer to the specified value
      */
@@ -101,6 +136,21 @@ export declare class EncryptedContainer {
      * this container
      */
     get principals(): Account[];
+    /**
+     * Check if this container is signed
+     */
+    get isSigned(): boolean;
+    /**
+     * Get the signing account of this container.
+     */
+    getSigningAccount(): Account | undefined;
+    /**
+     * Verify the signature on this container.
+     * This requires decrypting the container first to access the compressed plaintext.
+     *
+     * @returns true if signature is valid, false if invalid, or throws if not signed or plaintext unavailable
+     */
+    verifySignature(): Promise<boolean>;
 }
 export default EncryptedContainer;
 //# sourceMappingURL=encrypted-container.d.ts.map

package/lib/encrypted-container.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"encrypted-container.d.ts","sourceRoot":"","sources":["../../src/lib/encrypted-container.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,GAAG,IAAI,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAKnE,OAAO,EAAE,MAAM,EAA4C,MAAM,mBAAmB,CAAC;AAOrF,QAAA,MAAM,OAAO,EAAE,OAAO,WAAW,CAAC,OAA6B,CAAC;AAChE,KAAK,OAAO,GAAG,YAAY,CAAC,OAAO,WAAW,CAAC,OAAO,CAAC,CAAC;AAyFxD,KAAK,aAAa,GAAG;IACpB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACnB,CAAA;AAkUD,KAAK,sBAAsB,GAAG,IAAI,CAAC,aAAa,EAAE,YAAY,CAAC,GAAG;IACjE;;OAEG;IACH,UAAU,EAAE,OAAO,EAAE,CAAC;CACtB,CAAA;AAED,KAAK,wBAAwB,GAAG;IAC/B;;OAEG;IACH,UAAU,EAAE,IAAI,CAAC;CACjB,CAAA;AAED,qBAAa,kBAAkB;;IAC9B,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAiB;IAOlD;;OAEG;IACH,SAAS,CAAC,cAAc,EAAE,sBAAsB,GAAG,wBAAwB,CAAC;gBAUhE,UAAU,EAAE,OAAO,EAAE,GAAG,IAAI;IAcxC,IAAI,SAAS,IAAI,OAAO,CAEvB;IAMD;;;;;;;OAOG;IACH,MAAM,CAAC,mBAAmB,CAAC,IAAI,EAAE,WAAW,GAAG,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,kBAAkB;IASjG,MAAM,CAAC,iBAAiB,CAAC,IAAI,EAAE,WAAW,GAAG,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,IAAI,GAAG,kBAAkB;IAStG;;;;;;;;;OASG;IACH,MAAM,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,GAAG,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,kBAAkB;IAmB7H;;OAEG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,GAAG,MAAM,GAAG,IAAI;IAWvD,OAAO,KAAK,QAAQ,GAMnB;IAED,OAAO,KAAK,UAAU,GAMrB;IA8JD;;;;OAIG;IACH,eAAe,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,GAAG,IAAI;IAqBpD;;OAEG;IACG,WAAW,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ/D;;;;OAIG;IACH,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAmBxC;;OAEG;IACG,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAQnD;;OAEG;IACH,gBAAgB,IAAI,IAAI;IAMxB;;OAEG;IACG,YAAY,IAAI,OAAO,CAAC,WAAW,CAAC;IAmB1C;;OAEG;IACG,gBAAgB,IAAI,OAAO,CAAC,WAAW,CAAC;IAe9C;;;OAGG;IACH,IAAI,UAAU,IAAI,OAAO,EAAE,CAM1B;CACD;AAQD,eAAe,kBAAkB,CAAC"}
+{"version":3,"file":"encrypted-container.d.ts","sourceRoot":"","sources":["../../src/lib/encrypted-container.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,GAAG,IAAI,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAKnE,OAAO,EAAE,MAAM,EAAqE,MAAM,mBAAmB,CAAC;AAE9G,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAI9C;;GAEG;AACH,eAAO,MAAM,4BAA4B,qmBAsC/B,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,OAAO,4BAA4B,CAAC,MAAM,CAAC,CAAC;AAEtF;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,gBAAgB;IAC5D,gBAAyB,IAAI,EAAE,MAAM,CAA6B;IAElE,OAAO,CAAC,QAAQ,CAAC,mCAAmC,CAAU;IAC9D,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,mCAAmC,CAA0C;IAErG,QAAQ,CAAC,IAAI,EAAE,2BAA2B,CAAC;IAE3C;;OAEG;IACH,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,IAAI,2BAA2B;gBAKzD,IAAI,EAAE,2BAA2B,EAAE,OAAO,EAAE,MAAM;IAY9D,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,uBAAuB;IAI1D,MAAM,IAAI,UAAU,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,GAAG;QAAE,IAAI,EAAE,2BAA2B,CAAA;KAAE;WAOpF,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,uBAAuB,CAAC;CAkBvE;AAQD,QAAA,MAAM,OAAO,EAAE,OAAO,WAAW,CAAC,OAA6B,CAAC;AAChE,KAAK,OAAO,GAAG,YAAY,CAAC,OAAO,WAAW,CAAC,OAAO,CAAC,CAAC;AAExD;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IAClC,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,MAAM,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAmRF,KAAK,aAAa,GAAG;IACpB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACnB,CAAA;AA+bD,KAAK,sBAAsB,GAAG,IAAI,CAAC,aAAa,EAAE,YAAY,CAAC,GAAG;IACjE;;OAEG;IACH,UAAU,EAAE,OAAO,EAAE,CAAC;CACtB,CAAA;AAED,KAAK,wBAAwB,GAAG;IAC/B;;OAEG;IACH,UAAU,EAAE,IAAI,CAAC;CACjB,CAAA;AAcD,qBAAa,kBAAkB;;IAC9B,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAiB;IAOlD;;OAEG;IACH,SAAS,CAAC,cAAc,EAAE,sBAAsB,GAAG,wBAAwB,CAAC;gBAehE,UAAU,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,MAAM,CAAC,EAAE,OAAO;IAkB1D,IAAI,SAAS,IAAI,OAAO,CAEvB;IAMD;;;;;;;OAOG;IACH,MAAM,CAAC,mBAAmB,CAAC,IAAI,EAAE,WAAW,GAAG,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,kBAAkB;IASjG,MAAM,CAAC,iBAAiB,CAAC,IAAI,EAAE,WAAW,GAAG,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,IAAI,GAAG,kBAAkB;IAStG;;;;;;;;;OASG;IACH,MAAM,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,GAAG,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,oBAAoB,GAAG,kBAAkB;IA+BrJ;;OAEG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,GAAG,MAAM,GAAG,IAAI;IAWvD,OAAO,KAAK,QAAQ,GAMnB;IAED,OAAO,KAAK,UAAU,GAMrB;IA8KD;;;;OAIG;IACH,eAAe,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,GAAG,IAAI;IAqBpD;;OAEG;IACG,WAAW,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ/D;;;;OAIG;IACH,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAmBxC;;OAEG;IACG,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAQnD;;OAEG;IACH,gBAAgB,IAAI,IAAI;IAMxB;;OAEG;IACG,YAAY,IAAI,OAAO,CAAC,WAAW,CAAC;IAmB1C;;OAEG;IACG,gBAAgB,IAAI,OAAO,CAAC,WAAW,CAAC;IAe9C;;;OAGG;IACH,IAAI,UAAU,IAAI,OAAO,EAAE,CAM1B;IAED;;OAEG;IACH,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAED;;OAEG;IACH,iBAAiB,IAAI,OAAO,GAAG,SAAS;IAexC;;;;;OAKG;IACG,eAAe,IAAI,OAAO,CAAC,OAAO,CAAC;CA2DzC;AAQD,eAAe,kBAAkB,CAAC"}