@paimaexample/wallets 0.3.117

package/esm/config/src/schema/sync-protocols/ntp/rpc.d.ts

@@ -0,0 +1,45 @@
+import type { Static } from "@sinclair/typebox";
+import { ConfigSyncProtocolType } from "../types.js";
+import { type MergeIntersects } from "../../../../../utils/src/mod.js";
+export declare const ConfigSyncProtocolSchemaNtpBase: import("../../utils.js").ConfigSchema<import("@sinclair/typebox").TObject<{
+    name: import("@sinclair/typebox").TString;
+} & {
+    pollingInterval: import("@sinclair/typebox").TUnsafe<import("../../../../../utils/src/mod.js").IntervalMs>;
+} & {
+    startBlockHeight: import("@sinclair/typebox").TUnsafe<import("../../../../../utils/src/mod.js").BlockNumber>;
+}>, import("@sinclair/typebox").TObject<{
+    stopBlockHeight: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TUnsafe<import("../../../../../utils/src/mod.js").BlockNumber>, import("@sinclair/typebox").TNull]>;
+} & {
+    stepSize: import("@sinclair/typebox").TNumber;
+}>>;
+export declare const CommonResponseNtpBase: {
+    readonly internal: {};
+    readonly payload: {
+        readonly ownChain: import("@sinclair/typebox").TObject<{
+            blockNumber: import("@sinclair/typebox").TUnsafe<import("../../../../../utils/src/mod.js").BlockNumber>;
+        }>;
+    };
+};
+export declare const ConfigSyncProtocolSchemaNtpMain: import("../../utils.js").ConfigSchema<import("@sinclair/typebox").TObject<{
+    name: import("@sinclair/typebox").TString;
+} & {
+    pollingInterval: import("@sinclair/typebox").TUnsafe<import("../../../../../utils/src/mod.js").IntervalMs>;
+} & {
+    startBlockHeight: import("@sinclair/typebox").TUnsafe<import("../../../../../utils/src/mod.js").BlockNumber>;
+} & {
+    type: import("@sinclair/typebox").TLiteral<ConfigSyncProtocolType.NTP_MAIN>;
+}>, import("@sinclair/typebox").TObject<{
+    stopBlockHeight: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TUnsafe<import("../../../../../utils/src/mod.js").BlockNumber>, import("@sinclair/typebox").TNull]>;
+} & {
+    stepSize: import("@sinclair/typebox").TNumber;
+}>>;
+export type ConfigSyncProtocolNtpMain = MergeIntersects<Static<ReturnType<typeof ConfigSyncProtocolSchemaNtpMain.allProperties<true>>>>;
+export declare const CommonResponseNtpMain: import("@sinclair/typebox").TObject<{
+    internal: import("@sinclair/typebox").TObject<{}>;
+    payload: import("@sinclair/typebox").TObject<{
+        readonly ownChain: import("@sinclair/typebox").TObject<{
+            blockNumber: import("@sinclair/typebox").TUnsafe<import("../../../../../utils/src/mod.js").BlockNumber>;
+        }>;
+    }>;
+}>;
+//# sourceMappingURL=rpc.d.ts.map

package/esm/config/src/schema/sync-protocols/ntp/rpc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rpc.d.ts","sourceRoot":"","sources":["../../../../../../src/config/src/schema/sync-protocols/ntp/rpc.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AAMrD,OAAO,EAAE,KAAK,eAAe,EAAkB,MAAM,iCAAiC,CAAC;AAUvF,eAAO,MAAM,+BAA+B;;;;;;;;;;GAO1C,CAAC;AAEH,eAAO,MAAM,qBAAqB;;;;;;;CAOmB,CAAC;AAMtD,eAAO,MAAM,+BAA+B;;;;;;;;;;;;GAMxC,CAAC;AACL,MAAM,MAAM,yBAAyB,GAAG,eAAe,CACrD,MAAM,CAAC,UAAU,CAAC,OAAO,+BAA+B,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAC/E,CAAC;AAEF,eAAO,MAAM,qBAAqB;;;;;;;EAEjC,CAAC"}

package/esm/config/src/schema/sync-protocols/ntp/rpc.js

@@ -0,0 +1,33 @@
+import { Type } from "@sinclair/typebox";
+import { ConfigSyncProtocolType } from "../types.js";
+import { NameField, PollingSyncProtocol, StartStopBlockheight, } from "../../common.js";
+import { TypeboxHelpers } from "../../../../../utils/src/mod.js";
+import { genCommonResponse, } from "../common.js";
+// ===========
+// Base schema
+// ===========
+export const ConfigSyncProtocolSchemaNtpBase = NameField.cloneMerge(PollingSyncProtocol).cloneMerge(StartStopBlockheight).cloneMerge({
+    required: Type.Object({}),
+    optional: Type.Object({
+        stepSize: Type.Number({ default: 1000 }),
+    }),
+});
+export const CommonResponseNtpBase = {
+    internal: {},
+    payload: {
+        ownChain: Type.Object({
+            blockNumber: TypeboxHelpers.BlockNumber(),
+        }),
+    },
+};
+// ======================
+// NTP Main config
+// ======================
+export const ConfigSyncProtocolSchemaNtpMain = ConfigSyncProtocolSchemaNtpBase
+    .cloneMerge({
+    required: Type.Object({
+        type: Type.Literal(ConfigSyncProtocolType.NTP_MAIN),
+    }),
+    optional: Type.Object({}),
+});
+export const CommonResponseNtpMain = genCommonResponse(CommonResponseNtpBase);

package/esm/config/src/schema/sync-protocols/types.d.ts

@@ -0,0 +1,125 @@
+import type { FlipObject } from "../../../../utils/src/mod.js";
+import { ConfigNetworkType } from "../network/mod.js";
+import type { ConfigSyncProtocolDecoratorType } from "./decorators/types.js";
+import type { NetworkConfig } from "../../config/parts/network.js";
+import type { ConfigSyncProtocolMapping } from "./all.js";
+import type { EncodedStateValue, getEvmEvent } from "../../mod.js";
+export declare enum ConfigSyncProtocolType {
+    NTP_MAIN = "ntp-main",
+    EVM_RPC_PARALLEL = "evm-rpc-parallel",
+    CARDANO_CARP_PARALLEL = "cardano-carp-parallel",
+    CARDANO_UTXORPC_PARALLEL = "cardano-utxorpc-parallel",
+    MINA_PARALLEL = "mina-sql-parallel",
+    AVAIL_PARALLEL = "avail-rpc-parallel",
+    MIDNIGHT_PARALLEL = "midnight-graphql-parallel",
+    BITCOIN_RPC_PARALLEL = "bitcoin-rpc-parallel"
+}
+export declare const SyncProtocolToNetwork: {
+    "ntp-main": ConfigNetworkType.NTP;
+    "evm-rpc-parallel": ConfigNetworkType.EVM;
+    "cardano-carp-parallel": ConfigNetworkType.CARDANO;
+    "cardano-utxorpc-parallel": ConfigNetworkType.CARDANO;
+    "mina-sql-parallel": ConfigNetworkType.MINA;
+    "avail-rpc-parallel": ConfigNetworkType.AVAIL;
+    "midnight-graphql-parallel": ConfigNetworkType.MIDNIGHT;
+    "bitcoin-rpc-parallel": ConfigNetworkType.BITCOIN;
+};
+export type NetworkTypeFromSyncProtocol<T extends ConfigSyncProtocolType> = (typeof SyncProtocolToNetwork)[T];
+export type SyncProtocolFromNetwork<T extends ConfigNetworkType> = FlipObject<typeof SyncProtocolToNetwork> extends Partial<Record<ConfigNetworkType, ConfigSyncProtocolType>> ? FlipObject<typeof SyncProtocolToNetwork>[T] : never;
+type BasePrimitive = {
+    name: string;
+    type: `${string}:${string}`;
+    startBlockHeight: number;
+    scheduledPrefix?: string;
+};
+type EVMPrimitive = BasePrimitive & {
+    abi: ReturnType<typeof getEvmEvent> | ReturnType<typeof getEvmEvent>[];
+    contractAddress: string;
+};
+type MidnightPrimitive = BasePrimitive & {
+    name: string;
+    contractAddress: string;
+    contract: {
+        ledger: (data: EncodedStateValue) => any;
+    };
+    networkId?: number;
+    genesisHash?: string;
+};
+type CardanoUtxoRpcPrimitive = BasePrimitive & {
+    TODO_ADD_MISSING_FIELDS: string;
+};
+type CardanoCarpPrimitive = BasePrimitive & {
+    TODO_ADD_MISSING_FIELDS: string;
+};
+type MinaPrimitive = BasePrimitive & {
+    TODO_ADD_MISSING_FIELDS: string;
+};
+type AvailPrimitive = BasePrimitive & {
+    appId: number;
+    applicationKey: string;
+    genesisHash: string;
+};
+type NtpMainPrimitive = BasePrimitive & {};
+export type BitcoinPrimitiveDirection = "inputs" | "outputs" | "both";
+type BitcoinPrimitive = BasePrimitive & {
+    /**
+     * The address to watch for transactions. Must be a fixed address, for now multi address wallets are not supported.
+     */
+    watchAddress: string;
+    /**
+     * Allows narrowing notifications to only creations or spends.
+     * Defaults to `both`.
+     */
+    direction?: BitcoinPrimitiveDirection;
+    /**
+     * Optional human label for this address (e.g. exchange name).
+     */
+    label?: string;
+};
+/**
+ * A mapping between specific sync protocols and their corresponding primitive types.
+ * This helps in creating a discriminated union for PrimitiveEntry.
+ */
+export type ProtocolPrimitiveMap = {
+    [ConfigSyncProtocolType.NTP_MAIN]: NtpMainPrimitive;
+    [ConfigSyncProtocolType.EVM_RPC_PARALLEL]: EVMPrimitive;
+    [ConfigSyncProtocolType.MIDNIGHT_PARALLEL]: MidnightPrimitive;
+    [ConfigSyncProtocolType.CARDANO_CARP_PARALLEL]: CardanoCarpPrimitive;
+    [ConfigSyncProtocolType.CARDANO_UTXORPC_PARALLEL]: CardanoUtxoRpcPrimitive;
+    [ConfigSyncProtocolType.MINA_PARALLEL]: MinaPrimitive;
+    [ConfigSyncProtocolType.AVAIL_PARALLEL]: AvailPrimitive;
+    [ConfigSyncProtocolType.BITCOIN_RPC_PARALLEL]: BitcoinPrimitive;
+};
+/**
+ * PrimitiveEntry contains the sync protocol name,
+ * and the primitive configuration created by `getConfig()`
+ */
+export type PrimitiveEntry = {
+    [K in ConfigSyncProtocolType]: {
+        /** The sync protocol this primitive belongs to */
+        syncProtocol: K;
+        /**
+         * The primitive configuration, correctly typed based on the syncProtocol.
+         * Protocols not in ProtocolPrimitiveMap will default to DefaultPrimitive.
+         */
+        primitive: K extends keyof ProtocolPrimitiveMap ? ProtocolPrimitiveMap[K] : never;
+        /** Custom identifier for the primitive */
+        id: string;
+    };
+}[ConfigSyncProtocolType];
+export type NetworkFromSyncProtocol<T extends ConfigSyncProtocolType | ConfigSyncProtocolDecoratorType> = T extends ConfigSyncProtocolType ? Extract<NetworkConfig, {
+    type: NetworkTypeFromSyncProtocol<T>;
+}> : undefined;
+export type SyncProtocolWithNetwork = {
+    [K in keyof typeof SyncProtocolToNetwork]: {
+        networkType: NetworkFromSyncProtocol<K>["type"];
+        syncProtocolType: ConfigSyncProtocolMapping[K]["type"];
+        syncProtocol: ConfigSyncProtocolMapping[K];
+        network: NetworkFromSyncProtocol<K>;
+        primitives: Extract<PrimitiveEntry, {
+            syncProtocol: ConfigSyncProtocolMapping[K]["type"];
+        }>[];
+    };
+}[keyof typeof SyncProtocolToNetwork];
+export {};
+//# sourceMappingURL=types.d.ts.map

package/esm/config/src/schema/sync-protocols/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../src/config/src/schema/sync-protocols/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,uBAAuB,CAAC;AAC7E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,UAAU,CAAC;AAC1D,OAAO,KAAK,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAEnE,oBAAY,sBAAsB;IAChC,QAAQ,aAAa;IACrB,gBAAgB,qBAAqB;IACrC,qBAAqB,0BAA0B;IAC/C,wBAAwB,6BAA6B;IACrD,aAAa,sBAAsB;IACnC,cAAc,uBAAuB;IACrC,iBAAiB,8BAA8B;IAC/C,oBAAoB,yBAAyB;CAC9C;AAED,eAAO,MAAM,qBAAqB;;;;;;;;;CAS2B,CAAC;AAE9D,MAAM,MAAM,2BAA2B,CAAC,CAAC,SAAS,sBAAsB,IACtE,CAAC,OAAO,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC;AACpC,MAAM,MAAM,uBAAuB,CAAC,CAAC,SAAS,iBAAiB,IAC7D,UAAU,CAAC,OAAO,qBAAqB,CAAC,SACtC,OAAO,CAAC,MAAM,CAAC,iBAAiB,EAAE,sBAAsB,CAAC,CAAC,GACxD,UAAU,CAAC,OAAO,qBAAqB,CAAC,CAAC,CAAC,CAAC,GAC3C,KAAK,CAAC;AAEZ,KAAK,aAAa,GAAG;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,GAAG,MAAM,IAAI,MAAM,EAAE,CAAC;IAC5B,gBAAgB,EAAE,MAAM,CAAC;IACzB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,KAAK,YAAY,GAAG,aAAa,GAAG;IAClC,GAAG,EAAE,UAAU,CAAC,OAAO,WAAW,CAAC,GAAG,UAAU,CAAC,OAAO,WAAW,CAAC,EAAE,CAAC;IACvE,eAAe,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,KAAK,iBAAiB,GAAG,aAAa,GAAG;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,eAAe,EAAE,MAAM,CAAC;IACxB,QAAQ,EAAE;QACR,MAAM,EAAE,CAAC,IAAI,EAAE,iBAAiB,KAAK,GAAG,CAAC;KAC1C,CAAC;IACF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,KAAK,uBAAuB,GAAG,aAAa,GAAG;IAC7C,uBAAuB,EAAE,MAAM,CAAC;CACjC,CAAC;AAEF,KAAK,oBAAoB,GAAG,aAAa,GAAG;IAC1C,uBAAuB,EAAE,MAAM,CAAC;CACjC,CAAC;AAEF,KAAK,aAAa,GAAG,aAAa,GAAG;IACnC,uBAAuB,EAAE,MAAM,CAAC;CACjC,CAAC;AAEF,KAAK,cAAc,GAAG,aAAa,GAAG;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,KAAK,gBAAgB,GAAG,aAAa,GAAG,EAAE,CAAC;AAE3C,MAAM,MAAM,yBAAyB,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,CAAC;AAEtE,KAAK,gBAAgB,GAAG,aAAa,GAAG;IACtC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,SAAS,CAAC,EAAE,yBAAyB,CAAC;IACtC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,CAAC,sBAAsB,CAAC,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IACpD,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,EAAE,YAAY,CAAC;IACxD,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;IAC9D,CAAC,sBAAsB,CAAC,qBAAqB,CAAC,EAAE,oBAAoB,CAAC;IACrE,CAAC,sBAAsB,CAAC,wBAAwB,CAAC,EAAE,uBAAuB,CAAC;IAC3E,CAAC,sBAAsB,CAAC,aAAa,CAAC,EAAE,aAAa,CAAC;IACtD,CAAC,sBAAsB,CAAC,cAAc,CAAC,EAAE,cAAc,CAAC;IACxD,CAAC,sBAAsB,CAAC,oBAAoB,CAAC,EAAE,gBAAgB,CAAC;CACjE,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG;KAC1B,CAAC,IAAI,sBAAsB,GAAG;QAC7B,kDAAkD;QAClD,YAAY,EAAE,CAAC,CAAC;QAChB;;;WAGG;QACH,SAAS,EAAE,CAAC,SAAS,MAAM,oBAAoB,GAAG,oBAAoB,CAAC,CAAC,CAAC,GACrE,KAAK,CAAC;QACV,0CAA0C;QAC1C,EAAE,EAAE,MAAM,CAAC;KACZ;CACF,CAAC,sBAAsB,CAAC,CAAC;AAE1B,MAAM,MAAM,uBAAuB,CACjC,CAAC,SAAS,sBAAsB,GAAG,+BAA+B,IAChE,CAAC,SAAS,sBAAsB,GAChC,OAAO,CAAC,aAAa,EAAE;IAAE,IAAI,EAAE,2BAA2B,CAAC,CAAC,CAAC,CAAA;CAAE,CAAC,GAChE,SAAS,CAAC;AAEd,MAAM,MAAM,uBAAuB,GAAG;KACnC,CAAC,IAAI,MAAM,OAAO,qBAAqB,GAAG;QACzC,WAAW,EAAE,uBAAuB,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QAChD,gBAAgB,EAAE,yBAAyB,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QACvD,YAAY,EAAE,yBAAyB,CAAC,CAAC,CAAC,CAAC;QAC3C,OAAO,EAAE,uBAAuB,CAAC,CAAC,CAAC,CAAC;QACpC,UAAU,EAAE,OAAO,CACjB,cAAc,EACd;YAAE,YAAY,EAAE,yBAAyB,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAA;SAAE,CACvD,EAAE,CAAC;KACL;CACF,CAAC,MAAM,OAAO,qBAAqB,CAAC,CAAC"}

package/esm/config/src/schema/sync-protocols/types.js

@@ -0,0 +1,22 @@
+import { ConfigNetworkType } from "../network/mod.js";
+export var ConfigSyncProtocolType;
+(function (ConfigSyncProtocolType) {
+    ConfigSyncProtocolType["NTP_MAIN"] = "ntp-main";
+    ConfigSyncProtocolType["EVM_RPC_PARALLEL"] = "evm-rpc-parallel";
+    ConfigSyncProtocolType["CARDANO_CARP_PARALLEL"] = "cardano-carp-parallel";
+    ConfigSyncProtocolType["CARDANO_UTXORPC_PARALLEL"] = "cardano-utxorpc-parallel";
+    ConfigSyncProtocolType["MINA_PARALLEL"] = "mina-sql-parallel";
+    ConfigSyncProtocolType["AVAIL_PARALLEL"] = "avail-rpc-parallel";
+    ConfigSyncProtocolType["MIDNIGHT_PARALLEL"] = "midnight-graphql-parallel";
+    ConfigSyncProtocolType["BITCOIN_RPC_PARALLEL"] = "bitcoin-rpc-parallel";
+})(ConfigSyncProtocolType || (ConfigSyncProtocolType = {}));
+export const SyncProtocolToNetwork = {
+    [ConfigSyncProtocolType.NTP_MAIN]: ConfigNetworkType.NTP,
+    [ConfigSyncProtocolType.EVM_RPC_PARALLEL]: ConfigNetworkType.EVM,
+    [ConfigSyncProtocolType.CARDANO_CARP_PARALLEL]: ConfigNetworkType.CARDANO,
+    [ConfigSyncProtocolType.CARDANO_UTXORPC_PARALLEL]: ConfigNetworkType.CARDANO,
+    [ConfigSyncProtocolType.MINA_PARALLEL]: ConfigNetworkType.MINA,
+    [ConfigSyncProtocolType.AVAIL_PARALLEL]: ConfigNetworkType.AVAIL,
+    [ConfigSyncProtocolType.MIDNIGHT_PARALLEL]: ConfigNetworkType.MIDNIGHT,
+    [ConfigSyncProtocolType.BITCOIN_RPC_PARALLEL]: ConfigNetworkType.BITCOIN,
+};

package/esm/config/src/schema/utils.d.ts

@@ -0,0 +1,53 @@
+import type { MergeIntersects } from "../../../utils/src/mod.js";
+import type { Static, TIntersect, TObject, TPartial } from "@sinclair/typebox";
+/**
+ * We limit the top-level types that are allowed to avoid performance issues.
+ * The problem comes with `cloneMerge` where we need to combine many ConfigSchemas together.
+ * If we allow things other than objects, we have to support almost *any* type
+ *
+ * You might be tempted to think you could just handle only common cases:
+ * - TObject, TUnion, TIntersect
+ * But the problem is combining these is non-trivial in a general way.
+ * There exists a general solution `TComposite<TObject[]>`,
+ * but the type is extremely complex which slows down Typescript a lot.
+ */
+type ObjectLike = TObject;
+type ObjectContent<T extends ObjectLike> = T extends TObject<infer O> ? O : never;
+export type ConfigProperties<Required extends ObjectLike, Optional extends ObjectLike> = {
+    required: Required;
+    /**
+     * Note: each `optional` value MUST contain a `default` field.
+     *       the default value can be null
+     */
+    optional: Optional;
+};
+export type AllProperties<Required extends ObjectLike, Optional extends ObjectLike, Bool extends boolean> = TIntersect<[Required, Bool extends true ? Optional : TPartial<Optional>]>;
+export type AllPropertiesFor<Schema extends ConfigSchema<any, any>, Bool extends boolean> = Schema extends ConfigSchema<infer Required, infer Optional> ? AllProperties<Required, Optional, Bool> : never;
+export type ToMapping<Type extends string, T extends Partial<Record<Type, ConfigSchema<TObject, TObject>>>> = {
+    [K in keyof T]: T[K] extends ConfigSchema<TObject, TObject> ? MergeIntersects<Static<AllPropertiesFor<T[K], true>>> : never;
+};
+/**
+ * This class is to used to help handle the fact that some fields are required and some are optional.
+ *
+ * Notably, in some cases we want to allow omitting optional fields (when defining your configuration)
+ * But in other cases (ex: using the config after it's been generated), we want to enforce that all optional fields that have a default are present.
+ *
+ * You can't easily solve this in Typebox without this class
+ * because default values aren't part of the type signature
+ * so there is no easy way to recover them after-the-fact
+ * (aka distinguish between a field that defaults to null vs defaults to a non-nullable specific value)
+ * However, it's possible thanks to this class
+ */
+export declare class ConfigSchema<Required extends ObjectLike, Optional extends ObjectLike> {
+    readonly config: ConfigProperties<Required, Optional>;
+    constructor(config: ConfigProperties<Required, Optional>);
+    allProperties: <Bool extends boolean>(requireOptional: Bool) => AllProperties<Required, Optional, Bool>;
+    defaultProperties: () => MergeIntersects<Partial<Static<Optional>>>;
+    /**
+     * Merge two ConfigSchemas together
+     * DANGER: this will not merge top-level `options` of these objects
+     */
+    cloneMerge: <NewRequired extends ObjectLike, NewOptional extends ObjectLike>(newConfig: ConfigProperties<NewRequired, NewOptional> | ConfigSchema<NewRequired, NewOptional>) => ConfigSchema<TObject<ObjectContent<Required> & ObjectContent<NewRequired>>, TObject<ObjectContent<Optional> & ObjectContent<NewOptional>>>;
+}
+export {};
+//# sourceMappingURL=utils.d.ts.map

package/esm/config/src/schema/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../src/config/src/schema/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAI/E;;;;;;;;;;GAUG;AACH,KAAK,UAAU,GAAG,OAAO,CAAC;AAE1B,KAAK,aAAa,CAAC,CAAC,SAAS,UAAU,IAAI,CAAC,SAAS,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GACrE,KAAK,CAAC;AAEV,MAAM,MAAM,gBAAgB,CAC1B,QAAQ,SAAS,UAAU,EAC3B,QAAQ,SAAS,UAAU,IACzB;IACF,QAAQ,EAAE,QAAQ,CAAC;IACnB;;;OAGG;IACH,QAAQ,EAAE,QAAQ,CAAC;CACpB,CAAC;AACF,MAAM,MAAM,aAAa,CACvB,QAAQ,SAAS,UAAU,EAC3B,QAAQ,SAAS,UAAU,EAC3B,IAAI,SAAS,OAAO,IAClB,UAAU,CAAC,CAAC,QAAQ,EAAE,IAAI,SAAS,IAAI,GAAG,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;AAC9E,MAAM,MAAM,gBAAgB,CAC1B,MAAM,SAAS,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,EACrC,IAAI,SAAS,OAAO,IAClB,MAAM,SAAS,YAAY,CAAC,MAAM,QAAQ,EAAE,MAAM,QAAQ,CAAC,GAC3D,aAAa,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,GACvC,KAAK,CAAC;AAEV,MAAM,MAAM,SAAS,CACnB,IAAI,SAAS,MAAM,EACnB,CAAC,SAAS,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,IAC7D;KACD,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,GACvD,eAAe,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,GACrD,KAAK;CACV,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,qBAAa,YAAY,CACvB,QAAQ,SAAS,UAAU,EAC3B,QAAQ,SAAS,UAAU;aAEC,MAAM,EAAE,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,CAAC;gBAA5C,MAAM,EAAE,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAWxE,aAAa,GAAI,IAAI,SAAS,OAAO,EACnC,iBAAiB,IAAI,KACpB,aAAa,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,CAOxC;IAEF,iBAAiB,QAAO,eAAe,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAGhE;IAEF;;;OAGG;IACH,UAAU,GAAI,WAAW,SAAS,UAAU,EAAE,WAAW,SAAS,UAAU,EAC1E,WACI,gBAAgB,CAAC,WAAW,EAAE,WAAW,CAAC,GAC1C,YAAY,CAAC,WAAW,EAAE,WAAW,CAAC,KACzC,YAAY,CACb,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,GAAG,aAAa,CAAC,WAAW,CAAC,CAAC,EAC7D,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,GAAG,aAAa,CAAC,WAAW,CAAC,CAAC,CAC9D,CAeC;CACH"}

package/esm/config/src/schema/utils.js

@@ -0,0 +1,58 @@
+import { Type } from "@sinclair/typebox";
+import { Value } from "@sinclair/typebox/value";
+/**
+ * This class is to used to help handle the fact that some fields are required and some are optional.
+ *
+ * Notably, in some cases we want to allow omitting optional fields (when defining your configuration)
+ * But in other cases (ex: using the config after it's been generated), we want to enforce that all optional fields that have a default are present.
+ *
+ * You can't easily solve this in Typebox without this class
+ * because default values aren't part of the type signature
+ * so there is no easy way to recover them after-the-fact
+ * (aka distinguish between a field that defaults to null vs defaults to a non-nullable specific value)
+ * However, it's possible thanks to this class
+ */
+export class ConfigSchema {
+    config;
+    constructor(config) {
+        // TODO: fast-fail if
+        // 1. any required property is an optional field
+        // 1. any `optional` does not set a default value
+        this.config = config;
+        // TODO: replace once TS5 decorators are better supported
+        this.allProperties.bind(this);
+        this.defaultProperties.bind(this);
+        this.cloneMerge.bind(this);
+    }
+    allProperties = (requireOptional) => {
+        return Type.Intersect([
+            this.config.required,
+            requireOptional
+                ? this.config.optional
+                : Type.Partial(this.config.optional),
+        ]);
+    };
+    defaultProperties = () => {
+        const defaults = Value.Default(this.config.optional, {});
+        return defaults;
+    };
+    /**
+     * Merge two ConfigSchemas together
+     * DANGER: this will not merge top-level `options` of these objects
+     */
+    cloneMerge = (newConfig) => {
+        const config = newConfig instanceof ConfigSchema
+            ? newConfig.config
+            : newConfig;
+        return new ConfigSchema({
+            required: Type.Object({
+                ...this.config.required.properties,
+                ...config.required.properties,
+            }),
+            optional: Type.Object({
+                ...this.config.optional.properties,
+                ...config.optional.properties,
+            }),
+        });
+    };
+}

package/esm/events/src/app-events.d.ts

@@ -0,0 +1,65 @@
+import type { ArgPath, BrokerName, ExcludeFromTuple, LogEvent, LogEventFields, OutputKeypairToObj, RemoveAllIndexed, TransformAllEventInput } from './types.js';
+import { TopicPrefix } from './types.js';
+import type { TSchema, Static, TObject } from '@sinclair/typebox';
+type Data<T extends LogEvent<LogEventFields<TSchema>[]>> = {
+    name: T['name'];
+    fields: KeypairToObj<T['fields']>;
+    topic: string;
+};
+type AllEventsUnion<T extends Record<string, LogEvent<LogEventFields<TSchema>[]>>> = {
+    [K in keyof T]: Data<T[K]>;
+};
+export type EventQueue<T extends Record<string, LogEvent<LogEventFields<TSchema>[]>>> = {
+    address: `0x${string}`;
+    data: AllEventsUnion<T>[keyof T];
+}[];
+export declare const toSignature: <T extends LogEvent<LogEventFields<TSchema>[]>>(event: T) => string;
+export declare const toSignatureHash: <T extends LogEvent<LogEventFields<TSchema>[]>>(event: T) => string;
+export type AppEvents = ReturnType<typeof groupEvents>;
+export type RegisteredEvent<T extends LogEvent<LogEventFields<TSchema>[]>> = {
+    /**
+     * the next three properties are basically the return type of toPath, but
+     * using ReturnType for some reason binds path to never[], which makes any
+     * assignment fail to typecheck.
+     */
+    path: (string | ArgPath)[];
+    broker: BrokerName<TopicPrefix.App>;
+    type: TObject<OutputKeypairToObj<ExcludeFromTuple<TransformAllEventInput<RemoveAllIndexed<T['fields']>>, never>>>;
+    /**
+     * keep the original definition around since it's nicer to work with, it
+     * also has the advantage that it allows recovering the initial order in
+     * case the signature/topicHash needs to be computed again, which can't be
+     * done from the path (since you don't know which non indexed fields go in
+     * between each indexed field).
+     */
+    definition: T;
+    /**
+     * we add this to avoid having to re-compute it all the time
+     */
+    topicHash: string;
+};
+export declare const registerEvents: <const T extends Record<string, LogEvent<LogEventFields<TSchema>[]>>>(entries: T) => { [K in keyof T]: RegisteredEvent<T[K]>; };
+/**
+ * groups events by their name (essentially, grouping by overloads)
+ */
+export declare const groupEvents: <T extends Record<string, RegisteredEvent<LogEvent<LogEventFields<TSchema>[]>>>>(events: T) => { [K in T[string] as K["definition"]["name"]]: T[string][]; };
+export declare const encodeEventForStf: <T extends Omit<RegisteredEvent<LogEvent<LogEventFields<TSchema>[]>>, "path">>(args: {
+    from: `0x${string}`;
+    topic: T;
+    data: KeypairToObj<T["definition"]["fields"]>;
+}) => {
+    address: `0x${string}`;
+    data: {
+        name: T["definition"]["name"];
+        fields: KeypairToObj<T["definition"]["fields"]>;
+        topic: string;
+    };
+};
+type KeypairToObj<T extends {
+    name: string;
+    type: any;
+}[]> = {
+    [K in T[number] as K['name']]: Static<K['type']>;
+};
+export {};
+//# sourceMappingURL=app-events.d.ts.map

package/esm/events/src/app-events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-events.d.ts","sourceRoot":"","sources":["../../../src/events/src/app-events.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,OAAO,EACP,UAAU,EACV,gBAAgB,EAChB,QAAQ,EACR,cAAc,EACd,kBAAkB,EAClB,gBAAgB,EAChB,sBAAsB,EACvB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAU,WAAW,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAIlE,KAAK,IAAI,CAAC,CAAC,SAAS,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI;IACzD,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC;IAChB,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;IAClC,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAGF,KAAK,cAAc,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,IAAI;KAClF,CAAC,IAAI,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,IAAI;IACtF,OAAO,EAAE,KAAK,MAAM,EAAE,CAAC;IACvB,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;CAClC,EAAE,CAAC;AAEJ,eAAO,MAAM,WAAW,GAAI,CAAC,SAAS,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,KAAG,MAErF,CAAC;AAEF,eAAO,MAAM,eAAe,GAAI,CAAC,SAAS,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC,EAC3E,OAAO,CAAC,KACP,MAEF,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG,UAAU,CAAC,OAAO,WAAW,CAAC,CAAC;AAEvD,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI;IAC3E;;;;OAIG;IACH,IAAI,EAAE,CAAC,MAAM,GAAG,OAAO,CAAC,EAAE,CAAC;IAC3B,MAAM,EAAE,UAAU,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IACpC,IAAI,EAAE,OAAO,CACX,kBAAkB,CAChB,gBAAgB,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAC/E,CACF,CAAC;IACF;;;;;;OAMG;IACH,UAAU,EAAE,CAAC,CAAC;IACd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AACF,eAAO,MAAM,cAAc,GAAI,KAAK,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,EAChG,SAAS,CAAC,KACT,GACA,CAAC,IAAI,MAAM,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAgBtC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,WAAW,GACtB,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,EAE9E,QAAQ,CAAC,KACR,GACA,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,GAczD,CAAC;AAIF,eAAO,MAAM,iBAAiB,GAC5B,CAAC,SAAS,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,CAAC,EAC5E,MAAM;IACN,IAAI,EAAE,KAAK,MAAM,EAAE,CAAC;IACpB,KAAK,EAAE,CAAC,CAAC;IACT,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;CAC/C,KAAG;IACF,OAAO,EAAE,KAAK,MAAM,EAAE,CAAC;IACvB,IAAI,EAAE;QACJ,IAAI,EAAE,CAAC,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC;QAC9B,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;QAChD,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CAUH,CAAC;AAGF,KAAK,YAAY,CAAC,CAAC,SAAS;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,GAAG,CAAA;CAAE,EAAE,IAAI;KAC1D,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;CACjD,CAAC"}

package/esm/events/src/app-events.js

@@ -0,0 +1,51 @@
+import { toPath, TopicPrefix } from './types.js';
+import sha3 from 'js-sha3';
+const { keccak_256 } = sha3;
+export const toSignature = (event) => {
+    return event.name + '(' + event.fields.map(f => f.type.type).join(',') + ')';
+};
+export const toSignatureHash = (event) => {
+    return keccak_256(toSignature(event));
+};
+export const registerEvents = (entries) => {
+    return Object.fromEntries(Object.keys(entries).map(key => {
+        const event = entries[key];
+        const topicHash = toSignatureHash(event);
+        return [
+            key,
+            {
+                ...toPath(TopicPrefix.App, event, topicHash),
+                definition: event,
+                topicHash,
+            },
+        ];
+    })); // we can't know the type here
+};
+/**
+ * groups events by their name (essentially, grouping by overloads)
+ */
+export const groupEvents = (events) => {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    let result = {}; // we can't know the type here
+    for (const key of Object.keys(events)) {
+        const event = events[key];
+        if (!result[event.definition.name]) {
+            result[event.definition.name] = [];
+        }
+        result[event.definition.name].push(event);
+    }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    return result;
+};
+// Create payload for the stf from an object.  Using this allows statically
+// checking `data` with the type from `T`.
+export const encodeEventForStf = (args) => {
+    return {
+        address: args.from,
+        data: {
+            name: args.topic.definition.name,
+            fields: args.data,
+            topic: toSignatureHash(args.topic.definition),
+        },
+    };
+};