Interface IPIService

Interface for the PI Service

interface IPIService {
    createClientPairByTicker(
        ticker: string,
    ): Promise<undefined | [PITokenClient, TokenClient]>;
    getAllPITokens(): Promise<PITokenExtended[]>;
    getDelegationHistory(count: number): Promise<DelegationRecord[]>;
    getPITokenByProcessId(
        processId: string,
    ): Promise<undefined | PITokenExtended>;
    getPITokenByTicker(ticker: string): Promise<undefined | PITokenExtended>;
    getTotalDelegatedAOByProject(): Promise<ProjectDelegationTotal[]>;
    getUserDelegations(walletAddress?: string): Promise<DelegationInfo>;
    setDelegation(
        walletFrom: string,
        walletTo: string,
        factor: number,
    ): Promise<string>;
}

Implemented by

PIService

Index

Methods

createClientPairByTicker getAllPITokens getDelegationHistory getPITokenByProcessId getPITokenByTicker getTotalDelegatedAOByProject getUserDelegations setDelegation

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
- Defined in services/pi/abstract/IPIService.ts:105

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
- Defined in services/pi/abstract/IPIService.ts:55

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
- Defined in services/pi/abstract/IPIService.ts:92

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
- Defined in services/pi/abstract/IPIService.ts:69

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
- Defined in services/pi/abstract/IPIService.ts:62

getTotalDelegatedAOByProject

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

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

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
- Defined in services/pi/abstract/IPIService.ts:76

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
- Defined in services/pi/abstract/IPIService.ts:85