@xyo-network/xl1-protocol-sdk 1.16.23 → 1.16.24

package/dist/neutral/provider/viewer/XyoViewer.d.ts

@@ -1,7 +1,7 @@
-import type { AccountBalanceViewerMethods, BlockViewierMethods, ChainViewerMethods, ForkViewerMethods, NetworkStakeStepRewardViewer, StakeViewerMethods, TransactionViewerMethods, TransferBalanceViewerMethods } from '../../viewers/index.ts';
+import type { AccountBalanceViewer, AccountBalanceViewerMethods, BlockViewierMethods, ChainViewerMethods, ForkViewerMethods, NetworkStakeStepRewardViewer, StakeViewerMethods, TransactionViewerMethods, TransferBalanceViewerMethods } from '../../viewers/index.ts';
 import type { NetworkStakeViewer } from './NetworkStake/index.ts';
 import type { StepViewer } from './StepViewer.ts';
-export interface XyoViewerMethods extends AccountBalanceViewerMethods, TransferBalanceViewerMethods, NetworkStakeStepRewardViewer, ChainViewerMethods, BlockViewierMethods, TransactionViewerMethods, StakeViewerMethods, ForkViewerMethods {
+export interface XyoViewerMethods extends AccountBalanceViewerMethods, TransferBalanceViewerMethods, NetworkStakeStepRewardViewer, AccountBalanceViewer, ChainViewerMethods, BlockViewierMethods, TransactionViewerMethods, StakeViewerMethods, ForkViewerMethods {
 }
 export interface XyoViewer extends XyoViewerMethods {
     networkStake?: NetworkStakeViewer;

package/dist/neutral/provider/viewer/XyoViewer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"XyoViewer.d.ts","sourceRoot":"","sources":["../../../../src/provider/viewer/XyoViewer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,2BAA2B,EAC3B,mBAAmB,EACnB,kBAAkB,EAClB,iBAAiB,EACjB,4BAA4B,EAC5B,kBAAkB,EAClB,wBAAwB,EACxB,4BAA4B,EAC7B,MAAM,wBAAwB,CAAA;AAC/B,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AACjE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAEjD,MAAM,WAAW,gBAAiB,SAAQ,2BAA2B,EAAE,4BAA4B,EACjG,4BAA4B,EAC5B,kBAAkB,EAAE,mBAAmB,EAAE,wBAAwB,EAAE,kBAAkB,EAAE,iBAAiB;CACzG;AAED,MAAM,WAAW,SAAU,SAAQ,gBAAgB;IACjD,YAAY,CAAC,EAAE,kBAAkB,CAAA;IACjC,IAAI,CAAC,EAAE,UAAU,CAAA;CAClB"}
+{"version":3,"file":"XyoViewer.d.ts","sourceRoot":"","sources":["../../../../src/provider/viewer/XyoViewer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,oBAAoB,EACpB,2BAA2B,EAC3B,mBAAmB,EACnB,kBAAkB,EAClB,iBAAiB,EACjB,4BAA4B,EAC5B,kBAAkB,EAClB,wBAAwB,EACxB,4BAA4B,EAC7B,MAAM,wBAAwB,CAAA;AAC/B,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AACjE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAEjD,MAAM,WAAW,gBAAiB,SAAQ,2BAA2B,EAAE,4BAA4B,EACjG,4BAA4B,EAAE,oBAAoB,EAClD,kBAAkB,EAAE,mBAAmB,EAAE,wBAAwB,EAAE,kBAAkB,EAAE,iBAAiB;CACzG;AAED,MAAM,WAAW,SAAU,SAAQ,gBAAgB;IACjD,YAAY,CAAC,EAAE,kBAAkB,CAAA;IACjC,IAAI,CAAC,EAAE,UAAU,CAAA;CAClB"}

package/dist/neutral/viewers/AccountBalance.d.ts

@@ -58,11 +58,11 @@ export declare const AccountBalanceHistoryItemZod: z.ZodTuple<[z.ZodObject<{
 }, z.z.core.$strip>], null>;
 export type AccountBalanceHistoryItem = z.infer<typeof AccountBalanceHistoryItemZod>;
 export interface AccountBalanceViewerMethods {
-    accountBalance(address: Address, headOrRange?: Hash | XL1BlockRange): Promisable<AttoXL1>;
-    accountBalanceHistory(address: Address, headOrRange?: Hash | XL1BlockRange): Promisable<AccountBalanceHistoryItem[]>;
     accountsBalances(address: Address[], headOrRange?: Hash | XL1BlockRange): Promisable<Partial<Record<Address, AttoXL1>>>;
     accountsBalancesHistory(address: Address[], headOrRange?: Hash | XL1BlockRange): Promisable<Partial<Record<Address, AccountBalanceHistoryItem[]>>>;
 }
 export interface AccountBalanceViewer extends AccountBalanceViewerMethods {
+    accountBalance(address: Address, headOrRange?: Hash | XL1BlockRange): Promisable<AttoXL1>;
+    accountBalanceHistory(address: Address, headOrRange?: Hash | XL1BlockRange): Promisable<AccountBalanceHistoryItem[]>;
 }
 //# sourceMappingURL=AccountBalance.d.ts.map

package/dist/neutral/viewers/AccountBalance.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AccountBalance.d.ts","sourceRoot":"","sources":["../../../src/viewers/AccountBalance.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,OAAO,EAAE,IAAI,EAAE,UAAU,EAC1B,MAAM,gBAAgB,CAAA;AAEvB,OAAO,EACL,KAAK,OAAO,EAEZ,KAAK,aAAa,EACnB,MAAM,2BAA2B,CAAA;AAClC,OAAO,CAAC,MAAM,KAAK,CAAA;AAInB,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2BAIvC,CAAA;AAEF,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAA;AAEpF,MAAM,WAAW,2BAA2B;IAC1C,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,WAAW,CAAC,EAAE,IAAI,GAAG,aAAa,GAAG,UAAU,CAAC,OAAO,CAAC,CAAA;IACzF,qBAAqB,CAAC,OAAO,EAAE,OAAO,EAAE,WAAW,CAAC,EAAE,IAAI,GAAG,aAAa,GAAG,UAAU,CAAC,yBAAyB,EAAE,CAAC,CAAA;IAEpH,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,WAAW,CAAC,EAAE,IAAI,GAAG,aAAa,GAAG,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAA;IACvH,uBAAuB,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,WAAW,CAAC,EAAE,IAAI,GAAG,aAAa,GAAG,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,yBAAyB,EAAE,CAAC,CAAC,CAAC,CAAA;CACnJ;AAED,MAAM,WAAW,oBAAqB,SAAQ,2BAA2B;CAAG"}
+{"version":3,"file":"AccountBalance.d.ts","sourceRoot":"","sources":["../../../src/viewers/AccountBalance.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,OAAO,EAAE,IAAI,EAAE,UAAU,EAC1B,MAAM,gBAAgB,CAAA;AAEvB,OAAO,EACL,KAAK,OAAO,EAEZ,KAAK,aAAa,EACnB,MAAM,2BAA2B,CAAA;AAClC,OAAO,CAAC,MAAM,KAAK,CAAA;AAInB,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2BAIvC,CAAA;AAEF,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAA;AAEpF,MAAM,WAAW,2BAA2B;IAC1C,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,WAAW,CAAC,EAAE,IAAI,GAAG,aAAa,GAAG,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAA;IACvH,uBAAuB,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,WAAW,CAAC,EAAE,IAAI,GAAG,aAAa,GAAG,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,yBAAyB,EAAE,CAAC,CAAC,CAAC,CAAA;CACnJ;AAED,MAAM,WAAW,oBAAqB,SAAQ,2BAA2B;IACvE,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,WAAW,CAAC,EAAE,IAAI,GAAG,aAAa,GAAG,UAAU,CAAC,OAAO,CAAC,CAAA;IACzF,qBAAqB,CAAC,OAAO,EAAE,OAAO,EAAE,WAAW,CAAC,EAAE,IAAI,GAAG,aAAa,GAAG,UAAU,CAAC,yBAAyB,EAAE,CAAC,CAAA;CACrH"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "http://json.schemastore.org/package.json",
   "name": "@xyo-network/xl1-protocol-sdk",
-  "version": "1.16.23",
+  "version": "1.16.24",
   "description": "XYO Layer One SDK Protocol",
   "homepage": "https://xylabs.com",
   "bugs": {

package/src/config/Config.ts

@@ -1,7 +1,6 @@
 import * as z from 'zod'
 
 import { ApiConfigZod } from './Api.ts'
-import { AppConfigZod } from './App.ts'
 import { BridgeConfigZod } from './Bridge.ts'
 import { ChainConfigZod } from './Chain.ts'
 import { EvmConfigZod } from './Evm.ts'
@@ -9,6 +8,7 @@ import { LogConfigZod } from './Log.ts'
 import { MempoolConfigZod } from './Mempool.ts'
 import { ProducerConfigZod } from './Producer.ts'
 import { RewardRedemptionApiConfigZod } from './RewardRedemptionApi.ts'
+import { ServicesConfigZod } from './Services.ts'
 import { StorageConfigZod } from './storage/index.ts'
 import { TelemetryConfigZod } from './Telemetry.ts'
 import { ValidationConfigZod } from './Validation.ts'
@@ -18,13 +18,13 @@ export const Xl1CommonConfigSchema = z.object({ ...LogConfigZod.shape }).describ
 export const ConfigZod = z.object({
   ...Xl1CommonConfigSchema.shape,
   api: ApiConfigZod.default(ApiConfigZod.parse({})).describe('Configuration for the API node'),
-  app: AppConfigZod.default(AppConfigZod.parse({})).describe('Configuration for the application'),
   bridge: BridgeConfigZod.default(BridgeConfigZod.parse({})).describe('Configuration for the Bridge node'),
   chain: ChainConfigZod.default(ChainConfigZod.parse({})).describe('Configuration for the chain'),
   evm: EvmConfigZod.default(EvmConfigZod.parse({})).describe('Configuration for EVM-backed services'),
   mempool: MempoolConfigZod.default(MempoolConfigZod.parse({})).describe('Configuration for the mempool'),
   producer: ProducerConfigZod.default(ProducerConfigZod.parse({})).describe('Configuration for the producer'),
   rewardRedemptionApi: RewardRedemptionApiConfigZod.default(RewardRedemptionApiConfigZod.parse({})).describe('Configuration for the rewards redemption API'),
+  services: ServicesConfigZod.default(ServicesConfigZod.parse({})).describe('Configuration for the global services'),
   storage: StorageConfigZod.default(StorageConfigZod.parse({})).describe('Configuration for the storage'),
   telemetry: TelemetryConfigZod.default(TelemetryConfigZod.parse({})).describe('Configuration for telemetry'),
   validation: ValidationConfigZod.default(ValidationConfigZod.parse({})).describe('Configuration for validation'),

package/src/config/Producer.ts

@@ -16,12 +16,6 @@ export const ProducerConfigZod = z.object({
     type: 'array',
   })),
 
-  apiEndpoint: z.string().optional().register(globalRegistry, {
-    description: 'Endpoint of the API to use for chain data',
-    title: 'producer.apiEndpoint',
-    type: 'string',
-  }),
-
   disableIntentRedeclaration: z.boolean().optional().register(globalRegistry, {
     description: 'Should the producer skip redeclaring their intent to continue producing blocks',
     title: 'producer.disableIntentRedeclaration',

package/src/config/Services.ts

@@ -0,0 +1,12 @@
+import { globalRegistry } from 'zod'
+import * as z from 'zod'
+
+export const ServicesConfigZod = z.object({
+  accountBalanceViewerEndpoint: z.string().optional().register(globalRegistry, {
+    description: 'Endpoint of the API to use for instantiating an external AccountBalanceViewer',
+    title: 'services.accountBalanceViewerEndpoint',
+    type: 'string',
+  }),
+})
+
+export type ServicesConfig = z.infer<typeof ServicesConfigZod>

package/src/config/Telemetry.ts

@@ -1,6 +1,23 @@
 import { globalRegistry } from 'zod'
 import * as z from 'zod'
 
+export const MetricsScrapeConfigZod = z.object({
+  path: z.string().default('/metrics').register(globalRegistry, {
+    default: '/metrics',
+    description: 'Path for the metrics scrape endpoint',
+    title: 'telemetry.metrics.scrape.path',
+    type: 'string',
+  }),
+  port: z.coerce.number().default(9464).register(globalRegistry, {
+    default: 9464,
+    description: 'Port for the metrics scrape endpoint',
+    title: 'telemetry.metrics.scrape.port',
+    type: 'number',
+  }),
+}).describe('Metrics scrape configuration')
+
+export const MetricsConfigZod = z.object({ scrape: MetricsScrapeConfigZod }).describe('Metrics configuration options')
+
 export const OpenTelemetryConfigZod = z.object({
   // OpenTelemetry options
   otlpEndpoint: z.url().optional().register(globalRegistry, {
@@ -11,6 +28,8 @@ export const OpenTelemetryConfigZod = z.object({
 })
 
 export const TelemetryConfigZod = z.object({
+  // Metrics configuration
+  metrics: MetricsConfigZod.optional().describe('Metrics configuration'),
   // OpenTelemetry configuration
   otel: OpenTelemetryConfigZod.optional().describe('OpenTelemetry configuration'),
 }).describe('Telemetry configuration options')

package/src/provider/viewer/XyoViewer.ts

@@ -1,4 +1,5 @@
 import type {
+  AccountBalanceViewer,
   AccountBalanceViewerMethods,
   BlockViewierMethods,
   ChainViewerMethods,
@@ -12,7 +13,7 @@ import type { NetworkStakeViewer } from './NetworkStake/index.ts'
 import type { StepViewer } from './StepViewer.ts'
 
 export interface XyoViewerMethods extends AccountBalanceViewerMethods, TransferBalanceViewerMethods,
-  NetworkStakeStepRewardViewer,
+  NetworkStakeStepRewardViewer, AccountBalanceViewer,
   ChainViewerMethods, BlockViewierMethods, TransactionViewerMethods, StakeViewerMethods, ForkViewerMethods {
 }
 

package/src/viewers/AccountBalance.ts

@@ -20,11 +20,11 @@ export const AccountBalanceHistoryItemZod = z.tuple([
 export type AccountBalanceHistoryItem = z.infer<typeof AccountBalanceHistoryItemZod>
 
 export interface AccountBalanceViewerMethods {
-  accountBalance(address: Address, headOrRange?: Hash | XL1BlockRange): Promisable<AttoXL1>
-  accountBalanceHistory(address: Address, headOrRange?: Hash | XL1BlockRange): Promisable<AccountBalanceHistoryItem[]>
-
   accountsBalances(address: Address[], headOrRange?: Hash | XL1BlockRange): Promisable<Partial<Record<Address, AttoXL1>>>
   accountsBalancesHistory(address: Address[], headOrRange?: Hash | XL1BlockRange): Promisable<Partial<Record<Address, AccountBalanceHistoryItem[]>>>
 }
 
-export interface AccountBalanceViewer extends AccountBalanceViewerMethods {}
+export interface AccountBalanceViewer extends AccountBalanceViewerMethods {
+  accountBalance(address: Address, headOrRange?: Hash | XL1BlockRange): Promisable<AttoXL1>
+  accountBalanceHistory(address: Address, headOrRange?: Hash | XL1BlockRange): Promisable<AccountBalanceHistoryItem[]>
+}

package/dist/neutral/config/App.d.ts

@@ -1,6 +0,0 @@
-import * as z from 'zod';
-export declare const AppConfigZod: z.ZodObject<{
-    port: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
-}, z.core.$strip>;
-export type AppConfig = z.infer<typeof AppConfigZod>;
-//# sourceMappingURL=App.d.ts.map

package/dist/neutral/config/App.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"App.d.ts","sourceRoot":"","sources":["../../../src/config/App.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AAExB,eAAO,MAAM,YAAY;;iBAOvB,CAAA;AAEF,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAA"}

package/src/config/App.ts

@@ -1,13 +0,0 @@
-import { globalRegistry } from 'zod'
-import * as z from 'zod'
-
-export const AppConfigZod = z.object({
-  port: z.coerce.number().default(3000).register(globalRegistry, {
-    default: 3000,
-    description: 'Port for the application',
-    title: 'app.port',
-    type: 'number',
-  }),
-})
-
-export type AppConfig = z.infer<typeof AppConfigZod>