@somnia-chain/markets-sdk

@somnia-chain/markets-sdk / index / PerpVoucherIneligibleReason

Type Alias: PerpVoucherIneligibleReason

PerpVoucherIneligibleReason = "dormant" | "notStarted" | "ended" | "notFlat" | "mainFunded" | "alreadyClaimed" | "budgetExhausted"

Defined in: packages/sdk/src/perp/voucher.ts:88

Why an account cannot claim a voucher right now.

The reasons are checked in the order VoucherDistributor.claim() checks them, so the reason names the revert a claim would produce at the same block.

  • dormant — the bank has no credit granter. The programme is off for everyone.
  • notStarted — the campaign window has not opened (CampaignInactive).
  • ended — the campaign window has closed (CampaignInactive).
  • notFlat — the account holds a position or a resting order (ClaimantNotFlat). A voucher is starting capital for a new account, not a margin top-up.
  • mainFunded — the account carries principal from a linked main wallet (ClaimantIsMainFunded). The two programmes cannot share one balance.
  • alreadyClaimed — this address has claimed from this distributor before (AlreadyClaimed). The limit is once per address for the distributor's life.
  • budgetExhausted — the budget is below one grant (BudgetExhausted).