Class ARNSClient

Client for interacting with ARNS (Arweave Name Service) records.

Hierarchy

DryRunCachingClient
- ARNSClient

Implements

IARNSClient

Constructors

constructor

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

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:25

clearCache

clearCache(): void
Clears the Cache

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

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

getArNSRecords

getArNSRecords(
params?: { cursor?: string; limit?: number },
): Promise<GetArNSRecordsResponse>
Retrieves paginated ARNS records.
Parameters
- Optionalparams: { cursor?: string; limit?: number }
  Optional pagination parameters (cursor and limit)
  - Optionalcursor?: string
    Cursor for pagination
  - Optionallimit?: number
    Maximum number of records to retrieve
Returns Promise<GetArNSRecordsResponse>
Promise resolving to paginated ARNS records response
Implementation of IARNSClient.getArNSRecords
- Defined in clients/ario/arns/ARNSClient.ts:66

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:137

getProcessId

getProcessId(): string
Gets the process ID for this client.

Returns string
The process ID string
Implementation of IARNSClient.getProcessId
Overrides DryRunCachingClient.getProcessId
- Defined in clients/ario/arns/ARNSClient.ts:89

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:152

getRecord

getRecord(name: string): Promise<ARNSRecordResponse | undefined>
Retrieves an ARNS record for a given name.
Parameters
- name: string
  The name to get the ARNS record for
Returns Promise<ARNSRecordResponse | undefined>
Promise resolving to the ARNS record if found, undefined otherwise
Implementation of IARNSClient.getRecord
- Defined in clients/ario/arns/ARNSClient.ts:46

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

`Protected`result

result(messageId: string): Promise<MessageResult>
Protected
Parameters
- messageId: string
Returns Promise<MessageResult>
Inherited from DryRunCachingClient.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 DryRunCachingClient.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 DryRunCachingClient.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 DryRunCachingClient.setWallet
- Defined in core/ao/BaseClient.ts:124

`Static`autoConfiguration

autoConfiguration(): ARNSClient
Returns ARNSClient
See
IAutoconfiguration.autoConfiguration
- Defined in clients/ario/arns/ARNSClient.ts:26

`Static`defaultBuilder

defaultBuilder(): ClientBuilder<ARNSClient>
Returns ClientBuilder<ARNSClient>
See
IDefaultBuilder.defaultBuilder
- Defined in clients/ario/arns/ARNSClient.ts:35

Class ARNSClient

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ARNSClient

Properties

Protected ReadonlybaseConfig

Methods

Protected_dryrun

Parameters

Returns Promise<DryRunResult>

clearCache

Returns void

Protecteddryrun

Parameters

Returns Promise<DryRunResult>

getAOClient

Returns IAOClient

getArNSRecords

Parameters

Optionalcursor?: string

Optionallimit?: number

Returns Promise<GetArNSRecordsResponse>

getCallingWalletAddress

Returns Promise<string>

Throws

getProcessId

Returns string

getProcessInfo

Returns Promise<Partial<FullArweaveTransaction>>

Throws

getRecord

Parameters

Returns Promise<ARNSRecordResponse | undefined>

getWallet

Returns any

getWalletAddressSync

Returns string

Throws

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

StaticautoConfiguration

Returns ARNSClient

See

StaticdefaultBuilder

Returns ClientBuilder<ARNSClient>

See

Settings

On This Page

`Protected` `Readonly`baseConfig

`Protected`_dryrun

`Protected`dryrun

`Optional`cursor?: string

`Optional`limit?: number

`Protected`message

`Protected`result

`Protected`results

`Static`autoConfiguration

`Static`defaultBuilder