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(IP): 50

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

getSoftStakingRewardsHistory

getSoftStakingRewardsHistory(
requestParameters?: GetSoftStakingRewardsHistoryRequest,
): Promise<RestApiResponse<GetSoftStakingRewardsHistoryResponse>>
Get Soft Staking Rewards History

Weight(IP): 50

Security Type: USER_DATA

Notes:
- 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.
Parameters
- OptionalrequestParameters: GetSoftStakingRewardsHistoryRequest
  Request parameters.
Returns Promise<RestApiResponse<GetSoftStakingRewardsHistoryResponse>>
Throws
Memberof
SoftStakingApiInterface
- Defined in clients/staking/src/rest-api/modules/soft-staking-api.ts:240

setSoftStaking

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

Weight(IP): 50

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