Interface IFairLaunchProcessClient

Interface for interacting with a Fair Launch Process.

interface IFairLaunchProcessClient {
    getAoProceeds(): Promise<ProceedsData>;
    getInfo(): Promise<FairLaunchInfo>;
    getPiProceeds(): Promise<ProceedsData>;
    getWithdrawableAo(time?: number): Promise<string>;
    getWithdrawablePi(time?: number): Promise<string>;
    withdrawAo(): Promise<any>;
    withdrawPi(): Promise<any>;
}

Implemented by

FairLaunchProcessClient

Index

Methods

getAoProceeds getInfo getPiProceeds getWithdrawableAo getWithdrawablePi withdrawAo withdrawPi

Methods

getAoProceeds

getAoProceeds(): Promise<ProceedsData>
Gets AO proceeds data for all yield cycles.

Returns Promise<ProceedsData>
Promise resolving to proceeds data indexed by yield cycle
- Defined in clients/pi/fair-launch-process/abstract/IFairLaunchProcessClient.ts:45

getInfo

getInfo(): Promise<FairLaunchInfo>
Gets information about the Fair Launch Process.

Returns Promise<FairLaunchInfo>
Promise resolving to a DryRunResult with process information
- Defined in clients/pi/fair-launch-process/abstract/IFairLaunchProcessClient.ts:11

getPiProceeds

getPiProceeds(): Promise<ProceedsData>
Gets PI proceeds data for all yield cycles.

Returns Promise<ProceedsData>
Promise resolving to proceeds data indexed by yield cycle
- Defined in clients/pi/fair-launch-process/abstract/IFairLaunchProcessClient.ts:51

getWithdrawableAo

getWithdrawableAo(time?: number): Promise<string>
Gets the withdrawable AO amount for a specific time.
Parameters
- Optionaltime: number
  Optional timestamp to check withdrawable amount at (defaults to current time)
Returns Promise<string>
Promise resolving to withdrawable AO amount as string
- Defined in clients/pi/fair-launch-process/abstract/IFairLaunchProcessClient.ts:18

getWithdrawablePi

getWithdrawablePi(time?: number): Promise<string>
Gets the withdrawable PI amount for a specific time.
Parameters
- Optionaltime: number
  Optional timestamp to check withdrawable amount at (defaults to current time)
Returns Promise<string>
Promise resolving to withdrawable PI amount as string
- Defined in clients/pi/fair-launch-process/abstract/IFairLaunchProcessClient.ts:25

withdrawAo

withdrawAo(): Promise<any>
Withdraws available AO tokens to the treasury. Only the deployer can perform this action.

Returns Promise<any>
Promise resolving to the withdrawal result
- Defined in clients/pi/fair-launch-process/abstract/IFairLaunchProcessClient.ts:32

withdrawPi

withdrawPi(): Promise<any>
Withdraws available PI tokens to the treasury. Only the deployer can perform this action.

Returns Promise<any>
Promise resolving to the withdrawal result
- Defined in clients/pi/fair-launch-process/abstract/IFairLaunchProcessClient.ts:39