@usherlabs/cex-broker 0.2.44 → 0.2.46

package/dist/helpers/market-data-vendor-backfill/manifests.d.ts

@@ -0,0 +1,1086 @@
+export declare const CAPABILITY_POLICY_ID: "market-data-vendor-backfill-capabilities/v1";
+export declare const RESOURCE_POLICY_ID: "market-data-vendor-backfill-resources/v1";
+export declare const ADAPTER_POLICY_ID: "cryptohftdata-orderbook-adapter/v1";
+export declare const ACQUISITION_POLICY_ID: "cryptohftdata-hourly-acquisition/v1";
+export declare const CAPABILITY_POLICY: Readonly<{
+    policy_sha256: string;
+    policy_id: "market-data-vendor-backfill-capabilities/v1";
+    provider: "cryptohftdata";
+    adapter_policy: {
+        readonly policy_id: "cryptohftdata-orderbook-adapter/v1";
+        readonly adapter_version: "cryptohftdata-orderbook/v2";
+    };
+    acquisition_policy: {
+        readonly policy_id: "cryptohftdata-hourly-acquisition/v1";
+        readonly object_granularity: "utc_hour";
+        readonly authentication: "bearer";
+        readonly initialization_lookback_ms: 0;
+    };
+    profiles: readonly [{
+        readonly exchange: "okx";
+        readonly market_type: "spot";
+        readonly feed: "ORDERBOOK";
+        readonly canonical_trading_pair: "ARB-USDT";
+        readonly provider_exchange_id: "okx_spot";
+        readonly resolved_symbol: "ARB-USDT";
+        readonly construction_modes: readonly ["sampled_top_n_snapshot"];
+        readonly source_policies: readonly ["authoritative_window"];
+        readonly max_depth: 400;
+    }];
+}>;
+export declare const RESOURCE_POLICY: Readonly<{
+    policy_sha256: string;
+    policy_id: "market-data-vendor-backfill-resources/v1";
+    limits: {
+        readonly max_files: 10000;
+        readonly max_bytes: number;
+        readonly max_rows: 1000000000;
+        readonly max_duration_ms: number;
+        readonly max_boundary_lookback_ms: number;
+    };
+    request_bounds: {
+        readonly max_depth: 500;
+        readonly max_window_ms: number;
+        readonly max_required_events: 100000;
+    };
+}>;
+export declare const EFFECTIVE_ADAPTER_POLICY_PIN: Readonly<{
+    policy_id: "cryptohftdata-orderbook-adapter/v1";
+    policy_sha256: string;
+}>;
+export declare const EFFECTIVE_ACQUISITION_POLICY_PIN: Readonly<{
+    policy_id: "cryptohftdata-hourly-acquisition/v1";
+    policy_sha256: string;
+}>;
+export declare const SCHEMA_ARTIFACTS: readonly Readonly<{
+    schema_id: string;
+    path: "schemas/request.schema.json" | "schemas/result.schema.json" | "schemas/required-clock.schema.json" | "schemas/archive-selection.schema.json" | "schemas/promotion-receipt.schema.json";
+    schema_sha256: string;
+    schema: {
+        $schema: string;
+        $id: string;
+        title: string;
+        type: string;
+        additionalProperties: boolean;
+        required: string[];
+        properties: {
+            schema_id: {
+                const: string;
+            };
+            selection_sha256: {
+                $ref: string;
+            };
+            scope: {
+                $ref: string;
+            };
+            required_clock: {
+                $ref: string;
+            };
+            coverage_policy: {
+                $ref: string;
+            };
+            source_policy: {
+                enum: string[];
+            };
+            coverage_class: {
+                enum: string[];
+            };
+            requested_intervals: {
+                type: string;
+                minItems: number;
+                items: {
+                    $ref: string;
+                };
+            };
+            selected_intervals: {
+                type: string;
+                items: {
+                    type: string;
+                    additionalProperties: boolean;
+                    required: string[];
+                    properties: {
+                        start_at: {
+                            $ref: string;
+                        };
+                        end_at: {
+                            $ref: string;
+                        };
+                        capture_bundle_id: {
+                            $ref: string;
+                        };
+                        capture_origin: {
+                            $ref: string;
+                        };
+                    };
+                };
+            };
+            precedence: {
+                type: string;
+                minItems: number;
+                maxItems: number;
+                uniqueItems: boolean;
+                items: {
+                    enum: string[];
+                };
+            };
+            bundles: {
+                type: string;
+                items: {
+                    type: string;
+                    additionalProperties: boolean;
+                    required: string[];
+                    properties: {
+                        capture_bundle_id: {
+                            $ref: string;
+                        };
+                        capture_origin: {
+                            $ref: string;
+                        };
+                        interval: {
+                            $ref: string;
+                        };
+                        qualification: {
+                            oneOf: ({
+                                type: string;
+                                additionalProperties?: undefined;
+                                required?: undefined;
+                                properties?: undefined;
+                            } | {
+                                type: string;
+                                additionalProperties: boolean;
+                                required: string[];
+                                properties: {
+                                    qualification_event_id: {
+                                        $ref: string;
+                                    };
+                                    state: {
+                                        const: string;
+                                    };
+                                    receipt_id: {
+                                        $ref: string;
+                                    };
+                                    promotion_identity_sha256: {
+                                        $ref: string;
+                                    };
+                                };
+                            })[];
+                        };
+                    };
+                };
+            };
+            support_anchors: {
+                type: string;
+                items: {
+                    type: string;
+                    additionalProperties: boolean;
+                    required: string[];
+                    properties: {
+                        capture_bundle_id: {
+                            $ref: string;
+                        };
+                        raw_capture_id: {
+                            $ref: string;
+                        };
+                        snapshot_id: {
+                            $ref: string;
+                        };
+                        source_time: {
+                            $ref: string;
+                        };
+                        normalized_summary_checksum: {
+                            $ref: string;
+                        };
+                        metadata_ref: {
+                            type: string;
+                            additionalProperties: boolean;
+                            required: string[];
+                            properties: {
+                                capture_origin: {
+                                    $ref: string;
+                                };
+                                qualification_event_id: {
+                                    oneOf: ({
+                                        type: string;
+                                        $ref?: undefined;
+                                    } | {
+                                        $ref: string;
+                                        type?: undefined;
+                                    })[];
+                                };
+                                receipt_id: {
+                                    oneOf: ({
+                                        type: string;
+                                        $ref?: undefined;
+                                    } | {
+                                        $ref: string;
+                                        type?: undefined;
+                                    })[];
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+            receipt_ids: {
+                type: string;
+                uniqueItems: boolean;
+                items: {
+                    $ref: string;
+                };
+            };
+            qualification_event_ids: {
+                type: string;
+                uniqueItems: boolean;
+                items: {
+                    $ref: string;
+                };
+            };
+            resolved_at: {
+                $ref: string;
+            };
+        };
+        $defs: {
+            uuid: {
+                type: string;
+                pattern: string;
+            };
+            sha256: {
+                type: string;
+                pattern: string;
+            };
+            timestamp: {
+                type: string;
+                pattern: string;
+            };
+            safeInteger: {
+                type: string;
+                minimum: number;
+                maximum: number;
+            };
+            captureOrigin: {
+                enum: string[];
+            };
+            scope: {
+                type: string;
+                additionalProperties: boolean;
+                required: string[];
+                properties: {
+                    exchange: {
+                        type: string;
+                        pattern: string;
+                    };
+                    trading_pair: {
+                        type: string;
+                        minLength: number;
+                        maxLength: number;
+                    };
+                    market_type: {
+                        enum: string[];
+                    };
+                    feed: {
+                        const: string;
+                    };
+                };
+            };
+            clockReference: {
+                type: string;
+                additionalProperties: boolean;
+                required: string[];
+                properties: {
+                    clock_id: {
+                        $ref: string;
+                    };
+                    clock_sha256: {
+                        $ref: string;
+                    };
+                    event_count: {
+                        $ref: string;
+                    };
+                };
+            };
+            coveragePolicy: {
+                type: string;
+                additionalProperties: boolean;
+                required: string[];
+                properties: {
+                    policy_id: {
+                        const: string;
+                    };
+                    max_asof_lag_ms: {
+                        $ref: string;
+                    };
+                    future_rows: {
+                        const: string;
+                    };
+                    missing_required_event: {
+                        const: string;
+                    };
+                };
+            };
+            interval: {
+                type: string;
+                additionalProperties: boolean;
+                required: string[];
+                properties: {
+                    start_at: {
+                        $ref: string;
+                    };
+                    end_at: {
+                        $ref: string;
+                    };
+                };
+            };
+        };
+    } | {
+        $schema: string;
+        $id: string;
+        title: string;
+        type: string;
+        additionalProperties: boolean;
+        required: string[];
+        properties: {
+            schema_id: {
+                const: string;
+            };
+            receipt_id: {
+                $ref: string;
+            };
+            promotion_identity_sha256: {
+                $ref: string;
+            };
+            verified_at: {
+                $ref: string;
+            };
+            request_id: {
+                $ref: string;
+            };
+            idempotency_key: {
+                $ref: string;
+            };
+            source: {
+                const: string;
+            };
+            capture_origin: {
+                const: string;
+            };
+            source_mode: {
+                const: string;
+            };
+            provider: {
+                type: string;
+                minLength: number;
+                maxLength: number;
+            };
+            adapter_version: {
+                type: string;
+                minLength: number;
+                maxLength: number;
+            };
+            effective_policies: {
+                type: string;
+                additionalProperties: boolean;
+                required: string[];
+                properties: {
+                    capability_policy: {
+                        $ref: string;
+                    };
+                    resource_policy: {
+                        $ref: string;
+                    };
+                    adapter_policy: {
+                        $ref: string;
+                    };
+                    acquisition_policy: {
+                        $ref: string;
+                    };
+                };
+            };
+            capture_bundle_id: {
+                $ref: string;
+            };
+            scope: {
+                $ref: string;
+            };
+            window: {
+                $ref: string;
+            };
+            depth: {
+                type: string;
+                minimum: number;
+                maximum: number;
+            };
+            construction_mode: {
+                enum: string[];
+            };
+            canonical_schema: {
+                type: string;
+                additionalProperties: boolean;
+                required: string[];
+                properties: {
+                    schema_id: {
+                        type: string;
+                        minLength: number;
+                        maxLength: number;
+                    };
+                    schema_sha256: {
+                        $ref: string;
+                    };
+                };
+            };
+            coverage_policy: {
+                $ref: string;
+            };
+            selection_sha256: {
+                $ref: string;
+            };
+            vendor_semantic_digest: {
+                $ref: string;
+            };
+            canonical_semantic_digest: {
+                $ref: string;
+            };
+            prefix_digest: {
+                $ref: string;
+            };
+            suffix_digest: {
+                $ref: string;
+            };
+            seam_verified: {
+                const: boolean;
+            };
+            coverage_verified: {
+                const: boolean;
+            };
+            dataset_objects: {
+                type: string;
+                minItems: number;
+                maxItems: number;
+                items: {
+                    type: string;
+                    additionalProperties: boolean;
+                    required: string[];
+                    properties: {
+                        identity: {
+                            type: string;
+                            minLength: number;
+                            maxLength: number;
+                        };
+                        checksum: {
+                            $ref: string;
+                        };
+                        bytes: {
+                            $ref: string;
+                        };
+                        rows: {
+                            $ref: string;
+                        };
+                    };
+                };
+            };
+        };
+        $defs: {
+            uuid: {
+                type: string;
+                pattern: string;
+            };
+            sha256: {
+                type: string;
+                pattern: string;
+            };
+            timestamp: {
+                type: string;
+                pattern: string;
+            };
+            safeInteger: {
+                type: string;
+                minimum: number;
+                maximum: number;
+            };
+            scope: {
+                type: string;
+                additionalProperties: boolean;
+                required: string[];
+                properties: {
+                    exchange: {
+                        type: string;
+                        pattern: string;
+                    };
+                    trading_pair: {
+                        type: string;
+                        minLength: number;
+                        maxLength: number;
+                    };
+                    market_type: {
+                        enum: string[];
+                    };
+                    feed: {
+                        const: string;
+                    };
+                };
+            };
+            interval: {
+                type: string;
+                additionalProperties: boolean;
+                required: string[];
+                properties: {
+                    start_at: {
+                        $ref: string;
+                    };
+                    end_at: {
+                        $ref: string;
+                    };
+                };
+            };
+            coveragePolicy: {
+                type: string;
+                additionalProperties: boolean;
+                required: string[];
+                properties: {
+                    policy_id: {
+                        const: string;
+                    };
+                    max_asof_lag_ms: {
+                        $ref: string;
+                    };
+                    future_rows: {
+                        const: string;
+                    };
+                    missing_required_event: {
+                        const: string;
+                    };
+                };
+            };
+            policyPin: {
+                type: string;
+                additionalProperties: boolean;
+                required: string[];
+                properties: {
+                    policy_id: {
+                        type: string;
+                        minLength: number;
+                        maxLength: number;
+                    };
+                    policy_sha256: {
+                        $ref: string;
+                    };
+                };
+            };
+        };
+    } | {
+        $schema: string;
+        $id: string;
+        title: string;
+        type: string;
+        additionalProperties: boolean;
+        required: string[];
+        properties: {
+            schema_id: {
+                const: string;
+            };
+            request_id: {
+                $ref: string;
+            };
+            attempt_id: {
+                $ref: string;
+            };
+            idempotency_key: {
+                $ref: string;
+            };
+            scope: {
+                $ref: string;
+            };
+            window: {
+                $ref: string;
+            };
+            depth: {
+                type: string;
+                minimum: number;
+                maximum: number;
+            };
+            construction_mode: {
+                enum: string[];
+            };
+            source_policy: {
+                enum: string[];
+            };
+            target: {
+                type: string;
+                additionalProperties: boolean;
+                required: string[];
+                properties: {
+                    environment: {
+                        type: string;
+                        pattern: string;
+                    };
+                    cluster: {
+                        type: string;
+                        pattern: string;
+                    };
+                };
+            };
+            coverage_policy: {
+                $ref: string;
+            };
+            required_clock: {
+                type: string;
+                additionalProperties: boolean;
+                required: string[];
+                properties: {
+                    schema_id: {
+                        const: string;
+                    };
+                    clock_id: {
+                        $ref: string;
+                    };
+                    file_name: {
+                        type: string;
+                        pattern: string;
+                    };
+                    clock_sha256: {
+                        $ref: string;
+                    };
+                    event_count: {
+                        $ref: string;
+                    };
+                };
+            };
+            initial_selection: {
+                $ref: string;
+            };
+            expected_canonical_schema: {
+                $ref: string;
+            };
+            product_pins: {
+                type: string;
+                additionalProperties: boolean;
+                required: string[];
+                properties: {
+                    capability_policy: {
+                        $ref: string;
+                    };
+                    resource_policy: {
+                        $ref: string;
+                    };
+                };
+            };
+            production_authorization_id: {
+                $ref: string;
+            };
+        };
+        $defs: {
+            uuid: {
+                type: string;
+                pattern: string;
+            };
+            sha256: {
+                type: string;
+                pattern: string;
+            };
+            timestamp: {
+                type: string;
+                pattern: string;
+            };
+            safeInteger: {
+                type: string;
+                minimum: number;
+                maximum: number;
+            };
+            scope: {
+                type: string;
+                additionalProperties: boolean;
+                required: string[];
+                properties: {
+                    exchange: {
+                        type: string;
+                        pattern: string;
+                    };
+                    trading_pair: {
+                        type: string;
+                        minLength: number;
+                        maxLength: number;
+                    };
+                    market_type: {
+                        enum: string[];
+                    };
+                    feed: {
+                        const: string;
+                    };
+                };
+            };
+            interval: {
+                type: string;
+                additionalProperties: boolean;
+                required: string[];
+                properties: {
+                    start_at: {
+                        $ref: string;
+                    };
+                    end_at: {
+                        $ref: string;
+                    };
+                };
+            };
+            coveragePolicy: {
+                type: string;
+                additionalProperties: boolean;
+                required: string[];
+                properties: {
+                    policy_id: {
+                        const: string;
+                    };
+                    max_asof_lag_ms: {
+                        $ref: string;
+                    };
+                    future_rows: {
+                        const: string;
+                    };
+                    missing_required_event: {
+                        const: string;
+                    };
+                };
+            };
+            artifactPin: {
+                type: string;
+                additionalProperties: boolean;
+                required: string[];
+                properties: {
+                    schema_id: {
+                        type: string;
+                        minLength: number;
+                        maxLength: number;
+                    };
+                    schema_sha256: {
+                        $ref: string;
+                    };
+                };
+            };
+            policyPin: {
+                type: string;
+                additionalProperties: boolean;
+                required: string[];
+                properties: {
+                    policy_id: {
+                        type: string;
+                        minLength: number;
+                        maxLength: number;
+                    };
+                    policy_sha256: {
+                        $ref: string;
+                    };
+                };
+            };
+        };
+    } | {
+        $schema: string;
+        $id: string;
+        title: string;
+        type: string;
+        additionalProperties: boolean;
+        required: string[];
+        properties: {
+            schema_id: {
+                const: string;
+            };
+            clock_id: {
+                $ref: string;
+            };
+            clock_sha256: {
+                $ref: string;
+            };
+            created_at: {
+                $ref: string;
+            };
+            targets: {
+                type: string;
+                minItems: number;
+                maxItems: number;
+                items: {
+                    type: string;
+                    additionalProperties: boolean;
+                    required: string[];
+                    properties: {
+                        target_id: {
+                            $ref: string;
+                        };
+                        target_at: {
+                            $ref: string;
+                        };
+                    };
+                };
+            };
+        };
+        $defs: {
+            uuid: {
+                type: string;
+                pattern: string;
+            };
+            sha256: {
+                type: string;
+                pattern: string;
+            };
+            timestamp: {
+                type: string;
+                pattern: string;
+            };
+        };
+    } | {
+        $schema: string;
+        $id: string;
+        title: string;
+        type: string;
+        additionalProperties: boolean;
+        required: string[];
+        properties: {
+            schema_id: {
+                const: string;
+            };
+            result_sha256: {
+                $ref: string;
+            };
+            job_id: {
+                $ref: string;
+            };
+            request_file_sha256: {
+                oneOf: ({
+                    type: string;
+                    $ref?: undefined;
+                } | {
+                    $ref: string;
+                    type?: undefined;
+                })[];
+            };
+            executable_sha256: {
+                $ref: string;
+            };
+            schema_manifest_sha256: {
+                $ref: string;
+            };
+            cex_package: {
+                type: string;
+                additionalProperties: boolean;
+                required: string[];
+                properties: {
+                    name: {
+                        const: string;
+                    };
+                    version: {
+                        type: string;
+                        pattern: string;
+                    };
+                    package_sha256: {
+                        $ref: string;
+                    };
+                };
+            };
+            capability_policy: {
+                $ref: string;
+            };
+            resource_policy: {
+                $ref: string;
+            };
+            build: {
+                type: string;
+                additionalProperties: boolean;
+                required: string[];
+                properties: {
+                    fiet_tee_commit: {
+                        type: string;
+                        pattern: string;
+                    };
+                    created_at: {
+                        $ref: string;
+                    };
+                };
+            };
+            started_at: {
+                $ref: string;
+            };
+            completed_at: {
+                $ref: string;
+            };
+            outcome: {
+                type: string;
+                additionalProperties: boolean;
+                required: string[];
+                properties: {
+                    status: {
+                        enum: string[];
+                    };
+                    reason_code: {
+                        type: string;
+                        pattern: string;
+                    };
+                    reason_subcode: {
+                        oneOf: ({
+                            type: string;
+                            pattern?: undefined;
+                        } | {
+                            type: string;
+                            pattern: string;
+                        })[];
+                    };
+                    request_id: {
+                        oneOf: ({
+                            type: string;
+                            $ref?: undefined;
+                        } | {
+                            $ref: string;
+                            type?: undefined;
+                        })[];
+                    };
+                    idempotency_key: {
+                        oneOf: ({
+                            type: string;
+                            $ref?: undefined;
+                        } | {
+                            $ref: string;
+                            type?: undefined;
+                        })[];
+                    };
+                    target: {
+                        oneOf: ({
+                            type: string;
+                            additionalProperties?: undefined;
+                            required?: undefined;
+                            properties?: undefined;
+                        } | {
+                            type: string;
+                            additionalProperties: boolean;
+                            required: string[];
+                            properties: {
+                                environment: {
+                                    type: string;
+                                    pattern: string;
+                                };
+                                cluster: {
+                                    type: string;
+                                    pattern: string;
+                                };
+                            };
+                        })[];
+                    };
+                    selection: {
+                        oneOf: ({
+                            type: string;
+                            $ref?: undefined;
+                        } | {
+                            $ref: string;
+                            type?: undefined;
+                        })[];
+                    };
+                    receipt: {
+                        oneOf: ({
+                            type: string;
+                            $ref?: undefined;
+                        } | {
+                            $ref: string;
+                            type?: undefined;
+                        })[];
+                    };
+                    diagnostics: {
+                        type: string;
+                        maxProperties: number;
+                        additionalProperties: {
+                            oneOf: ({
+                                type: string;
+                                maxLength: number;
+                                minimum?: undefined;
+                                maximum?: undefined;
+                            } | {
+                                type: string;
+                                minimum: number;
+                                maximum: number;
+                                maxLength?: undefined;
+                            } | {
+                                type: string;
+                                maxLength?: undefined;
+                                minimum?: undefined;
+                                maximum?: undefined;
+                            })[];
+                        };
+                    };
+                };
+            };
+        };
+        allOf: {
+            if: {
+                properties: {
+                    outcome: {
+                        type: string;
+                        properties: {
+                            status: {
+                                const: string;
+                            };
+                            reason_subcode: {
+                                const: string;
+                            };
+                        };
+                        required: string[];
+                    };
+                };
+                required: string[];
+            };
+            then: {
+                type: string;
+                properties: {
+                    request_file_sha256: {
+                        type: string;
+                    };
+                };
+            };
+            else: {
+                type: string;
+                properties: {
+                    request_file_sha256: {
+                        $ref: string;
+                    };
+                };
+            };
+        }[];
+        $defs: {
+            uuid: {
+                type: string;
+                pattern: string;
+            };
+            sha256: {
+                type: string;
+                pattern: string;
+            };
+            timestamp: {
+                type: string;
+                pattern: string;
+            };
+            policyPin: {
+                type: string;
+                additionalProperties: boolean;
+                required: string[];
+                properties: {
+                    policy_id: {
+                        type: string;
+                        minLength: number;
+                        maxLength: number;
+                    };
+                    policy_sha256: {
+                        $ref: string;
+                    };
+                };
+            };
+        };
+    };
+}>[];
+export declare const SCHEMA_MANIFEST: Readonly<{
+    manifest_sha256: string;
+    schema_id: string;
+    artifacts: {
+        schema_id: string;
+        path: "schemas/request.schema.json" | "schemas/result.schema.json" | "schemas/required-clock.schema.json" | "schemas/archive-selection.schema.json" | "schemas/promotion-receipt.schema.json";
+        schema_sha256: string;
+    }[];
+}>;
+export type PolicyPin = {
+    policy_id: string;
+    policy_sha256: string;
+};
+export declare function assertPolicyDocumentIdentity(policy: Record<string, unknown> & {
+    policy_sha256: string;
+}): void;