Class MPCWalletStakeApi

MPCWalletStakeApi - object-oriented interface

Export

MPCWalletStakeApi

Hierarchy (view full)

Implements

Constructors

constructor

Properties

axios basePath configuration

Methods

broadcastStakingOperation createStakingOperation getStakingOperation

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

broadcastStakingOperation

  • broadcastStakingOperation(walletId, addressId, stakingOperationId, broadcastStakingOperationRequest, options?): Promise<AxiosResponse<StakingOperation, any>>

  • Broadcast a staking operation.

    Parameters

    • walletId: string

      The ID of the wallet the address belongs to.

    • addressId: string

      The ID of the address the staking operation belongs to.

    • stakingOperationId: string

      The ID of the staking operation to broadcast.

    • broadcastStakingOperationRequest: BroadcastStakingOperationRequest
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<StakingOperation, any>>

    Summary

    Broadcast a staking operation

    Throws

    Memberof

    MPCWalletStakeApi

createStakingOperation

  • createStakingOperation(walletId, addressId, createStakingOperationRequest, options?): Promise<AxiosResponse<StakingOperation, any>>

  • Create a new staking operation.

    Parameters

    • walletId: string

      The ID of the wallet the address belongs to.

    • addressId: string

      The ID of the address to create the staking operation for.

    • createStakingOperationRequest: CreateStakingOperationRequest
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<StakingOperation, any>>

    Summary

    Create a new staking operation for an address

    Throws

    Memberof

    MPCWalletStakeApi

getStakingOperation

  • getStakingOperation(walletId, addressId, stakingOperationId, options?): Promise<AxiosResponse<StakingOperation, any>>

  • Get the latest state of a staking operation.

    Parameters

    • walletId: string

      The ID of the wallet the address belongs to

    • addressId: string

      The ID of the address to fetch the staking operation for.

    • stakingOperationId: string

      The ID of the staking operation.

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<StakingOperation, any>>

    Summary

    Get the latest state of a staking operation

    Throws

    Memberof

    MPCWalletStakeApi

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationbroadcastStakingOperationcreateStakingOperationgetStakingOperation