Interface iClaimBuilderDoc<T>

interface iClaimBuilderDoc<T> {
    _docId: string;
    _id?: string;
    action: {
        balancesToSet?: iPredeterminedBalances<T>;
        codes?: string[];
        listId?: string;
        seedCode?: string;
    automatic?: boolean;
    cid: string;
    collectionId: T;
    createdBy: string;
    deletedAt?: T;
    docClaimed: boolean;
    lastUpdated: T;
    manualDistribution?: boolean;
    metadata?: iMetadata<T>;
    plugins: IntegrationPluginParams<string>[];
    state: {
        [pluginId: string]: any;
    trackerDetails?: iChallengeTrackerIdDetails<T>;

Type Parameters

Hierarchy (view full)

  • Doc
    • iClaimBuilderDoc

Implemented by


_docId: string

A unique stringified document ID

_id?: string

A unique document ID (Mongo DB ObjectID)

action: {
    balancesToSet?: iPredeterminedBalances<T>;
    codes?: string[];
    listId?: string;
    seedCode?: string;

Details for the action to perform if the criteria is correct

Type declaration

  • Optional balancesToSet?: iPredeterminedBalances<T>
  • Optional codes?: string[]
  • Optional listId?: string
  • Optional seedCode?: string
automatic?: boolean

If true, the claim has been designated to be completed automatically for users.

cid: string

The CID (content ID) of the document. This is used behind the scenes to handle off-chain vs on-chain data races.

collectionId: T

The collection ID of the document

createdBy: string

The cosmos address of the user who created this password

deletedAt?: T

Deleted at timestamp

docClaimed: boolean

True if the document is claimed by the collection

lastUpdated: T
manualDistribution?: boolean

If true, the claim codes are to be distributed manually. This doc will only be used for storage purposes.

metadata?: iMetadata<T>

Metadata for the claim

plugins: IntegrationPluginParams<string>[]

Dynamic checks to run in the form of plugins

state: {
    [pluginId: string]: any;

The current state of each plugin

Type declaration

  • [pluginId: string]: any
trackerDetails?: iChallengeTrackerIdDetails<T>

Which challenge tracker is it tied to