Class PITokenClient

Client for interacting with a specific PI token process.

Hierarchy

BaseClient
- PITokenClient

Implements

IPITokenClient

Constructors

constructor

new PITokenClient(baseConfig: BaseClientConfig): PITokenClient
Parameters
- baseConfig: BaseClientConfig
Returns PITokenClient
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

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
Implementation of IPITokenClient.getBalance
- Defined in clients/pi/PIToken/PITokenClient.ts:185

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

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
Implementation of IPITokenClient.getClaimableBalance
- Defined in clients/pi/PIToken/PITokenClient.ts:251

getInfo

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

Returns Promise<DryRunResult>
Promise resolving to a DryRunResult with token information
Implementation of IPITokenClient.getInfo
- Defined in clients/pi/PIToken/PITokenClient.ts:32

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

getTickHistory

getTickHistory(): Promise<string>
Gets the tick history from the PI token process.

Returns Promise<string>
Promise resolving to the tick history data as a string
Implementation of IPITokenClient.getTickHistory
- Defined in clients/pi/PIToken/PITokenClient.ts:46

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

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

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
Implementation of IPITokenClient.parseTickHistory
- Defined in clients/pi/PIToken/PITokenClient.ts:172

`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

`Static`autoConfiguration

autoConfiguration(): Promise<PITokenClient>
Returns Promise<PITokenClient>
See
IAutoconfiguration.autoConfiguration
- Defined in clients/pi/PIToken/PITokenClient.ts:335

`Static`build

build(processId: string, cuUrl?: string): PITokenClient
Static method to easily build a PIToken client with optional CU URL override
Parameters
- processId: string
  The PI Token process ID
- OptionalcuUrl: string
  Optional Compute Unit URL to override the default
Returns PITokenClient
A configured PITokenClient instance
- Defined in clients/pi/PIToken/PITokenClient.ts:364

`Static`builder

builder(): ClientBuilder<PITokenClient>
Create a new builder instance for PITokenClient

Returns ClientBuilder<PITokenClient>
A new builder instance
- Defined in clients/pi/PIToken/PITokenClient.ts:344

`Static`defaultBuilder

defaultBuilder(): Promise<ClientBuilder<PITokenClient>>
Returns Promise<ClientBuilder<PITokenClient>>
See
IDefaultBuilder.defaultBuilder
- Defined in clients/pi/PIToken/PITokenClient.ts:352

Class PITokenClient

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PITokenClient

Properties

Protected ReadonlybaseConfig

Methods

Protected_dryrun

Parameters

Returns Promise<DryRunResult>

Protecteddryrun

Parameters

Returns Promise<DryRunResult>

getAOClient

Returns IAOClient

getBalance

Parameters

Returns Promise<string>

getCallingWalletAddress

Returns Promise<string>

Throws

getClaimableBalance

Returns Promise<string>

getInfo

Returns Promise<DryRunResult>

getProcessId

Returns string

getProcessInfo

Returns Promise<Partial<FullArweaveTransaction>>

Throws

getTickHistory

Returns Promise<string>

getWallet

Returns any

getWalletAddressSync

Returns string

Throws

isReadOnly

Returns boolean

isRunningDryRunsAsMessages

Returns boolean

Protectedmessage

Parameters

Returns Promise<string>

messageResult

Parameters

Returns Promise<MessageResult>

parseTickHistory

Parameters

Returns TickHistoryEntry[]

Protectedresult

Parameters

Returns Promise<MessageResult>

Protectedresults

Parameters

Returns Promise<ResultsResponse>

setDryRunAsMessage

Parameters

Returns void

setWallet

Parameters

Returns void

StaticautoConfiguration

Returns Promise<PITokenClient>

See

Staticbuild

Parameters

Returns PITokenClient

Staticbuilder

Returns ClientBuilder<PITokenClient>

StaticdefaultBuilder

Returns Promise<ClientBuilder<PITokenClient>>

See

`Protected` `Readonly`baseConfig

`Protected`_dryrun

`Protected`dryrun

`Protected`message

`Protected`result

`Protected`results

`Static`autoConfiguration

`Static`build

`Static`builder

`Static`defaultBuilder