Interface iClaimDetails<T>

interface iClaimDetails<T extends NumberType> {
    _includesPrivateParams: boolean;
    _templateInfo?: {
        completedTemplateStep?: boolean;
        pluginId?: string;
        supportedApproaches?: string[];
    };
    approach?: string;
    assignMethod?: string;
    balancesToSet?: iPredeterminedBalances<T>;
    cachePolicy?: iClaimCachePolicy<T>;
    categories?: string[];
    claimId: string;
    collectionId?: T;
    createdBy?: string;
    estimatedCost?: string;
    estimatedTime?: string;
    lastUpdated?: T;
    listId?: string;
    managedBy?: string;
    manualDistribution?: boolean;
    metadata?: iMetadata<T>;
    plugins: IntegrationPluginDetails<string>[];
    rewards?: iClaimReward<T>[];
    satisfyMethod?: iSatisfyMethod;
    seedCode?: string;
    showInSearchResults?: boolean;
    standaloneClaim?: boolean;
    trackerDetails?: iChallengeTrackerIdDetails<T>;
    version: T;
}

Type Parameters

Implemented by

Properties

_includesPrivateParams _templateInfo? approach? assignMethod? balancesToSet? cachePolicy? categories? claimId collectionId? createdBy? estimatedCost? estimatedTime? lastUpdated? listId? managedBy? manualDistribution? metadata? plugins rewards? satisfyMethod? seedCode? showInSearchResults? standaloneClaim? trackerDetails? version

Properties

_includesPrivateParams

_includesPrivateParams: boolean

Whether the claim fetch includes private params

Optional Internal_templateInfo

_templateInfo?: {
    completedTemplateStep?: boolean;
    pluginId?: string;
    supportedApproaches?: string[];
}

For internal use by the frontend.

Optionalapproach

approach?: string

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

OptionalassignMethod

assignMethod?: string

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

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

OptionalbalancesToSet

balancesToSet?: iPredeterminedBalances<T>

The balances to set for the claim.

Only used for claims for collections that have off-chain indexed balances and are assigning balances based on the claim.

OptionalcachePolicy

cachePolicy?: iClaimCachePolicy<T>

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

Optionalcategories

categories?: string[]

The categories of the claim

claimId

claimId: string

Unique claim ID.

OptionalcollectionId

collectionId?: T

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

OptionalcreatedBy

createdBy?: string

The original creator of the claim

OptionalestimatedCost

estimatedCost?: string

Estimated cost for the claim.

OptionalestimatedTime

estimatedTime?: string

Estimated time to satisfy the claim's requirements.

OptionallastUpdated

lastUpdated?: T

Last updated timestamp for the claim.

OptionallistId

listId?: string

Address list ID that the claim is for (if applicable - list claims).

OptionalmanagedBy

managedBy?: string

The BitBadges address of the user who is currently managing this

OptionalmanualDistribution

manualDistribution?: boolean

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 badge claims. This is only used in advanced self-hosted cases.

Optionalmetadata

metadata?: iMetadata<T>

Metadata for the claim.

plugins

plugins: IntegrationPluginDetails<string>[]

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

Optionalrewards

rewards?: iClaimReward<T>[]

Rewards for the claim.

OptionalsatisfyMethod

satisfyMethod?: iSatisfyMethod

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.

OptionalseedCode

seedCode?: string

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

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

OptionalshowInSearchResults

showInSearchResults?: boolean

If true, the claim will be shown in search results

OptionalstandaloneClaim

standaloneClaim?: boolean

Standalone claims are not linked with a badge or list.

OptionaltrackerDetails

trackerDetails?: iChallengeTrackerIdDetails<T>

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

version

version: T

The version of the claim.

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR