📚Overview

This directory contains comprehensive developer documentation for the BitBadges blockchain's x/badges module. Note: For most development, you may actually not need to know many of the underlying details of x/badges that we describe in this section. For example, you may only need high-level API getters like fetching balances and metadata.

Table of Contents

1. Concepts - Core data structures and business logic

2. Messages - Transaction messages and handlers

3. Queries - Query types and endpoints

4. Events - Event emissions and tracking

5. Examples - Common usage patterns and building blocks

Main Features

• No code, no smart contracts - All implemented as a Cosmos module

• 1000x transferability customization for whatever requirements you may need

• Three transferability levels enforced for as much or as little customization as needed (collection-level, sender, recipient approvals)

• Seamless compatibility for checking off-chain criteria like in the BitBadges site where you can gate mints by 7000+ no-code plugins

• Deploy once, support ETH, COSMOS, BTC, SOL users with same token

• Supports any IBC currency

• IBC interoperable through wrapping to x/bank IBC denoms

• Transferability is checked EVERY transfer on-chain, enforcing compliance seamlessly at the protocol level

• Extendible with smart contract frameworks

Message Reference

Collection Management

• MsgCreateCollection - Create new collection

• MsgUpdateCollection - Update existing collection

• MsgUniversalUpdateCollection - Universal create/update interface with invariants support

• MsgDeleteCollection - Delete collection

Token Transfers

• MsgTransferBadges - Transfer tokens between addresses

User Approvals

• MsgUpdateUserApprovals - Update transfer approvals

Address Lists & Dynamic Stores

• MsgCreateAddressLists - Create reusable address lists

• MsgCreateDynamicStore - Create key-value store

• MsgUpdateDynamicStore - Update dynamic store properties

• MsgDeleteDynamicStore - Delete dynamic store

• MsgSetDynamicStoreValue - Set address-specific store values

• MsgIncrementStoreValue - Increase values for addresses

• MsgDecrementStoreValue - Decrease values for addresses

• More messages... - See full message reference

Query Reference

Core Queries

• GetCollection - Retrieve collection data

• GetBalance - Get user balances

• GetApprovalTracker - Get approval usage data

• GetAddressList - Retrieve address list

• More queries... - See full query reference

Quick Links

• BitBadges Chain Repository

• BitBadges Documentation

• Proto Definitions

Documentation Style

This documentation follows the Cosmos SDK module documentation standards and is designed for developers building on or integrating with the BitBadges blockchain.