Interface SoftStakingApiInterface

SoftStakingApi - interface SoftStakingApi

interface SoftStakingApiInterface {
    getSoftStakingProductList(
        requestParameters?: GetSoftStakingProductListRequest,
    ): Promise<RestApiResponse<GetSoftStakingProductListResponse>>;
    getSoftStakingRewardsHistory(
        requestParameters?: GetSoftStakingRewardsHistoryRequest,
    ): Promise<RestApiResponse<GetSoftStakingRewardsHistoryResponse>>;
    setSoftStaking(
        requestParameters: SetSoftStakingRequest,
    ): Promise<RestApiResponse<SetSoftStakingResponse>>;
}

Implemented by

SoftStakingApi

Index

Methods

getSoftStakingProductList getSoftStakingRewardsHistory setSoftStaking

Methods

getSoftStakingProductList

getSoftStakingProductList(
requestParameters?: GetSoftStakingProductListRequest,
): Promise<RestApiResponse<GetSoftStakingProductListResponse>>
Get the available Soft Staking product list.

Weight: 50
Parameters
- OptionalrequestParameters: GetSoftStakingProductListRequest
  Request parameters.
Returns Promise<RestApiResponse<GetSoftStakingProductListResponse>>
Throws
Memberof
SoftStakingApiInterface
- Defined in clients/staking/src/rest-api/modules/soft-staking-api.ts:196

getSoftStakingRewardsHistory

getSoftStakingRewardsHistory(
requestParameters?: GetSoftStakingRewardsHistoryRequest,
): Promise<RestApiResponse<GetSoftStakingRewardsHistoryResponse>>
- The time between startTime and endTime cannot be longer than 3 months. If startTime and endTime are both not sent, then the last 30 days' data will be returned. If startTime is sent but endTime is not sent, the next 30 days' data beginning from startTime will be returned. If endTime is sent but startTime is not sent, the 30 days' data before endTime will be returned.
Weight: 50
Parameters
- OptionalrequestParameters: GetSoftStakingRewardsHistoryRequest
  Request parameters.
Returns Promise<RestApiResponse<GetSoftStakingRewardsHistoryResponse>>
Throws
Memberof
SoftStakingApiInterface
- Defined in clients/staking/src/rest-api/modules/soft-staking-api.ts:213

setSoftStaking

setSoftStaking(
requestParameters: SetSoftStakingRequest,
): Promise<RestApiResponse<SetSoftStakingResponse>>
Enable or disable Soft Staking.

Weight: 50
Parameters
- requestParameters: SetSoftStakingRequest
  Request parameters.
Returns Promise<RestApiResponse<SetSoftStakingResponse>>
Throws
Memberof
SoftStakingApiInterface
- Defined in clients/staking/src/rest-api/modules/soft-staking-api.ts:227