Class PIService

Service for combining PI-related functionality

Implements

IPIService

Index

Constructors

Methods

createClientPairByTicker getAllPITokens getDelegationHistory getPITokenByProcessId getPITokenByTicker getTotalDelegatedAOByProject getUserDelegations setDelegation autoConfiguration

Constructors

constructor

new PIService(
    oracleClient: PIOracleClient,
    delegateClient: PIDelegateClient,
    historianClient: DelegationHistorianClient,
): PIService
Parameters
- oracleClient: PIOracleClient
- delegateClient: PIDelegateClient
- historianClient: DelegationHistorianClient
Returns PIService
- Defined in services/pi/PIService.ts:19

Methods

createClientPairByTicker

createClientPairByTicker(
ticker: string,
): Promise<undefined | [PITokenClient, TokenClient]>
Creates token client pairs for a specific token by ticker
Parameters
- ticker: string
  The ticker symbol of the token
Returns Promise<undefined | [PITokenClient, TokenClient]>
Promise resolving to a tuple containing PITokenClient and TokenClient
Implementation of IPIService.createClientPairByTicker
- Defined in services/pi/PIService.ts:218

getAllPITokens

getAllPITokens(): Promise<PITokenExtended[]>
Gets all available PI tokens with extended information

Returns Promise<PITokenExtended[]>
Promise resolving to an array of PI tokens with extended information
Implementation of IPIService.getAllPITokens
- Defined in services/pi/PIService.ts:41

getDelegationHistory

getDelegationHistory(count: number): Promise<DelegationRecord[]>
Gets historical delegation records
Parameters
- count: number
  Number of records to fetch
Returns Promise<DelegationRecord[]>
Promise resolving to an array of delegation records
Implementation of IPIService.getDelegationHistory
- Defined in services/pi/PIService.ts:191

getPITokenByProcessId

getPITokenByProcessId(processId: string): Promise<undefined | PITokenExtended>
Gets a specific PI token by process ID
Parameters
- processId: string
  The process ID of the token
Returns Promise<undefined | PITokenExtended>
Promise resolving to a PI token with extended information
Implementation of IPIService.getPITokenByProcessId
- Defined in services/pi/PIService.ts:131

getPITokenByTicker

getPITokenByTicker(ticker: string): Promise<undefined | PITokenExtended>
Gets a specific PI token by ticker
Parameters
- ticker: string
  The ticker symbol of the token
Returns Promise<undefined | PITokenExtended>
Promise resolving to a PI token with extended information
Implementation of IPIService.getPITokenByTicker
- Defined in services/pi/PIService.ts:113

getTotalDelegatedAOByProject

getTotalDelegatedAOByProject(): Promise<ProjectDelegationTotal[]>
Gets the total delegated AO by project

Returns Promise<ProjectDelegationTotal[]>
Promise resolving to an array of project delegation totals
Implementation of IPIService.getTotalDelegatedAOByProject
- Defined in services/pi/PIService.ts:204

getUserDelegations

getUserDelegations(walletAddress?: string): Promise<DelegationInfo>
Gets delegation information for the current wallet
Parameters
- OptionalwalletAddress: string
  Optional wallet address to get delegations for
Returns Promise<DelegationInfo>
Promise resolving to delegation information
Implementation of IPIService.getUserDelegations
- Defined in services/pi/PIService.ts:150

setDelegation

setDelegation(
    walletFrom: string,
    walletTo: string,
    factor: number,
): Promise<string>
Sets a delegation preference
Parameters
- walletFrom: string
  The wallet address from which the delegation is made
- walletTo: string
  The wallet address to delegate to
- factor: number
  The factor value representing delegation strength
Returns Promise<string>
Promise resolving to a string with the result of the operation
Implementation of IPIService.setDelegation
- Defined in services/pi/PIService.ts:173

`Static`autoConfiguration

autoConfiguration(): Promise<IPIService>
Returns Promise<IPIService>
See
IAutoconfiguration.autoConfiguration
- Defined in services/pi/PIService.ts:29