Class FairLaunchProcessClient

Client for interacting with a Fair Launch Process.

Hierarchy

BaseClient
- FairLaunchProcessClient

Implements

IFairLaunchProcessClient

Constructors

constructor

new FairLaunchProcessClient(
baseConfig: BaseClientConfig,
): FairLaunchProcessClient
Parameters
- baseConfig: BaseClientConfig
Returns FairLaunchProcessClient
Inherited from BaseClient.constructor
- Defined in core/ao/BaseClient.ts:36

Properties

`Protected` `Readonly`baseConfig

baseConfig: BaseClientConfig

Methods

`Protected`_dryrun

_dryrun(
    data?: any,
    tags?: Tags,
    anchor?: string,
    id?: string,
    owner?: string,
): Promise<DryRunResult>
Parameters
- data: any = ''
- tags: Tags = []
- Optionalanchor: string
- Optionalid: string
- Optionalowner: string
Returns Promise<DryRunResult>
Inherited from BaseClient._dryrun
- Defined in core/ao/BaseClient.ts:99

`Protected`dryrun

dryrun(
    data?: any,
    tags?: Tags,
    anchor?: string,
    id?: string,
    owner?: string,
): Promise<DryRunResult>
Protected
Parameters
- data: any = ''
- tags: Tags = []
- Optionalanchor: string
- Optionalid: string
- Optionalowner: string
Returns Promise<DryRunResult>
Inherited from BaseClient.dryrun
- Defined in core/ao/BaseClient.ts:90

getAOClient

getAOClient(): IAOClient
Gets the current AO client instance being used by this process client.

Returns IAOClient
The IAOClient instance currently in use
Inherited from BaseClient.getAOClient
- Defined in core/ao/BaseClient.ts:160

getAoProceeds

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

Returns Promise<ProceedsData>
Promise resolving to proceeds data indexed by yield cycle
Implementation of IFairLaunchProcessClient.getAoProceeds
- Defined in clients/pi/fair-launch-process/FairLaunchProcessClient.ts:153

getCallingWalletAddress

getCallingWalletAddress(): Promise<string>
Gets the wallet address associated with the client.

Returns Promise<string>
Promise resolving to the wallet address string

Throws
Error if client is in read-only mode
Inherited from BaseClient.getCallingWalletAddress
- Defined in core/ao/BaseClient.ts:137

getInfo

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

Returns Promise<FairLaunchInfo>
Promise resolving to FairLaunchInfo with process information
Implementation of IFairLaunchProcessClient.getInfo
- Defined in clients/pi/fair-launch-process/FairLaunchProcessClient.ts:32

getPiProceeds

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

Returns Promise<ProceedsData>
Promise resolving to proceeds data indexed by yield cycle
Implementation of IFairLaunchProcessClient.getPiProceeds
- Defined in clients/pi/fair-launch-process/FairLaunchProcessClient.ts:179

getProcessId

getProcessId(): string
Returns string
Boolean indicating whether or not the client is set to run dryruns as messages. (non default behavior)
Inherited from BaseClient.getProcessId
- Defined in core/ao/BaseClient.ts:133

getProcessInfo

getProcessInfo(): Promise<Partial<FullArweaveTransaction>>
Retrieves the transaction that created this process. This transaction contains the initial state and configuration of the process in its tags.

Returns Promise<Partial<FullArweaveTransaction>>
Promise resolving to the transaction data containing process creation details

Throws
ArweaveGraphQLError if there is an error retrieving the transaction
Inherited from BaseClient.getProcessInfo
- Defined in core/ao/BaseClient.ts:152

getWallet

getWallet(): any
Gets the wallet this client uses to sign messages

Returns any
the wallet used for message signing
Inherited from BaseClient.getWallet
- Defined in core/ao/BaseClient.ts:156

getWalletAddressSync

getWalletAddressSync(): string
Gets the wallet address associated with the client synchronously. Uses the hasher and JWK to derive the wallet address without async operations.

Returns string
The wallet address string

Throws
Error if client is in read-only mode or if synchronous hashing is not supported
Inherited from BaseClient.getWalletAddressSync
- Defined in core/ao/BaseClient.ts:164

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
Implementation of IFairLaunchProcessClient.getWithdrawableAo
- Defined in clients/pi/fair-launch-process/FairLaunchProcessClient.ts:50

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
Implementation of IFairLaunchProcessClient.getWithdrawablePi
- Defined in clients/pi/fair-launch-process/FairLaunchProcessClient.ts:81

isReadOnly

isReadOnly(): boolean
A Readonly Client can only perform dry run and result operations, however does not require a wallet to be used. If a wallet is specified on instantiation the client will additionally be able to use write operations (messages).

Returns boolean
Boolean indicating whether or not the client is for read operations only.
Inherited from BaseClient.isReadOnly
- Defined in core/ao/BaseClient.ts:148

isRunningDryRunsAsMessages

isRunningDryRunsAsMessages(): boolean
Returns boolean
Boolean indicating whether or not the client is set to run dryruns as messages. (non default behavior)
Inherited from BaseClient.isRunningDryRunsAsMessages
- Defined in core/ao/BaseClient.ts:144

`Protected`message

message(data?: string, tags?: Tags, anchor?: string): Promise<string>
Protected
Parameters
- data: string = ''
- tags: Tags = []
- Optionalanchor: string
Returns Promise<string>
Inherited from BaseClient.message
- Defined in core/ao/BaseClient.ts:48

messageResult

messageResult(
    data?: string,
    tags?: Tags,
    anchor?: string,
): Promise<MessageResult>
Parameters
- data: string = ''
- tags: Tags = []
- Optionalanchor: string
Returns Promise<MessageResult>
Inherited from BaseClient.messageResult
- Defined in core/ao/BaseClient.ts:201

`Protected`result

result(messageId: string): Promise<MessageResult>
Protected
Parameters
- messageId: string
Returns Promise<MessageResult>
Inherited from BaseClient.result
- Defined in core/ao/BaseClient.ts:80

`Protected`results

results(
    from?: string,
    to?: string,
    limit?: number,
    sort?: SortOrder,
): Promise<ResultsResponse>
Protected
Parameters
- Optionalfrom: string
- Optionalto: string
- limit: number = 25
- sort: SortOrder = SortOrder.ASCENDING
Returns Promise<ResultsResponse>
Inherited from BaseClient.results
- Defined in core/ao/BaseClient.ts:64

setDryRunAsMessage

setDryRunAsMessage(enabled: boolean): void
Controls whether dryrun executes as a message or simulation.
Parameters
- enabled: boolean
  When true, dryrun will execute as a real message. When false (default), executes as a simulation.
Returns void
Inherited from BaseClient.setDryRunAsMessage
- Defined in core/ao/BaseClient.ts:117

setWallet

setWallet(wallet: any): void
Sets the wallet being used for this client. If the client is readonly it will now have write abilities.
Parameters
- wallet: any
  the wallet to use with this client.
Returns void
Inherited from BaseClient.setWallet
- Defined in core/ao/BaseClient.ts:124

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
Implementation of IFairLaunchProcessClient.withdrawAo
- Defined in clients/pi/fair-launch-process/FairLaunchProcessClient.ts:112

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
Implementation of IFairLaunchProcessClient.withdrawPi
- Defined in clients/pi/fair-launch-process/FairLaunchProcessClient.ts:133

`Static`from

from(processId: string, wallet?: any): FairLaunchProcessClient
Parameters
- processId: string
- Optionalwallet: any
Returns FairLaunchProcessClient
- Defined in clients/pi/fair-launch-process/FairLaunchProcessClient.ts:19

Class FairLaunchProcessClient

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FairLaunchProcessClient

Properties

Protected ReadonlybaseConfig

Methods

Protected_dryrun

Parameters

Returns Promise<DryRunResult>

Protecteddryrun

Parameters

Returns Promise<DryRunResult>

getAOClient

Returns IAOClient

getAoProceeds

Returns Promise<ProceedsData>

getCallingWalletAddress

Returns Promise<string>

Throws

getInfo

Returns Promise<FairLaunchInfo>

getPiProceeds

Returns Promise<ProceedsData>

getProcessId

Returns string

getProcessInfo

Returns Promise<Partial<FullArweaveTransaction>>

Throws

getWallet

Returns any

getWalletAddressSync

Returns string

Throws

getWithdrawableAo

Parameters

Returns Promise<string>

getWithdrawablePi

Parameters

Returns Promise<string>

isReadOnly

Returns boolean

isRunningDryRunsAsMessages

Returns boolean

Protectedmessage

Parameters

Returns Promise<string>

messageResult

Parameters

Returns Promise<MessageResult>

Protectedresult

Parameters

Returns Promise<MessageResult>

Protectedresults

Parameters

Returns Promise<ResultsResponse>

setDryRunAsMessage

Parameters

Returns void

setWallet

Parameters

Returns void

withdrawAo

Returns Promise<any>

withdrawPi

Returns Promise<any>

Staticfrom

Parameters

Returns FairLaunchProcessClient

Settings

On This Page

`Protected` `Readonly`baseConfig

`Protected`_dryrun

`Protected`dryrun

`Protected`message

`Protected`result

`Protected`results

`Static`from