Interface RedeemApiInterface

RedeemApi - interface RedeemApi

interface RedeemApiInterface {
    batchRedeem(
        requestParameters: BatchRedeemRequest,
    ): Promise<RestApiResponse<BatchRedeemResponse>>;
    getRedeemStatus(
        requestParameters: GetRedeemStatusRequest,
    ): Promise<RestApiResponse<GetRedeemStatusResponse>>;
}

Implemented by

RedeemApi

Index

Methods

batchRedeem getRedeemStatus

Methods

batchRedeem

batchRedeem(
requestParameters: BatchRedeemRequest,
): Promise<RestApiResponse<BatchRedeemResponse>>
Redeem one or more settled prediction tokens on-chain to claim winnings. Requires SAS authorization.

Weight(IP): 200

Security Type: TRADE
Parameters
- requestParameters: BatchRedeemRequest
  Request parameters.
Returns Promise<RestApiResponse<BatchRedeemResponse>>
Throws
Memberof
RedeemApiInterface
- Defined in clients/w3w-prediction/src/rest-api/modules/redeem-api.ts:166

getRedeemStatus

getRedeemStatus(
requestParameters: GetRedeemStatusRequest,
): Promise<RestApiResponse<GetRedeemStatusResponse>>
Query the on-chain transaction status of a previously submitted redeem request.

Weight(IP): 200

Security Type: USER_DATA

Response Notes:
- Status values:
Value Description

PENDING Transaction submitted, awaiting confirmation

CONFIRMED Transaction confirmed on-chain

FAILED Transaction failed

NOT_FOUND Transaction hash not found
Parameters
- requestParameters: GetRedeemStatusRequest
  Request parameters.
Returns Promise<RestApiResponse<GetRedeemStatusResponse>>
Throws
Memberof
RedeemApiInterface
- Defined in clients/w3w-prediction/src/rest-api/modules/redeem-api.ts:192