Skip to content

Latest commit

 

History

History
52 lines (34 loc) · 1.31 KB

README.md

File metadata and controls

52 lines (34 loc) · 1.31 KB

Charms

crates.io

charms is a library, CLI tool and web API for programmable tokens and NFTs on top of Bitcoin.

Charms are bundles of tokens, NFTs and arbitrary app state, enchanting Bitcoin UTXOs, that can be used to build apps directly on Bitcoin.

For example: Charms NFTs have state, so it's easy to create a token managed by an NFT: the token's remaining unminted supply is stored in the NFT state, and you can only mint the token when updating the NFT state accordingly (in the same transaction).

Charms are created using spells — special messages added to Bitcoin transactions, manifesting creation and transformation of charms.

Get Started

Install Charms CLI:

cargo +nightly install charms

Create your first app (your own token on Bitcoin):

charms app new my-token
cd ./my-token
ls -l

How To

Concepts and guides: charms.dev

Charms CLI:

charms --help

Inspiration

Charms are inspired by Runes — a way to create tokens on top of Bitcoin. Charms are, in a way, a generalization of Runes.

The main difference is that Charms are easily programmable (and composable).

©️2024 sigmazero