A comprehensive TypeScript monorepo for managing Token-2022 tokens with extensions on Solana, specifically designed for different token templates for Stablecoins, RWAs, and Arcade Token. It includes built in advanced access control features such as integration with sRFC-37.
Note: sRFC-37 is still under development and not ready for mainnet use. If you use this repo please be sure to not use sRFC-37 yet.
Most implementations of standard token types follow similar patterns and usages of Token Extensions. This repo provides issuers and tokenization engines best practices for integrating and using Token Extensions. Additionally apps can use the SDK to easily abstract away complexities related to working with Token Extensions.
- Node.js 18+
- pnpm 8+
- Solana CLI
# Install pnpm if you haven't already
npm install -g pnpm
# Install dependencies
pnpm install# Start the development server
pnpm run ui
# Open http://localhost:3000 in your browserSee the cli readme for detailed docs
# Install dependencies
pnpm install
# Build all packages
pnpm build
# Create a stablecoin
cd packages/cli
pnpm start create stablecoin \
--name "My Stable Coin" \
--symbol "MSC" \
--decimals 6 \
--uri "https://example.com/metadata.json"
# Create an arcade token
pnpm start create arcade-token \
--name "Game Points" \
--symbol "POINTS" \
--decimals 0 \
--uri "https://example.com/game-metadata.json"See the sdk readme for detailed docs
import {
createStablecoinInitTransaction,
createArcadeTokenInitTransaction,
} from '@mosaic/sdk';
import { createSolanaRpc, generateKeyPairSigner } from 'gill';
const rpc = createSolanaRpc('https://api.devnet.solana.com');
const authority = await generateKeyPairSigner();
const mint = await generateKeyPairSigner();
// Create a stablecoin with compliance features
const tx = await createStablecoinInitTransaction(
rpc,
'USD Coin',
'USDC',
6,
'https://example.com/metadata.json',
authority.address,
mint,
authority
);This monorepo contains the following packages:
- @mosaic/sdk - Core SDK with token templates, allowlist / blocklist integrations, management utilities, and Token-2022 integration
- @mosaic/cli - Command-line interface for token creation and management
- @mosaic/ui - UI for a full featured tokenization engine for token management with wallet integration and sRFC-37 administration
- @mosaic/abl - Allowlist/Blocklist implementation for sRFC-37 compliance
- @mosaic/ebalts - Efficient Block/Allow List Token Standard (sRFC-37) for advanced blocklist / allowlist functionality
- @mosaic/tlv-account-resolution - TLV account resolution utilities
The majority of tokens fit into a few different templates. This includes Stablecoins, RWAs, Arcade Tokens, Tokenized Equities, and ICOs / App tokens. Generally tokens need the ability to manage access to the token via a blocklist or allowlist, and for compliance reasons also be able to seize & freeze assets. The following breaks down the templates for each token type and corresponds to the templates in the SDK.
Token-2022 Extensions:
- Default Account State - Required for the sRFC-37 blocklist/allowlist
- Metadata - On-chain token metadata
- Confidential Balances - Balance encryption for token accounts and transfers
- Pausable - Disable all interactions with the token
- Permanent Delegate - Burn or transfer funds from any address
Token-2022 Extensions:
- Default Account State - Required for the sRFC-37 blocklist/allowlist
- Metadata - Rich on-chain metadata for gaming
- Permanent Delegate - Burn or transfer funds from any address
- Pausable - Disable all interactions with the token
Token-2022 Extension:
- Default Account State - Required for the sRFC-37 blocklist/allowlist
- Metadata - On-chain token metadata
- Confidential Balances - Balance encryption for token accounts and transfers
- Pausable - Disable all interactions with the token
- Permanent Delegate - Burn or transfer funds from any address
- Scaled UI Amount - Updatable multiplier for dividend distribution, stock splits, reverse stock splits
# Install dependencies for all packages
pnpm install
# Build all packages
pnpm build
# Run development mode for all packages
pnpm dev
# Run tests across all packages
pnpm test
# Lint all packages
pnpm lint
pnpm lint:fix
# Format code
pnpm format
pnpm format:check
# Type checking
pnpm type-check
# Clean build artifacts
pnpm clean
# Pre-commit checks
pnpm precommit# Enter a specific package
cd packages/sdk # or cli, ui, abl, ebalts, tlv-account-resolution
# Run package-specific commands
pnpm dev # Development mode
pnpm build # Build package
pnpm test # Run tests
pnpm lint # Lint codeThe project implements a layered architecture:
- Low-level Packages:
@mosaic/abl,@mosaic/ebalts,@mosaic/tlv-account-resolution - Core SDK:
@mosaic/sdkintegrates all low-level packages - User Interfaces:
@mosaic/cliand@mosaic/uiprovide different ways to interact with the SDK
- Metadata
- Default Account State
- Confidential Balances
- Pausable
- Permanent Delegate
- Scaled UI Amount
- Allowlists: Restrict token operations to approved addresses
- Blocklists: Block specific addresses from token operations
- Freeze/Thaw: Access to underlying freeze functionality in Token-2022
- Permissionless Operations: Permissionless freeze / thaw for enhanced onboarding UX
- Gating Program Integration: Link to the ABL program. This can be updated to use your own program.
- Authority Management: Manage the freeze authority
- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature) - Make your changes in the appropriate package
- Add tests for new functionality
- Run the full test suite (
pnpm test) - Run "precommit" to automatically format and check linting (
pnpm precommit) - Ensure code quality (
pnpm check) - Update documentation as needed
- Commit your changes (
git commit -m 'Add amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
MIT License - see LICENSE file for details