Skip to content

Interface: UserRecurringApprovalArgs

Approval id — caller picks; usually a fresh UUID.

Defined in: packages/bitbadgesjs-sdk/src/core/subscriptions.ts:358

Properties

approvalId

approvalId: string

Defined in: packages/bitbadgesjs-sdk/src/core/subscriptions.ts:368

Approval id — caller picks; usually a fresh UUID.

denom

denom: string

Defined in: packages/bitbadgesjs-sdk/src/core/subscriptions.ts:372

Coin denom — must match the faucet's coinTransfer denom.

detailsDescription?

optional detailsDescription?: string

Defined in: packages/bitbadgesjs-sdk/src/core/subscriptions.ts:376

Optional override for details.description. Defaults to a short English string.

detailsName?

optional detailsName?: string

Defined in: packages/bitbadgesjs-sdk/src/core/subscriptions.ts:374

Optional override for details.name. Defaults to "Recurring Approval".

firstIntervalStartTime

firstIntervalStartTime: bigint

Defined in: packages/bitbadgesjs-sdk/src/core/subscriptions.ts:362

First charge window's start time, in ms since epoch.

subscriptionApproval

subscriptionApproval: iCollectionApprovalWithDetails<bigint>

Defined in: packages/bitbadgesjs-sdk/src/core/subscriptions.ts:360

The faucet (collection-side) subscription approval this recurring approval consents to.

tokenIds

tokenIds: iUintRange<bigint>[]

Defined in: packages/bitbadgesjs-sdk/src/core/subscriptions.ts:370

Token ids the subscription mints. Lifted directly from the faucet approval.

transferTimes

transferTimes: UintRangeArray<bigint>

Defined in: packages/bitbadgesjs-sdk/src/core/subscriptions.ts:366

Outer window during which the recurring approval is active. Typically UintRangeArray.FullRanges().

ubadgeTipAmount

ubadgeTipAmount: bigint

Defined in: packages/bitbadgesjs-sdk/src/core/subscriptions.ts:364

Optional tip added on top of the base subscription amount each interval. Pass 0n for no tip.

Edit this page on GitHub