@hashgraphonline/standards-sdk 0.1.165 → 0.1.166

package/dist/browser/hcs-21/types.d.ts

@@ -0,0 +1,774 @@
+import { z } from 'zod';
+import { QuoteResult } from '../inscribe/types';
+export declare const HCS21_PROTOCOL = "hcs-21";
+export declare const HCS21_MAX_MESSAGE_BYTES = 1024;
+export declare const HCS21_SAFE_MESSAGE_BYTES = 1000;
+export declare const HCS21ManifestPointerPattern: RegExp;
+export declare const HCS21TopicIdPattern: RegExp;
+export declare const HCS21MetadataPointerPattern: RegExp;
+export type HCS21Operation = 'register' | 'update' | 'delete';
+export interface AdapterPackage {
+    registry: string;
+    name: string;
+    version: string;
+    integrity: string;
+}
+export interface AdapterConfigContext {
+    type: string;
+    account?: string;
+    threshold?: string;
+    ctopic?: string;
+    ttopic?: string;
+    stopic?: string;
+    [key: string]: unknown;
+}
+export interface AdapterDeclaration {
+    p: typeof HCS21_PROTOCOL;
+    op: HCS21Operation;
+    adapter_id: string;
+    entity: string;
+    package: AdapterPackage;
+    manifest: string;
+    manifest_sequence?: number;
+    config: AdapterConfigContext;
+    state_model?: string;
+    signature?: string;
+}
+export interface AdapterDeclarationEnvelope {
+    declaration: AdapterDeclaration;
+    consensusTimestamp?: string;
+    sequenceNumber: number;
+    payer?: string;
+}
+export declare enum HCS21TopicType {
+    ADAPTER_REGISTRY = 0,
+    REGISTRY_OF_REGISTRIES = 1,
+    ADAPTER_CATEGORY = 2
+}
+export interface AdapterCategoryEntry {
+    adapterId: string;
+    adapterTopicId: string;
+    metadata?: string;
+    memo?: string;
+    payer?: string;
+    sequenceNumber: number;
+    consensusTimestamp?: string;
+}
+export interface ManifestPointer {
+    pointer: string;
+    topicId: string;
+    sequenceNumber: number;
+    manifestSequence?: number;
+    jobId?: string;
+    transactionId?: string;
+    totalCostHbar?: string;
+    costBreakdown?: QuoteResult['breakdown'];
+}
+export declare const adapterPackageSchema: z.ZodObject<{
+    registry: z.ZodString;
+    name: z.ZodString;
+    version: z.ZodString;
+    integrity: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    name?: string;
+    version?: string;
+    registry?: string;
+    integrity?: string;
+}, {
+    name?: string;
+    version?: string;
+    registry?: string;
+    integrity?: string;
+}>;
+export declare const adapterConfigContextSchema: z.ZodObject<{
+    type: z.ZodString;
+    account: z.ZodOptional<z.ZodString>;
+    threshold: z.ZodOptional<z.ZodString>;
+    ctopic: z.ZodOptional<z.ZodString>;
+    ttopic: z.ZodOptional<z.ZodString>;
+    stopic: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodUnknown, z.objectOutputType<{
+    type: z.ZodString;
+    account: z.ZodOptional<z.ZodString>;
+    threshold: z.ZodOptional<z.ZodString>;
+    ctopic: z.ZodOptional<z.ZodString>;
+    ttopic: z.ZodOptional<z.ZodString>;
+    stopic: z.ZodOptional<z.ZodString>;
+}, z.ZodUnknown, "strip">, z.objectInputType<{
+    type: z.ZodString;
+    account: z.ZodOptional<z.ZodString>;
+    threshold: z.ZodOptional<z.ZodString>;
+    ctopic: z.ZodOptional<z.ZodString>;
+    ttopic: z.ZodOptional<z.ZodString>;
+    stopic: z.ZodOptional<z.ZodString>;
+}, z.ZodUnknown, "strip">>;
+export declare const adapterDeclarationSchema: z.ZodObject<{
+    p: z.ZodLiteral<"hcs-21">;
+    op: z.ZodEnum<["register", "update", "delete"]>;
+    adapter_id: z.ZodString;
+    entity: z.ZodString;
+    package: z.ZodObject<{
+        registry: z.ZodString;
+        name: z.ZodString;
+        version: z.ZodString;
+        integrity: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        name?: string;
+        version?: string;
+        registry?: string;
+        integrity?: string;
+    }, {
+        name?: string;
+        version?: string;
+        registry?: string;
+        integrity?: string;
+    }>;
+    manifest: z.ZodString;
+    manifest_sequence: z.ZodOptional<z.ZodNumber>;
+    config: z.ZodObject<{
+        type: z.ZodString;
+        account: z.ZodOptional<z.ZodString>;
+        threshold: z.ZodOptional<z.ZodString>;
+        ctopic: z.ZodOptional<z.ZodString>;
+        ttopic: z.ZodOptional<z.ZodString>;
+        stopic: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodUnknown, z.objectOutputType<{
+        type: z.ZodString;
+        account: z.ZodOptional<z.ZodString>;
+        threshold: z.ZodOptional<z.ZodString>;
+        ctopic: z.ZodOptional<z.ZodString>;
+        ttopic: z.ZodOptional<z.ZodString>;
+        stopic: z.ZodOptional<z.ZodString>;
+    }, z.ZodUnknown, "strip">, z.objectInputType<{
+        type: z.ZodString;
+        account: z.ZodOptional<z.ZodString>;
+        threshold: z.ZodOptional<z.ZodString>;
+        ctopic: z.ZodOptional<z.ZodString>;
+        ttopic: z.ZodOptional<z.ZodString>;
+        stopic: z.ZodOptional<z.ZodString>;
+    }, z.ZodUnknown, "strip">>;
+    state_model: z.ZodOptional<z.ZodString>;
+    signature: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    p?: "hcs-21";
+    op?: "delete" | "register" | "update";
+    signature?: string;
+    adapter_id?: string;
+    entity?: string;
+    package?: {
+        name?: string;
+        version?: string;
+        registry?: string;
+        integrity?: string;
+    };
+    manifest?: string;
+    manifest_sequence?: number;
+    config?: {
+        threshold?: string;
+        type?: string;
+        account?: string;
+        ctopic?: string;
+        ttopic?: string;
+        stopic?: string;
+    } & {
+        [k: string]: unknown;
+    };
+    state_model?: string;
+}, {
+    p?: "hcs-21";
+    op?: "delete" | "register" | "update";
+    signature?: string;
+    adapter_id?: string;
+    entity?: string;
+    package?: {
+        name?: string;
+        version?: string;
+        registry?: string;
+        integrity?: string;
+    };
+    manifest?: string;
+    manifest_sequence?: number;
+    config?: {
+        threshold?: string;
+        type?: string;
+        account?: string;
+        ctopic?: string;
+        ttopic?: string;
+        stopic?: string;
+    } & {
+        [k: string]: unknown;
+    };
+    state_model?: string;
+}>;
+export declare const adapterManifestSchema: z.ZodObject<{
+    meta: z.ZodObject<{
+        spec_version: z.ZodString;
+        adapter_version: z.ZodString;
+        minimum_version: z.ZodOptional<z.ZodString>;
+        generated: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        spec_version?: string;
+        adapter_version?: string;
+        minimum_version?: string;
+        generated?: string;
+    }, {
+        spec_version?: string;
+        adapter_version?: string;
+        minimum_version?: string;
+        generated?: string;
+    }>;
+    adapter: z.ZodObject<{
+        name: z.ZodString;
+        id: z.ZodString;
+        maintainers: z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            contact: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            name?: string;
+            contact?: string;
+        }, {
+            name?: string;
+            contact?: string;
+        }>, "many">;
+        license: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        name?: string;
+        id?: string;
+        maintainers?: {
+            name?: string;
+            contact?: string;
+        }[];
+        license?: string;
+    }, {
+        name?: string;
+        id?: string;
+        maintainers?: {
+            name?: string;
+            contact?: string;
+        }[];
+        license?: string;
+    }>;
+    package: z.ZodObject<{
+        registry: z.ZodString;
+        dist_tag: z.ZodOptional<z.ZodString>;
+        artifacts: z.ZodArray<z.ZodObject<{
+            url: z.ZodString;
+            digest: z.ZodString;
+            signature: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            signature?: string;
+            url?: string;
+            digest?: string;
+        }, {
+            signature?: string;
+            url?: string;
+            digest?: string;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        registry?: string;
+        dist_tag?: string;
+        artifacts?: {
+            signature?: string;
+            url?: string;
+            digest?: string;
+        }[];
+    }, {
+        registry?: string;
+        dist_tag?: string;
+        artifacts?: {
+            signature?: string;
+            url?: string;
+            digest?: string;
+        }[];
+    }>;
+    runtime: z.ZodObject<{
+        platforms: z.ZodArray<z.ZodString, "many">;
+        primary: z.ZodString;
+        entry: z.ZodString;
+        dependencies: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        env: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        platforms?: string[];
+        primary?: string;
+        entry?: string;
+        dependencies?: string[];
+        env?: string[];
+    }, {
+        platforms?: string[];
+        primary?: string;
+        entry?: string;
+        dependencies?: string[];
+        env?: string[];
+    }>;
+    capabilities: z.ZodObject<{
+        discovery: z.ZodBoolean;
+        communication: z.ZodBoolean;
+        protocols: z.ZodArray<z.ZodString, "many">;
+        discovery_tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        communication_channels: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        extras: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, "strip", z.ZodTypeAny, {
+        communication?: boolean;
+        discovery?: boolean;
+        protocols?: string[];
+        discovery_tags?: string[];
+        communication_channels?: string[];
+        extras?: Record<string, unknown>;
+    }, {
+        communication?: boolean;
+        discovery?: boolean;
+        protocols?: string[];
+        discovery_tags?: string[];
+        communication_channels?: string[];
+        extras?: Record<string, unknown>;
+    }>;
+    consensus: z.ZodObject<{
+        state_model: z.ZodOptional<z.ZodString>;
+        profile_uri: z.ZodOptional<z.ZodString>;
+        entity_schema: z.ZodOptional<z.ZodString>;
+        required_fields: z.ZodArray<z.ZodString, "many">;
+        hashing: z.ZodLiteral<"sha384">;
+    }, "strip", z.ZodTypeAny, {
+        state_model?: string;
+        profile_uri?: string;
+        entity_schema?: string;
+        required_fields?: string[];
+        hashing?: "sha384";
+    }, {
+        state_model?: string;
+        profile_uri?: string;
+        entity_schema?: string;
+        required_fields?: string[];
+        hashing?: "sha384";
+    }>;
+}, "strip", z.ZodTypeAny, {
+    capabilities?: {
+        communication?: boolean;
+        discovery?: boolean;
+        protocols?: string[];
+        discovery_tags?: string[];
+        communication_channels?: string[];
+        extras?: Record<string, unknown>;
+    };
+    package?: {
+        registry?: string;
+        dist_tag?: string;
+        artifacts?: {
+            signature?: string;
+            url?: string;
+            digest?: string;
+        }[];
+    };
+    meta?: {
+        spec_version?: string;
+        adapter_version?: string;
+        minimum_version?: string;
+        generated?: string;
+    };
+    adapter?: {
+        name?: string;
+        id?: string;
+        maintainers?: {
+            name?: string;
+            contact?: string;
+        }[];
+        license?: string;
+    };
+    runtime?: {
+        platforms?: string[];
+        primary?: string;
+        entry?: string;
+        dependencies?: string[];
+        env?: string[];
+    };
+    consensus?: {
+        state_model?: string;
+        profile_uri?: string;
+        entity_schema?: string;
+        required_fields?: string[];
+        hashing?: "sha384";
+    };
+}, {
+    capabilities?: {
+        communication?: boolean;
+        discovery?: boolean;
+        protocols?: string[];
+        discovery_tags?: string[];
+        communication_channels?: string[];
+        extras?: Record<string, unknown>;
+    };
+    package?: {
+        registry?: string;
+        dist_tag?: string;
+        artifacts?: {
+            signature?: string;
+            url?: string;
+            digest?: string;
+        }[];
+    };
+    meta?: {
+        spec_version?: string;
+        adapter_version?: string;
+        minimum_version?: string;
+        generated?: string;
+    };
+    adapter?: {
+        name?: string;
+        id?: string;
+        maintainers?: {
+            name?: string;
+            contact?: string;
+        }[];
+        license?: string;
+    };
+    runtime?: {
+        platforms?: string[];
+        primary?: string;
+        entry?: string;
+        dependencies?: string[];
+        env?: string[];
+    };
+    consensus?: {
+        state_model?: string;
+        profile_uri?: string;
+        entity_schema?: string;
+        required_fields?: string[];
+        hashing?: "sha384";
+    };
+}>;
+export declare const registryMetadataSchema: z.ZodObject<{
+    version: z.ZodString;
+    name: z.ZodString;
+    description: z.ZodString;
+    operator: z.ZodObject<{
+        account: z.ZodString;
+        name: z.ZodOptional<z.ZodString>;
+        contact: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        name?: string;
+        account?: string;
+        contact?: string;
+    }, {
+        name?: string;
+        account?: string;
+        contact?: string;
+    }>;
+    entityTypes: z.ZodArray<z.ZodString, "many">;
+    categories: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    links: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    name?: string;
+    version?: string;
+    description?: string;
+    tags?: string[];
+    operator?: {
+        name?: string;
+        account?: string;
+        contact?: string;
+    };
+    entityTypes?: string[];
+    categories?: string[];
+    links?: Record<string, string>;
+}, {
+    name?: string;
+    version?: string;
+    description?: string;
+    tags?: string[];
+    operator?: {
+        name?: string;
+        account?: string;
+        contact?: string;
+    };
+    entityTypes?: string[];
+    categories?: string[];
+    links?: Record<string, string>;
+}>;
+export declare const metadataDocumentSchema: z.ZodUnion<[z.ZodObject<{
+    meta: z.ZodObject<{
+        spec_version: z.ZodString;
+        adapter_version: z.ZodString;
+        minimum_version: z.ZodOptional<z.ZodString>;
+        generated: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        spec_version?: string;
+        adapter_version?: string;
+        minimum_version?: string;
+        generated?: string;
+    }, {
+        spec_version?: string;
+        adapter_version?: string;
+        minimum_version?: string;
+        generated?: string;
+    }>;
+    adapter: z.ZodObject<{
+        name: z.ZodString;
+        id: z.ZodString;
+        maintainers: z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            contact: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            name?: string;
+            contact?: string;
+        }, {
+            name?: string;
+            contact?: string;
+        }>, "many">;
+        license: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        name?: string;
+        id?: string;
+        maintainers?: {
+            name?: string;
+            contact?: string;
+        }[];
+        license?: string;
+    }, {
+        name?: string;
+        id?: string;
+        maintainers?: {
+            name?: string;
+            contact?: string;
+        }[];
+        license?: string;
+    }>;
+    package: z.ZodObject<{
+        registry: z.ZodString;
+        dist_tag: z.ZodOptional<z.ZodString>;
+        artifacts: z.ZodArray<z.ZodObject<{
+            url: z.ZodString;
+            digest: z.ZodString;
+            signature: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            signature?: string;
+            url?: string;
+            digest?: string;
+        }, {
+            signature?: string;
+            url?: string;
+            digest?: string;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        registry?: string;
+        dist_tag?: string;
+        artifacts?: {
+            signature?: string;
+            url?: string;
+            digest?: string;
+        }[];
+    }, {
+        registry?: string;
+        dist_tag?: string;
+        artifacts?: {
+            signature?: string;
+            url?: string;
+            digest?: string;
+        }[];
+    }>;
+    runtime: z.ZodObject<{
+        platforms: z.ZodArray<z.ZodString, "many">;
+        primary: z.ZodString;
+        entry: z.ZodString;
+        dependencies: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        env: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        platforms?: string[];
+        primary?: string;
+        entry?: string;
+        dependencies?: string[];
+        env?: string[];
+    }, {
+        platforms?: string[];
+        primary?: string;
+        entry?: string;
+        dependencies?: string[];
+        env?: string[];
+    }>;
+    capabilities: z.ZodObject<{
+        discovery: z.ZodBoolean;
+        communication: z.ZodBoolean;
+        protocols: z.ZodArray<z.ZodString, "many">;
+        discovery_tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        communication_channels: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        extras: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, "strip", z.ZodTypeAny, {
+        communication?: boolean;
+        discovery?: boolean;
+        protocols?: string[];
+        discovery_tags?: string[];
+        communication_channels?: string[];
+        extras?: Record<string, unknown>;
+    }, {
+        communication?: boolean;
+        discovery?: boolean;
+        protocols?: string[];
+        discovery_tags?: string[];
+        communication_channels?: string[];
+        extras?: Record<string, unknown>;
+    }>;
+    consensus: z.ZodObject<{
+        state_model: z.ZodOptional<z.ZodString>;
+        profile_uri: z.ZodOptional<z.ZodString>;
+        entity_schema: z.ZodOptional<z.ZodString>;
+        required_fields: z.ZodArray<z.ZodString, "many">;
+        hashing: z.ZodLiteral<"sha384">;
+    }, "strip", z.ZodTypeAny, {
+        state_model?: string;
+        profile_uri?: string;
+        entity_schema?: string;
+        required_fields?: string[];
+        hashing?: "sha384";
+    }, {
+        state_model?: string;
+        profile_uri?: string;
+        entity_schema?: string;
+        required_fields?: string[];
+        hashing?: "sha384";
+    }>;
+}, "strip", z.ZodTypeAny, {
+    capabilities?: {
+        communication?: boolean;
+        discovery?: boolean;
+        protocols?: string[];
+        discovery_tags?: string[];
+        communication_channels?: string[];
+        extras?: Record<string, unknown>;
+    };
+    package?: {
+        registry?: string;
+        dist_tag?: string;
+        artifacts?: {
+            signature?: string;
+            url?: string;
+            digest?: string;
+        }[];
+    };
+    meta?: {
+        spec_version?: string;
+        adapter_version?: string;
+        minimum_version?: string;
+        generated?: string;
+    };
+    adapter?: {
+        name?: string;
+        id?: string;
+        maintainers?: {
+            name?: string;
+            contact?: string;
+        }[];
+        license?: string;
+    };
+    runtime?: {
+        platforms?: string[];
+        primary?: string;
+        entry?: string;
+        dependencies?: string[];
+        env?: string[];
+    };
+    consensus?: {
+        state_model?: string;
+        profile_uri?: string;
+        entity_schema?: string;
+        required_fields?: string[];
+        hashing?: "sha384";
+    };
+}, {
+    capabilities?: {
+        communication?: boolean;
+        discovery?: boolean;
+        protocols?: string[];
+        discovery_tags?: string[];
+        communication_channels?: string[];
+        extras?: Record<string, unknown>;
+    };
+    package?: {
+        registry?: string;
+        dist_tag?: string;
+        artifacts?: {
+            signature?: string;
+            url?: string;
+            digest?: string;
+        }[];
+    };
+    meta?: {
+        spec_version?: string;
+        adapter_version?: string;
+        minimum_version?: string;
+        generated?: string;
+    };
+    adapter?: {
+        name?: string;
+        id?: string;
+        maintainers?: {
+            name?: string;
+            contact?: string;
+        }[];
+        license?: string;
+    };
+    runtime?: {
+        platforms?: string[];
+        primary?: string;
+        entry?: string;
+        dependencies?: string[];
+        env?: string[];
+    };
+    consensus?: {
+        state_model?: string;
+        profile_uri?: string;
+        entity_schema?: string;
+        required_fields?: string[];
+        hashing?: "sha384";
+    };
+}>, z.ZodObject<{
+    version: z.ZodString;
+    name: z.ZodString;
+    description: z.ZodString;
+    operator: z.ZodObject<{
+        account: z.ZodString;
+        name: z.ZodOptional<z.ZodString>;
+        contact: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        name?: string;
+        account?: string;
+        contact?: string;
+    }, {
+        name?: string;
+        account?: string;
+        contact?: string;
+    }>;
+    entityTypes: z.ZodArray<z.ZodString, "many">;
+    categories: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    links: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    name?: string;
+    version?: string;
+    description?: string;
+    tags?: string[];
+    operator?: {
+        name?: string;
+        account?: string;
+        contact?: string;
+    };
+    entityTypes?: string[];
+    categories?: string[];
+    links?: Record<string, string>;
+}, {
+    name?: string;
+    version?: string;
+    description?: string;
+    tags?: string[];
+    operator?: {
+        name?: string;
+        account?: string;
+        contact?: string;
+    };
+    entityTypes?: string[];
+    categories?: string[];
+    links?: Record<string, string>;
+}>]>;
+export type AdapterDeclarationValidation = z.infer<typeof adapterDeclarationSchema>;
+export type AdapterManifest = z.infer<typeof adapterManifestSchema>;
+export type RegistryMetadataRecord = z.infer<typeof registryMetadataSchema>;
+export type HCS21MetadataDocument = AdapterManifest | RegistryMetadataRecord;
+//# sourceMappingURL=types.d.ts.map