A unique stringified document ID
Optional_idA unique document ID (Mongo DB ObjectID)
Details for the action to perform if the criteria is correct
OptionalapproachThe expected approach for the claim. This is for display purposes for the frontend.
Available options:
OptionalassignAlgorithm to determine the claaim number indices
OptionalcacheFor on-demand claims, we cache the result per user for a short period.
To help optimize performance, please provide a cache policy.
This is only applicable to on-demand claims.
OptionalcategoriesThe categories of the claim
The CID (content ID) of the document. This is used behind the scenes to handle off-chain vs on-chain data races.
The collection ID of the document
The BitBadges address of the user who created this password
OptionaldeletedDeleted at timestamp
True if the document is claimed by the collection
OptionalestimatedEstimated cost for the user
OptionalestimatedEstimated time to satisfy the claim's requirements
The BitBadges address of the user who is currently managing this
OptionalmanualIf true, the claim codes are to be distributed manually. This doc will only be used for storage purposes. Only in use for legacy on-chain claims.
OptionalmetadataMetadata for the claim
OptionalpluginFor query purposes, the plugin IDs
Dynamic checks to run in the form of plugins
OptionalrewardsRewards to be shown upon a successful claim. If you need further gating, you can do this in two-steps.
OptionalsatisfyCustom success logic. If not provided, we will default to AND logic with all plugins.
OptionalshowIf true, the claim will be shown in search results
The current state of each plugin
OptionaltestOptionaltrackerWhich challenge tracker is it tied to
Deep copies the object and returns a new instance.
Converts the object to a different NumberType equivalent.
Optionaloptions: ConvertOptionsCompares 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").
OptionalnormalizeNumberTypes: booleanInternal helper method to convert the number fields of the object to a different NumberType equivalent.
Checks if the object has number fields.
Converts the object to a JSON object with all primitive types.
Converts the object to a JSON string.