miso-share

A Sui Move package for fixed-supply currency issuance, designed for representing equity-like ownership stakes.

share::share::initialize mints exactly 10,000,000.000000 tokens (6 decimals) and makes the supply immutable. It enforces a set of structural invariants at initialization to guarantee the resulting token is well-formed, tamper-proof, and freeze-proof:

• The type parameter must be <address>::share::Share
• The currency's MetadataCap must already be deleted (metadata is frozen)
• The treasury cap must be the canonical cap recorded on the currency at creation — this also rejects legacy-migrated currencies
• Decimals must equal 6
• Existing supply must be zero
• The currency must not be regulated — a regulated currency carries a DenyCapV2 whose holder could deny-list or globally pause share holders forever, so the deny authority must never exist over a share currency

Install

Pin to a full commit SHA (never a branch):

[dependencies]
share = { git = "https://github.com/misofm/share.git", rev = "<commit-sha>" }

Usage

1. Create a package with a share module containing a Share type (a plain key object, e.g. public struct Share has key { id: UID } — NOT a one-time witness; the name must be exactly Share in a module named share).
2. Create a currency with sui::coin_registry::new_currency.
3. Set any desired metadata (name, symbol, icon, description), then call finalize_and_delete_metadata_cap to freeze it.
4. Call share::share::initialize with the currency and its canonical treasury cap (the one created together with the currency).
5. Distribute the returned Balance<Share> to shareholders.

Dependencies

Dependency	Source
Sui Framework	Sui standard libraries

Build

sui move build

Test

sui move test

Contributing

Issues and pull requests are welcome. By contributing you agree that your contributions are licensed under the project's Apache 2.0 license.

License

Apache 2.0 © Miso Labs, Inc.