Whether the claim fetch includes private params
Optional Internal_templateFor internal use by the frontend.
OptionalapproachHow the claim is expected to be completed. This is for display purposes for the frontend.
Available options:
Typically, you will use the in-site approach
OptionalassignAlgorithm to determine the claim number order. Blank is just incrementing claim numbers.
For most cases, you will not need to specify this.
OptionalbalancesThe 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.
OptionalcacheCache policy for the claim. Only needed for on-demand claims.
OptionalcategoriesThe categories of the claim
Unique claim ID.
OptionalcollectionCollection ID that the claim is for (if applicable - collection claims).
OptionalcreatedThe original creator of the claim
OptionalestimatedEstimated cost for the claim.
OptionalestimatedEstimated time to satisfy the claim's requirements.
OptionallastLast updated timestamp for the claim.
OptionallistAddress list ID that the claim is for (if applicable - list claims).
OptionalmanagedThe BitBadges address of the user who is currently managing this
OptionalmanualIf 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.
OptionalmetadataMetadata for the claim.
Claim plugins. These are the criteria that must pass for a user to claim.
OptionalrewardsRewards for the claim.
OptionalsatisfyCustom 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.
OptionalseedSeed 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.
OptionalshowIf true, the claim will be shown in search results
OptionalstandaloneStandalone claims are not linked with a badge or list.
OptionaltrackerThe tracker details for the claim (if applicable - collection claims).
The version of the claim.
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.