Class StakePoolBuilder

Hierarchy

StakePoolBuilder

Constructors

constructor

new StakePoolBuilder(db: Pool, logger: Logger): StakePoolBuilder
Parameters
- db: Pool
- logger: Logger
Returns StakePoolBuilder
- Defined in packages/cardano-services/src/StakePool/DbSyncStakePoolProvider/StakePoolBuilder.ts:59

Properties

`Private` #db

#db: Pool

`Private` #logger

#logger: Logger

Methods

buildAndQuery

buildAndQuery(filters: undefined | {
    _condition?: FilterCondition;
    identifier?: MultipleChoiceSearchFilter<Partial<Pick<PoolParameters, "id"> & Pick<StakePoolMetadata, "ticker" | "name">>>;
    pledgeMet?: boolean;
    status?: StakePoolStatus[];
    text?: string;
}): {
    params: string[];
    query: string;
}
Parameters
- filters: undefined | {
      _condition?: FilterCondition;
      identifier?: MultipleChoiceSearchFilter<Partial<Pick<PoolParameters, "id"> & Pick<StakePoolMetadata, "ticker" | "name">>>;
      pledgeMet?: boolean;
      status?: StakePoolStatus[];
      text?: string;
  }
Returns {
params: string[];
query: string;
}
- params: string[]
- query: string
- Defined in packages/cardano-services/src/StakePool/DbSyncStakePoolProvider/StakePoolBuilder.ts:229

buildBlockfrostQuery

buildBlockfrostQuery(filters: undefined | {
    _condition?: FilterCondition;
    identifier?: MultipleChoiceSearchFilter<Partial<Pick<PoolParameters, "id"> & Pick<StakePoolMetadata, "ticker" | "name">>>;
    pledgeMet?: boolean;
    status?: StakePoolStatus[];
    text?: string;
}): {
    params: string[];
    query: string;
}
Parameters
- filters: undefined | {
      _condition?: FilterCondition;
      identifier?: MultipleChoiceSearchFilter<Partial<Pick<PoolParameters, "id"> & Pick<StakePoolMetadata, "ticker" | "name">>>;
      pledgeMet?: boolean;
      status?: StakePoolStatus[];
      text?: string;
  }
Returns {
params: string[];
query: string;
}
- params: string[]
- query: string
- Defined in packages/cardano-services/src/StakePool/DbSyncStakePoolProvider/StakePoolBuilder.ts:293

buildOrQuery

buildOrQuery(filters: undefined | {
    _condition?: FilterCondition;
    identifier?: MultipleChoiceSearchFilter<Partial<Pick<PoolParameters, "id"> & Pick<StakePoolMetadata, "ticker" | "name">>>;
    pledgeMet?: boolean;
    status?: StakePoolStatus[];
    text?: string;
}): {
    params: string[];
    query: string;
}
Parameters
- filters: undefined | {
      _condition?: FilterCondition;
      identifier?: MultipleChoiceSearchFilter<Partial<Pick<PoolParameters, "id"> & Pick<StakePoolMetadata, "ticker" | "name">>>;
      pledgeMet?: boolean;
      status?: StakePoolStatus[];
      text?: string;
  }
Returns {
params: string[];
query: string;
}
- params: string[]
- query: string
- Defined in packages/cardano-services/src/StakePool/DbSyncStakePoolProvider/StakePoolBuilder.ts:203

buildPoolsByIdentifierQuery

buildPoolsByIdentifierQuery(identifier: MultipleChoiceSearchFilter<Partial<Pick<PoolParameters, "id"> & Pick<StakePoolMetadata, "ticker" | "name">>>): {
    id: {
        isPrimary: boolean;
        name: string;
    };
    params: string[];
    query: string;
}
Parameters
- identifier: MultipleChoiceSearchFilter<Partial<Pick<PoolParameters, "id"> & Pick<StakePoolMetadata, "ticker" | "name">>>
Returns {
    id: {
        isPrimary: boolean;
        name: string;
    };
    params: string[];
    query: string;
}
- id: {
  isPrimary: boolean;
  name: string;
  }
  - isPrimary: boolean
  - name: string
- params: string[]
- query: string
- Defined in packages/cardano-services/src/StakePool/DbSyncStakePoolProvider/StakePoolBuilder.ts:147

buildPoolsByPledgeMetQuery

buildPoolsByPledgeMetQuery(pledgeMet: boolean): SubQuery[]
Parameters
- pledgeMet: boolean
Returns SubQuery[]
- Defined in packages/cardano-services/src/StakePool/DbSyncStakePoolProvider/StakePoolBuilder.ts:172

buildPoolsByStatusQuery

buildPoolsByStatusQuery(status: StakePoolStatus[]): {
    id: {
        isPrimary: boolean;
        name: string;
    };
    query: string;
}
Parameters
- status: StakePoolStatus[]
Returns {
    id: {
        isPrimary: boolean;
        name: string;
    };
    query: string;
}
- id: {
  isPrimary: boolean;
  name: string;
  }
  - isPrimary: boolean
  - name: string
- query: string
- Defined in packages/cardano-services/src/StakePool/DbSyncStakePoolProvider/StakePoolBuilder.ts:163

getLastEpoch

getLastEpoch(): Promise<number>
Returns Promise<number>
- Defined in packages/cardano-services/src/StakePool/DbSyncStakePoolProvider/StakePoolBuilder.ts:184

getLastEpochWithData

getLastEpochWithData(): Promise<Epoch>
Returns Promise<Epoch>
- Defined in packages/cardano-services/src/StakePool/DbSyncStakePoolProvider/StakePoolBuilder.ts:195

queryPoolAPY

queryPoolAPY(hashesIds: number[], epochLength: number, options?: Partial<QueryStakePoolsArgs>): Promise<PoolAPY[]>
Parameters
- hashesIds: number[]
- epochLength: number
- Optional options: Partial<QueryStakePoolsArgs>
Returns Promise<PoolAPY[]>
- Defined in packages/cardano-services/src/StakePool/DbSyncStakePoolProvider/StakePoolBuilder.ts:90

queryPoolData

queryPoolData(updatesIds: number[], useBlockfrost: boolean, options?: QueryStakePoolsArgs): Promise<PoolData[]>
Parameters
- updatesIds: number[]
- useBlockfrost: boolean
- Optional options: QueryStakePoolsArgs
Returns Promise<PoolData[]>
- Defined in packages/cardano-services/src/StakePool/DbSyncStakePoolProvider/StakePoolBuilder.ts:101

queryPoolHashes

queryPoolHashes(query: string, params?: any[]): Promise<PoolUpdate[]>
Parameters
- query: string
- params: any[] = []
Returns Promise<PoolUpdate[]>
- Defined in packages/cardano-services/src/StakePool/DbSyncStakePoolProvider/StakePoolBuilder.ts:118

queryPoolMetrics

queryPoolMetrics(hashesIds: number[], totalStake: null | string, useBlockfrost: boolean, options?: QueryStakePoolsArgs): Promise<PoolMetrics[]>
Parameters
- hashesIds: number[]
- totalStake: null | string
- useBlockfrost: boolean
- Optional options: QueryStakePoolsArgs
Returns Promise<PoolMetrics[]>
- Defined in packages/cardano-services/src/StakePool/DbSyncStakePoolProvider/StakePoolBuilder.ts:124

queryPoolOwners

queryPoolOwners(updatesIds: number[]): Promise<PoolOwner[]>
Parameters
- updatesIds: number[]
Returns Promise<PoolOwner[]>
- Defined in packages/cardano-services/src/StakePool/DbSyncStakePoolProvider/StakePoolBuilder.ts:84

queryPoolRelays

queryPoolRelays(updatesIds: number[]): Promise<PoolRelay[]>
Parameters
- updatesIds: number[]
Returns Promise<PoolRelay[]>
- Defined in packages/cardano-services/src/StakePool/DbSyncStakePoolProvider/StakePoolBuilder.ts:78

queryPoolStats

queryPoolStats(): Promise<StakePoolStats>
Returns Promise<StakePoolStats>
- Defined in packages/cardano-services/src/StakePool/DbSyncStakePoolProvider/StakePoolBuilder.ts:285

queryRegistrations

queryRegistrations(hashesIds: number[]): Promise<PoolRegistration[]>
Parameters
- hashesIds: number[]
Returns Promise<PoolRegistration[]>
- Defined in packages/cardano-services/src/StakePool/DbSyncStakePoolProvider/StakePoolBuilder.ts:70

queryRetirements

queryRetirements(hashesIds: number[]): Promise<PoolRetirement[]>
Parameters
- hashesIds: number[]
Returns Promise<PoolRetirement[]>
- Defined in packages/cardano-services/src/StakePool/DbSyncStakePoolProvider/StakePoolBuilder.ts:64

Class StakePoolBuilder

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

db: Pool

logger: Logger

Returns StakePoolBuilder

Properties

Private #db

Private #logger

Methods

buildAndQuery

Parameters

filters: undefined | { _condition?: FilterCondition; identifier?: MultipleChoiceSearchFilter<Partial<Pick<PoolParameters, "id"> & Pick<StakePoolMetadata, "ticker" | "name">>>; pledgeMet?: boolean; status?: StakePoolStatus[]; text?: string; }

Returns { params: string[]; query: string; }

params: string[]

query: string

buildBlockfrostQuery

Parameters

filters: undefined | { _condition?: FilterCondition; identifier?: MultipleChoiceSearchFilter<Partial<Pick<PoolParameters, "id"> & Pick<StakePoolMetadata, "ticker" | "name">>>; pledgeMet?: boolean; status?: StakePoolStatus[]; text?: string; }

Returns { params: string[]; query: string; }

params: string[]

query: string

buildOrQuery

Parameters

filters: undefined | { _condition?: FilterCondition; identifier?: MultipleChoiceSearchFilter<Partial<Pick<PoolParameters, "id"> & Pick<StakePoolMetadata, "ticker" | "name">>>; pledgeMet?: boolean; status?: StakePoolStatus[]; text?: string; }

Returns { params: string[]; query: string; }

params: string[]

query: string

buildPoolsByIdentifierQuery

Parameters

identifier: MultipleChoiceSearchFilter<Partial<Pick<PoolParameters, "id"> & Pick<StakePoolMetadata, "ticker" | "name">>>

Returns { id: { isPrimary: boolean; name: string; }; params: string[]; query: string; }

id: { isPrimary: boolean; name: string; }

isPrimary: boolean

name: string

params: string[]

query: string

buildPoolsByPledgeMetQuery

Parameters

pledgeMet: boolean

Returns SubQuery[]

buildPoolsByStatusQuery

Parameters

status: StakePoolStatus[]

Returns { id: { isPrimary: boolean; name: string; }; query: string; }

id: { isPrimary: boolean; name: string; }

isPrimary: boolean

name: string

query: string

getLastEpoch

Returns Promise<number>

getLastEpochWithData

Returns Promise<Epoch>

queryPoolAPY

Parameters

hashesIds: number[]

epochLength: number

Optional options: Partial<QueryStakePoolsArgs>

Returns Promise<PoolAPY[]>

queryPoolData

Parameters

updatesIds: number[]

useBlockfrost: boolean

Optional options: QueryStakePoolsArgs

Returns Promise<PoolData[]>

queryPoolHashes

Parameters

query: string

params: any[] = []

Returns Promise<PoolUpdate[]>

queryPoolMetrics

Parameters

hashesIds: number[]

totalStake: null | string

`Private` #db

`Private` #logger

filters: undefined | {
_condition?: FilterCondition;
identifier?: MultipleChoiceSearchFilter<Partial<Pick<PoolParameters, "id"> & Pick<StakePoolMetadata, "ticker" | "name">>>;
pledgeMet?: boolean;
status?: StakePoolStatus[];
text?: string;
}

Returns {
params: string[];
query: string;
}

filters: undefined | {
_condition?: FilterCondition;
identifier?: MultipleChoiceSearchFilter<Partial<Pick<PoolParameters, "id"> & Pick<StakePoolMetadata, "ticker" | "name">>>;
pledgeMet?: boolean;
status?: StakePoolStatus[];
text?: string;
}

Returns {
params: string[];
query: string;
}

filters: undefined | {
_condition?: FilterCondition;
identifier?: MultipleChoiceSearchFilter<Partial<Pick<PoolParameters, "id"> & Pick<StakePoolMetadata, "ticker" | "name">>>;
pledgeMet?: boolean;
status?: StakePoolStatus[];
text?: string;
}

Returns {
params: string[];
query: string;
}

Returns {
id: {
isPrimary: boolean;
name: string;
};
params: string[];
query: string;
}

id: {
isPrimary: boolean;
name: string;
}

Returns {
id: {
isPrimary: boolean;
name: string;
};
query: string;
}

id: {
isPrimary: boolean;
name: string;
}

`Optional` options: Partial<QueryStakePoolsArgs>

`Optional` options: QueryStakePoolsArgs

`Optional` options: QueryStakePoolsArgs