@xyo-network/xl1-protocol-sdk 1.7.4 → 1.7.6

package/src/config/Log.ts

@@ -0,0 +1,6 @@
+import type { LogLevelKey } from '@xylabs/logger'
+import { LogLevel } from '@xylabs/logger'
+import z from 'zod'
+const LogLevels = Object.keys(LogLevel) as [LogLevelKey, ...LogLevelKey[]]
+
+export const LogConfigSchema = z.object({ level: z.enum(LogLevels).default('info').describe('Desired process verbosity') })

package/src/config/Producer.ts

@@ -0,0 +1,16 @@
+import z from 'zod'
+
+import { MnemonicStringSchema } from '../validation/index.ts'
+
+export const ProducerConfigSchema = z.object({
+  // TODO: Port schema
+  healthCheckPort: z.coerce.number().optional().describe('Port for the Producer health checks'),
+  // TODO: BigInt schema
+  minStake: z.coerce.number().default(1).describe('Minimum stake required to be a Producer'),
+  mnemonic: MnemonicStringSchema.optional().describe('Mnemonic for the Producer wallet'),
+  // TODO: Port schema
+  port: z.coerce.number().default(8081).describe('Port for the Producer'),
+  disableIntentRedeclaration: z.boolean().optional().describe('Should the producer skip redeclaring their intent to continue producing blocks'),
+  // TODO: Address schema
+  rewardAddress: z.string().optional().describe('Address to receive block rewards'),
+})

package/src/config/Telemetry.ts

@@ -0,0 +1,13 @@
+import z from 'zod'
+
+export const OpenTelemetryConfigSchema = z.object({
+  // OpenTelemetry options
+  otlpEndpoint: z.string().optional().describe('OTLP endpoint for exporting telemetry data'),
+})
+
+export const TelemetryConfigSchema = z.object({
+  // OpenTelemetry configuration
+  otel: OpenTelemetryConfigSchema.optional().describe('OpenTelemetry configuration'),
+}).describe('Telemetry configuration options')
+
+export type TelemetryConfig = z.infer<typeof TelemetryConfigSchema>

package/src/config/index.ts

@@ -0,0 +1 @@
+export * from './Config.ts'

package/src/config/storage/Storage.ts

@@ -0,0 +1,10 @@
+import z from 'zod'
+
+import { MongoConfigSchema } from './driver/index.ts'
+
+export const StorageConfigSchema = z.object({
+  mongo: MongoConfigSchema.optional().describe('Configuration for the MongoDBstorage driver'),
+  root: z.string().optional().describe('Root directory for local storage'),
+}).describe('Storage configuration options')
+
+export type StorageConfig = z.infer<typeof StorageConfigSchema>

package/src/config/storage/driver/Mongo.ts

@@ -0,0 +1,12 @@
+import z from 'zod'
+
+export const MongoConfigSchema = z.object({
+  // TODO: Create from other arguments
+  connectionString: z.string().min(1).max(1024).optional().describe('MongoDB connection string'),
+  database: z.string().min(1).max(128).optional().describe('MongoDB database name'),
+  domain: z.string().min(1).max(128).optional().describe('MongoDB domain'),
+  password: z.string().min(1).max(128).optional().describe('MongoDB password'),
+  username: z.string().min(1).max(128).optional().describe('MongoDB username'),
+})
+
+export type MongoConfig = z.infer<typeof MongoConfigSchema>

package/src/config/storage/driver/index.ts

@@ -0,0 +1 @@
+export * from './Mongo.ts'

package/src/config/storage/index.ts

@@ -0,0 +1 @@
+export * from './Storage.ts'

package/src/index.ts

@@ -1,7 +1,9 @@
 export * from './block/index.ts'
 export * from './ChainServiceCollection.ts'
 export * from './ChainServiceCollectionV2.ts'
+export * from './config/index.ts'
 export * from './instances/index.ts'
 export * from './payload/index.ts'
 export * from './SignedBigInt.ts'
 export * from './transaction/index.ts'
+export * from './validation/index.ts'

package/src/validation/index.ts

@@ -0,0 +1,2 @@
+export * from './lib/index.ts'
+export * from './schema/index.ts'

package/src/validation/lib/getUrl.ts

@@ -0,0 +1,6 @@
+import { isLocalhost } from './isLocalhost.ts'
+
+export const getUrl = (host: string, port: number): string => {
+  const scheme = isLocalhost(host) ? 'http' : 'https'
+  return `${scheme}://${host}:${port}`
+}

package/src/validation/lib/index.ts

@@ -0,0 +1,2 @@
+export * from './getUrl.ts'
+export * from './isLocalhost.ts'

package/src/validation/lib/isLocalhost.ts

@@ -0,0 +1,8 @@
+export const isLocalhost = (hostname: string): boolean => {
+  return (
+    hostname === 'localhost'
+    || hostname === '127.0.0.1'
+    || hostname === '::1' // IPv6 localhost
+    || hostname.endsWith('.localhost')
+  )
+}

package/src/validation/schema/Address.ts

@@ -0,0 +1 @@
+export const TODO = true

package/src/validation/schema/Mnemonic.ts

@@ -0,0 +1,20 @@
+import { z } from 'zod'
+
+/**
+ * Validates a single string containing a BIP-39 mnemonic.
+ *
+ * • Trims leading/trailing whitespace.
+ * • Collapses any run of whitespace (spaces, tabs, new-lines) to a single space.
+ * • Splits on spaces → array of words.
+ * • Checks that the word-count is 12, 15, 18, 21, or 24.
+ *
+ */
+export const MnemonicStringSchema = z
+  .string()
+  .transform(s => s.trim().replaceAll(/\s+/g, ' ')) // normalize spacing
+  .refine(
+    s => [12, 15, 18, 21, 24].includes(s.split(' ').length),
+    { message: 'Mnemonic must contain 12, 15, 18, 21, or 24 words.' },
+  ).describe('BIP-39 mnemonic string')
+
+export type MnemonicString = z.infer<typeof MnemonicStringSchema>

package/src/validation/schema/index.ts

@@ -0,0 +1,2 @@
+export * from './Address.ts'
+export * from './Mnemonic.ts'