Class DbSyncStakePoolProvider

Hierarchy

RunnableModule<this> & {
    cardanoNode: CardanoNode;
    dbPools: DbPools;
    healthCheck: (() => Promise<HealthCheckResponse>);
    logger: Logger;
}
- DbSyncStakePoolProvider

Implements

StakePoolProvider

Constructors

constructor

new DbSyncStakePoolProvider(__namedParameters: StakePoolProviderProps, __namedParameters: StakePoolProviderDependencies): DbSyncStakePoolProvider
Parameters
- __namedParameters: StakePoolProviderProps
- __namedParameters: StakePoolProviderDependencies
Returns DbSyncStakePoolProvider
Overrides DbSyncProvider(RunnableModule).constructor
- Defined in packages/cardano-services/src/StakePool/DbSyncStakePoolProvider/DbSyncStakePoolProvider.ts:87

Properties

`Private` #builder

#builder: StakePoolBuilder

`Private` #cache

#cache: InMemoryCache

`Private` #epochLength

#epochLength: number

`Private` #epochMonitor

#epochMonitor: EpochMonitor

`Private` #epochRolloverDisposer

#epochRolloverDisposer: Disposer

`Private` #metadataService

#metadataService: StakePoolMetadataService

`Private` #paginationPageSizeLimit

#paginationPageSizeLimit: number

`Private` #responseConfig

#responseConfig: undefined | {
    search?: {
        metrics?: {
            apy?: boolean;
        };
    };
}

`Private` #useBlockfrost

#useBlockfrost: boolean

cardanoNode

cardanoNode: CardanoNode

dbPools

dbPools: DbPools

healthCheck

healthCheck: (() => Promise<HealthCheckResponse>)

Type declaration

- (): Promise<HealthCheckResponse>
- Returns Promise<HealthCheckResponse>

logger

logger: Logger

name

name: string

state

state: RunnableModuleState

`Static` notSupportedSortFields

Methods

`Private` attachExtendedMetadata

attachExtendedMetadata(poolData: PoolData[]): Promise<void>
Parameters
- poolData: PoolData[]
Returns Promise<void>
- Defined in packages/cardano-services/src/StakePool/DbSyncStakePoolProvider/DbSyncStakePoolProvider.ts:146

`Private` cacheStakePools

cacheStakePools(cachedPromises: {
[k: string]: PromiseOrValue<StakePool | undefined>;
}, resultPromise: Promise<StakePoolResults>, rewardsHistoryKey: string): void
Parameters
- cachedPromises: {
  [k: string]: PromiseOrValue<StakePool | undefined>;
  }
  - [k: string]: PromiseOrValue<StakePool | undefined>
- resultPromise: Promise<StakePoolResults>
- rewardsHistoryKey: string
Returns void
- Defined in packages/cardano-services/src/StakePool/DbSyncStakePoolProvider/DbSyncStakePoolProvider.ts:197

`Private` getPoolsDataOrdered

getPoolsDataOrdered(poolUpdates: PoolUpdate[], totalStake: null | string, useBlockfrost: boolean, options: QueryStakePoolsArgs): Promise<{
    hashesIds: number[];
    orderedResult: PoolMetrics[] | PoolData[] | PoolAPY[];
    orderedResultHashIds: number[];
    orderedResultUpdateIds: number[];
    poolDatas: PoolData[];
    sortType: PoolSortType;
}>
Parameters
- poolUpdates: PoolUpdate[]
- totalStake: null | string
- useBlockfrost: boolean
- options: QueryStakePoolsArgs
Returns Promise<{
    hashesIds: number[];
    orderedResult: PoolMetrics[] | PoolData[] | PoolAPY[];
    orderedResultHashIds: number[];
    orderedResultUpdateIds: number[];
    poolDatas: PoolData[];
    sortType: PoolSortType;
}>
- Defined in packages/cardano-services/src/StakePool/DbSyncStakePoolProvider/DbSyncStakePoolProvider.ts:164

`Private` getQueryBySortType

getQueryBySortType(sortType: PoolSortType, queryArgs: {
    hashesIds: number[];
    totalStake: null | string;
    updatesIds: number[];
}, useBlockfrost: boolean): ((options: QueryStakePoolsArgs) => Promise<PoolMetrics[]>) | ((options: QueryStakePoolsArgs) => Promise<PoolData[]>) | ((options: QueryStakePoolsArgs) => Promise<PoolAPY[]>)
Parameters
- sortType: PoolSortType
- queryArgs: {
      hashesIds: number[];
      totalStake: null | string;
      updatesIds: number[];
  }
  - hashesIds: number[]
  - totalStake: null | string
  - updatesIds: number[]
- useBlockfrost: boolean
Returns ((options: QueryStakePoolsArgs) => Promise<PoolMetrics[]>) | ((options: QueryStakePoolsArgs) => Promise<PoolData[]>) | ((options: QueryStakePoolsArgs) => Promise<PoolAPY[]>)
- Defined in packages/cardano-services/src/StakePool/DbSyncStakePoolProvider/DbSyncStakePoolProvider.ts:117

initialize

initialize(): Promise<void>
Returns Promise<void>
Inherited from DbSyncProvider(RunnableModule).initialize
- Defined in packages/util/dist/cjs/RunnableModule.d.ts:15

initializeAfter

initializeAfter(): void
Returns void
Inherited from DbSyncProvider(RunnableModule).initializeAfter
- Defined in packages/util/dist/cjs/RunnableModule.d.ts:19

initializeBefore

initializeBefore(): void
Returns void
Inherited from DbSyncProvider(RunnableModule).initializeBefore
- Defined in packages/util/dist/cjs/RunnableModule.d.ts:18

initializeImpl

initializeImpl(): Promise<void>
Returns Promise<void>
Overrides DbSyncProvider(RunnableModule).initializeImpl
- Defined in packages/cardano-services/src/StakePool/DbSyncStakePoolProvider/DbSyncStakePoolProvider.ts:398

`Private` queryExtraPoolsData

queryExtraPoolsData(idsToFetch: PoolUpdate[], sortType: PoolSortType, totalStake: null | string, orderedResult: OrderedResult, useBlockfrost: boolean): Promise<{
    poolMetrics: never[];
    poolOwners: never[];
    poolRegistrations: never[];
    poolRelays: never[];
    poolRetirements: never[];
    poolRewards: never[];
} | {
    poolMetrics: PoolMetrics[];
    poolOwners: never[] | PoolOwner[];
    poolRegistrations: never[] | PoolRegistration[];
    poolRelays: PoolRelay[];
    poolRetirements: never[] | PoolRetirement[];
}>
Parameters
- idsToFetch: PoolUpdate[]
- sortType: PoolSortType
- totalStake: null | string
- orderedResult: OrderedResult
- useBlockfrost: boolean
Returns Promise<{
    poolMetrics: never[];
    poolOwners: never[];
    poolRegistrations: never[];
    poolRelays: never[];
    poolRetirements: never[];
    poolRewards: never[];
} | {
    poolMetrics: PoolMetrics[];
    poolOwners: never[] | PoolOwner[];
    poolRegistrations: never[] | PoolRegistration[];
    poolRelays: PoolRelay[];
    poolRetirements: never[] | PoolRetirement[];
}>
- Defined in packages/cardano-services/src/StakePool/DbSyncStakePoolProvider/DbSyncStakePoolProvider.ts:233

queryStakePools

queryStakePools(options: QueryStakePoolsArgs): Promise<Paginated<StakePool>>
Parameters
- options: QueryStakePoolsArgs
Returns Promise<Paginated<StakePool>>
Implementation of StakePoolProvider.queryStakePools
- Defined in packages/cardano-services/src/StakePool/DbSyncStakePoolProvider/DbSyncStakePoolProvider.ts:296

queryStakePoolsChecks

queryStakePoolsChecks(options: QueryStakePoolsArgs): void
Parameters
- options: QueryStakePoolsArgs
Returns void
- Defined in packages/cardano-services/src/StakePool/DbSyncStakePoolProvider/DbSyncStakePoolProvider.ts:258

shutdown

shutdown(): Promise<void>
Returns Promise<void>
Inherited from DbSyncProvider(RunnableModule).shutdown
- Defined in packages/util/dist/cjs/RunnableModule.d.ts:17

shutdownAfter

shutdownAfter(): void
Returns void
Inherited from DbSyncProvider(RunnableModule).shutdownAfter
- Defined in packages/util/dist/cjs/RunnableModule.d.ts:23

shutdownBefore

shutdownBefore(): void
Returns void
Inherited from DbSyncProvider(RunnableModule).shutdownBefore
- Defined in packages/util/dist/cjs/RunnableModule.d.ts:22

shutdownImpl

shutdownImpl(): Promise<void>
Returns Promise<void>
Overrides DbSyncProvider(RunnableModule).shutdownImpl
- Defined in packages/cardano-services/src/StakePool/DbSyncStakePoolProvider/DbSyncStakePoolProvider.ts:406

stakePoolStats

stakePoolStats(): Promise<StakePoolStats>
Returns Promise<StakePoolStats>
Implementation of StakePoolProvider.stakePoolStats
- Defined in packages/cardano-services/src/StakePool/DbSyncStakePoolProvider/DbSyncStakePoolProvider.ts:393

start

start(): Promise<void>
Returns Promise<void>
Inherited from DbSyncProvider(RunnableModule).start
- Defined in packages/util/dist/cjs/RunnableModule.d.ts:16

startAfter

startAfter(): void
Returns void
Inherited from DbSyncProvider(RunnableModule).startAfter
- Defined in packages/util/dist/cjs/RunnableModule.d.ts:21

startBefore

startBefore(): void
Returns void
Inherited from DbSyncProvider(RunnableModule).startBefore
- Defined in packages/util/dist/cjs/RunnableModule.d.ts:20

startImpl

startImpl(): Promise<void>
Returns Promise<void>
Overrides DbSyncProvider(RunnableModule).startImpl
- Defined in packages/cardano-services/src/StakePool/DbSyncStakePoolProvider/DbSyncStakePoolProvider.ts:402

Class DbSyncStakePoolProvider

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

__namedParameters: StakePoolProviderProps

__namedParameters: StakePoolProviderDependencies

Returns DbSyncStakePoolProvider

Properties

Private #builder

Private #cache

Private #epochLength

Private #epochMonitor

Private #epochRolloverDisposer

Private #metadataService

Private #paginationPageSizeLimit

Private #responseConfig

Private #useBlockfrost

cardanoNode

dbPools

healthCheck

Type declaration

Returns Promise<HealthCheckResponse>

logger

name

state

Static notSupportedSortFields

Methods

Private attachExtendedMetadata

Parameters

poolData: PoolData[]

Returns Promise<void>

Private cacheStakePools

Parameters

cachedPromises: { [k: string]: PromiseOrValue<StakePool | undefined>; }

[k: string]: PromiseOrValue<StakePool | undefined>

resultPromise: Promise<StakePoolResults>

rewardsHistoryKey: string

Returns void

Private getPoolsDataOrdered

Parameters

poolUpdates: PoolUpdate[]

totalStake: null | string

useBlockfrost: boolean

options: QueryStakePoolsArgs

Returns Promise<{ hashesIds: number[]; orderedResult: PoolMetrics[] | PoolData[] | PoolAPY[]; orderedResultHashIds: number[]; orderedResultUpdateIds: number[]; poolDatas: PoolData[]; sortType: PoolSortType; }>

Private getQueryBySortType

Parameters

sortType: PoolSortType

queryArgs: { hashesIds: number[]; totalStake: null | string; updatesIds: number[]; }

hashesIds: number[]

totalStake: null | string

updatesIds: number[]

useBlockfrost: boolean

Returns ((options: QueryStakePoolsArgs) => Promise<PoolMetrics[]>) | ((options: QueryStakePoolsArgs) => Promise<PoolData[]>) | ((options: QueryStakePoolsArgs) => Promise<PoolAPY[]>)

initialize

Returns Promise<void>

initializeAfter

Returns void

initializeBefore

Returns void

initializeImpl

Returns Promise<void>

Private queryExtraPoolsData

Parameters

idsToFetch: PoolUpdate[]

sortType: PoolSortType

totalStake: null | string

orderedResult: OrderedResult

useBlockfrost: boolean

queryStakePools

Parameters

options: QueryStakePoolsArgs

Returns Promise<Paginated<StakePool>>

queryStakePoolsChecks

`Private` #builder

`Private` #cache

`Private` #epochLength

`Private` #epochMonitor

`Private` #epochRolloverDisposer

`Private` #metadataService

`Private` #paginationPageSizeLimit

`Private` #responseConfig

`Private` #useBlockfrost

`Static` notSupportedSortFields

`Private` attachExtendedMetadata

`Private` cacheStakePools

cachedPromises: {
[k: string]: PromiseOrValue<StakePool | undefined>;
}

`Private` getPoolsDataOrdered

Returns Promise<{
hashesIds: number[];
orderedResult: PoolMetrics[] | PoolData[] | PoolAPY[];
orderedResultHashIds: number[];
orderedResultUpdateIds: number[];
poolDatas: PoolData[];
sortType: PoolSortType;
}>

`Private` getQueryBySortType

queryArgs: {
hashesIds: number[];
totalStake: null | string;
updatesIds: number[];
}

`Private` queryExtraPoolsData