Class RandomClient

See

specification

Hierarchy

BaseClient
- RandomClient

Implements

IRandomClient

Constructors

constructor

new RandomClient(randomConfig: RandomClientConfig): RandomClient
Parameters
- randomConfig: RandomClientConfig
Returns RandomClient
Overrides BaseClient.constructor
- Defined in clients/randao/random/RandomClient.ts:35

Properties

`Protected` `Readonly`baseConfig

baseConfig: BaseClientConfig

`Readonly`tokenClient

tokenClient: TokenClient

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

claimRewards

claimRewards(): Promise<void>
Claim provider rewards

Returns Promise<void>
Implementation of IRandomClient.claimRewards
- Defined in clients/randao/random/RandomClient.ts:87

commit

commit(
    params: {
        puzzle: { input: string; modulus: string };
        requestId: string;
    },
): Promise<void>
Posts a timeunlocked commitement to a randomness request
Parameters
- params: { puzzle: { input: string; modulus: string }; requestId: string }
  - puzzle: { input: string; modulus: string }
    input: string
    The timelock puzzle input base64 (no 0x)
    
    modulus: string
    The timelock puzzle modulus base64 (no 0x)
  - requestId: string
    Id of the randomness request to commit to
Returns Promise<void>
Implementation of IRandomClient.commit
- Defined in clients/randao/random/RandomClient.ts:98

crank

crank(): Promise<void>
Triggers resolution of stuck contests

Returns Promise<void>
Implementation of IRandomClient.crank
- Defined in clients/randao/random/RandomClient.ts:76

createRequest

createRequest(
    provider_ids: string[],
    requestedInputs?: number,
    callbackId?: string,
): Promise<boolean>
Creates a new randomness request using a list of provider IDs.
Parameters
- provider_ids: string[]
- OptionalrequestedInputs: number
  The number of requested random inputs.
- callbackId: string = ''
  A unique identifier for tracking the request callback.
Returns Promise<boolean>
- A promise that resolves with a boolean indicating success.
Implementation of IRandomClient.createRequest
- Defined in clients/randao/random/RandomClient.ts:250

`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

getAllProviderActivity

getAllProviderActivity(): Promise<ProviderActivity[]>
Gets a list of all provider activity

Returns Promise<ProviderActivity[]>
- A promise that resolves with a list of provider activity.
Implementation of IRandomClient.getAllProviderActivity
- Defined in clients/randao/random/RandomClient.ts:285

getAllUserInfo

getAllUserInfo(): Promise<GetUserInfoResponse[]>
Gets all users info: internal balance/created at time

Returns Promise<GetUserInfoResponse[]>
- A promise that resolves with an array of users info objects
Implementation of IRandomClient.getAllUserInfo
- Defined in clients/randao/random/RandomClient.ts:150

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

getOpenRandomRequests

getOpenRandomRequests(provider: string): Promise<GetOpenRandomRequestsResponse>
Retrieves all open, incomplete randomness requests for a specific provider. These requests lack required inputs (modulus, proof, output).
Parameters
- provider: string
  The identifier for the provider.
Returns Promise<GetOpenRandomRequestsResponse>
- A promise that resolves with an array of open random requests.
Implementation of IRandomClient.getOpenRandomRequests
- Defined in clients/randao/random/RandomClient.ts:208

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

getProviderActivity

getProviderActivity(providerId: String): Promise<ProviderActivity>
Gets provider activity for a given provider
Parameters
- providerId: String
Returns Promise<ProviderActivity>
- A promise that resolves with a provider activity for the given providerId
Implementation of IRandomClient.getProviderActivity
- Defined in clients/randao/random/RandomClient.ts:307

getProviderAvailableValues

getProviderAvailableValues(
providerId: string,
): Promise<GetProviderAvailableValuesResponse>
Retrieves the number of available random values associated with the specified provider.
Parameters
- providerId: string
Returns Promise<GetProviderAvailableValuesResponse>
- A promise that resolves with the number of available random values for the provider.
Implementation of IRandomClient.getProviderAvailableValues
- Defined in clients/randao/random/RandomClient.ts:122

getRandomRequests

getRandomRequests(
randomnessRequestIds: string[],
): Promise<GetRandomRequestsResponse>
Fetches randomness requests based on a list of request IDs.
Parameters
- randomnessRequestIds: string[]
  Array of IDs for the randomness requests to retrieve.
Returns Promise<GetRandomRequestsResponse>
- A promise that resolves with an array of requested randomness data.
Implementation of IRandomClient.getRandomRequests
- Defined in clients/randao/random/RandomClient.ts:222

getRandomRequestViaCallbackId

getRandomRequestViaCallbackId(
callbackId: string,
): Promise<GetRandomRequestsResponse>
Retrieves a randomness request based on a callback ID.
Parameters
- callbackId: string
  The callback ID of the randomness request to retrieve.
Returns Promise<GetRandomRequestsResponse>
- A promise that resolves with the requested randomness data.
Implementation of IRandomClient.getRandomRequestViaCallbackId
- Defined in clients/randao/random/RandomClient.ts:236

getUserInfo

getUserInfo(userId: string): Promise<GetUserInfoResponse>
Gets a users info: internal balance/created at time
Parameters
- userId: string
Returns Promise<GetUserInfoResponse>
- A promise that resolves with the users info object
Implementation of IRandomClient.getUserInfo
- Defined in clients/randao/random/RandomClient.ts:136

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

prepay

prepay(quantity: number, userId?: string): Promise<boolean>
Prepays for future random requests
Parameters
- quantity: number
- OptionaluserId: string
Returns Promise<boolean>
Implementation of IRandomClient.prepay
- Defined in clients/randao/random/RandomClient.ts:268

redeem

redeem(
    providersIds?: string[],
    requestedInputs?: number,
    callbackId?: string,
): Promise<boolean>
Redeem random credits
Parameters
- OptionalprovidersIds: string[]
- OptionalrequestedInputs: number
- OptionalcallbackId: string
Returns Promise<boolean>
Implementation of IRandomClient.redeem
- Defined in clients/randao/random/RandomClient.ts:164

`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

reveal

reveal(
params: { requestId: string; rsa_key: { p: string; q: string } },
): Promise<void>
Posts a timeunlocked commitement to a randomness request
Parameters
- params: { requestId: string; rsa_key: { p: string; q: string } }
  - requestId: string
    Id of the randomness request to reveal
  - rsa_key: { p: string; q: string }
    p: string
    base64 (no 0x)
    
    q: string
    base64 (no 0x)
Returns Promise<void>
Implementation of IRandomClient.reveal
- Defined in clients/randao/random/RandomClient.ts:110

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

updateProviderAvailableValues

updateProviderAvailableValues(
    availableRandomValues: number,
    providerId?: string,
    info?: MonitoringData,
): Promise<boolean>
Updates the count of available random values for a specific provider.
Parameters
- availableRandomValues: number
- OptionalproviderId: string
  The identifier for the provider allowing the staker to update the providers balance.
- Optionalinfo: MonitoringData
  An optional MonitoringData object containing provider monitoring information.
Returns Promise<boolean>
- A promise that resolves with a boolean indicating success.
Implementation of IRandomClient.updateProviderAvailableValues
- Defined in clients/randao/random/RandomClient.ts:188

`Static`autoConfiguration

autoConfiguration(): Promise<RandomClient>
Returns Promise<RandomClient>
See
IAutoconfiguration.autoConfiguration
- Defined in clients/randao/random/RandomClient.ts:50

`Static`builder

builder(): TokenInterfacingClientBuilder<RandomClient>
Returns TokenInterfacingClientBuilder<RandomClient>
- Defined in clients/randao/random/RandomClient.ts:56

`Static`defaultBuilder

defaultBuilder(): Promise<TokenInterfacingClientBuilder<RandomClient>>
Returns Promise<TokenInterfacingClientBuilder<RandomClient>>
See
IDefaultBuilder.defaultBuilder
- Defined in clients/randao/random/RandomClient.ts:64

Class RandomClient

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns RandomClient

Properties

Protected ReadonlybaseConfig

ReadonlytokenClient

Methods

Protected_dryrun

Parameters

Returns Promise<DryRunResult>

claimRewards

Returns Promise<void>

commit

Parameters

puzzle: { input: string; modulus: string }

input: string

modulus: string

requestId: string

Returns Promise<void>

crank

Returns Promise<void>

createRequest

Parameters

Returns Promise<boolean>

Protecteddryrun

Parameters

Returns Promise<DryRunResult>

getAllProviderActivity

Returns Promise<ProviderActivity[]>

getAllUserInfo

Returns Promise<GetUserInfoResponse[]>

getAOClient

Returns IAOClient

getCallingWalletAddress

Returns Promise<string>

Throws

getOpenRandomRequests

Parameters

Returns Promise<GetOpenRandomRequestsResponse>

getProcessId

Returns string

getProcessInfo

Returns Promise<Partial<FullArweaveTransaction>>

Throws

getProviderActivity

Parameters

Returns Promise<ProviderActivity>

getProviderAvailableValues

Parameters

Returns Promise<GetProviderAvailableValuesResponse>

getRandomRequests

Parameters

Returns Promise<GetRandomRequestsResponse>

getRandomRequestViaCallbackId

Parameters

Returns Promise<GetRandomRequestsResponse>

getUserInfo

Parameters

Returns Promise<GetUserInfoResponse>

getWallet

Returns any

getWalletAddressSync

Returns string

Throws

isReadOnly

Returns boolean

isRunningDryRunsAsMessages

Returns boolean

Protectedmessage

Parameters

Returns Promise<string>

`Protected` `Readonly`baseConfig

`Readonly`tokenClient

`Protected`_dryrun

`Protected`dryrun

`Protected`message

`Protected`result

`Protected`results

`Static`autoConfiguration

`Static`builder

`Static`defaultBuilder