Interface IPIDelegateClient

Interface for interacting with the PI delegate process.

interface IPIDelegateClient {
    getDelegation(walletAddress?: string): Promise<string>;
    getInfo(): Promise<DryRunResult>;
    parseDelegationInfo(delegationData: string): DelegationInfo;
    setDelegation(options: SetDelegationOptions): Promise<string>;
}

Implemented by

PIDelegateClient

Index

Methods

getDelegation getInfo parseDelegationInfo setDelegation

Methods

getDelegation

getDelegation(walletAddress?: string): Promise<string>
Gets delegation information for the specified wallet.
Parameters
- OptionalwalletAddress: string
  Optional wallet address to get delegations for. If not provided, uses the wallet specified in the configuration.
Returns Promise<string>
Promise resolving to delegation information details
- Defined in clients/pi/delegate/abstract/IPIDelegateClient.ts:48

getInfo

getInfo(): Promise<DryRunResult>
Gets information from the delegate process.

Returns Promise<DryRunResult>
Promise resolving to a DryRunResult with delegation information
- Defined in clients/pi/delegate/abstract/IPIDelegateClient.ts:41

parseDelegationInfo

parseDelegationInfo(delegationData: string): DelegationInfo
Parse the raw delegation info string into a structured object
Parameters
- delegationData: string
  Raw delegation data string
Returns DelegationInfo
Parsed delegation information
- Defined in clients/pi/delegate/abstract/IPIDelegateClient.ts:62

setDelegation

setDelegation(options: SetDelegationOptions): Promise<string>
Sets delegation preferences for the specified wallet.
Parameters
- options: SetDelegationOptions
  Options for setting delegation preferences including wallet address, delegation preferences, and total factor
Returns Promise<string>
Promise resolving to a string with the result of the operation
- Defined in clients/pi/delegate/abstract/IPIDelegateClient.ts:55