Class ProviderProfileClient

Hierarchy

DryRunCachingClient
- ProviderProfileClient

Implements

IProviderProfileClient

Constructors

constructor

new ProviderProfileClient(
config: DryRunCachingClientConfig,
): ProviderProfileClient
Parameters
- config: DryRunCachingClientConfig
Returns ProviderProfileClient
Inherited from DryRunCachingClient.constructor
- Defined in core/ao/client-variants/DryRunCachingClient.ts:16

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 DryRunCachingClient._dryrun
- Defined in core/ao/client-variants/DryRunCachingClient.ts:26

clearCache

clearCache(): void
Clears the Cache

Returns void
Inherited from DryRunCachingClient.clearCache
- Defined in core/ao/client-variants/DryRunCachingClient.ts:21

`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 DryRunCachingClient.dryrun
- Defined in core/ao/BaseClient.ts:92

getAllProvidersInfo

getAllProvidersInfo(): Promise<ProviderInfo[]>
Gets provider info for all providers

Returns Promise<ProviderInfo[]>
Promise resolving to an array of provider info objects
Implementation of IProviderProfileClient.getAllProvidersInfo
- Defined in clients/randao/provider-profile/ProviderProfileClient.ts:53

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 DryRunCachingClient.getCallingWalletAddress
- Defined in core/ao/BaseClient.ts:139

getProcessId

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

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 DryRunCachingClient.getProcessInfo
- Defined in core/ao/BaseClient.ts:154

getProviderInfo

getProviderInfo(providerId?: string): Promise<ProviderInfo>
Known issues with return value on this method TODO fix
Parameters
- OptionalproviderId: string
Returns Promise<ProviderInfo>
Implementation of IProviderProfileClient.getProviderInfo
- Defined in clients/randao/provider-profile/ProviderProfileClient.ts:80

getWallet

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

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

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 DryRunCachingClient.isReadOnly
- Defined in core/ao/BaseClient.ts:150

isRunningDryRunsAsMessages

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

`Protected`message

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

messageResult

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

`Protected`result

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

`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 DryRunCachingClient.results
- Defined in core/ao/BaseClient.ts:66

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 DryRunCachingClient.setDryRunAsMessage
- Defined in core/ao/BaseClient.ts:119

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 DryRunCachingClient.setWallet
- Defined in core/ao/BaseClient.ts:126

updateDetails

updateDetails(providerDetails: ProviderDetails): Promise<string>
Updates provider details
Parameters
- providerDetails: ProviderDetails
  Details about the provider
Returns Promise<string>
Promise resolving to the message ID
Implementation of IProviderProfileClient.updateDetails
- Defined in clients/randao/provider-profile/ProviderProfileClient.ts:39

`Static`autoConfiguration

autoConfiguration(): ProviderProfileClient
Returns ProviderProfileClient
See
IAutoconfiguration.autoConfiguration
- Defined in clients/randao/provider-profile/ProviderProfileClient.ts:23

`Static`defaultBuilder

defaultBuilder(): ClientBuilder<ProviderProfileClient>
Returns ClientBuilder<ProviderProfileClient>
See
IDefaultBuilder.defaultBuilder
- Defined in clients/randao/provider-profile/ProviderProfileClient.ts:32

Class ProviderProfileClient

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ProviderProfileClient

Properties

Protected ReadonlybaseConfig

Methods

Protected_dryrun

Parameters

Returns Promise<DryRunResult>

clearCache

Returns void

Protecteddryrun

Parameters

Returns Promise<DryRunResult>

getAllProvidersInfo

Returns Promise<ProviderInfo[]>

getCallingWalletAddress

Returns Promise<string>

Throws

getProcessId

Returns string

getProcessInfo

Returns Promise<Partial<FullArweaveTransaction>>

Throws

getProviderInfo

Parameters

Returns Promise<ProviderInfo>

getWallet

Returns any

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

updateDetails

Parameters

Returns Promise<string>

StaticautoConfiguration

Returns ProviderProfileClient

See

StaticdefaultBuilder

Returns ClientBuilder<ProviderProfileClient>

See

Settings

On This Page

`Protected` `Readonly`baseConfig

`Protected`_dryrun

`Protected`dryrun

`Protected`message

`Protected`result

`Protected`results

`Static`autoConfiguration

`Static`defaultBuilder