Class StakingClient

See

specification

Hierarchy (View Summary)

BaseClient
- StakingClient
  - ProviderStakingClient

Implements

IStakingClient

Index

Constructors

constructor

new StakingClient(stakingConfig: StakingClientConfig): StakingClient
Parameters
- stakingConfig: StakingClientConfig
Returns StakingClient
Overrides BaseClient.constructor
- Defined in clients/ao/staking/StakingClient.ts:23

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

`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:92

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

getStakingToken

getStakingToken(): TokenClient
Returns TokenClient
- Defined in clients/ao/staking/StakingClient.ts:72

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

`Protected`result

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

stake

stake(quantity: string, additionaForwardedlTags?: Tags): Promise<boolean>
Stakes tokens by transferring them with an X-Stake tag
Parameters
- quantity: string
  Amount of tokens to stake
- OptionaladditionaForwardedlTags: Tags
Returns Promise<boolean>
Promise resolving to the boolean representation of staking success
Implementation of IStakingClient.stake
- Defined in clients/ao/staking/StakingClient.ts:34

unstake

unstake(data: string): Promise<boolean>
Unstakes tokens for a provider
Parameters
- data: string
  optional data to pass when unstaking
Returns Promise<boolean>
Promise resolving to true if unstaking was successful, false if it failed
Implementation of IStakingClient.unstake
- Defined in clients/ao/staking/StakingClient.ts:54

Class StakingClient

See

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns StakingClient

Properties

Protected ReadonlybaseConfig

ReadonlytokenClient

Methods

Protected_dryrun

Parameters

Returns Promise<DryRunResult>

Protecteddryrun

Parameters

Returns Promise<DryRunResult>

getCallingWalletAddress

Returns Promise<string>

Throws

getProcessId

Returns string

getProcessInfo

Returns Promise<Partial<FullArweaveTransaction>>

Throws

getStakingToken

Returns TokenClient

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

stake

Parameters

Returns Promise<boolean>

unstake

Parameters

Returns Promise<boolean>

Settings

On This Page

`Protected` `Readonly`baseConfig

`Readonly`tokenClient

`Protected`_dryrun

`Protected`dryrun

`Protected`message

`Protected`result

`Protected`results