Distribution methods
Before we dive deeper into how to work with each of the APIs, we want to call out the different distribution methods of a Kudos.
When sending a Kudos to someone, especially when the Kudos is something extremely personal, you want to make sure that only the specified & allowlisted recipients can claim it (this list is even stored on-chain in the form of a Merkle root so you can be sure that nobody else can claim these tokens). You can specify this configuration on creation via the Kudos creation API by setting
isAllowlistRequired=true and isSignatureRequired=true.In general we recommend this path for almost all Kudos tokens for integrity purposes, especially if you know the recipients' ETH addresses ahead of time.
What allowlisting & specifying addresses for a Kudos looks like in the MintKudos UI
When claiming a token with an allowlist, the recipient must sign a message with their wallet to prove ownership of the wallet
There are some cases where you may not be able to obtain the potential recipients' addresses. For example, you may be giving out a Kudos token for attending your talk at a conference. In these cases, you may need to resort to providing a claim link that can be claimed by an unspecified audience.
You can specify this configuration on creation via the Kudos creation API by setting
isAllowlistRequired=false and isSignatureRequired=false. Whenever possible, we recommend not using this distribution method, as if people can find the claim URL, they can airdrop the token to themselves and also to others.
What not specifying addresses for a Kudos looks like in the MintKudos UI. In the above screenshot, there will be a maximum of 100 unspecified addresses that can claim the Kudos
When claiming a token with no allowlist, the recipient can just input their own ETH address on the claim page and claim a token.