Class PIOracleClient

Client for interacting with the PI Oracle process. The Oracle provides information about all available PI tokens.

Hierarchy

BaseClient
- PIOracleClient

Implements

IPIOracleClient

Constructors

constructor

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

createTokenClient

createTokenClient(processId: string): PITokenClient
Create a PITokenClient for a specific token process ID
Parameters
- processId: string
  The process ID of the token to create a client for
Returns PITokenClient
A configured PITokenClient
Implementation of IPIOracleClient.createTokenClient
- Defined in clients/pi/oracle/PIOracleClient.ts:166

createTokenClientPairs

createTokenClientPairs(): Promise<Map<string, [PITokenClient, TokenClient]>>
Creates token client pairs for all available PI tokens The first item is a PITokenClient created with the id field The second item is a BaseToken client created with the process field

Returns Promise<Map<string, [PITokenClient, TokenClient]>>
A map of token ticker to [PITokenClient, TokenClient] tuples
Implementation of IPIOracleClient.createTokenClientPairs
- Defined in clients/pi/oracle/PIOracleClient.ts:237

createTokenClientPairsArray

createTokenClientPairsArray(): Promise<[PITokenClient, TokenClient][]>
Creates an array of token client pairs for all available PI tokens Each pair contains a PITokenClient created with the id field and a BaseToken client created with the process field

Returns Promise<[PITokenClient, TokenClient][]>
An array of [PITokenClient, TokenClient] tuples
Implementation of IPIOracleClient.createTokenClientPairsArray
- Defined in clients/pi/oracle/PIOracleClient.ts:282

createTokenClients

createTokenClients(): Promise<Map<string, PITokenClient>>
Creates token clients for all available PI tokens

Returns Promise<Map<string, PITokenClient>>
A map of token ticker to PITokenClient instances
Implementation of IPIOracleClient.createTokenClients
- Defined in clients/pi/oracle/PIOracleClient.ts:178

createTokenClientsArray

createTokenClientsArray(): Promise<PITokenClient[]>
Creates an array of PITokenClient instances for all available PI tokens

Returns Promise<PITokenClient[]>
An array of PITokenClient instances

Deprecated
Use createTokenClientPairsArray instead
Implementation of IPIOracleClient.createTokenClientsArray
- Defined in clients/pi/oracle/PIOracleClient.ts:206

`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

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<DryRunResult>
Gets information about the PI Oracle process.

Returns Promise<DryRunResult>
Promise resolving to a DryRunResult with oracle information
Implementation of IPIOracleClient.getInfo
- Defined in clients/pi/oracle/PIOracleClient.ts:35

getPITokens

getPITokens(): Promise<string>
Gets available PI tokens from the delegation oracle.

Returns Promise<string>
Promise resolving to a list of PI tokens as a string
Implementation of IPIOracleClient.getPITokens
- Defined in clients/pi/oracle/PIOracleClient.ts:55

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

getTokensMap

getTokensMap(): Promise<Map<string, PIToken>>
Gets a map of all PI tokens with their token process IDs and other details

Returns Promise<Map<string, PIToken>>
A map of token ticker to token details
Implementation of IPIOracleClient.getTokensMap
- Defined in clients/pi/oracle/PIOracleClient.ts:135

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

parsePITokens

parsePITokens(piTokensData: string): PIToken[]
Parse the raw PI tokens string into a structured array
Parameters
- piTokensData: string
  Raw PI tokens data string
Returns PIToken[]
Parsed PI tokens
Implementation of IPIOracleClient.parsePITokens
- Defined in clients/pi/oracle/PIOracleClient.ts:78

`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<PIOracleClient>
Returns Promise<PIOracleClient>
See
IAutoconfiguration.autoConfiguration
- Defined in clients/pi/oracle/PIOracleClient.ts:357

`Static`build

build(cuUrl?: string): PIOracleClient
Static method to easily build a default Oracle client
Parameters
- OptionalcuUrl: string
  Optional Compute Unit URL to override the default
Returns PIOracleClient
A configured PIOracleClient instance
- Defined in clients/pi/oracle/PIOracleClient.ts:385

`Static`builder

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

Returns ClientBuilder<PIOracleClient>
A new builder instance
- Defined in clients/pi/oracle/PIOracleClient.ts:366

`Static`defaultBuilder

defaultBuilder(): Promise<ClientBuilder<PIOracleClient>>
Returns Promise<ClientBuilder<PIOracleClient>>
See
IDefaultBuilder.defaultBuilder
- Defined in clients/pi/oracle/PIOracleClient.ts:374

Class PIOracleClient

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PIOracleClient

Properties

Protected ReadonlybaseConfig

Methods

Protected_dryrun

Parameters

Returns Promise<DryRunResult>

createTokenClient

Parameters

Returns PITokenClient

createTokenClientPairs

Returns Promise<Map<string, [PITokenClient, TokenClient]>>

createTokenClientPairsArray

Returns Promise<[PITokenClient, TokenClient][]>

createTokenClients

Returns Promise<Map<string, PITokenClient>>

createTokenClientsArray

Returns Promise<PITokenClient[]>

Deprecated

Protecteddryrun

Parameters

Returns Promise<DryRunResult>

getAOClient

Returns IAOClient

getCallingWalletAddress

Returns Promise<string>

Throws

getInfo

Returns Promise<DryRunResult>

getPITokens

Returns Promise<string>

getProcessId

Returns string

getProcessInfo

Returns Promise<Partial<FullArweaveTransaction>>

Throws

getTokensMap

Returns Promise<Map<string, PIToken>>

getWallet

Returns any

getWalletAddressSync

Returns string

Throws

isReadOnly

Returns boolean

isRunningDryRunsAsMessages

Returns boolean

Protectedmessage

Parameters

Returns Promise<string>

messageResult

Parameters

Returns Promise<MessageResult>

parsePITokens

Parameters

Returns PIToken[]

Protectedresult

Parameters

Returns Promise<MessageResult>

Protectedresults

Parameters

Returns Promise<ResultsResponse>

setDryRunAsMessage

Parameters

Returns void

setWallet

Parameters

Returns void

StaticautoConfiguration

Returns Promise<PIOracleClient>

`Protected` `Readonly`baseConfig

`Protected`_dryrun

`Protected`dryrun

`Protected`message

`Protected`result

`Protected`results

`Static`autoConfiguration

`Static`build

`Static`builder

`Static`defaultBuilder