Function MPCWalletStakeApiFactory

  • MPCWalletStakeApiFactory(configuration?, basePath?, axios?): {
        broadcastStakingOperation(walletId, addressId, stakingOperationId, broadcastStakingOperationRequest, options?): AxiosPromise<StakingOperation>;
        createStakingOperation(walletId, addressId, createStakingOperationRequest, options?): AxiosPromise<StakingOperation>;
        getStakingOperation(walletId, addressId, stakingOperationId, options?): AxiosPromise<StakingOperation>;
    }

  • MPCWalletStakeApi - factory interface

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns {
        broadcastStakingOperation(walletId, addressId, stakingOperationId, broadcastStakingOperationRequest, options?): AxiosPromise<StakingOperation>;
        createStakingOperation(walletId, addressId, createStakingOperationRequest, options?): AxiosPromise<StakingOperation>;
        getStakingOperation(walletId, addressId, stakingOperationId, options?): AxiosPromise<StakingOperation>;
    }

    • broadcastStakingOperation:function
      • broadcastStakingOperation(walletId, addressId, stakingOperationId, broadcastStakingOperationRequest, options?): AxiosPromise<StakingOperation>

      • 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 AxiosPromise<StakingOperation>

        Summary

        Broadcast a staking operation

        Throws

    • createStakingOperation:function
      • createStakingOperation(walletId, addressId, createStakingOperationRequest, options?): AxiosPromise<StakingOperation>

      • 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 AxiosPromise<StakingOperation>

        Summary

        Create a new staking operation for an address

        Throws

    • getStakingOperation:function
      • getStakingOperation(walletId, addressId, stakingOperationId, options?): AxiosPromise<StakingOperation>

      • 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 AxiosPromise<StakingOperation>

        Summary

        Get the latest state of a staking operation

        Throws

    Export

Settings

Member Visibility

Theme