@xyo-network/chain-services 1.7.0 → 1.7.2

package/dist/neutral/index.d.ts

@@ -1,362 +1,12 @@
-import * as _xyo_network_archivist_model from '@xyo-network/archivist-model';
-import { ReadArchivist, ArchivistInstance } from '@xyo-network/archivist-model';
-import * as _xyo_network_xl1_protocol from '@xyo-network/xl1-protocol';
-import { AccountBalanceServiceV2, OpenTelemetryProviders, Service, PayloadRepository, AttoXL1, BlockBoundWitness, HydratedTransaction, ElectionService, BlockRewardService, StakeIntentService, HydratedBlockStateValidationFunctionV2, PendingTransactionsService, BlockProducerService, HydratedBlock, Transfer, ChainStakeIntent, ChainService, ChainIteratorEventData, EventingChainBlockNumberIterator, ChainBlockNumberIterator, ChainStakeViewer, Intent } from '@xyo-network/xl1-protocol';
-import { Hash, Address } from '@xylabs/hex';
-import { BalancesStepSummary } from '@xyo-network/xl1-protocol-sdk';
-import { CreatableParams, AbstractCreatable } from '@xylabs/creatable';
-import { EventData } from '@xylabs/events';
-import { Promisable } from '@xylabs/promise';
-import * as _xyo_network_account_model from '@xyo-network/account-model';
-import { AccountInstance } from '@xyo-network/account-model';
-import * as _xyo_network_module_model from '@xyo-network/module-model';
-import * as _xyo_network_payload_model from '@xyo-network/payload-model';
-import { WithStorageMeta, Payload } from '@xyo-network/payload-model';
-import { BlockRewardDiviner } from '@xyo-network/chain-modules';
-import { Provider, ContractRunner } from 'ethers/providers';
-import { LRUCache } from 'lru-cache';
-import { StakedXyoChain } from '@xyo-network/typechain';
-import { IntervalMap } from '@xyo-network/chain-utils';
-import { Mutex } from 'async-mutex';
-
-declare const accountBalanceServiceFromArchivist: (archivist: ReadArchivist) => Promise<AccountBalanceServiceV2>;
-/** @deprecated use accountBalanceServiceFromArchivist */
-declare const accountBalanceServiceFromArchivistV2: (archivist: ReadArchivist) => Promise<AccountBalanceServiceV2>;
-
-interface BaseServiceParams extends CreatableParams, OpenTelemetryProviders {
-}
-interface BaseAccountableServiceParams extends BaseServiceParams {
-    account: AccountInstance;
-}
-
-declare global {
-    var xyoServiceSingletons: Record<string, unknown>;
-}
-declare class BaseService<TParams extends BaseServiceParams = BaseServiceParams, TEventData extends EventData = EventData> extends AbstractCreatable<TParams, TEventData> {
-    private static singletonInitMutex;
-    static get singletons(): Record<string, unknown>;
-    static initSingleton<TService extends BaseService<TParams>, TParams extends BaseServiceParams>(params: Partial<TParams>): Promise<TService>;
-    paramsHandler(params?: Partial<TParams>): TParams;
-    span<T>(name: string, fn: () => T): T;
-    spanAsync<T>(name: string, fn: () => Promise<T>): Promise<T>;
-}
-declare abstract class BaseAccountableService<TParams extends BaseAccountableServiceParams = BaseAccountableServiceParams> extends BaseService<TParams> {
-}
-interface CreatableService<T extends BaseService = BaseService> extends Service {
-    new (params: T['params']): T;
-    create<T extends BaseService>(this: CreatableService<T>, params?: Partial<T['params']>): Promisable<T>;
-}
-declare function creatableService<T extends BaseService = BaseService>(): <U extends CreatableService<T>>(constructor: U) => void;
-
-interface BaseAccountBalanceServiceParams extends BaseServiceParams {
-    chainArchivist: ReadArchivist;
-    summaryRepository: PayloadRepository<Hash, BalancesStepSummary>;
-}
-declare class BaseAccountBalanceService extends BaseService<BaseAccountBalanceServiceParams> implements AccountBalanceServiceV2 {
-    balances(head: Hash, address: Address[]): Promise<Partial<Record<Address, AttoXL1>>>;
-}
-
-interface Validator {
-    validatePendingBlock(block: BlockBoundWitness): Promisable<Error[]>;
-    validatePendingTransaction(tx: HydratedTransaction): Promise<boolean>;
-}
-
-interface XyoValidatorParams extends BaseServiceParams {
-    account: AccountInstance;
-    chainArchivist: ReadArchivist;
-    chainId: Address;
-    electionService: ElectionService;
-    pendingBundledTransactionsArchivist: ArchivistInstance;
-    rewardService: BlockRewardService;
-    stakeIntentService: StakeIntentService;
-    validateHydratedBlockState: HydratedBlockStateValidationFunctionV2;
-}
-declare class XyoValidator<TParams extends XyoValidatorParams = XyoValidatorParams> extends BaseService<TParams> implements Validator {
-    get address(): Lowercase<string>;
-    protected get account(): AccountInstance;
-    protected get chainArchivist(): ReadArchivist<_xyo_network_payload_model.Payload, Lowercase<string>>;
-    protected get chainInfo(): Lowercase<string>;
-    protected get electionService(): ElectionService;
-    protected get pendingBundledTransactionsArchivist(): ArchivistInstance<_xyo_network_archivist_model.ArchivistParams<_xyo_network_module_model.AnyConfigSchema<_xyo_network_archivist_model.ArchivistConfig<void, void>>>, _xyo_network_archivist_model.ArchivistModuleEventData, _xyo_network_payload_model.Payload>;
-    protected get rewardService(): BlockRewardService;
-    validatePendingBlock(_block: BlockBoundWitness): Promisable<Error[]>;
-    validatePendingTransaction(hydratedTransaction: HydratedTransaction): Promise<boolean>;
-}
-
-/**
- * The default block size for a block
- */
-declare const DEFAULT_BLOCK_SIZE = 10;
-declare const XYO_PRODUCER_REDECLARATION_DURATION = 10000;
-/**
- * The number of blocks within which a producer will redeclare
- * their intent to produce blocks
- */
-declare const XYO_PRODUCER_REDECLARATION_WINDOW = 500;
-interface BaseBlockProducerServiceParams extends XyoValidatorParams {
-    balanceService: AccountBalanceServiceV2;
-    pendingTransactionsService: PendingTransactionsService;
-    rejectedTransactionsArchivist: ArchivistInstance;
-    rewardAddress: Address;
-}
-declare class BaseBlockProducerService extends BaseService<BaseBlockProducerServiceParams> implements BlockProducerService {
-    protected _blockRewardDiviner: BlockRewardDiviner | undefined;
-    /**
-     * The default block size for a block
-     */
-    static get DefaultBlockSize(): number;
-    /**
-     * The amount of time for which the producer will redeclare
-     * their intent to continue producing blocks
-     */
-    static get RedeclarationDuration(): number;
-    /**
-     * The number of blocks within which the producer will redeclare
-     * their intent to continue producing blocks
-     */
-    static get RedeclarationWindow(): number;
-    /**
-     * Should the producer should redeclare
-     * their intent to continue producing blocks
-     */
-    static get RedeclareIntent(): boolean;
-    get address(): Lowercase<string>;
-    protected get account(): _xyo_network_account_model.AccountInstance;
-    protected get balanceService(): AccountBalanceServiceV2;
-    protected get chainArchivist(): _xyo_network_archivist_model.ReadArchivist<_xyo_network_payload_model.Payload, Lowercase<string>>;
-    protected get chainId(): Lowercase<string>;
-    protected get electionService(): _xyo_network_xl1_protocol.ElectionService;
-    protected get pendingTransactionsService(): PendingTransactionsService;
-    protected get rejectedTransactionsArchivist(): ArchivistInstance<_xyo_network_archivist_model.ArchivistParams<_xyo_network_module_model.AnyConfigSchema<_xyo_network_archivist_model.ArchivistConfig<void, void>>>, _xyo_network_archivist_model.ArchivistModuleEventData, _xyo_network_payload_model.Payload>;
-    protected get rewardAddress(): Address;
-    protected get rewardService(): _xyo_network_xl1_protocol.BlockRewardService;
-    protected get stakeIntentService(): StakeIntentService;
-    protected get validateHydratedBlockState(): _xyo_network_xl1_protocol.HydratedBlockStateValidationFunctionV2;
-    next(head: WithStorageMeta<BlockBoundWitness>): Promise<HydratedBlock | undefined>;
-    protected getBlockRewardTransfer(block: number): Promise<Transfer | undefined>;
-    /**
-     * Handles the producer redeclaration logic
-     * @param head The current head block
-     * @returns chain stake intent for the producer redeclaration, or undefined if no redeclaration is needed
-     */
-    protected getProducerRedeclaration(head: WithStorageMeta<BlockBoundWitness>): Promise<ChainStakeIntent | undefined>;
-    protected proposeNextValidBlock(head: WithStorageMeta<BlockBoundWitness>, validateBalances?: boolean): Promise<HydratedBlock | undefined>;
-}
-
-interface BaseBlockRewardServiceParams extends BaseServiceParams {
-}
-declare class BaseBlockRewardService<TParams extends BaseBlockRewardServiceParams = BaseBlockRewardServiceParams> extends BaseService<TParams> implements BlockRewardService {
-    getRewardForBlock(_blockNumber: bigint): Promisable<bigint>;
-}
-
-interface EvmBlockRewardServiceParams extends BaseBlockRewardServiceParams {
-    account: AccountInstance;
-    chainService?: ChainService;
-    provider?: Provider;
-}
-declare class EvmBlockRewardService extends BaseBlockRewardService<EvmBlockRewardServiceParams> implements BlockRewardService {
-    protected _contractAddress: string | undefined;
-    protected get chainService(): ChainService;
-    protected get contractAddress(): string;
-    protected get provider(): Provider;
-    createHandler(): Promise<void>;
-    getRewardForBlock(blockNumber: bigint): Promise<bigint>;
-}
-
-interface MemoryBlockRewardServiceParams extends BaseBlockRewardServiceParams {
-    creatorReward?: bigint;
-    initialStepReward?: bigint;
-    minRewardPerBlock?: bigint;
-    stepFactorDenominator?: bigint;
-    stepFactorNumerator?: bigint;
-    stepSize?: bigint;
-}
-declare class MemoryBlockRewardService<TParams extends MemoryBlockRewardServiceParams = MemoryBlockRewardServiceParams> extends BaseBlockRewardService<TParams> implements BlockRewardService {
-    protected readonly rewardFromBlockNumber: (blockNumber: bigint, startingReward?: bigint, blocksPerStep?: bigint, stepFactorNumerator?: bigint, stepFactorDenominator?: bigint, minBlockReward?: bigint, creatorReward?: bigint) => bigint;
-    get creatorReward(): bigint;
-    get initialReward(): bigint;
-    get minRewardPerBlock(): bigint;
-    get stepFactorDenominator(): bigint;
-    get stepFactorNumerator(): bigint;
-    get stepSize(): bigint;
-    static paramsHandler<T extends MemoryBlockRewardService['params']>(inParams?: Partial<T>): Promise<T>;
-    getRewardForBlock(blockNumber: bigint): Promisable<bigint>;
-}
-
-interface XyoChainIteratorParams extends BaseServiceParams {
-    chainArchivist: ArchivistInstance;
-    head: BlockBoundWitness;
-}
-
-declare class ChainBlockNumberIterationService extends BaseService<XyoChainIteratorParams, ChainIteratorEventData> implements EventingChainBlockNumberIterator {
-    protected _blocksByBlockNumber: LRUCache<number, BlockBoundWitness, unknown>;
-    get chainArchivist(): ArchivistInstance;
-    get chainId(): Address;
-    get(block: number): Promise<BlockBoundWitness>;
-    head(): Promise<BlockBoundWitness>;
-    next(block: number): Promise<BlockBoundWitness | undefined>;
-    previous(block?: number | undefined, count?: number): Promise<BlockBoundWitness[]>;
-    updateHead(head: BlockBoundWitness): Promise<void>;
-}
-
-interface BlockNumberIteration {
-    validatePendingBlock(block: BlockBoundWitness): Promisable<Error[]>;
-    validatePendingTransaction(tx: HydratedTransaction): Promise<boolean>;
-}
-
-interface EvmChainServiceParams extends BaseServiceParams {
-    contract: StakedXyoChain;
-    id: Address;
-    runner: ContractRunner;
-}
-/**
- * A class that represents a chain stake as backed by an EVM smart contract
- */
-declare class EvmChainService extends BaseService<EvmChainServiceParams> implements ChainService {
-    get chainId(): Address;
-    get contract(): StakedXyoChain;
-    get runner(): ContractRunner;
-    active(): Promise<bigint>;
-    activeByAddressStaked(address: string): Promise<bigint>;
-    activeByStaker(address: string): Promise<bigint>;
-    addStake(staked: string, amount: bigint): Promise<boolean>;
-    forkedAtBlockNumber(): Promise<bigint>;
-    forkedAtHash(): Promise<bigint>;
-    forkedChainId(): Promise<Address>;
-    minWithdrawalBlocks(): Promise<bigint>;
-    pending(): Promise<bigint>;
-    pendingByStaker(staker: string): Promise<bigint>;
-    removeStake(slot: bigint): Promise<boolean>;
-    rewardsContract(): Promise<string>;
-    stakingTokenAddress(): Promise<string>;
-    withdrawStake(slot: bigint): Promise<boolean>;
-    withdrawn(): Promise<bigint>;
-    withdrawnByStaker(staker: string): Promise<bigint>;
-}
-
-interface MemoryChainServiceParams extends BaseServiceParams {
-}
-/**
- * A class that represents a chain stake as backed in memory
- */
-declare class MemoryChainService extends BaseService<MemoryChainServiceParams> implements ChainService {
-    protected _simulatedStake: bigint;
-    get chainId(): Address;
-    active(): Promise<bigint>;
-    activeByAddressStaked(_address: string): Promise<bigint>;
-    activeByStaker(_address: string): Promise<bigint>;
-    addStake(_staked: string, _amount: bigint): Promise<boolean>;
-    createHandler(): void;
-    forkedAtBlockNumber(): Promise<bigint>;
-    forkedAtHash(): Promise<bigint>;
-    forkedChainId(): Promise<Address>;
-    minWithdrawalBlocks(): Promise<bigint>;
-    pending(): Promise<bigint>;
-    pendingByStaker(_staker: string): Promise<bigint>;
-    removeStake(_slot: bigint): Promise<boolean>;
-    rewardsContract(): Promise<string>;
-    stakingTokenAddress(): Promise<string>;
-    withdrawStake(_slot: bigint): Promise<boolean>;
-    withdrawn(): Promise<bigint>;
-    withdrawnByStaker(_staker: string): Promise<bigint>;
-}
-
-interface BaseElectionServicesParams extends BaseServiceParams {
-    chainIterator?: ChainBlockNumberIterator;
-    chainStakeViewer?: ChainStakeViewer;
-    stakeIntentService?: StakeIntentService;
-}
-declare class BaseElectionService extends BaseService<BaseElectionServicesParams> implements ElectionService {
-    get chainIterator(): ChainBlockNumberIterator;
-    get chainStakeViewer(): ChainStakeViewer;
-    get stakeIntentService(): StakeIntentService;
-    getCreatorCommitteeForNextBlock(current: BlockBoundWitness): Promise<Address[]>;
-    protected generateCreatorCommittee(candidates: Address[], previousBlockHash: Hash, maxSize?: number): Address[];
-}
-
-interface BasePendingTransactionsServiceParams extends BaseServiceParams {
-    chainArchivist?: ArchivistInstance;
-    chainId?: Address;
-    pendingBundledTransactionsArchivist?: ArchivistInstance;
-    rejectedTransactionsArchivist?: ArchivistInstance;
-}
-declare class BasePendingTransactionsService extends BaseService<BasePendingTransactionsServiceParams> implements PendingTransactionsService {
-    private static readonly MutexPriority;
-    /**
-     * A mutex to ensure that the counting the number of pending transactions is
-     * not called concurrently
-     */
-    private _countPendingTransactionsMutex;
-    /**
-     * A local Archivist optimized for fast retrieval that stores only validated
-     * pending transactions
-     */
-    private _curatedPendingBundledTransactionsArchivist;
-    /**
-     * The last count of total pending transactions
-     */
-    private _pendingTransactionsCount;
-    /**
-     * A set of transaction hashes that are pending removal from the
-     * curated pending transactions archivist. This is used to track
-     * which transactions need to be removed from the archivist.
-     */
-    private _removablePendingTransactionHashes;
-    /**
-     * A mutex to ensure that the curated pending transactions archivist is
-     * updated in a thread-safe manner
-     */
-    private _updateCuratedPendingTransactionsArchivistMutex;
-    private get chainArchivist();
-    private get chainId();
-    private get pendingBundledTransactionsArchivist();
-    private get pendingBundledTransactionsLocalArchivist();
-    private get pendingTransactionsCount();
-    private get rejectedTransactionsArchivist();
-    createHandler(): Promise<void>;
-    getPendingTransactions(head: Hash, limit: number): Promise<HydratedTransaction[]>;
-    private cleanupWorker;
-    private countPendingTransactions;
-    private filterAlreadyFinalizedTransactions;
-    private insertNewTransactions;
-    /**
-     * Marks any included transactions in the provided payloads for removal preventing them
-     * from being included in the curated pending transactions archivist and from being offered
-     * during the next retrieval of pending transactions.
-     * @param payloads An array of payloads that may contain transactions.
-     */
-    private markAnyIncludedTransactionsForRemoval;
-    private pruneCuratedPendingTransactionsArchivist;
-}
-
-declare const getBlockSignedStakeDeclarations: (block: BlockBoundWitness, archivist: ArchivistInstance, intent: Intent) => Promise<ChainStakeIntent[]>;
-
-interface XyoStakeIntentServiceParams extends BaseServiceParams {
-    chainArchivist?: ArchivistInstance;
-    chainIterator?: EventingChainBlockNumberIterator;
-    chainStakeViewer?: ChainStakeViewer;
-    stakeIntentStateArchivist?: ArchivistInstance;
-}
-declare class XyoStakeIntentService extends BaseService<XyoStakeIntentServiceParams> implements StakeIntentService {
-    protected _lastIndexedBlockHash: Hash | undefined;
-    protected _producers: IntervalMap<Address>;
-    protected _stakeCache: LRUCache<Lowercase<string>, bigint, unknown>;
-    protected _updateMutex: Mutex;
-    protected get chainArchivist(): ArchivistInstance<_xyo_network_archivist_model.ArchivistParams<_xyo_network_module_model.AnyConfigSchema<_xyo_network_archivist_model.ArchivistConfig<void, void>>>, _xyo_network_archivist_model.ArchivistModuleEventData, Payload>;
-    protected get chainIterator(): EventingChainBlockNumberIterator;
-    protected get chainStakeViewer(): ChainStakeViewer;
-    protected get stakeIntentStateArchivist(): ArchivistInstance<_xyo_network_archivist_model.ArchivistParams<_xyo_network_module_model.AnyConfigSchema<_xyo_network_archivist_model.ArchivistConfig<void, void>>>, _xyo_network_archivist_model.ArchivistModuleEventData, Payload>;
-    createHandler(): Promise<void>;
-    getDeclaredCandidateRanges(address: Address, intent: Intent): Promise<Readonly<Readonly<[number, number]>[]>>;
-    getDeclaredCandidatesForBlock(block: number, intent: Intent): Promise<Address[]>;
-    getRequiredMinimumStakeForIntent(intent: Intent): bigint;
-    isStakedForBlock(block: number, intent: Intent, address: Address): Promise<boolean>;
-    startHandler(): Promise<void>;
-    private filterToValidStake;
-    private persistState;
-    private recoverState;
-    private updateIndex;
-}
-
-export { BaseAccountBalanceService, BaseAccountableService, BaseBlockProducerService, BaseBlockRewardService, BaseElectionService, BasePendingTransactionsService, BaseService, ChainBlockNumberIterationService, DEFAULT_BLOCK_SIZE, EvmBlockRewardService, EvmChainService, MemoryBlockRewardService, MemoryChainService, XYO_PRODUCER_REDECLARATION_DURATION, XYO_PRODUCER_REDECLARATION_WINDOW, XyoStakeIntentService, XyoValidator, accountBalanceServiceFromArchivist, accountBalanceServiceFromArchivistV2, creatableService, getBlockSignedStakeDeclarations };
-export type { BaseAccountBalanceServiceParams, BaseAccountableServiceParams, BaseBlockProducerServiceParams, BaseBlockRewardServiceParams, BaseElectionServicesParams, BasePendingTransactionsServiceParams, BaseServiceParams, BlockNumberIteration, CreatableService, EvmBlockRewardServiceParams, EvmChainServiceParams, MemoryBlockRewardServiceParams, MemoryChainServiceParams, Validator, XyoChainIteratorParams, XyoStakeIntentServiceParams, XyoValidatorParams };
+export * from './AccountBalance/index.ts';
+export * from './BaseService.ts';
+export * from './BlockProducer/index.ts';
+export * from './BlockReward/index.ts';
+export * from './ChainBlockNumberIteration/index.ts';
+export * from './ChainService/index.ts';
+export * from './ChainValidator/index.ts';
+export * from './Election/index.ts';
+export * from './model/index.ts';
+export * from './PendingTransactions/index.ts';
+export * from './StakeIntent/index.ts';
+//# sourceMappingURL=index.d.ts.map