Interface IPITokenClient

Interface for interacting with a specific PI token process.

interface IPITokenClient {
    getBalance(target?: string): Promise<string>;
    getClaimableBalance(): Promise<string>;
    getInfo(): Promise<DryRunResult>;
    getTickHistory(): Promise<string>;
    parseTickHistory(tickHistoryData: string): TickHistoryEntry[];
}

Implemented by

PITokenClient

Index

Methods

getBalance getClaimableBalance getInfo getTickHistory parseTickHistory

Methods

getBalance

getBalance(target?: string): Promise<string>
Gets the balance from the PI token process.
Parameters
- Optionaltarget: string
  Optional target wallet address. If not provided, uses the calling wallet address.
Returns Promise<string>
Promise resolving to the balance as a string
- Defined in clients/pi/PIToken/abstract/IPITokenClient.ts:85

getClaimableBalance

getClaimableBalance(): Promise<string>
Gets the claimable balance from the PI token process.

Returns Promise<string>
Promise resolving to the claimable balance as a string
- Defined in clients/pi/PIToken/abstract/IPITokenClient.ts:91

getInfo

getInfo(): Promise<DryRunResult>
Gets information about the PI token process.

Returns Promise<DryRunResult>
Promise resolving to a DryRunResult with token information
- Defined in clients/pi/PIToken/abstract/IPITokenClient.ts:72

getTickHistory

getTickHistory(): Promise<string>
Gets yield tick history information.

Returns Promise<string>
Promise resolving to tick history data as a string
- Defined in clients/pi/PIToken/abstract/IPITokenClient.ts:78

parseTickHistory

parseTickHistory(tickHistoryData: string): TickHistoryEntry[]
Parse the raw tick history string into a structured array
Parameters
- tickHistoryData: string
  Raw tick history data string
Returns TickHistoryEntry[]
Parsed tick history entries
- Defined in clients/pi/PIToken/abstract/IPITokenClient.ts:98