Defining and Locking Circulating Supply

This example demonstrates how circulating supply is dynamically calculated and how to control it through mint approval management.

Overview

Unlike traditional blockchains with set-and-forget supply mechanisms, BitBadges supply is dynamically calculated based on the ability to use mint approvals and the ability to create new ones or edit them.

Thus, note that if the manager can create any new Mint approval, they can theoretically increase the supply by whatever the approval allows.

Lock Supply Forever (Fixed Cap)

const FullTimeRanges = [
    {
        start: '1',
        end: '18446744073709551615',
    },
];

const collectionPermissions = {
    // ... other permissions
    canUpdateCollectionApprovals: [
        {
            fromListId: 'Mint', // Target all mint approvals
            toListId: 'All',
            initiatedByListId: 'All',
            transferTimes: FullTimeRanges,
            badgeIds: FullTimeRanges,
            ownershipTimes: FullTimeRanges,
            approvalId: 'All',
            permanentlyPermittedTimes: [],
            permanentlyForbiddenTimes: FullTimeRanges, // Cannot update mint approvals
        },
    ],
};

Result: All Mint approvals are final. Whatever currently possible is possible but final.

Controlled Supply (Managed Growth)

const collectionPermissions = {
    // ... other permissions
    canUpdateCollectionApprovals: [
        {
            fromListId: 'Mint',
            toListId: 'All',
            initiatedByListId: 'All',
            transferTimes: FullTimeRanges,
            badgeIds: FullTimeRanges,
            ownershipTimes: FullTimeRanges,
            approvalId: 'initial-mint', // Only lock initial mint approval
            permanentlyPermittedTimes: [],
            permanentlyForbiddenTimes: FullTimeRanges,
        },
    ],
};

Result: "initial-mint" approval locked, but manager can add new ones.

Dynamic Supply (Fully Flexible)

const collectionPermissions = {
    // ... other permissions
    canUpdateCollectionApprovals: [], // Soft-enabled
};

Result: Manager can always modify mint approvals and adjust supply

Lock Specific Badge IDs

const collectionPermissions = {
    // ... other permissions
    canUpdateCollectionApprovals: [
        {
            fromListId: 'Mint',
            toListId: 'All',
            initiatedByListId: 'All',
            transferTimes: FullTimeRanges,
            badgeIds: [
                {
                    start: '1',
                    end: '100',
                },
            ],
            ownershipTimes: FullTimeRanges,
            approvalId: 'All',
            permanentlyPermittedTimes: [],
            permanentlyForbiddenTimes: FullTimeRanges,
        },
    ],
};

Result: The Mint approvals for badges 1-100 are locked and final. The manager can still create new Mint approvals for other badge IDs or post-mint approvals for those badges.

Related Examples

• Freezing Mint Transferability - Lock all mint approvals

• Building Collection Approvals - Create mint approvals

• Empty Approval Criteria - Unlimited mint template

Related Concepts

• Total Supply - Supply calculation mechanics

• Max Number of Transfers - Transfer limits

• Permissions System - Permission controls