Class DelegationHistorianClient

Hierarchy

BaseClient
- DelegationHistorianClient

Implements

IDelegationHistorianClient

Constructors

constructor

new DelegationHistorianClient(
baseConfig: BaseClientConfig,
): DelegationHistorianClient
Parameters
- baseConfig: BaseClientConfig
Returns DelegationHistorianClient
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>
Implementation of IDelegationHistorianClient.dryrun
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
Implementation of IDelegationHistorianClient.getAOClient
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
Implementation of IDelegationHistorianClient.getCallingWalletAddress
Inherited from BaseClient.getCallingWalletAddress
- Defined in core/ao/BaseClient.ts:137

getLastNRecords

getLastNRecords(count: number): Promise<DelegationRecord[]>
Fetches the last N records of delegations
Parameters
- count: number
  Number of records to fetch
Returns Promise<DelegationRecord[]>
Array of delegation records
Implementation of IDelegationHistorianClient.getLastNRecords
- Defined in clients/pi/historian/DelegationHistorianClient.ts:72

getLastRecord

getLastRecord(): Promise<DelegationRecord>
Fetches the last record of delegations

Returns Promise<DelegationRecord>
The last delegation record
Implementation of IDelegationHistorianClient.getLastRecord
- Defined in clients/pi/historian/DelegationHistorianClient.ts:51

getProcessId

getProcessId(): string
Returns string
Boolean indicating whether or not the client is set to run dryruns as messages. (non default behavior)
Implementation of IDelegationHistorianClient.getProcessId
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
Implementation of IDelegationHistorianClient.getProcessInfo
Inherited from BaseClient.getProcessInfo
- Defined in core/ao/BaseClient.ts:152

getTotalDelegatedAOByProject

getTotalDelegatedAOByProject(): Promise<ProjectDelegationTotal[]>
Fetches the total delegated AO by project

Returns Promise<ProjectDelegationTotal[]>
Array of project delegation totals
Implementation of IDelegationHistorianClient.getTotalDelegatedAOByProject
- Defined in clients/pi/historian/DelegationHistorianClient.ts:27

getWallet

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

Returns any
the wallet used for message signing
Implementation of IDelegationHistorianClient.getWallet
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
Implementation of IDelegationHistorianClient.getWalletAddressSync
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.
Implementation of IDelegationHistorianClient.isReadOnly
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)
Implementation of IDelegationHistorianClient.isRunningDryRunsAsMessages
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>
Implementation of IDelegationHistorianClient.message
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>
Implementation of IDelegationHistorianClient.result
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>
Implementation of IDelegationHistorianClient.results
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
Implementation of IDelegationHistorianClient.setDryRunAsMessage
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
Implementation of IDelegationHistorianClient.setWallet
Inherited from BaseClient.setWallet
- Defined in core/ao/BaseClient.ts:124

`Static`autoConfiguration

autoConfiguration(): Promise<DelegationHistorianClient>
Returns Promise<DelegationHistorianClient>
See
IAutoconfiguration.autoConfiguration
- Defined in clients/pi/historian/DelegationHistorianClient.ts:109

`Static`build

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

`Static`builder

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

Returns ClientBuilder<DelegationHistorianClient>
A new builder instance
- Defined in clients/pi/historian/DelegationHistorianClient.ts:118

`Static`defaultBuilder

defaultBuilder(): Promise<ClientBuilder<DelegationHistorianClient>>
Returns Promise<ClientBuilder<DelegationHistorianClient>>
See
IDefaultBuilder.defaultBuilder
- Defined in clients/pi/historian/DelegationHistorianClient.ts:126

Class DelegationHistorianClient

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DelegationHistorianClient

Properties

Protected ReadonlybaseConfig

Methods

Protected_dryrun

Parameters

Returns Promise<DryRunResult>

Protecteddryrun

Parameters

Returns Promise<DryRunResult>

getAOClient

Returns IAOClient

getCallingWalletAddress

Returns Promise<string>

Throws

getLastNRecords

Parameters

Returns Promise<DelegationRecord[]>

getLastRecord

Returns Promise<DelegationRecord>

getProcessId

Returns string

getProcessInfo

Returns Promise<Partial<FullArweaveTransaction>>

Throws

getTotalDelegatedAOByProject

Returns Promise<ProjectDelegationTotal[]>

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 Promise<DelegationHistorianClient>

See

Staticbuild

Parameters

Returns DelegationHistorianClient

Staticbuilder

Returns ClientBuilder<DelegationHistorianClient>

StaticdefaultBuilder

Returns Promise<ClientBuilder<DelegationHistorianClient>>

See

Settings

On This Page

`Protected` `Readonly`baseConfig

`Protected`_dryrun

`Protected`dryrun

`Protected`message

`Protected`result

`Protected`results

`Static`autoConfiguration

`Static`build

`Static`builder

`Static`defaultBuilder