@somnia-chain/markets-sdk / index / PerpVoucherCampaign
Interface: PerpVoucherCampaign
Defined in: packages/sdk/src/perp/voucher.ts:38
The live credit-voucher campaign behind one MarginBank.
Every amount is in raw collateral units and every time is Unix seconds.
Properties
distributor
distributor:
`0x${string}`
Defined in: packages/sdk/src/perp/voucher.ts:40
The VoucherDistributor the bank accepts credit from. Pass it to claimPerpVoucher to skip resolution.
collateralToken
collateralToken:
`0x${string}`
Defined in: packages/sdk/src/perp/voucher.ts:42
The collateral token the grant is paid in.
grantAmount
grantAmount:
bigint
Defined in: packages/sdk/src/perp/voucher.ts:44
What one claim credits, in raw collateral units.
expiryDurationSec
expiryDurationSec:
bigint
Defined in: packages/sdk/src/perp/voucher.ts:49
Seconds after a claim before the grant can be swept back. A sweep happens only when the account holds no positions or resting orders; it never forces a close.
startsAt
startsAt:
bigint
Defined in: packages/sdk/src/perp/voucher.ts:51
Unix seconds when claims open. Inclusive.
endsAt
endsAt:
bigint
Defined in: packages/sdk/src/perp/voucher.ts:53
Unix seconds when claims close. Exclusive.
budgetRemaining
budgetRemaining:
bigint
Defined in: packages/sdk/src/perp/voucher.ts:58
The distributor's collateral balance. This is the hard cap on claims: when it
falls below grantAmount, every claim reverts until someone funds it.
claimsRemaining
claimsRemaining:
bigint
Defined in: packages/sdk/src/perp/voucher.ts:60
How many more claims the budget covers: budgetRemaining / grantAmount, rounded down.
leverageCapX
leverageCapX:
number
Defined in: packages/sdk/src/perp/voucher.ts:66
The leverage a voucher account is confined to when it increases a position.
0 blocks every increase; it does not mean "uncapped". Each market's own
initial margin still applies, so the effective limit is the lower of the two.