Class ProviderStakingClient

Hierarchy (View Summary)

StakingClient
- ProviderStakingClient

Implements

IProviderStakingClient

Constructors

constructor

new ProviderStakingClient(
stakingConfig: StakingClientConfig,
): ProviderStakingClient
Parameters
- stakingConfig: StakingClientConfig
Returns ProviderStakingClient
Inherited from StakingClient.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 StakingClient._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>
Inherited from StakingClient.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 StakingClient.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 StakingClient.getCallingWalletAddress
- Defined in core/ao/BaseClient.ts:137

getProcessId

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

getStake

getStake(providerId: string): Promise<ProviderStakeInfo>
Gets the current stake for a provider
Parameters
- providerId: string
  The ID of the provider to check stake for
Returns Promise<ProviderStakeInfo>
Promise resolving to the stake information
Implementation of IProviderStakingClient.getStake
- Defined in clients/randao/provider-staking/ProviderStakingClient.ts:94

getStakingToken

getStakingToken(): TokenClient
Returns TokenClient
Inherited from StakingClient.getStakingToken
- 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 StakingClient.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 StakingClient.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 StakingClient.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 StakingClient.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 StakingClient.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 StakingClient.messageResult
- Defined in core/ao/BaseClient.ts:201

`Protected`result

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

stake

stake(
    quantity: string,
    additionaForwardedlTags?: Tags,
    actorId?: string,
): Promise<boolean>
Stakes tokens by transferring them with an X-Stake tag
Parameters
- quantity: string
  Amount of tokens to stake
- OptionaladditionaForwardedlTags: Tags
  Additional tags to forward with the stake
- OptionalactorId: string
  Optional actor ID to authorize for the provider
Returns Promise<boolean>
Promise resolving to the boolean representation of staking success
Implementation of IProviderStakingClient.stake
Overrides StakingClient.stake
- Defined in clients/randao/provider-staking/ProviderStakingClient.ts:52

stakeWithDetails

stakeWithDetails(
    quantity: string,
    providerDetails?: ProviderDetails,
    actorId?: string,
): Promise<boolean>
Stakes tokens by transferring them with an X-Stake tag and provider details
Parameters
- quantity: string
  Amount of tokens to stake
- OptionalproviderDetails: ProviderDetails
  Optional provider details to include
- OptionalactorId: string
  Optional actor ID to authorize for the provider
Returns Promise<boolean>
Promise resolving to the boolean representation of staking success
Implementation of IProviderStakingClient.stakeWithDetails
- Defined in clients/randao/provider-staking/ProviderStakingClient.ts:67

unstake

unstake(providerId: string): Promise<boolean>
Parameters
- providerId: string
Returns Promise<boolean>
Override
Implementation of IProviderStakingClient.unstake
Overrides StakingClient.unstake
- Defined in clients/randao/provider-staking/ProviderStakingClient.ts:132

updateProviderActor

updateProviderActor(providerId: string, actorId: string): Promise<boolean>
Updates the provider actor for a staker
Parameters
- providerId: string
  The ID of the provider
- actorId: string
  The ID of the actor being authorized
Returns Promise<boolean>
Promise resolving to a boolean indicating success
Implementation of IProviderStakingClient.updateProviderActor
- Defined in clients/randao/provider-staking/ProviderStakingClient.ts:117

`Static`autoConfiguration

autoConfiguration(): ProviderStakingClient
Returns ProviderStakingClient
See
IAutoconfiguration.autoConfiguration
- Defined in clients/randao/provider-staking/ProviderStakingClient.ts:32

`Static`defaultBuilder

defaultBuilder(): TokenInterfacingClientBuilder<ProviderStakingClient>
Returns TokenInterfacingClientBuilder<ProviderStakingClient>
See
IDefaultBuilder.defaultBuilder
- Defined in clients/randao/provider-staking/ProviderStakingClient.ts:41

Class ProviderStakingClient

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ProviderStakingClient

Properties

Protected ReadonlybaseConfig

ReadonlytokenClient

Methods

Protected_dryrun

Parameters

Returns Promise<DryRunResult>

Protecteddryrun

Parameters

Returns Promise<DryRunResult>

getAOClient

Returns IAOClient

getCallingWalletAddress

Returns Promise<string>

Throws

getProcessId

Returns string

getProcessInfo

Returns Promise<Partial<FullArweaveTransaction>>

Throws

getStake

Parameters

Returns Promise<ProviderStakeInfo>

getStakingToken

Returns TokenClient

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

stake

Parameters

Returns Promise<boolean>

stakeWithDetails

Parameters

Returns Promise<boolean>

unstake

Parameters

Returns Promise<boolean>

Override

updateProviderActor

Parameters

Returns Promise<boolean>

StaticautoConfiguration

Returns ProviderStakingClient

See

StaticdefaultBuilder

`Protected` `Readonly`baseConfig

`Readonly`tokenClient

`Protected`_dryrun

`Protected`dryrun

`Protected`message

`Protected`result

`Protected`results

`Static`autoConfiguration

`Static`defaultBuilder