@xyo-network/xl1-protocol-sdk 1.15.27 → 1.16.0

package/src/validation/block/error.spec.ts

@@ -0,0 +1,20 @@
+import type { Address, Hash } from '@xylabs/hex'
+import type { HydratedBlock } from '@xyo-network/xl1-protocol'
+import {
+  describe, expect, it,
+} from 'vitest'
+
+import { HydratedBlockStateValidationError } from './error.ts'
+
+describe('HydratedBlockStateValidationError', () => {
+  it('should be able display chainId', () => {
+    const error: HydratedBlockStateValidationError = new HydratedBlockStateValidationError(
+      '2234567890abcdef1234567890abcdef12345678' as Hash, // Mock Hash
+      '1234567890abcdef1234567890abcdef12345678' as Address, // Mock Address
+      {} as HydratedBlock, // Mock HydratedBlock
+      'Test Error',
+      [new Error('Inner error')],
+    )
+    expect(error).toBeDefined()
+  })
+})

package/src/validation/block/error.ts

@@ -0,0 +1,46 @@
+import type { Hash } from '@xylabs/hex'
+import type {
+  BlockBoundWitness,
+  ChainId,
+  HydratedBlock,
+} from '@xyo-network/xl1-protocol'
+import { isValidationError, ValidationError } from '@xyo-network/xl1-protocol'
+
+export class BlockValidationError extends ValidationError<BlockBoundWitness> {}
+
+export const isBlockValidationError = (
+  error: unknown,
+): error is BlockValidationError => {
+  if (!isValidationError(error)) return false
+  return (
+    error.name === BlockValidationError.constructor.name
+  )
+}
+
+export class HydratedBlockValidationError extends ValidationError<HydratedBlock> {}
+
+export const isHydratedBlockValidationError = (
+  error: unknown,
+): error is HydratedBlockValidationError => {
+  if (!isValidationError(error)) return false
+  return (
+    error.name === HydratedBlockValidationError.constructor.name
+  )
+}
+
+export class HydratedBlockStateValidationError extends ValidationError<HydratedBlock> {
+  chainId: ChainId
+  constructor(hash: Hash, chainId: ChainId, value: HydratedBlock, message?: string, cause?: unknown) {
+    super(hash, value, message, cause)
+    this.chainId = chainId
+  }
+}
+
+export const isHydratedBlockStateValidationError = (
+  error: unknown,
+): error is HydratedBlockStateValidationError => {
+  if (!isValidationError(error)) return false
+  return (
+    error.name === HydratedBlockStateValidationError.constructor.name
+  )
+}

package/src/validation/block/index.ts

@@ -0,0 +1,4 @@
+export * from './BlockValidationFunction.ts'
+export * from './error.ts'
+export * from './HydratedBlockStateValidationFunction.ts'
+export * from './HydratedBlockValidationFunction.ts'

package/src/validation/index.ts

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

package/dist/neutral/ChainServiceCollection.d.ts

@@ -1,61 +0,0 @@
-import type { ArchivistInstance, WriteArchivist } from '@xyo-network/archivist-model';
-import type { WalletInstance } from '@xyo-network/wallet-model';
-import type { AccountBalanceService, BlockProducerService, BlockRewardService, ChainContractViewer, ChainStaker, ChainStakeViewer, ElectionService, EventingChainBlockNumberIteratorService, StakeIntentService } from '@xyo-network/xl1-protocol';
-/** @deprecated use ChainServiceCollectionV2 */
-export interface ChainServiceCollection {
-    /**
-     * The account which is used to sign transactions
-     */
-    account: WalletInstance;
-    /**
-     * Services for working with account balances
-     */
-    balanceService: AccountBalanceService;
-    /**
-     * The archivist which the chain data is stored in
-     */
-    chainArchivist: ArchivistInstance;
-    /**
-     * Service for viewing codified chain information
-     * from a contract
-     */
-    chainContractViewer: ChainContractViewer;
-    /**
-     * The chain iterator
-     */
-    chainIterator?: EventingChainBlockNumberIteratorService;
-    /**
-     * Service for viewing stake information
-     */
-    chainStakeViewer: ChainStakeViewer;
-    /**
-     * Service for staking
-     */
-    chainStaker: ChainStaker;
-    /**
-     * The archivist which the chain submissions are stored in
-     */
-    chainSubmissionsArchivistWrite: WriteArchivist;
-    /**
-     * Service for determining leader election
-     */
-    electionService: ElectionService;
-    /**
-     * The archivist which the pending transactions are stored
-     * as bundled transactions
-     */
-    pendingBundledTransactionsArchivistWrite: ArchivistInstance;
-    /**
-     * The block producer service
-     */
-    producer: BlockProducerService;
-    /**
-     * Service response for calculating block rewards
-     */
-    rewardService: BlockRewardService;
-    /**
-     * Services for working with staked intents
-     */
-    stakeIntentService: StakeIntentService;
-}
-//# sourceMappingURL=ChainServiceCollection.d.ts.map

package/dist/neutral/ChainServiceCollection.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ChainServiceCollection.d.ts","sourceRoot":"","sources":["../../src/ChainServiceCollection.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAA;AACrF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAA;AAC/D,OAAO,KAAK,EACV,qBAAqB,EAAE,oBAAoB,EAC3C,kBAAkB,EAAE,mBAAmB,EAAE,WAAW,EAAE,gBAAgB,EAAE,eAAe,EAAE,uCAAuC,EAChI,kBAAkB,EACnB,MAAM,2BAA2B,CAAA;AAElC,+CAA+C;AAC/C,MAAM,WAAW,sBAAsB;IAErC;;OAEG;IACH,OAAO,EAAE,cAAc,CAAA;IACvB;;OAEG;IACH,cAAc,EAAE,qBAAqB,CAAA;IACrC;;OAEG;IACH,cAAc,EAAE,iBAAiB,CAAA;IACjC;;;OAGG;IACH,mBAAmB,EAAE,mBAAmB,CAAA;IACxC;;OAEG;IACH,aAAa,CAAC,EAAE,uCAAuC,CAAA;IACvD;;OAEG;IACH,gBAAgB,EAAE,gBAAgB,CAAA;IAClC;;OAEG;IACH,WAAW,EAAE,WAAW,CAAA;IACxB;;OAEG;IACH,8BAA8B,EAAE,cAAc,CAAA;IAC9C;;OAEG;IACH,eAAe,EAAE,eAAe,CAAA;IAChC;;;OAGG;IACH,wCAAwC,EAAE,iBAAiB,CAAA;IAC3D;;OAEG;IACH,QAAQ,EAAE,oBAAoB,CAAA;IAC9B;;OAEG;IACH,aAAa,EAAE,kBAAkB,CAAA;IACjC;;OAEG;IACH,kBAAkB,EAAE,kBAAkB,CAAA;CACvC"}

package/dist/neutral/instances/ShiftedBigIntConfig.d.ts

@@ -1,9 +0,0 @@
-/** @deprecated use from \@xyo-network/xl1-protocol instead */
-export interface ShiftedBigIntConfig {
-    locale: Intl.LocalesArgument;
-    maxCharacters: number;
-    maxDecimal: number;
-    minDecimals: number;
-    places: number;
-}
-//# sourceMappingURL=ShiftedBigIntConfig.d.ts.map

package/dist/neutral/instances/ShiftedBigIntConfig.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ShiftedBigIntConfig.d.ts","sourceRoot":"","sources":["../../../src/instances/ShiftedBigIntConfig.ts"],"names":[],"mappings":"AAAA,8DAA8D;AAC9D,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,IAAI,CAAC,eAAe,CAAA;IAC5B,aAAa,EAAE,MAAM,CAAA;IACrB,UAAU,EAAE,MAAM,CAAA;IAClB,WAAW,EAAE,MAAM,CAAA;IACnB,MAAM,EAAE,MAAM,CAAA;CACf"}

package/dist/neutral/instances/XL1Amount.d.ts

@@ -1,15 +0,0 @@
-import type { AttoXL1, FemtoXL1, MicroXL1, MilliXL1, NanoXL1, PicoXL1 } from '@xyo-network/xl1-protocol';
-import type { ShiftedBigIntConfig } from './ShiftedBigIntConfig.ts';
-/** @deprecated use from \@xyo-network/xl1-protocol instead */
-export interface XL1AmountInstance {
-    value: AttoXL1;
-    to(places: bigint | number): bigint;
-    milli: MilliXL1;
-    micro: MicroXL1;
-    nano: NanoXL1;
-    pico: PicoXL1;
-    femto: FemtoXL1;
-    atto: AttoXL1;
-    toString(places: number, config: Partial<ShiftedBigIntConfig>): string;
-}
-//# sourceMappingURL=XL1Amount.d.ts.map

package/dist/neutral/instances/XL1Amount.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"XL1Amount.d.ts","sourceRoot":"","sources":["../../../src/instances/XL1Amount.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EACxD,MAAM,2BAA2B,CAAA;AAElC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAEnE,8DAA8D;AAC9D,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,OAAO,CAAA;IAEd,EAAE,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAA;IAEnC,KAAK,EAAE,QAAQ,CAAA;IAEf,KAAK,EAAE,QAAQ,CAAA;IAEf,IAAI,EAAE,OAAO,CAAA;IAEb,IAAI,EAAE,OAAO,CAAA;IAEb,KAAK,EAAE,QAAQ,CAAA;IAEf,IAAI,EAAE,OAAO,CAAA;IAEb,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG,MAAM,CAAA;CACvE"}

package/src/ChainServiceCollection.ts

@@ -1,66 +0,0 @@
-import type { ArchivistInstance, WriteArchivist } from '@xyo-network/archivist-model'
-import type { WalletInstance } from '@xyo-network/wallet-model'
-import type {
-  AccountBalanceService, BlockProducerService,
-  BlockRewardService, ChainContractViewer, ChainStaker, ChainStakeViewer, ElectionService, EventingChainBlockNumberIteratorService,
-  StakeIntentService,
-} from '@xyo-network/xl1-protocol'
-
-/** @deprecated use ChainServiceCollectionV2 */
-export interface ChainServiceCollection {
-
-  /**
-   * The account which is used to sign transactions
-   */
-  account: WalletInstance
-  /**
-   * Services for working with account balances
-   */
-  balanceService: AccountBalanceService
-  /**
-   * The archivist which the chain data is stored in
-   */
-  chainArchivist: ArchivistInstance
-  /**
-   * Service for viewing codified chain information
-   * from a contract
-   */
-  chainContractViewer: ChainContractViewer
-  /**
-   * The chain iterator
-   */
-  chainIterator?: EventingChainBlockNumberIteratorService
-  /**
-   * Service for viewing stake information
-   */
-  chainStakeViewer: ChainStakeViewer
-  /**
-   * Service for staking
-   */
-  chainStaker: ChainStaker
-  /**
-   * The archivist which the chain submissions are stored in
-   */
-  chainSubmissionsArchivistWrite: WriteArchivist
-  /**
-   * Service for determining leader election
-   */
-  electionService: ElectionService
-  /**
-   * The archivist which the pending transactions are stored
-   * as bundled transactions
-   */
-  pendingBundledTransactionsArchivistWrite: ArchivistInstance
-  /**
-   * The block producer service
-   */
-  producer: BlockProducerService
-  /**
-   * Service response for calculating block rewards
-   */
-  rewardService: BlockRewardService
-  /**
-   * Services for working with staked intents
-   */
-  stakeIntentService: StakeIntentService
-}

package/src/instances/ShiftedBigIntConfig.ts

@@ -1,8 +0,0 @@
-/** @deprecated use from \@xyo-network/xl1-protocol instead */
-export interface ShiftedBigIntConfig {
-  locale: Intl.LocalesArgument
-  maxCharacters: number
-  maxDecimal: number
-  minDecimals: number
-  places: number
-}

package/src/instances/XL1Amount.ts

@@ -1,29 +0,0 @@
-/* eslint-disable sonarjs/deprecation */
-/* eslint-disable @typescript-eslint/member-ordering */
-
-import type {
-  AttoXL1, FemtoXL1, MicroXL1, MilliXL1, NanoXL1, PicoXL1,
-} from '@xyo-network/xl1-protocol'
-
-import type { ShiftedBigIntConfig } from './ShiftedBigIntConfig.ts'
-
-/** @deprecated use from \@xyo-network/xl1-protocol instead */
-export interface XL1AmountInstance {
-  value: AttoXL1
-
-  to(places: bigint | number): bigint
-
-  milli: MilliXL1
-
-  micro: MicroXL1
-
-  nano: NanoXL1
-
-  pico: PicoXL1
-
-  femto: FemtoXL1
-
-  atto: AttoXL1
-
-  toString(places: number, config: Partial<ShiftedBigIntConfig>): string
-}