Skip to main content
Version: Next

Keys

This part of the cookbook contains everything related to keys in a drop, including adding keys to a drop, checking key usage and getting the number of active keys in a drop.

Getting Started​

For the cookbook, you will need the following installed.

  1. Node JS
  2. Keypom JS SDK
note

Ensure that you have initialized Keypom using the initKeypom function prior to running any of the SDK examples. For more info on this, see the introduction page

Adding Keys to a Drop​

Additional keys may be added to a drop using the addKeys function. This is particularly helpful when you want to create a large drop, and need to add more than 100 keys to the drop. You can simply loop addKeys instead of being restricted by the amount of gas used when calling createDrop. 

// Create an empty simple drop with no keys.
const {dropId} = await createDrop({
    account: fundingAccount,
    depositPerUseNEAR: 1,
});

// Add 10 completely random keys. The return value `keys` contains information about the generated keys
const {keys} = await addKeys({
    account: fundingAccount,
    dropId,
    numKeys: 10
})
caution

addKeys is limited to adding 50 password protected keys or 100 non-protected keys at a time. To add more keys, see the large drops example.

Removing Keys from a Drop​

Just as keys can be added to a drop retroactively, they can also be removed. The following shows that process. 

// Create drop with 5 keys
const {keys, dropId} = await createDrop({
    account: fundingAccount,
    numKeys: 5,
    depositPerUseNEAR: 1,
});

// Delete first key from drop
await deleteKeys({
    account: fundingAccount,
    dropId,
    publicKeys: keys.publicKeys[0] // Can be wrapped in an array as well
})

Checking Key Usage​

A good use case for checking key usage is when you want to track the progress/retention of the keys in your drop. An excellent example is the ticketing tutorial where each key use represented a different phase of the ticketing experience. To do this, you can get and parse the keyInfo object by calling getKeysForDrop. 

// Query for the key supply for the drop that was created
const keyInfos = await getKeysForDrop({
    dropId
})

// Check key usage of first key
const keyUsage = keyInfos[0].remaining_uses

console.log(keyUsage)

Checking Key Balance​

Similar to how checking a key usage is done, you can parse the keyInfo object to see a key's remaining allowance. 

// Query for the key supply for the drop that was created
const keyInfos = await getKeysForDrop({
    dropId
})

// Check key usage of first key
const keyBalance = keyInfos[0].allowance

console.log(keyBalance)

Check Number of Keys Remaining in a Drop​

When a key is fully depleted, it is deleted from the drop. To check the number of remaining keys, and thus the amount of keys to still be claimed, you can use getKeySupplyForDrop.

// Query for the key supply for a drop
const keySupply = await getKeySupplyForDrop({
    dropId
})

console.log(keySupply)