Claim Actions

Claim Actions

Claim actions are the final action executed upon a successful claim. BitBadges supports a couple different types of claims depending on the use case.

On-Chain Balances

Badges with the on-chain balance type are slightly different from the rest because it involves blockchain transactions to actually transfer the badges. For these claims, a successful claim will result in reserving the right to claim, but an additional transaction signature from the claimee is required to complete the process and obtain the badges. The transaction can be facilitated through the BitBadges site.

Behind the scenes, this works by issuing unique claim codes which are automatically populated when claming in-site. On-chian, these are the leaves of Merkle challenge in the approval criteria and are one-time use only to prevent replay attacks. These are not the same codes as the Codes plugin, if enabled.

Off-Chain Badges - Indexed

For badges with the "Off-Chain - Indexed" balance type, everything works the same, except that upon successful claim, we actually assign the badges (aka assigning them off-chain). There is no reserve step or signature step for the user. To work, BitBadges needs to store and host the balances (you can migrate to self-host after the claim is done).

Address Lists

For address list claims. If you can meet the criteria, you can get your address auto appended to the list.

Custom Actions

While we do not support custom generic claims out of the box, you can get creative and use one of the above to implement your own claims with custom actions. For example, create an address list claim and track successful claims / addresses but perform your own custom actions when you need to.

Custom Claim Numbers

By default, we use an incrementing claim number system. For example, claim #1, then claim #2, etc. However, certain plugins may require specifying claim numbers in order to function. Claim numbers can be used to distribute specific badges. They are not applicable to address lists or non-indexed (see below) actions.

Only one plugin is allowed to assign claim numbers which is determined by the assignMethod of the claim. If the assignMethod === a plugin's unique instance ID, we allow it to assign claim numbers.

Reusing Plugins for Assigning Non-Indexed Balances

Badges with "Off-Chain - Non-Indexed" balances type are slightly different because there is no claiming process. They are fetched on-demand, and any address must be able to be checked at any given time.

For these, we reuse some plugins (if compatible) to assign balances whether the plugin criteria is met or not. Compatiibility requires the plugin to be able to function with zero user interaction and only knowledge of the user's address. Plugins that require anything other than just the user's crypto address are incompatible.

For example, checking a minimum balance of $BADGE is safe to use because we always know a user's balance at any given time wihtout user interaction and just their address.