README.md

dob-cookbook

A comprehensive collection of Digital Object (DOB) protocol examples and best practices on Nervos CKB. This repository is a practical guide for DOB issuers, demonstrating various implementation patterns and rendering effects.

Introduction

Digital Objects (DOBs) represent a groundbreaking protocol suite for creating, managing, and trading digital assets on Nervos CKB. This cookbook provides a comprehensive set of examples and patterns to help DOB issuers implement their digital asset solutions effectively.

Why DOB?

Digital Objects (DOBs) offer several unique advantages:

• Composability: Build complex digital assets by combining simpler ones
• Extensibility: Easily extend functionality through protocol extensions
• Interoperability: Seamless interaction between different DOB implementations
• Efficiency: Optimized for on-chain storage and verification
• Flexibility: Support for various digital asset types and use cases

Examples

Each example in this cookbook includes:

• Detailed implementation code
• Rendered visual effects
• Usage instructions
• Best practices and considerations

DOB/0 Examples

Basic Loot	Colorful Loot	Regular Link PNG
BTCFS PNG	IPFS PNG	Regular Link SVG
BTCFS SVG (i0)	BTCFS PNG (i1)	BTCFS SVG (i1)

DOB/1 Examples

Basic Shape	Spore Genesis (svg_bg_btcfs_icon)	Nervape Genesis (btcfs_bg_btcfs_icon)
Azuki Genesis (ipfs_bg_btcfs_icon)	Nervape Compose (btcfs)

Compatibility Overview

DOB0 Compatibility

• Testnet

Case	JoyID	Omiga	CKB Explorer	Mobit	Dobby
Basic Loot	✅	✅	✅	✅	✅
Colorful Loot	✅	✅	✅	✅	✅
Regular Link PNG	✅	✅	✅	✅	✅
BTCFS PNG(i0)	✅	✅	✅	✅	❌
IPFS PNG	✅	✅	✅	✅	❌
Regular Link SVG	✅	✅	✅	✅	✅
BTCFS SVG (i0)	✅	✅	✅	✅	❌
BTCFS PNG (i1)	✅	✅	✅	✅	❌
BTCFS SVG (i1)	✅	✅	✅	✅	❌

• Mainnet

Case	JoyID	Omiga	CKB Explorer	Mobit	Dobby
Basic Loot	✅	✅	✅	✅	✅
Colorful Loot	✅	✅	✅	✅	✅
Regular Link PNG	✅	✅	✅	✅	✅
BTCFS PNG(i0)	✅	✅	✅	✅	✅
IPFS PNG	✅	✅	✅	✅	❌
Regular Link SVG	✅	✅	✅	✅	✅
BTCFS SVG (i0)	✅	✅	✅	✅	✅
BTCFS PNG (i1)	✅	✅	✅	✅	✅
BTCFS SVG (i1)	✅	✅	✅	✅	✅

DOB1 Compatibility

• Testnet

Case	JoyID	Omiga	CKB Explorer	Mobit	Dobby
Basic Shape	✅	✅	✅	✅	✅
Spore Genesis(svg_bg_btcfs_icon)	❌	✅	✅	✅	✅
Nervape Genesis(btcfs_bg_btcfs_icon)	✅	✅	✅	✅	✅
Azuki Genesis(ipfs_bg_btcfs_icon)	✅	✅	✅	✅	✅
Nervape Compose(btcfs)	✅	✅	✅	✅	✅

• Mainnet(TODO)

Case	JoyID	Omiga	CKB Explorer	Mobit	Dobby
Basic Shape	✅	✅	✅	✅	✅
Spore Genesis(svg_bg_btcfs_icon)	❌	✅	✅	✅	✅
Nervape Genesis(btcfs_bg_btcfs_icon)	✅	✅	✅	✅	✅
Azuki Genesis(ipfs_bg_btcfs_icon)	✅	✅	✅	✅	✅
Nervape Compose(btcfs)	✅	✅	✅	✅	✅

Why there is no compatibility information for Element Market in this compatibility table?

• Testnet: The Element Market currently does not provide a corresponding testing environment;
• Mainnet: The Element Market needs to manually add the Cluster to the whitelist and perform some necessary settings to see the rendering result of the DOB in the Cluster;

Contributing

We welcome contributions! Please read our Contributing Guidelines before submitting your examples.

Resources

• DOB Best Practices: 中文, English
• DOB cookbook FAQ: FAQ
• DOB/0
• DOB/1
• Spore Document

License

This project is licensed under the MIT License - see the LICENSE file for details.