Skip to content

Commit a1413c9

Browse files
author
grysz
committed
docs: redesign github pages site
1 parent 76d5d0c commit a1413c9

2 files changed

Lines changed: 461 additions & 123 deletions

File tree

‎docs/index.html‎

Lines changed: 117 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@
2929
</a>
3030
<nav class="site-nav" aria-label="Primary navigation">
3131
<a href="#kernel">Kernel</a>
32+
<a href="#architecture">Architecture</a>
3233
<a href="#package">Package</a>
33-
<a href="#upstream">Upstream</a>
3434
<a href="#roadmap">Roadmap</a>
3535
<a href="https://github.com/gryszzz/Kaspa-Script">GitHub</a>
3636
</nav>
@@ -40,14 +40,20 @@
4040
<section class="hero" id="top" aria-labelledby="hero-title">
4141
<div class="hero-media" aria-hidden="true"></div>
4242
<div class="hero-content">
43-
<p class="eyebrow">Rust compiler workspace for Kaspa's covenant era</p>
44-
<h1 id="hero-title">Kaspa contract artifacts with bytecode, kernel metadata, and upgrade gates.</h1>
43+
<p class="eyebrow">Kaspa-native compiler + programmability kernel</p>
44+
<h1 id="hero-title">Source-gated contract packages for Kaspa's next upgrade cycle.</h1>
4545
<p class="hero-copy">
4646
KaspaScript compiles a verified V1 contract subset into deterministic
4747
Kaspa txscript artifacts, then packages each contract with a
4848
capability profile, wallet previews, indexer schema, fee estimates,
4949
and a readiness report.
5050
</p>
51+
<ul class="hero-badges" aria-label="Kernel package surfaces">
52+
<li>schema v0</li>
53+
<li>verified TN12</li>
54+
<li>Toccata-aware</li>
55+
<li>mainnet guarded</li>
56+
</ul>
5157
<div class="hero-actions" aria-label="Project actions">
5258
<a class="button primary" href="https://github.com/gryszzz/Kaspa-Script">View Repo</a>
5359
<a class="button secondary" href="#quickstart">Run The CLI</a>
@@ -65,14 +71,28 @@ <h1 id="hero-title">Kaspa contract artifacts with bytecode, kernel metadata, and
6571
<dt>Mainnet</dt>
6672
<dd>Activation Guarded</dd>
6773
</div>
74+
<div>
75+
<dt>Package</dt>
76+
<dd>Golden Tested</dd>
77+
</div>
6878
</dl>
6979
</div>
70-
<aside class="hero-console" aria-label="Kernel package command preview">
71-
<div class="console-bar">
72-
<span>kernel package</span>
73-
<span>escrow.ks</span>
74-
</div>
75-
<pre><code>$ kaspascript kernel package escrow.ks \
80+
<aside class="hero-panel" aria-label="KaspaScript package preview">
81+
<figure class="brand-frame">
82+
<img
83+
src="assets/kaspascript-hero.jpg"
84+
alt="KaspaScript .ks visual identity"
85+
width="1536"
86+
height="1024"
87+
>
88+
<figcaption>Compiler output, kernel metadata, and readiness evidence in one package.</figcaption>
89+
</figure>
90+
<div class="hero-console">
91+
<div class="console-bar">
92+
<span>kernel package</span>
93+
<span>escrow.ks</span>
94+
</div>
95+
<pre><code>$ kaspascript kernel package escrow.ks \
7696
--target verified-tn12 \
7797
--compute-grams 1000 \
7898
--tx-bytes 400
@@ -82,14 +102,53 @@ <h1 id="hero-title">Kaspa contract artifacts with bytecode, kernel metadata, and
82102
artifact.target: verified-tn12
83103
bytecode_bytes: 76
84104
kernel.capabilities: kaspa-utxo-state-machine
85-
kernel.wallet_previews: 2
86-
kernel.indexer_schema: covenant_lineage
105+
transition_profiles: release, refund
106+
wallet_previews: state-transition
87107
readiness.level: verified
88-
readiness.ready: true
89108
minimum_fee_sompi: 100000</code></pre>
109+
</div>
110+
<div class="signal-grid" aria-label="Package signals">
111+
<div>
112+
<span>Execution</span>
113+
<strong>UTXO state machine</strong>
114+
</div>
115+
<div>
116+
<span>Wallet</span>
117+
<strong>Preview required</strong>
118+
</div>
119+
<div>
120+
<span>Indexer</span>
121+
<strong>Lineage schema</strong>
122+
</div>
123+
</div>
90124
</aside>
91125
</section>
92126

127+
<section class="proof-band" aria-label="KaspaScript proof points">
128+
<div class="proof-strip">
129+
<article>
130+
<span>01</span>
131+
<strong>Compiler gated</strong>
132+
<p>Unsupported or unpinned protocol surfaces fail before bytecode emission.</p>
133+
</article>
134+
<article>
135+
<span>02</span>
136+
<strong>Package native</strong>
137+
<p>Bytecode, ASM, capability profile, wallet preview, schema, fee, and readiness travel together.</p>
138+
</article>
139+
<article>
140+
<span>03</span>
141+
<strong>Kaspa shaped</strong>
142+
<p>Contracts are modeled as UTXO transitions with explicit state, signers, outputs, and lineage.</p>
143+
</article>
144+
<article>
145+
<span>04</span>
146+
<strong>Upgrade aware</strong>
147+
<p>Targets separate verified TN12, TN10 Toccata, preview, and future mainnet posture.</p>
148+
</article>
149+
</div>
150+
</section>
151+
93152
<section class="band intro-band" aria-label="Project summary">
94153
<div class="intro-grid">
95154
<article>
@@ -108,6 +167,40 @@ <h2>A compiler plus the first slice of a Kaspa-native programmability kernel.</h
108167
</div>
109168
</section>
110169

170+
<section class="section architecture-band" id="architecture" aria-labelledby="architecture-title">
171+
<div class="section-heading">
172+
<p class="section-kicker">Architecture</p>
173+
<h2 id="architecture-title">A compiler pipeline with a package kernel on top.</h2>
174+
<p>
175+
The repo is built as a Rust workspace so each stage has a clear job:
176+
parse source, lower to typed IR, emit source-grounded txscript, and
177+
attach package metadata that app builders can inspect.
178+
</p>
179+
</div>
180+
<div class="kernel-map" aria-label="KaspaScript architecture stages">
181+
<article>
182+
<span>source.ks</span>
183+
<strong>Lexer + parser</strong>
184+
<p>Position-tagged syntax for contracts, params, spends, expressions, and builtins.</p>
185+
</article>
186+
<article>
187+
<span>typed ir</span>
188+
<strong>Semantic lowering</strong>
189+
<p>Scope, type, finality, builtin, and target-safety checks before backend work begins.</p>
190+
</article>
191+
<article>
192+
<span>txscript</span>
193+
<strong>Backend gates</strong>
194+
<p>Verified targets emit deterministic Kaspa bytes; preview surfaces warn or block explicitly.</p>
195+
</article>
196+
<article>
197+
<span>kernel.json</span>
198+
<strong>Capability package</strong>
199+
<p>Wallet previews, indexer schema, fee policy, readiness, source snapshots, and transition profiles.</p>
200+
</article>
201+
</div>
202+
</section>
203+
111204
<section class="section" id="kernel" aria-labelledby="kernel-title">
112205
<div class="section-heading">
113206
<p class="section-kicker">Kernel</p>
@@ -184,6 +277,10 @@ <h2 id="package-title">One artifact for bytecode, app metadata, and review.</h2>
184277
<span>kernel</span>
185278
<p>Blueprint, capabilities, wallet previews, indexer schema, readiness, and fee policy.</p>
186279
</div>
280+
<div>
281+
<span>kernel.capabilities</span>
282+
<p>Execution model, feature evidence, transition profiles, wallet duties, and policy limits.</p>
283+
</div>
187284
<div>
188285
<span>fee_estimate</span>
189286
<p>Toccata minimum-standard-fee estimate with explicit assumptions.</p>
@@ -204,7 +301,9 @@ <h2 id="package-title">One artifact for bytecode, app metadata, and review.</h2>
204301
"ready": true
205302
},
206303
"capabilities": {
207-
"execution_model": "kaspa-utxo-state-machine"
304+
"execution_model": "kaspa-utxo-state-machine",
305+
"features": ["BaseScript", "WalletPreview"],
306+
"transition_profiles": ["release", "refund"]
208307
},
209308
"wallet_previews": ["release", "refund"],
210309
"indexer_schema": "covenant_lineage"
@@ -313,19 +412,19 @@ <h2 id="patterns-title">Verified examples and future-gated shapes.</h2>
313412
<p class="section-kicker">Completion Roadmap</p>
314413
<h2 id="roadmap-title">The next work is concrete.</h2>
315414
<p>
316-
The project is close to alpha complete. The next steps are focused
317-
on golden package snapshots, target selection, CI, SDK packaging,
318-
and testnet fixtures.
415+
The package format is now golden-tested. The next wave turns
416+
capability profiles into deeper contract analysis and tightens CI,
417+
SDK packaging, and TN10 fixtures.
319418
</p>
320419
</div>
321420
<div class="milestone-grid">
322421
<article>
323422
<h3>Alpha Complete</h3>
324-
<p>Kernel package golden snapshots, target selection, README examples, and CI checks.</p>
423+
<p>Machine-readable JSON Schema, CI checks, and package generation from the SDK.</p>
325424
</article>
326425
<article>
327426
<h3>Testnet Complete</h3>
328-
<p>Toccata tag fixture, TN10 transaction facade, covenant continuation and indexer cases.</p>
427+
<p>TN10 package fixtures, transaction facade, covenant continuation, and indexer cases.</p>
329428
</article>
330429
<article>
331430
<h3>Mainnet Ready</h3>

0 commit comments

Comments
 (0)