@xyo-network/xl1-protocol-sdk 4.0.4 → 4.0.5

package/dist/node/config/Actor.d.ts

@@ -0,0 +1,590 @@
+import { z } from 'zod/mini';
+/**
+ * BIP-32 derivation path for an actor wallet.
+ *
+ * - Absolute form: starts with `m/` (e.g. `m/44'/60'/0'/0/0`). The full path is used as-is,
+ *   giving the caller complete control over coin type, account, and hardening.
+ * - Relative form: a segment list without the `m/` prefix (e.g. `0`, `0/1`, `44'/60'/0'/0/0`).
+ *   The consumer appends this to its configured root base path.
+ *
+ * Each segment is a non-negative integer, optionally suffixed with `'` to mark it as hardened.
+ */
+export declare const AccountPathZod: z.ZodMiniString<string>;
+/** ActorConfigZod constant. */
+export declare const ActorConfigZod: z.ZodMiniObject<{
+    chain: z.ZodMiniDefault<z.ZodMiniObject<{
+        id: z.ZodMiniOptional<z.ZodMiniPipe<z.ZodMiniString<string>, z.ZodMiniTransform<import("@xylabs/sdk").BrandedHex, string>>>;
+        genesisRewardAddress: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniPipe<z.ZodMiniString<string>, z.ZodMiniTransform<Lowercase<string> & {
+            readonly __hex: true;
+        } & {
+            readonly __address: true;
+        }, string>>, z.ZodMiniPipe<z.ZodMiniString<string>, z.ZodMiniTransform<import("@xyo-network/sdk-protocol").XyoQuantAddress, string>>]>>;
+    }, z.core.$strip>>;
+    log: z.ZodMiniDefault<import("zod").ZodObject<{
+        logLevel: import("zod").ZodDefault<import("zod").ZodEnum<{
+            error: "error";
+            warn: "warn";
+            info: "info";
+            log: "log";
+            debug: "debug";
+            trace: "trace";
+        }>>;
+        silent: import("zod").ZodDefault<import("zod").ZodBoolean>;
+    }, z.core.$strip>>;
+    connections: z.ZodMiniDefault<import("zod").ZodDefault<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
+        access: import("zod").ZodOptional<import("zod").ZodEnum<{
+            read: "read";
+            write: "write";
+        }>>;
+        root: import("zod").ZodString;
+        store: import("zod").ZodOptional<import("zod").ZodString>;
+        type: import("zod").ZodLiteral<"lmdb">;
+    }, z.core.$strip>, import("zod").ZodObject<{
+        type: import("zod").ZodLiteral<"mongo">;
+        connectionString: import("zod").ZodOptional<import("zod").ZodString>;
+        database: import("zod").ZodOptional<import("zod").ZodString>;
+        domain: import("zod").ZodOptional<import("zod").ZodString>;
+        password: import("zod").ZodOptional<import("zod").ZodString>;
+        username: import("zod").ZodOptional<import("zod").ZodString>;
+    }, z.core.$strip>, import("zod").ZodObject<{
+        type: import("zod").ZodLiteral<"rpc">;
+        protocol: import("zod").ZodDefault<import("zod").ZodString>;
+        url: import("zod").ZodOptional<import("zod").ZodString>;
+        networkId: import("zod").ZodOptional<import("zod").ZodString>;
+        sessionId: import("zod").ZodOptional<import("zod").ZodString>;
+    }, z.core.$strip>, import("zod").ZodObject<{
+        type: import("zod").ZodLiteral<"rest">;
+        baseUrl: import("zod").ZodString;
+    }, z.core.$strip>, import("zod").ZodObject<{
+        bucket: import("zod").ZodOptional<import("zod").ZodString>;
+        endpoint: import("zod").ZodOptional<import("zod").ZodString>;
+        prefix: import("zod").ZodOptional<import("zod").ZodString>;
+        readUrl: import("zod").ZodOptional<import("zod").ZodString>;
+        type: import("zod").ZodLiteral<"s3">;
+        accessKeyId: import("zod").ZodOptional<import("zod").ZodString>;
+        accountId: import("zod").ZodOptional<import("zod").ZodString>;
+        secretAccessKey: import("zod").ZodOptional<import("zod").ZodString>;
+    }, z.core.$strip>, import("zod").ZodObject<{
+        type: import("zod").ZodLiteral<"evm-rpc">;
+        url: import("zod").ZodString;
+        chainId: import("zod").ZodOptional<import("zod").ZodString>;
+    }, z.core.$strip>, import("zod").ZodObject<{
+        type: import("zod").ZodLiteral<"memory">;
+    }, z.core.$strip>], "type">>>>;
+    providerBindings: z.ZodMiniDefault<import("zod").ZodDefault<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodObject<{
+        connection: import("zod").ZodOptional<import("zod").ZodString>;
+        provider: import("zod").ZodOptional<import("zod").ZodString>;
+    }, z.core.$strip>>>>;
+    providers: z.ZodMiniDefault<import("zod").ZodDefault<import("zod").ZodArray<import("zod").ZodObject<{
+        moniker: import("zod").ZodString;
+        labels: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString>>;
+    }, z.core.$loose>>>>;
+    telemetry: z.ZodMiniDefault<import("zod").ZodObject<{
+        metrics: import("zod").ZodOptional<import("zod").ZodObject<{
+            scrape: import("zod").ZodObject<{
+                path: import("zod").ZodDefault<import("zod").ZodString>;
+                port: import("zod").ZodOptional<import("zod").ZodCoercedNumber<unknown>>;
+            }, z.core.$strip>;
+        }, z.core.$strip>>;
+        otel: import("zod").ZodOptional<import("zod").ZodObject<{
+            otlpEndpoint: import("zod").ZodOptional<import("zod").ZodURL>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    validation: z.ZodMiniDefault<import("zod").ZodObject<{
+        signerAuthorizations: import("zod").ZodDefault<import("zod").ZodArray<import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
+            type: import("zod").ZodLiteral<"completedStepReward">;
+            signers: import("zod").ZodArray<import("zod/mini").ZodMiniUnion<readonly [import("zod/mini").ZodMiniPipe<import("zod/mini").ZodMiniString<string>, import("zod/mini").ZodMiniTransform<Lowercase<string> & {
+                readonly __hex: true;
+            } & {
+                readonly __address: true;
+            }, string>>, import("zod/mini").ZodMiniPipe<import("zod/mini").ZodMiniString<string>, import("zod/mini").ZodMiniTransform<import("@xyo-network/sdk-protocol").XyoQuantAddress, string>>]>>;
+        }, z.core.$strip>, import("zod").ZodObject<{
+            type: import("zod").ZodLiteral<"derivedReceive">;
+            scope: import("zod").ZodString;
+            signers: import("zod").ZodArray<import("zod/mini").ZodMiniUnion<readonly [import("zod/mini").ZodMiniPipe<import("zod/mini").ZodMiniString<string>, import("zod/mini").ZodMiniTransform<Lowercase<string> & {
+                readonly __hex: true;
+            } & {
+                readonly __address: true;
+            }, string>>, import("zod/mini").ZodMiniPipe<import("zod/mini").ZodMiniString<string>, import("zod/mini").ZodMiniTransform<import("@xyo-network/sdk-protocol").XyoQuantAddress, string>>]>>;
+        }, z.core.$strip>], "type">>>;
+        minCandidates: import("zod").ZodDefault<import("zod").ZodCoercedNumber<unknown>>;
+        backoffMs: import("zod").ZodDefault<import("zod").ZodCoercedNumber<unknown>>;
+    }, z.core.$strip>>;
+    name: z.ZodMiniString<string>;
+    accountPath: z.ZodMiniOptional<z.ZodMiniString<string>>;
+}, z.core.$strict>;
+/** ActorConfig type. */
+export type ActorConfig = z.infer<typeof ActorConfigZod>;
+/** Type guard that checks if a value is a valid ActorConfig. */
+export declare const isActorConfig: <T>(value: T) => value is T & {
+    chain: {
+        id?: import("@xylabs/sdk").BrandedHex | undefined;
+        genesisRewardAddress?: (Lowercase<string> & {
+            readonly __hex: true;
+        } & {
+            readonly __address: true;
+        }) | import("@xyo-network/sdk-protocol").XyoQuantAddress | undefined;
+    };
+    log: {
+        logLevel: "error" | "warn" | "info" | "log" | "debug" | "trace";
+        silent: boolean;
+    };
+    connections: Record<string, {
+        root: string;
+        type: "lmdb";
+        access?: "read" | "write" | undefined;
+        store?: string | undefined;
+    } | {
+        type: "mongo";
+        connectionString?: string | undefined;
+        database?: string | undefined;
+        domain?: string | undefined;
+        password?: string | undefined;
+        username?: string | undefined;
+    } | {
+        type: "rpc";
+        protocol: string;
+        url?: string | undefined;
+        networkId?: string | undefined;
+        sessionId?: string | undefined;
+    } | {
+        type: "rest";
+        baseUrl: string;
+    } | {
+        type: "s3";
+        bucket?: string | undefined;
+        endpoint?: string | undefined;
+        prefix?: string | undefined;
+        readUrl?: string | undefined;
+        accessKeyId?: string | undefined;
+        accountId?: string | undefined;
+        secretAccessKey?: string | undefined;
+    } | {
+        type: "evm-rpc";
+        url: string;
+        chainId?: string | undefined;
+    } | {
+        type: "memory";
+    }>;
+    providerBindings: Record<string, {
+        connection?: string | undefined;
+        provider?: string | undefined;
+    }>;
+    providers: {
+        [x: string]: unknown;
+        moniker: string;
+        labels?: string[] | undefined;
+    }[];
+    telemetry: {
+        metrics?: {
+            scrape: {
+                path: string;
+                port?: number | undefined;
+            };
+        } | undefined;
+        otel?: {
+            otlpEndpoint?: string | undefined;
+        } | undefined;
+    };
+    validation: {
+        signerAuthorizations: ({
+            type: "completedStepReward";
+            signers: (import("@xyo-network/sdk-protocol").XyoQuantAddress | (Lowercase<string> & {
+                readonly __hex: true;
+            } & {
+                readonly __address: true;
+            }))[];
+        } | {
+            type: "derivedReceive";
+            scope: string;
+            signers: (import("@xyo-network/sdk-protocol").XyoQuantAddress | (Lowercase<string> & {
+                readonly __hex: true;
+            } & {
+                readonly __address: true;
+            }))[];
+        })[];
+        minCandidates: number;
+        backoffMs: number;
+    };
+    name: string;
+    accountPath?: string | undefined;
+};
+/** Converts a value to ActorConfig, throwing if invalid. */
+export declare const asActorConfig: {
+    <T>(value: T): (T & {
+        chain: {
+            id?: import("@xylabs/sdk").BrandedHex | undefined;
+            genesisRewardAddress?: (Lowercase<string> & {
+                readonly __hex: true;
+            } & {
+                readonly __address: true;
+            }) | import("@xyo-network/sdk-protocol").XyoQuantAddress | undefined;
+        };
+        log: {
+            logLevel: "error" | "warn" | "info" | "log" | "debug" | "trace";
+            silent: boolean;
+        };
+        connections: Record<string, {
+            root: string;
+            type: "lmdb";
+            access?: "read" | "write" | undefined;
+            store?: string | undefined;
+        } | {
+            type: "mongo";
+            connectionString?: string | undefined;
+            database?: string | undefined;
+            domain?: string | undefined;
+            password?: string | undefined;
+            username?: string | undefined;
+        } | {
+            type: "rpc";
+            protocol: string;
+            url?: string | undefined;
+            networkId?: string | undefined;
+            sessionId?: string | undefined;
+        } | {
+            type: "rest";
+            baseUrl: string;
+        } | {
+            type: "s3";
+            bucket?: string | undefined;
+            endpoint?: string | undefined;
+            prefix?: string | undefined;
+            readUrl?: string | undefined;
+            accessKeyId?: string | undefined;
+            accountId?: string | undefined;
+            secretAccessKey?: string | undefined;
+        } | {
+            type: "evm-rpc";
+            url: string;
+            chainId?: string | undefined;
+        } | {
+            type: "memory";
+        }>;
+        providerBindings: Record<string, {
+            connection?: string | undefined;
+            provider?: string | undefined;
+        }>;
+        providers: {
+            [x: string]: unknown;
+            moniker: string;
+            labels?: string[] | undefined;
+        }[];
+        telemetry: {
+            metrics?: {
+                scrape: {
+                    path: string;
+                    port?: number | undefined;
+                };
+            } | undefined;
+            otel?: {
+                otlpEndpoint?: string | undefined;
+            } | undefined;
+        };
+        validation: {
+            signerAuthorizations: ({
+                type: "completedStepReward";
+                signers: (import("@xyo-network/sdk-protocol").XyoQuantAddress | (Lowercase<string> & {
+                    readonly __hex: true;
+                } & {
+                    readonly __address: true;
+                }))[];
+            } | {
+                type: "derivedReceive";
+                scope: string;
+                signers: (import("@xyo-network/sdk-protocol").XyoQuantAddress | (Lowercase<string> & {
+                    readonly __hex: true;
+                } & {
+                    readonly __address: true;
+                }))[];
+            })[];
+            minCandidates: number;
+            backoffMs: number;
+        };
+        name: string;
+        accountPath?: string | undefined;
+    }) | undefined;
+    <T>(value: T, assert: import("@xylabs/sdk").ZodFactoryConfig): T & {
+        chain: {
+            id?: import("@xylabs/sdk").BrandedHex | undefined;
+            genesisRewardAddress?: (Lowercase<string> & {
+                readonly __hex: true;
+            } & {
+                readonly __address: true;
+            }) | import("@xyo-network/sdk-protocol").XyoQuantAddress | undefined;
+        };
+        log: {
+            logLevel: "error" | "warn" | "info" | "log" | "debug" | "trace";
+            silent: boolean;
+        };
+        connections: Record<string, {
+            root: string;
+            type: "lmdb";
+            access?: "read" | "write" | undefined;
+            store?: string | undefined;
+        } | {
+            type: "mongo";
+            connectionString?: string | undefined;
+            database?: string | undefined;
+            domain?: string | undefined;
+            password?: string | undefined;
+            username?: string | undefined;
+        } | {
+            type: "rpc";
+            protocol: string;
+            url?: string | undefined;
+            networkId?: string | undefined;
+            sessionId?: string | undefined;
+        } | {
+            type: "rest";
+            baseUrl: string;
+        } | {
+            type: "s3";
+            bucket?: string | undefined;
+            endpoint?: string | undefined;
+            prefix?: string | undefined;
+            readUrl?: string | undefined;
+            accessKeyId?: string | undefined;
+            accountId?: string | undefined;
+            secretAccessKey?: string | undefined;
+        } | {
+            type: "evm-rpc";
+            url: string;
+            chainId?: string | undefined;
+        } | {
+            type: "memory";
+        }>;
+        providerBindings: Record<string, {
+            connection?: string | undefined;
+            provider?: string | undefined;
+        }>;
+        providers: {
+            [x: string]: unknown;
+            moniker: string;
+            labels?: string[] | undefined;
+        }[];
+        telemetry: {
+            metrics?: {
+                scrape: {
+                    path: string;
+                    port?: number | undefined;
+                };
+            } | undefined;
+            otel?: {
+                otlpEndpoint?: string | undefined;
+            } | undefined;
+        };
+        validation: {
+            signerAuthorizations: ({
+                type: "completedStepReward";
+                signers: (import("@xyo-network/sdk-protocol").XyoQuantAddress | (Lowercase<string> & {
+                    readonly __hex: true;
+                } & {
+                    readonly __address: true;
+                }))[];
+            } | {
+                type: "derivedReceive";
+                scope: string;
+                signers: (import("@xyo-network/sdk-protocol").XyoQuantAddress | (Lowercase<string> & {
+                    readonly __hex: true;
+                } & {
+                    readonly __address: true;
+                }))[];
+            })[];
+            minCandidates: number;
+            backoffMs: number;
+        };
+        name: string;
+        accountPath?: string | undefined;
+    };
+};
+/** toActorConfig constant. */
+export declare const toActorConfig: {
+    <T>(value: T): (T & {
+        chain: {
+            id?: import("@xylabs/sdk").BrandedHex | undefined;
+            genesisRewardAddress?: (Lowercase<string> & {
+                readonly __hex: true;
+            } & {
+                readonly __address: true;
+            }) | import("@xyo-network/sdk-protocol").XyoQuantAddress | undefined;
+        };
+        log: {
+            logLevel: "error" | "warn" | "info" | "log" | "debug" | "trace";
+            silent: boolean;
+        };
+        connections: Record<string, {
+            root: string;
+            type: "lmdb";
+            access?: "read" | "write" | undefined;
+            store?: string | undefined;
+        } | {
+            type: "mongo";
+            connectionString?: string | undefined;
+            database?: string | undefined;
+            domain?: string | undefined;
+            password?: string | undefined;
+            username?: string | undefined;
+        } | {
+            type: "rpc";
+            protocol: string;
+            url?: string | undefined;
+            networkId?: string | undefined;
+            sessionId?: string | undefined;
+        } | {
+            type: "rest";
+            baseUrl: string;
+        } | {
+            type: "s3";
+            bucket?: string | undefined;
+            endpoint?: string | undefined;
+            prefix?: string | undefined;
+            readUrl?: string | undefined;
+            accessKeyId?: string | undefined;
+            accountId?: string | undefined;
+            secretAccessKey?: string | undefined;
+        } | {
+            type: "evm-rpc";
+            url: string;
+            chainId?: string | undefined;
+        } | {
+            type: "memory";
+        }>;
+        providerBindings: Record<string, {
+            connection?: string | undefined;
+            provider?: string | undefined;
+        }>;
+        providers: {
+            [x: string]: unknown;
+            moniker: string;
+            labels?: string[] | undefined;
+        }[];
+        telemetry: {
+            metrics?: {
+                scrape: {
+                    path: string;
+                    port?: number | undefined;
+                };
+            } | undefined;
+            otel?: {
+                otlpEndpoint?: string | undefined;
+            } | undefined;
+        };
+        validation: {
+            signerAuthorizations: ({
+                type: "completedStepReward";
+                signers: (import("@xyo-network/sdk-protocol").XyoQuantAddress | (Lowercase<string> & {
+                    readonly __hex: true;
+                } & {
+                    readonly __address: true;
+                }))[];
+            } | {
+                type: "derivedReceive";
+                scope: string;
+                signers: (import("@xyo-network/sdk-protocol").XyoQuantAddress | (Lowercase<string> & {
+                    readonly __hex: true;
+                } & {
+                    readonly __address: true;
+                }))[];
+            })[];
+            minCandidates: number;
+            backoffMs: number;
+        };
+        name: string;
+        accountPath?: string | undefined;
+    }) | undefined;
+    <T>(value: T, assert: import("@xylabs/sdk").ZodFactoryConfig): T & {
+        chain: {
+            id?: import("@xylabs/sdk").BrandedHex | undefined;
+            genesisRewardAddress?: (Lowercase<string> & {
+                readonly __hex: true;
+            } & {
+                readonly __address: true;
+            }) | import("@xyo-network/sdk-protocol").XyoQuantAddress | undefined;
+        };
+        log: {
+            logLevel: "error" | "warn" | "info" | "log" | "debug" | "trace";
+            silent: boolean;
+        };
+        connections: Record<string, {
+            root: string;
+            type: "lmdb";
+            access?: "read" | "write" | undefined;
+            store?: string | undefined;
+        } | {
+            type: "mongo";
+            connectionString?: string | undefined;
+            database?: string | undefined;
+            domain?: string | undefined;
+            password?: string | undefined;
+            username?: string | undefined;
+        } | {
+            type: "rpc";
+            protocol: string;
+            url?: string | undefined;
+            networkId?: string | undefined;
+            sessionId?: string | undefined;
+        } | {
+            type: "rest";
+            baseUrl: string;
+        } | {
+            type: "s3";
+            bucket?: string | undefined;
+            endpoint?: string | undefined;
+            prefix?: string | undefined;
+            readUrl?: string | undefined;
+            accessKeyId?: string | undefined;
+            accountId?: string | undefined;
+            secretAccessKey?: string | undefined;
+        } | {
+            type: "evm-rpc";
+            url: string;
+            chainId?: string | undefined;
+        } | {
+            type: "memory";
+        }>;
+        providerBindings: Record<string, {
+            connection?: string | undefined;
+            provider?: string | undefined;
+        }>;
+        providers: {
+            [x: string]: unknown;
+            moniker: string;
+            labels?: string[] | undefined;
+        }[];
+        telemetry: {
+            metrics?: {
+                scrape: {
+                    path: string;
+                    port?: number | undefined;
+                };
+            } | undefined;
+            otel?: {
+                otlpEndpoint?: string | undefined;
+            } | undefined;
+        };
+        validation: {
+            signerAuthorizations: ({
+                type: "completedStepReward";
+                signers: (import("@xyo-network/sdk-protocol").XyoQuantAddress | (Lowercase<string> & {
+                    readonly __hex: true;
+                } & {
+                    readonly __address: true;
+                }))[];
+            } | {
+                type: "derivedReceive";
+                scope: string;
+                signers: (import("@xyo-network/sdk-protocol").XyoQuantAddress | (Lowercase<string> & {
+                    readonly __hex: true;
+                } & {
+                    readonly __address: true;
+                }))[];
+            })[];
+            minCandidates: number;
+            backoffMs: number;
+        };
+        name: string;
+        accountPath?: string | undefined;
+    };
+};
+//# sourceMappingURL=Actor.d.ts.map

package/dist/node/config/Actor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Actor.d.ts","sourceRoot":"","sources":["../../../src/config/Actor.ts"],"names":[],"mappings":"AAGA,OAAO,EAAkB,CAAC,EAAE,MAAM,UAAU,CAAA;AAI5C;;;;;;;;;GASG;AACH,eAAO,MAAM,cAAc,yBAGzB,CAAA;AAEF,+BAA+B;AAC/B,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAOzB,CAAA;AAEF,wBAAwB;AACxB,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAA;AAExD,gEAAgE;AAChE,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAA+B,CAAA;AACzD,4DAA4D;AAC5D,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAAgD,CAAA;AAC1E,8BAA8B;AAC9B,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAAgD,CAAA"}