Class ClaimBuilderDoc<T>

Type Parameters

Hierarchy (view full)




_docId: string

A unique stringified document ID

_id?: string

A unique document ID (Mongo DB ObjectID)

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

Details for the action to perform if the criteria is correct

Type declaration

  • Optional balancesToSet?: PredeterminedBalances<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?: Metadata<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?: ChallengeTrackerIdDetails<T>

Which challenge tracker is it tied to


  • Compares this object's fields to another object's fields for equality. Equality is determined by comparing the JSON representations of the objects.

    If normalizeNumberTypes is true, then all number types will be compared as strings (i.e. "1n" === "1" === 1). Else, they will be compared as their native types (i.e. 1n !== 1 !== "1").

    Type Parameters


    • other: undefined | null | CustomType<U>
    • Optional normalizeNumberTypes: boolean

    Returns boolean