Class HyperbeamClient

HyperBEAM client implementation for accessing AO-Core process state

Implements

IHyperbeamClient

Index

Constructors

Methods

compute getProcessState autoConfiguration

Constructors

constructor

new HyperbeamClient(config: HyperbeamClientConfig): HyperbeamClient
Parameters
- config: HyperbeamClientConfig
Returns HyperbeamClient
- Defined in core/ao/hyperbeam/hyperbeam-client/HyperbeamClient.ts:27

Methods

compute

compute(processId: string, additionalPath?: string): Promise<any>
Retrieves the cached state of a specific process from the HyperBEAM node (compute endpoint)

This is a convenience method that uses the compute endpoint for faster, cached responses.
Parameters
- processId: string
  The process ID to query
- OptionaladditionalPath: string
  Optional additional path components to access specific data within the process state
Returns Promise<any>
Promise resolving to the process state data
Example
```
// Get cached process state (fastest)
const state = await client.compute('process-id');

// Get specific data from cached process state
const balances = await client.compute('process-id', 'balances/wallet-address');
```
Implementation of IHyperbeamClient.compute
- Defined in core/ao/hyperbeam/hyperbeam-client/HyperbeamClient.ts:59

getProcessState

getProcessState(
    processId: string,
    endpoint: ProcessEndpoint,
    additionalPath?: string,
): Promise<any>
Retrieves the state of a specific process from the HyperBEAM node using a specified endpoint
Parameters
- processId: string
  The process ID to query
- endpoint: ProcessEndpoint
  The process endpoint to use (compute or now)
- OptionaladditionalPath: string
  Optional additional path components to access specific data within the process state
Returns Promise<any>
Promise resolving to the process state data
Example
```
// Get cached process state with specific path
const state = await client.getProcessState('process-id', ProcessEndpoint.COMPUTE, 'balances/wallet-address');

// Get real-time process state
const freshState = await client.getProcessState('process-id', ProcessEndpoint.NOW);
```
Implementation of IHyperbeamClient.getProcessState
- Defined in core/ao/hyperbeam/hyperbeam-client/HyperbeamClient.ts:48

`Static`autoConfiguration

autoConfiguration(): HyperbeamClient
Returns HyperbeamClient
- Defined in core/ao/hyperbeam/hyperbeam-client/HyperbeamClient.ts:41