CouponMinter.getRateLimitStatus

getRateLimitStatus spreads the result of canMintCouponsNow and adds isRateLimitEnabled (payload.maxTps !== null) plus waitSeconds (derived from waitMs / 1000) when minting is currently blocked.

Example

const status = ocp.CouponMinter.getRateLimitStatus(COUPON_MINTER_PAYLOAD);
if (!status.canMint) {
  console.log(`${status.waitSeconds?.toFixed(1)}s remaining`);
}

Parameters

Same as canMintCouponsNow: payload, optional now.

Returns

CanMintResult & { waitSeconds?: number; isRateLimitEnabled: boolean }.

Errors

Inherits OcpValidationError cases from canMintCouponsNow (maxTps, lastMint.time).

See also

• waitUntilCanMint

Source

• src/functions/CouponMinter/waitUntilCanMint.ts (getRateLimitStatus)