README.md

sMATT

Prerequisites

• node - Run JavaScript Everywhere
• pnpm - Fast, disk space efficient package manager
• Web browser of choice (Chrome or Firefox)
  • Chrome
  • Firefox
• Alby - Bitcoin Lightning Wallet & Nostr
  • Add extension to Chrome
  • Add extension to Firefox

Stack

• Pyodide
• Tailwind CSS
• Vite
• Vue 3

List of sMATT contracts presented

• Vault

Contribute

Project structure

smatt/
├── LICENSE                              # MIT License permission outline
├── README.md                            # Project setup and test setup walkthrough
├── index.html                           # Hypertext template where application is embedded
├── package.json                         # Project definitions and dependencies 
├── src/
│   ├── assets/                          # Collection of stylesheets and vector assets
│   │   └── ...                          # TODO: expand descriptions
│   │
│   ├── components/                      # Collection of Vue frontend components
│   │   └── ...                          # TODO: expand descriptions
│   │
│   ├── stores/                          # Collection of Vue composable stores
│   │   └── ...                          # TODO: expand descriptions
│   │
│   ├── views/                           # Collection of Vue frontend pages
│   │   └── ...                          # TODO: expand descriptions
│   │
│   └── workers/                         # Collection of web workers
│       └── mattvm.js                    # Pyodide parser with `pymatt` pre-installed
│
├── static/                              # Static assets
│   ├── coi-serviceworker.min.js         # Cross-origin isolation through a service worker
│   ├── chrome.svg                       # Vector asset of Chrome web browser logo
│   ├── favicon.ico                      # Small graphic image for the browser's address bar
│   ├── firefox.svg                      # Vector asset of Firefox logo used by README.md
│   ├── pymatt-0.0.1-py3-none-any.whl    # Wheel file for `pymatt` python package
│   ├── pyodide.asm.js                   # The JS half of the main "binary"
│   ├── pyodide.asm.wasm                 # The WebAssembly half of the main "binary"
│   ├── pyodide.js                       # Legacy support for browsers unable to use es6 module
│   ├── pyodide.mjs                      # Small JS loader shim which exports `loadPyodide`
│   ├── pyodide-lock.json                # Lockfile for Python packages
│   ├── python_stdlib.zip                # Python standard libraries for Pyodide
│   ├── smatt.svg                        # Project logo
│   ├── smatt-banner.svg                 # Project banner
│   └── smatt-social.svg                 # Project social link preview
│
├── tailwind.config.js                   # Styling plugins and rules for TailwindCSS
└── vite.config.js                       # Bundler configuration and static asset bypass

Notable exemptions: dotfiles, lockfile and component library generated files

Acknowledgements

1. ลูกทัวร์ - Look Tour typeface by uvSOV - Worawut Thanawatanawanich
2. Merkleize All The Things by Salvatore Ingala 𝕏 @salvatoshi
3. BIP-443: OP_CHECKCONTRACTVERIFY
4. YT: Merkleize All The Things (MATT) - Advancing Bitcoin | March 2nd, 2023
5. YT: sMATT contracts, zero to hero - bitcoin++ | May 3rd, 2024
6. VitePress Python Editor by @zqianem
7. YT: Build in-browser 3D experiences with WebGL and PyScript by Łukasz Langa at Pycon US 2024

License

This project is licensed under the terms of the MIT license.