Interface iClaimDetails<T>

interface iClaimDetails<T> {
    _includesPrivateParams: boolean;
    approach?: string;
    assignMethod?: string;
    balancesToSet?: iPredeterminedBalances<T>;
    categories?: string[];
    claimId: string;
    collectionId?: T;
    createdBy?: string;
    estimatedCost?: string;
    estimatedTime?: string;
    lastUpdated?: T;
    listId?: string;
    manualDistribution?: boolean;
    metadata?: iMetadata<T>;
    plugins: IntegrationPluginDetails<string>[];
    rewards?: iClaimReward<T>[];
    satisfyMethod?: iSatisfyMethod;
    seedCode?: string;
    showInSearchResults?: boolean;
    siwbbClaim?: boolean;
    trackerDetails?: iChallengeTrackerIdDetails<T>;
    version: T;
}

Type Parameters

Implemented by

Properties

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

Properties

_includesPrivateParams

_includesPrivateParams: boolean

Whether the claim fetch includes private params

Optionalapproach

approach?: string

Whether the claim is expected to be automatically triggered by someone (not the user).

OptionalassignMethod

assignMethod?: string

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

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.

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).

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).

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.

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 the badge.

Optionalrewards

rewards?: iClaimReward<T>[]

Rewards for the claim.

OptionalsatisfyMethod

satisfyMethod?: iSatisfyMethod

Custom satisfaction logic

OptionalseedCode

seedCode?: string

Seed code for the claim.

OptionalshowInSearchResults

showInSearchResults?: boolean

If true, the claim will be shown in search results

OptionalsiwbbClaim

siwbbClaim?: boolean

Is intended to be used for Sign In with BitBadges.

OptionaltrackerDetails

trackerDetails?: iChallengeTrackerIdDetails<T>

The tracker details for the claim.

version

version: T

The version of the claim.

Settings

Member Visibility

On This Page

Properties