Interface: iClaimDetails<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1944

Type Parameters#

T#

T extends NumberType

Properties#

_includesPrivateParams#

_includesPrivateParams: boolean

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1946

Whether the claim fetch includes private params

---

_templateInfo?#

optional _templateInfo?: object

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:2022

Internal

For internal use by the frontend.

completedTemplateStep?#

optional completedTemplateStep?: boolean

pluginId?#

optional pluginId?: string

supportedApproaches?#

optional supportedApproaches?: string[]

---

approach?#

optional approach?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1987

How the claim is expected to be completed. This is for display purposes for the frontend.

Available options:

• in-site (default): The claim is expected to be completed in-site.
• api: The claim is expected to be completed via an API call.
• zapier: The claim is expected to be completed via Zapier auto-completion.

Typically, you will use the in-site approach

---

assignMethod?#

optional assignMethod?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:2001

Algorithm to determine the claim number order. Blank is just incrementing claim numbers.

For most cases, you will not need to specify this.

---

cachePolicy?#

optional cachePolicy?: iClaimCachePolicy<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:2016

Cache policy for the claim. Only needed for on-demand claims.

---

categories?#

optional categories?: string[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1968

The categories of the claim

---

claimId#

claimId: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1948

Unique claim ID.

---

collectionId?#

optional collectionId?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1954

Collection ID that the claim is for (if applicable - collection claims).

---

createdBy?#

optional createdBy?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1950

The original creator of the claim

---

estimatedCost?#

optional estimatedCost?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1964

Estimated cost for the claim.

---

estimatedTime?#

optional estimatedTime?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1970

Estimated time to satisfy the claim's requirements.

---

lastUpdated?#

optional lastUpdated?: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:2003

Last updated timestamp for the claim.

---

managedBy?#

optional managedBy?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1952

The BitBadges address of the user who is currently managing this

---

manualDistribution?#

optional manualDistribution?: boolean

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1976

If manual distribution is enabled, we do not handle any distribution of claim codes. We leave that up to the claim creator.

Only applicable for on-chain token claims. This is only used in advanced self-hosted cases.

---

metadata?#

optional metadata?: iMetadata<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1995

Metadata for the claim.

---

plugins#

plugins: IntegrationPluginDetails<string>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1960

Claim plugins. These are the criteria that must pass for a user to claim.

---

rewards?#

optional rewards?: iClaimReward<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1962

Rewards for the claim.

---

satisfyMethod?#

optional satisfyMethod?: iSatisfyMethod

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:2012

Custom satisfaction logic.

If left blank, all plugins must pass for the claim to be satisfied. Otherwise, you can specify a custom method to determine if the claim is satisfied.

---

seedCode?#

optional seedCode?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1993

Seed code for the claim. Only used for on-chain token claims.

This is how we produce all reserved codes for the on-chain merkle challenge / proofs.

---

showInSearchResults?#

optional showInSearchResults?: boolean

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1966

If true, the claim will be shown in search results

---

standaloneClaim?#

optional standaloneClaim?: boolean

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1956

Standalone claims are not linked with a token or list.

---

trackerDetails?#

optional trackerDetails?: iChallengeTrackerIdDetails<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1958

The tracker details for the claim (if applicable - collection claims).

---

version#

version: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:2005

The version of the claim.