-
Notifications
You must be signed in to change notification settings - Fork 58
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(cardano-services): stake pool search http server
setup http server. add mainly queries to implement stake pool search add filters to DbSyncStakePoolSearchProvider queries tipify queries and create data mappers handle partial searches in stake pool search adapt stake pool search http server to generic http provider client
- Loading branch information
Juan Cruz
committed
Apr 20, 2022
1 parent
131f234
commit c3dd013
Showing
16 changed files
with
1,487 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
258 changes: 258 additions & 0 deletions
258
...rdano-services/src/StakePoolSearch/DbSyncStakePoolSearchProvider/DbSyncStakePoolSearch.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,258 @@ | ||
| /* eslint-disable sonarjs/no-nested-template-literals */ | ||
| import { Cardano, MultipleChoiceSearchFilter, StakePoolQueryOptions, StakePoolSearchProvider } from '@cardano-sdk/core'; | ||
| import { | ||
| EpochModel, | ||
| // EpochRewardModel, | ||
| OwnerAddressModel, | ||
| PoolDataModel, | ||
| PoolRegistrationModel, | ||
| PoolRetirementModel, | ||
| PoolUpdateModel, | ||
| RelayModel, | ||
| SubQuery | ||
| } from './types'; | ||
| import { Logger, dummyLogger } from 'ts-log'; | ||
| import { Pool, QueryResult } from 'pg'; | ||
| import { | ||
| mapAddressOwner, | ||
| // mapEpochReward, | ||
| mapPoolData, | ||
| mapPoolRegistration, | ||
| mapPoolRetirement, | ||
| mapPoolUpdate, | ||
| mapRelay, | ||
| toCoreStakePool | ||
| } from './mappers'; | ||
| import Queries, { | ||
| addSentenceToQuery, | ||
| buildOrQueryFromClauses, | ||
| findLastEpoch, | ||
| getIdentifierWhereClause, | ||
| getStatusWhereClause, | ||
| poolsByPledgeMetSubqueries, | ||
| withPagination | ||
| } from './queries'; | ||
|
|
||
| export class DbSyncStakePoolSearchProvider implements StakePoolSearchProvider { | ||
| #db: Pool; | ||
| #logger: Logger; | ||
|
|
||
| constructor(db: Pool, logger = dummyLogger) { | ||
| this.#logger = logger; | ||
| this.#db = db; | ||
| } | ||
|
|
||
| private async queryRetirements(hashesIds: number[]) { | ||
| this.#logger.debug('About to query pool retirements'); | ||
| const result: QueryResult<PoolRetirementModel> = await this.#db.query(Queries.findPoolsRetirements, [hashesIds]); | ||
| return result.rows.length > 0 ? result.rows.map(mapPoolRetirement) : []; | ||
| } | ||
| private async queryRegistrations(hashesIds: number[]) { | ||
| this.#logger.debug('About to query pool registrations'); | ||
| const result: QueryResult<PoolRegistrationModel> = await this.#db.query(Queries.findPoolsRegistrations, [ | ||
| hashesIds | ||
| ]); | ||
| return result.rows.length > 0 ? result.rows.map(mapPoolRegistration) : []; | ||
| } | ||
| private async queryPoolRelays(updatesIds: number[]) { | ||
| this.#logger.debug('About to query pool relays'); | ||
| const result: QueryResult<RelayModel> = await this.#db.query(Queries.findPoolsRelays, [updatesIds]); | ||
| return result.rows.length > 0 ? result.rows.map(mapRelay) : []; | ||
| } | ||
| private async queryPoolOwners(hashesIds: number[]) { | ||
| this.#logger.debug('About to query pool owners'); | ||
| const result: QueryResult<OwnerAddressModel> = await this.#db.query(Queries.findPoolsOwners, [hashesIds]); | ||
| return result.rows.length > 0 ? result.rows.map(mapAddressOwner) : []; | ||
| } | ||
| // private async queryPoolRewards(hashesIds: number[], limit?: number) { | ||
| // const params: [number[] | number] = [hashesIds]; | ||
| // if (limit) params.push(limit); | ||
| // // TODO: fetch necessary data to build Cardano.StakePoolEpochRewards | ||
| // const result: QueryResult<EpochRewardModel> = await this.#db.query( | ||
| // ` | ||
| // WITH pool_epoch_reward as ( | ||
| // SELECT | ||
| // COUNT(r.amount) as total_rewards, | ||
| // pool_id, | ||
| // r.spendable_epoch as epoch | ||
| // FROM reward r | ||
| // WHERE pool_id IN $1 | ||
| // GROUP BY pool_id, spendable_epoch | ||
| // ORDER BY spendable_epoch DESC | ||
| // ${limit ? 'LIMIT = $2' : ''} | ||
| // ) | ||
| // SELECT | ||
| // per.*, | ||
| // epoch.blk_count | ||
| // FROM pool_epoch_reward per | ||
| // JOIN epoch | ||
| // ON epoch."no" = per.epoch; | ||
| // `, | ||
| // params | ||
| // ); | ||
| // return result.rows.length > 0 ? result.rows.map(mapEpochReward) : []; | ||
| // } | ||
| private async queryPoolData(updatesIds: number[]) { | ||
| this.#logger.debug('About to query pool data'); | ||
| const result: QueryResult<PoolDataModel> = await this.#db.query(Queries.findPoolsData, [updatesIds]); | ||
| return result.rows.length > 0 ? result.rows.map(mapPoolData) : []; | ||
| } | ||
| // eslint-disable-next-line @typescript-eslint/no-explicit-any | ||
| private async queryPoolHashes(query: string, options?: StakePoolQueryOptions, params: any[] = []) { | ||
| const queryWithPagination = withPagination(query, options?.pagination); | ||
| const result: QueryResult<PoolUpdateModel> = await this.#db.query(queryWithPagination, params); | ||
| return result.rows.length > 0 ? result.rows.map(mapPoolUpdate) : []; | ||
| } | ||
| private buildPoolsByIdentifierQuery( | ||
| identifier: MultipleChoiceSearchFilter< | ||
| Partial<Pick<Cardano.PoolParameters, 'id'> & Pick<Cardano.StakePoolMetadata, 'name' | 'ticker'>> | ||
| > | ||
| ) { | ||
| const { where, params } = getIdentifierWhereClause(identifier); | ||
| const whereClause = 'WHERE '.concat(where); | ||
| const query = ` | ||
| ${Queries.IDENTIFIER_QUERY.SELECT_CLAUSE} | ||
| ${Queries.IDENTIFIER_QUERY.JOIN_CLAUSE.POOL_UPDATE} | ||
| ${Queries.IDENTIFIER_QUERY.JOIN_CLAUSE.OFFLINE_METADATA} | ||
| ${whereClause} | ||
| `; | ||
| return { id: { isPrimary: true, name: 'pools_by_identifier' }, params, query }; | ||
| } | ||
| private buildPoolsByStatusQuery(status: Cardano.StakePoolStatus[]) { | ||
| const whereClause = getStatusWhereClause(status); | ||
| const query = ` | ||
| ${Queries.STATUS_QUERY.SELECT_CLAUSE} | ||
| WHERE ${whereClause} | ||
| `; | ||
| return { id: { isPrimary: true, name: 'pools_by_status' }, query }; | ||
| } | ||
| private buildPoolsByPledgeMetQuery(pledgeMet: boolean) { | ||
| const subQueries = [...poolsByPledgeMetSubqueries]; | ||
| subQueries.push({ | ||
| id: { isPrimary: true, name: 'pools_by_pledge_met' }, | ||
| query: ` | ||
| ${Queries.POOLS_WITH_PLEDGE_MET.SELECT_CLAUSE} | ||
| ${Queries.POOLS_WITH_PLEDGE_MET.JOIN_CLAUSE} | ||
| WHERE ${Queries.POOLS_WITH_PLEDGE_MET.WHERE_CLAUSE(pledgeMet)}` | ||
| }); | ||
| return subQueries; | ||
| } | ||
| private async getLastEpoch() { | ||
| this.#logger.debug('About to query last epoch'); | ||
| const result: QueryResult<EpochModel> = await this.#db.query(Queries.findLastEpoch); | ||
| return result.rows[0].no; | ||
| } | ||
| private async buildOrQuery(filters: StakePoolQueryOptions['filters']) { | ||
| const subQueries: SubQuery[] = []; | ||
| const params = []; | ||
| let query = Queries.findPools; | ||
| if (filters?.identifier) { | ||
| const { id: _id, query: _query, params: _params } = this.buildPoolsByIdentifierQuery(filters.identifier); | ||
| subQueries.push({ id: _id, query: _query }); | ||
| params.push(..._params); | ||
| } | ||
| if (filters?.status) { | ||
| const statusResult = this.buildPoolsByStatusQuery(filters.status); | ||
| subQueries.push(statusResult); | ||
| } | ||
| if (filters?.pledgeMet !== undefined) { | ||
| const pledgeMetResult = this.buildPoolsByPledgeMetQuery(filters.pledgeMet); | ||
| subQueries.push(...pledgeMetResult); | ||
| } | ||
| if (filters?.identifier || filters?.pledgeMet !== undefined) | ||
| subQueries.unshift({ id: { name: 'current_epoch' }, query: findLastEpoch }); | ||
| if (subQueries.length > 0) { | ||
| query = | ||
| subQueries.length > 1 | ||
| ? buildOrQueryFromClauses(subQueries) | ||
| : `${subQueries.length > 1 ? `WITH (${subQueries.find((sq) => !sq.id.isPrimary)})` : ''} ${ | ||
| subQueries[0].query | ||
| } `; | ||
| } | ||
| return { params, query }; | ||
| } | ||
| private async buildAndQuery(filters: StakePoolQueryOptions['filters']) { | ||
| let query = Queries.findPools; | ||
| const params = []; | ||
| const whereClause = []; | ||
| if (filters?.pledgeMet !== undefined) { | ||
| const { WITH_CLAUSE, SELECT_CLAUSE, JOIN_CLAUSE, WHERE_CLAUSE } = Queries.POOLS_WITH_PLEDGE_MET; | ||
| query = WITH_CLAUSE + SELECT_CLAUSE + JOIN_CLAUSE; | ||
| whereClause.push(WHERE_CLAUSE(filters.pledgeMet)); | ||
| if (filters.identifier) { | ||
| query = addSentenceToQuery( | ||
| query, | ||
| `${Queries.IDENTIFIER_QUERY.JOIN_CLAUSE.POOL_UPDATE} | ||
| ${Queries.IDENTIFIER_QUERY.JOIN_CLAUSE.OFFLINE_METADATA}` | ||
| ); | ||
| const { where, params: identifierParams } = getIdentifierWhereClause(filters.identifier); | ||
| whereClause.push(where); | ||
| params.push(...identifierParams); | ||
| } | ||
| if (filters.status) { | ||
| query = addSentenceToQuery( | ||
| query, | ||
| ` | ||
| LEFT JOIN pool_retire pr ON | ||
| pr.id = ( | ||
| SELECT id | ||
| FROM pool_retire pr2 | ||
| WHERE pr2.hash_id = ph.id | ||
| ORDER BY id desc | ||
| LIMIT 1 | ||
| ) | ||
| ` | ||
| ); | ||
| whereClause.push(getStatusWhereClause(filters.status, { activeEpoch: 'ph.active_epoch_no' })); | ||
| } | ||
| } else if (filters?.status) { | ||
| query = `${Queries.STATUS_QUERY.WITH_CLAUSE} ${Queries.STATUS_QUERY.SELECT_CLAUSE}`; | ||
| whereClause.push(getStatusWhereClause(filters.status)); | ||
| if (filters?.identifier) { | ||
| query = addSentenceToQuery(query, Queries.IDENTIFIER_QUERY.JOIN_CLAUSE.OFFLINE_METADATA); | ||
| const { where, params: identifierParams } = getIdentifierWhereClause(filters.identifier); | ||
| whereClause.push(where); | ||
| params.push(...identifierParams); | ||
| } | ||
| } else if (filters?.identifier) { | ||
| const { where, params: identifierParams } = getIdentifierWhereClause(filters.identifier); | ||
| query = ` | ||
| ${Queries.IDENTIFIER_QUERY.SELECT_CLAUSE} | ||
| ${Queries.IDENTIFIER_QUERY.JOIN_CLAUSE} | ||
| WHERE ${where} | ||
| `; | ||
| params.push(...identifierParams); | ||
| } | ||
| if (whereClause.length > 0) query = addSentenceToQuery(query, ` WHERE ${whereClause.join(' AND ')}`); | ||
| return { params, query }; | ||
| } | ||
| public async queryStakePools(options?: StakePoolQueryOptions): Promise<Cardano.StakePool[]> { | ||
| const { params, query } = | ||
| options?.filters?._condition === 'or' | ||
| ? await this.buildOrQuery(options?.filters) | ||
| : await this.buildAndQuery(options?.filters); | ||
| this.#logger.debug('About to query pool hashes'); | ||
| const poolUpdates = await this.queryPoolHashes(query, options, params); | ||
| const hashesIds = poolUpdates.map(({ id }) => id); | ||
| this.#logger.debug(`${hashesIds.length} pools found`); | ||
| const updatesIds = poolUpdates.map(({ updateId }) => updateId); | ||
| const [poolDatas, poolRelays, poolOwners, poolRegistrations, poolRetirements, lastEpoch] = await Promise.all([ | ||
| this.queryPoolData(updatesIds), | ||
| this.queryPoolRelays(updatesIds), | ||
| this.queryPoolOwners(hashesIds), | ||
| this.queryRegistrations(hashesIds), | ||
| this.queryRetirements(hashesIds), | ||
| this.getLastEpoch() | ||
| ]); | ||
| // const rewards = await this.queryPoolRewards(hashesIds, options?.rewardsHistoryLimit); | ||
|
|
||
| return toCoreStakePool({ | ||
| lastEpoch, | ||
| poolDatas, | ||
| poolOwners, | ||
| poolRegistrations, | ||
| poolRelays, | ||
| poolRetirements | ||
| }); | ||
| } | ||
| } |
3 changes: 3 additions & 0 deletions
3
packages/cardano-services/src/StakePoolSearch/DbSyncStakePoolSearchProvider/index.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| export * from './DbSyncStakePoolSearch'; | ||
| export * from './mappers'; | ||
| export * from './types'; |
Oops, something went wrong.