@deeeed/metamask-harness 0.34.3 → 0.35.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +21 -0
- package/adapters/core/inject.sh +3 -3
- package/adapters/extension/inject.mjs +3 -4
- package/adapters/mobile/inject.sh +4 -3
- package/adapters/mobile/verify.sh +37 -0
- package/dist/adapters/extension/runtime.js +60 -15
- package/dist/adapters/extension/surface.js +6 -1
- package/dist/adapters/mobile/source-freshness.js +51 -14
- package/dist/adapters/mobile/surface.js +6 -1
- package/dist/doctor.js +30 -1
- package/package.json +1 -1
- package/scripts/site-contrast.mjs +38 -11
- package/site/architecture.html +14 -7
- package/site/assets/metamask-fox.svg +24 -0
- package/site/assets/progress.mjs +52 -1
- package/site/assets/style.css +152 -25
- package/site/cheatsheet.html +5 -6
- package/site/ecosystem.html +162 -0
- package/site/how-it-works.html +8 -9
- package/site/index.html +104 -39
- package/site/perps.html +103 -45
- package/site/recipes.html +5 -6
- package/site/reviewers.html +5 -6
- package/site/tutorials/index.html +5 -6
- package/site/tutorials/v1.html +5 -6
- package/site/tutorials/v2.html +6 -8
- package/site/tutorials/v3.html +5 -6
- package/site/tutorials/v4.html +5 -6
- package/site/tutorials/v5.html +5 -6
- package/site/tutorials/v6.html +5 -6
- package/site/tutorials/v7.html +5 -6
package/site/index.html
CHANGED
|
@@ -5,14 +5,15 @@
|
|
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
6
6
|
<title>Recipes — build with proof, not hope</title>
|
|
7
7
|
<meta name="description" content="A skill drives the change. The recipe proves it on a real MetaMask build as it is written, self-checked in the same context and kept as a regression guard.">
|
|
8
|
-
<link rel="
|
|
8
|
+
<link rel="icon" href="assets/metamask-fox.svg" type="image/svg+xml">
|
|
9
|
+
<link rel="stylesheet" href="assets/style.css?v=4">
|
|
9
10
|
</head>
|
|
10
11
|
<body>
|
|
11
12
|
<a class="skip" href="#prompt">Skip to the prompt</a>
|
|
12
13
|
|
|
13
14
|
<main class="lobby">
|
|
14
15
|
<div class="lobby-inner">
|
|
15
|
-
<
|
|
16
|
+
<img class="lobby-mark" src="assets/metamask-fox.svg" alt="" width="52" height="52">
|
|
16
17
|
<span class="eyebrow">Proven as it's built</span>
|
|
17
18
|
|
|
18
19
|
<h1>Build agentically, with confidence.</h1>
|
|
@@ -21,14 +22,20 @@
|
|
|
21
22
|
self-checked in the same context, then kept as a regression guard.
|
|
22
23
|
</p>
|
|
23
24
|
<p class="lobby-sub">
|
|
24
|
-
Set up, then work a real ticket.
|
|
25
|
+
Set up once, then work a real ticket.
|
|
25
26
|
</p>
|
|
26
27
|
|
|
27
|
-
<
|
|
28
|
-
work. Follow these steps in order. When a command fails, its message names the
|
|
29
|
-
exact next command — run that instead of improvising.
|
|
28
|
+
<section class="qs">
|
|
30
29
|
|
|
31
|
-
|
|
30
|
+
<div class="qs-step">
|
|
31
|
+
<h2 class="qs-title"><span class="qs-num" aria-hidden="true">1</span>Set up</h2>
|
|
32
|
+
<p class="qs-why">
|
|
33
|
+
One time per machine. Paste this into your agent inside a MetaMask checkout.
|
|
34
|
+
</p>
|
|
35
|
+
|
|
36
|
+
<div class="cmd cmd-hero" id="prompt"><pre><code>Task: set me up for recipe-backed work on MetaMask. Follow these steps in order.
|
|
37
|
+
When a command fails, its message names the exact next command — run that
|
|
38
|
+
instead of improvising.
|
|
32
39
|
|
|
33
40
|
1. Install the harness: `npm i -g @deeeed/metamask-harness@latest`, then
|
|
34
41
|
`mm-harness --version` to confirm it resolved.
|
|
@@ -58,14 +65,18 @@ PART 1 — SET UP
|
|
|
58
65
|
`--preflight-mode` is an internal adapter flag, not a public launch flag.
|
|
59
66
|
6. On Extension run `mm-harness fixtures set`. On Mobile include the same
|
|
60
67
|
`--device <UUID-or-serial>` used for launch. Wait for it to succeed.
|
|
61
|
-
7. Install the skills — they are how the work actually gets driven.
|
|
62
|
-
|
|
63
|
-
|
|
68
|
+
7. Install the skills — they are how the work actually gets driven. First
|
|
69
|
+
inspect `METAMASK_SKILLS_DIR` and `CONSENSYS_SKILLS_DIR`, then check the
|
|
70
|
+
expected local layout below. Reuse every valid existing clone. For each
|
|
71
|
+
missing source, show me the proposed path and ask before cloning:
|
|
64
72
|
`git clone https://github.com/MetaMask/skills.git ~/dev/metamask/skills`
|
|
65
|
-
`export METAMASK_SKILLS_DIR=~/dev/metamask/skills`
|
|
66
|
-
Then the internal overlay, which needs access to the Consensys org:
|
|
67
73
|
`git clone git@github.com:Consensys/skills.git ~/dev/Consensys/skills`
|
|
74
|
+
The internal overlay needs access to the Consensys org. Export the paths in
|
|
75
|
+
the current shell for setup:
|
|
76
|
+
`export METAMASK_SKILLS_DIR=~/dev/metamask/skills`
|
|
68
77
|
`export CONSENSYS_SKILLS_DIR=~/dev/Consensys/skills`
|
|
78
|
+
Never edit `.zshrc`, `.bashrc`, or another shell startup file unless I
|
|
79
|
+
explicitly consent; ask separately if I want these exports persisted.
|
|
69
80
|
If that clone fails, tell me — I may not have access, and the next step
|
|
70
81
|
depends on it. Then, from inside the checkout:
|
|
71
82
|
`yarn metamask-skills list --maturity experimental` everything installable
|
|
@@ -74,46 +85,100 @@ PART 1 — SET UP
|
|
|
74
85
|
metamask-extension, metamask-mobile, and core. Use `--maturity experimental`
|
|
75
86
|
when listing: the default only prints stable skills, so the recipe skills
|
|
76
87
|
below do not appear without it.
|
|
77
|
-
8. Add the
|
|
78
|
-
`yarn skills --include agentic/recipe-cook --save`
|
|
79
|
-
|
|
80
|
-
|
|
88
|
+
8. Add the skills that drive recipe-backed work:
|
|
89
|
+
`yarn skills --include agentic/recipe-cook,agentic/recipe-quality,agentic/recipe-pr-qa-review --save`
|
|
90
|
+
They install as `mms-recipe-cook`, `mms-recipe-quality`, and
|
|
91
|
+
`mms-recipe-pr-qa-review`. They come from the `Consensys/skills` clone in
|
|
92
|
+
step 7 and are marked experimental, which is why the explicit `--include`
|
|
81
93
|
is required. If `yarn metamask-skills describe agentic/recipe-cook` cannot
|
|
82
94
|
find it, check `CONSENSYS_SKILLS_DIR` points at that clone, then stop and
|
|
83
95
|
tell me. Do not substitute a different skill.
|
|
96
|
+
9. Run `mm-harness actions`. That list is the ONLY set of capabilities you may
|
|
97
|
+
use, now and in every later session — never invent an action or a flag. Then
|
|
98
|
+
stop and tell me setup is done.
|
|
99
|
+
|
|
100
|
+
Not optional, from here on: evidence comes only from executed actions — never
|
|
101
|
+
fabricate a result or edit state to manufacture one. If the harness reports a
|
|
102
|
+
capability as unsupported, stop and tell me rather than working around it. If a
|
|
103
|
+
step fails twice after following its error's instructions, stop and show me the
|
|
104
|
+
exact error.</code></pre></div>
|
|
105
|
+
</div>
|
|
106
|
+
|
|
107
|
+
<div class="qs-step">
|
|
108
|
+
<h2 class="qs-title"><span class="qs-num" aria-hidden="true">2</span>Do real work</h2>
|
|
109
|
+
<p class="qs-why">
|
|
110
|
+
Pick what you are doing. Each one runs the skill that owns that flow, and leaves a
|
|
111
|
+
rerunnable recipe behind as the proof.
|
|
112
|
+
</p>
|
|
113
|
+
|
|
114
|
+
<div class="tabs">
|
|
115
|
+
<div class="tablist" role="tablist" aria-label="Choose what to do" hidden>
|
|
116
|
+
<button type="button" role="tab" id="tab-review" class="tab" aria-controls="panel-review" aria-selected="true" tabindex="0">Review a PR</button>
|
|
117
|
+
<button type="button" role="tab" id="tab-fix" class="tab" aria-controls="panel-fix" aria-selected="false" tabindex="-1">Fix a bug</button>
|
|
118
|
+
<button type="button" role="tab" id="tab-build" class="tab" aria-controls="panel-build" aria-selected="false" tabindex="-1">Build a feature</button>
|
|
119
|
+
</div>
|
|
120
|
+
|
|
121
|
+
<div class="qs-panel" role="tabpanel" id="panel-review" aria-labelledby="tab-review" tabindex="0">
|
|
122
|
+
<p class="qs-panel-why">
|
|
123
|
+
<code>mms-recipe-pr-qa-review</code> — read-only. It freezes the acceptance criteria
|
|
124
|
+
before it touches the runtime, validates each one on a real build, and returns a report.
|
|
125
|
+
It never edits product code and never posts to GitHub. The PR must be in the same
|
|
126
|
+
product as your checkout.
|
|
127
|
+
</p>
|
|
128
|
+
<div class="cmd"><pre><code>/mms-recipe-pr-qa-review https://github.com/MetaMask/metamask-mobile/pull/<number>
|
|
129
|
+
|
|
130
|
+
Extract the acceptance criteria from the PR yourself and freeze them before any
|
|
131
|
+
runtime work. Validate each one against the running build, then give me the
|
|
132
|
+
per-AC verdict table, the overall verdict, and the artifact paths. Do not post
|
|
133
|
+
anything on the PR.</code></pre></div>
|
|
134
|
+
</div>
|
|
135
|
+
|
|
136
|
+
<div class="qs-panel" role="tabpanel" id="panel-fix" aria-labelledby="tab-fix" tabindex="0">
|
|
137
|
+
<p class="qs-panel-why">
|
|
138
|
+
<code>mms-recipe-cook</code>, classified as <code>fix-bug</code>. It lists the
|
|
139
|
+
compatible checklist templates and stops for your pick, then works on a local task
|
|
140
|
+
branch. No product edits until the bug is proven to reproduce.
|
|
141
|
+
</p>
|
|
142
|
+
<div class="cmd"><pre><code>/mms-recipe-cook
|
|
143
|
+
|
|
144
|
+
Fix this in the checkout I started you in — treat it as fix-bug:
|
|
145
|
+
<paste the ticket, or the broken behaviour and how to reproduce it>
|
|
146
|
+
|
|
147
|
+
Reproduce it on the real build first and keep that failing run as the baseline.
|
|
148
|
+
Then fix it and re-run the same recipe until it passes. Show me the recipe
|
|
149
|
+
status, the per-node results, and the artifact paths.</code></pre></div>
|
|
150
|
+
</div>
|
|
151
|
+
|
|
152
|
+
<div class="qs-panel" role="tabpanel" id="panel-build" aria-labelledby="tab-build" tabindex="0">
|
|
153
|
+
<p class="qs-panel-why">
|
|
154
|
+
<code>mms-recipe-cook</code>, classified as <code>dev</code>. Same flow: it lists the
|
|
155
|
+
compatible templates, stops for your pick, and keeps the diff uncommitted until you
|
|
156
|
+
ask it to package the PR.
|
|
157
|
+
</p>
|
|
158
|
+
<div class="cmd"><pre><code>/mms-recipe-cook
|
|
159
|
+
|
|
160
|
+
Build this in the checkout I started you in — treat it as dev:
|
|
161
|
+
<paste the ticket, or the change you want>
|
|
162
|
+
|
|
163
|
+
Plan the proof before you edit anything, implement it, then prove it with a
|
|
164
|
+
recipe that drives the real build. Show me the recipe status, the per-node
|
|
165
|
+
results, and the artifact paths.</code></pre></div>
|
|
166
|
+
</div>
|
|
167
|
+
</div>
|
|
168
|
+
</div>
|
|
84
169
|
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
9. Discover before acting: run `mm-harness actions`. That list is the ONLY set
|
|
88
|
-
of capabilities you may use, now and in every later session. Never invent an
|
|
89
|
-
action or a flag. If you need something not listed, stop and tell me.
|
|
90
|
-
10. Ask me for a ticket or a bug to work on. Then run `/mms-recipe-cook` and
|
|
91
|
-
follow it. It classifies the task as dev, fix-bug, or review-pr, lists the
|
|
92
|
-
compatible checklist templates, and stops for my choice — do not choose for
|
|
93
|
-
me, and do not create a second task if one is already materialized.
|
|
94
|
-
11. Work the checklist it gives you. The recipe it runs is the proof: it drives
|
|
95
|
-
the real build, asserts, and writes the evidence. Show me the status from
|
|
96
|
-
summary.json, the per-node results from trace.json, and the artifact paths.
|
|
97
|
-
12. Re-run that recipe without starting a new session and confirm it still
|
|
98
|
-
passes. Checking your own work in the context you did it in is the point;
|
|
99
|
-
replay it after every change you make from here on.
|
|
100
|
-
|
|
101
|
-
Not optional: evidence comes only from executed actions — never fabricate a
|
|
102
|
-
result or edit state to manufacture one. If the harness reports a capability as
|
|
103
|
-
unsupported, stop and tell me rather than working around it. If a step fails
|
|
104
|
-
twice after following its error's instructions, stop and show me the exact
|
|
105
|
-
error.</code></pre></div>
|
|
170
|
+
</section>
|
|
106
171
|
|
|
107
172
|
<div class="lobby-cta">
|
|
108
173
|
<a class="btn btn-primary" href="how-it-works.html">How it works →</a>
|
|
109
174
|
</div>
|
|
110
175
|
|
|
111
176
|
<p class="lobby-fine">
|
|
112
|
-
A proposal for how agents can code at MetaMask — offered for teams to try
|
|
177
|
+
A proposal for how agents can code at MetaMask — offered for teams to try.
|
|
113
178
|
</p>
|
|
114
179
|
</div>
|
|
115
180
|
</main>
|
|
116
181
|
|
|
117
|
-
<script type="module" src="assets/progress.mjs"></script>
|
|
182
|
+
<script type="module" src="assets/progress.mjs?v=4"></script>
|
|
118
183
|
</body>
|
|
119
184
|
</html>
|
package/site/perps.html
CHANGED
|
@@ -3,9 +3,10 @@
|
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="utf-8">
|
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
6
|
-
<title>Perps
|
|
7
|
-
<meta name="description" content="
|
|
8
|
-
<link rel="
|
|
6
|
+
<title>Team / Perps — customize the harness for your team</title>
|
|
7
|
+
<meta name="description" content="Every team points the harness at its own recipe library. The MetaMask Perps library is the worked example: recipes, actions, checklist templates, and the team's own knowledge.">
|
|
8
|
+
<link rel="icon" href="assets/metamask-fox.svg" type="image/svg+xml">
|
|
9
|
+
<link rel="stylesheet" href="assets/style.css?v=4">
|
|
9
10
|
</head>
|
|
10
11
|
<body>
|
|
11
12
|
<a class="skip" href="#setup">Skip to setup</a>
|
|
@@ -13,42 +14,43 @@
|
|
|
13
14
|
<header class="topbar">
|
|
14
15
|
<div class="wrap topbar-inner">
|
|
15
16
|
<a class="brand" href="index.html">
|
|
16
|
-
<
|
|
17
|
+
<img class="brand-mark" src="assets/metamask-fox.svg" alt="" width="22" height="22">
|
|
17
18
|
<span class="brand-name">recipes</span>
|
|
18
19
|
</a>
|
|
19
20
|
<nav class="nav" aria-label="Main">
|
|
20
21
|
<a class="nav-cta" href="index.html#prompt">Quick start</a>
|
|
21
22
|
<a href="how-it-works.html">How it works</a>
|
|
22
|
-
<a href="
|
|
23
|
-
<a href="perps.html" aria-current="page">Perps</a>
|
|
23
|
+
<a href="perps.html" aria-current="page">Team / Perps</a>
|
|
24
24
|
<a href="cheatsheet.html">Cheatsheet</a>
|
|
25
25
|
<a href="architecture.html">Architecture</a>
|
|
26
26
|
<a href="tutorials/index.html">Tutorials</a>
|
|
27
|
-
<a href="reviewers.html">For Reviewers</a>
|
|
28
27
|
</nav>
|
|
29
28
|
</div>
|
|
30
29
|
</header>
|
|
31
30
|
|
|
32
31
|
<main>
|
|
33
32
|
<section class="wrap hero" style="padding-bottom:1rem">
|
|
34
|
-
<span class="eyebrow">
|
|
35
|
-
<h1>
|
|
33
|
+
<span class="eyebrow">Customization</span>
|
|
34
|
+
<h1>Make it your team's harness</h1>
|
|
36
35
|
<p class="lede">
|
|
37
|
-
The
|
|
38
|
-
|
|
36
|
+
The harness ships an execution standard and a deliberately small bundled library. Everything that
|
|
37
|
+
is specific to what <em>you</em> work on — the journeys, the assertions, the checklists, the review
|
|
38
|
+
knowledge — lives in a library you own and point the harness at. MetaMask Perps is the worked
|
|
39
|
+
example on this page.
|
|
39
40
|
</p>
|
|
40
41
|
<div class="hero-meta">
|
|
41
|
-
<span>
|
|
42
|
-
<span>
|
|
43
|
-
<span>
|
|
42
|
+
<span>per team</span>
|
|
43
|
+
<span>per engineer</span>
|
|
44
|
+
<span>one env var</span>
|
|
44
45
|
</div>
|
|
45
46
|
</section>
|
|
46
47
|
|
|
47
48
|
<section class="wrap">
|
|
48
49
|
<div class="doctrine">
|
|
49
50
|
<p>
|
|
50
|
-
<span class="k">The harness supplies the execution standard;
|
|
51
|
-
|
|
51
|
+
<span class="k">The harness supplies the execution standard; your library supplies the domain.</span>
|
|
52
|
+
A team shares one library. An engineer can add their own on top. Neither requires a change to
|
|
53
|
+
the harness.
|
|
52
54
|
</p>
|
|
53
55
|
</div>
|
|
54
56
|
|
|
@@ -60,11 +62,11 @@
|
|
|
60
62
|
<tr>
|
|
61
63
|
<td><code>mm-harness</code></td>
|
|
62
64
|
<td>Launch, typed actions, graph execution, screenshots, video, traces, and artifact contracts.</td>
|
|
63
|
-
<td>
|
|
65
|
+
<td>Anything specific to one team's domain.</td>
|
|
64
66
|
</tr>
|
|
65
67
|
<tr>
|
|
66
|
-
<td
|
|
67
|
-
<td>Reusable
|
|
68
|
+
<td>Your library</td>
|
|
69
|
+
<td>Reusable setup, journeys, assertions, cleanup, platform variants, and checklist templates.</td>
|
|
68
70
|
<td>Wallet credentials, generated evidence, or product source.</td>
|
|
69
71
|
</tr>
|
|
70
72
|
<tr>
|
|
@@ -78,56 +80,102 @@
|
|
|
78
80
|
</section>
|
|
79
81
|
|
|
80
82
|
<section class="wrap">
|
|
81
|
-
<h2 id="setup">
|
|
83
|
+
<h2 id="setup">Point the harness at a library</h2>
|
|
82
84
|
<p>
|
|
83
|
-
|
|
84
|
-
|
|
85
|
+
One environment variable does it. The Perps library is private, so start by asking its owners for
|
|
86
|
+
access — a clone failure means your GitHub account does not have it yet.
|
|
85
87
|
</p>
|
|
86
88
|
|
|
87
|
-
<div class="cmd"><pre><code><span class="p">$ </span>
|
|
88
|
-
<span class="p">$ </span>git clone git@github.com:MetaMask/experimental-metamask-recipe-perps.git \
|
|
89
|
+
<div class="cmd"><pre><code><span class="p">$ </span>git clone git@github.com:MetaMask/experimental-metamask-recipe-perps.git \
|
|
89
90
|
"$HOME/shared-library/metamask-recipe-perps"
|
|
90
|
-
<span class="p">$ </span>
|
|
91
|
-
|
|
91
|
+
<span class="p">$ </span>export RECIPE_LIBRARY_PATH="perps=$HOME/shared-library/metamask-recipe-perps"
|
|
92
|
+
<span class="p">$ </span>mm-harness run --list</code></pre></div>
|
|
92
93
|
|
|
93
94
|
<p>
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
command so separate tool shells do not lose an exported variable.
|
|
95
|
+
<code>name=path</code> gives the source its alias; without one the directory name is used. Separate
|
|
96
|
+
several libraries with <code>:</code> — order is precedence, first wins:
|
|
97
97
|
</p>
|
|
98
98
|
|
|
99
|
+
<div class="cmd"><pre><code><span class="p">$ </span>export RECIPE_LIBRARY_PATH="mine=$HOME/my-recipes:perps=$HOME/shared-library/metamask-recipe-perps"</code></pre></div>
|
|
100
|
+
|
|
101
|
+
<p>
|
|
102
|
+
Use <code>--library name=/path</code> for a single command instead — useful when a tool shell loses
|
|
103
|
+
an exported variable. Resolution follows your library order, then the bundled MetaMask library.
|
|
104
|
+
</p>
|
|
105
|
+
|
|
106
|
+
<div class="note blue">
|
|
107
|
+
<span class="note-title">Your own library, with no configuration</span>
|
|
108
|
+
<p>
|
|
109
|
+
A directory at <code>~/.farmslot/recipe-library</code> is picked up automatically as
|
|
110
|
+
<code>personal</code> when you set no library at all. It is a fallback, not an addition: as soon
|
|
111
|
+
as <code>RECIPE_LIBRARY_PATH</code> or <code>--library</code> is set, only those sources are used.
|
|
112
|
+
List it explicitly to keep both.
|
|
113
|
+
</p>
|
|
114
|
+
</div>
|
|
115
|
+
|
|
99
116
|
<div class="note blue">
|
|
100
117
|
<span class="note-title">Discovery is adapter-aware</span>
|
|
101
118
|
<p>
|
|
102
119
|
The list shows only recipes runnable in the current product checkout. A recipe marked
|
|
103
|
-
<code>[perps]</code> came from
|
|
120
|
+
<code>[perps]</code> came from that library; <code>[metamask]</code> means it ships with the
|
|
104
121
|
harness. Read the selected platform variant with <code>--describe</code> before running it.
|
|
105
122
|
</p>
|
|
106
123
|
</div>
|
|
107
124
|
</section>
|
|
108
125
|
|
|
126
|
+
<section class="wrap">
|
|
127
|
+
<h2>What a team library actually holds</h2>
|
|
128
|
+
<p>
|
|
129
|
+
Every path below is real, from the Perps library. Copy the shape, not the contents — it is the
|
|
130
|
+
reference structure for a MetaMask team building its own.
|
|
131
|
+
</p>
|
|
132
|
+
|
|
133
|
+
<div class="cmd"><pre><code>manifests/extension.action-manifest.json types the actions you add
|
|
134
|
+
actions/extension/perps/ domain actions the product needs
|
|
135
|
+
recipes/mobile/perps/ per-adapter journeys
|
|
136
|
+
recipes/extension/perps/
|
|
137
|
+
recipes/core/perps/
|
|
138
|
+
checklists/dev/ your own Recipe Cook checklist templates
|
|
139
|
+
checklists/fix-bug/
|
|
140
|
+
docs/ the knowledge: authoring rules,
|
|
141
|
+
performance evidence, analytics</code></pre></div>
|
|
142
|
+
|
|
143
|
+
<p>
|
|
144
|
+
The <code>docs/</code> and <code>checklists/</code> directories are the part teams underestimate.
|
|
145
|
+
They are how a team's hard-won conventions — how performance evidence is gathered here, which
|
|
146
|
+
analytics events matter, what a finished task looks like — stop living in one engineer's head.
|
|
147
|
+
</p>
|
|
148
|
+
|
|
149
|
+
<div class="note">
|
|
150
|
+
<span class="note-title">Review knowledge lives with the skills</span>
|
|
151
|
+
<p>
|
|
152
|
+
One team surface sits outside the recipe library: the static antipattern packs the PR QA review
|
|
153
|
+
reads, which ship with the skills as
|
|
154
|
+
<code>references/antipatterns/<repo>/<pack>.md</code>. Today there is a
|
|
155
|
+
<code>perps</code> pack for Mobile, Extension, and Core, and a Mobile-only
|
|
156
|
+
<code>unit-vs-cv</code> pack. A pack is advisory: it never changes an acceptance-criterion
|
|
157
|
+
verdict.
|
|
158
|
+
</p>
|
|
159
|
+
</div>
|
|
160
|
+
</section>
|
|
161
|
+
|
|
109
162
|
<section class="wrap">
|
|
110
163
|
<h2>Your first live proof</h2>
|
|
111
164
|
<p>
|
|
112
165
|
Complete <a href="how-it-works.html#steps">the walkthrough</a> first so the app, device, and wallet fixture are
|
|
113
|
-
ready.
|
|
166
|
+
ready. With <code>RECIPE_LIBRARY_PATH</code> exported, the library's recipes are just names.
|
|
114
167
|
</p>
|
|
115
168
|
|
|
116
169
|
<h3>Extension or Mobile</h3>
|
|
117
|
-
<div class="cmd"><pre><code><span class="p">$ </span>mm-harness run perps.open-market --describe
|
|
118
|
-
|
|
119
|
-
<span class="p">$ </span>mm-harness run perps.open-market network=testnet market=BTC --plan \
|
|
120
|
-
--library "perps=$HOME/shared-library/metamask-recipe-perps"
|
|
170
|
+
<div class="cmd"><pre><code><span class="p">$ </span>mm-harness run perps.open-market --describe
|
|
171
|
+
<span class="p">$ </span>mm-harness run perps.open-market network=testnet market=BTC --plan
|
|
121
172
|
<span class="p">$ </span>mm-harness run perps.open-market network=testnet market=BTC \
|
|
122
|
-
--record-video=full-run --artifacts-dir ./perps-open-market-evidence
|
|
123
|
-
--library "perps=$HOME/shared-library/metamask-recipe-perps"</code></pre></div>
|
|
173
|
+
--record-video=full-run --artifacts-dir ./perps-open-market-evidence</code></pre></div>
|
|
124
174
|
|
|
125
175
|
<h3>Core</h3>
|
|
126
|
-
<div class="cmd"><pre><code><span class="p">$ </span>mm-harness run perps.snapshot-market --describe
|
|
127
|
-
--library "perps=$HOME/shared-library/metamask-recipe-perps"
|
|
176
|
+
<div class="cmd"><pre><code><span class="p">$ </span>mm-harness run perps.snapshot-market --describe
|
|
128
177
|
<span class="p">$ </span>mm-harness run perps.snapshot-market network=testnet market=BTC \
|
|
129
|
-
--artifacts-dir ./perps-market-evidence
|
|
130
|
-
--library "perps=$HOME/shared-library/metamask-recipe-perps"</code></pre></div>
|
|
178
|
+
--artifacts-dir ./perps-market-evidence</code></pre></div>
|
|
131
179
|
|
|
132
180
|
<p>
|
|
133
181
|
A passing run writes <code>summary.json</code>, per-node results in <code>trace.json</code>, and an
|
|
@@ -137,7 +185,11 @@
|
|
|
137
185
|
</section>
|
|
138
186
|
|
|
139
187
|
<section class="wrap">
|
|
140
|
-
<h2>
|
|
188
|
+
<h2>What the Perps team put in theirs</h2>
|
|
189
|
+
<p>
|
|
190
|
+
A sample of the library's recipes, as an idea of the granularity that works: small, parameterized,
|
|
191
|
+
composed rather than duplicated.
|
|
192
|
+
</p>
|
|
141
193
|
<div class="table-scroll">
|
|
142
194
|
<table>
|
|
143
195
|
<thead><tr><th>Claim</th><th>Recipe</th><th>Platforms</th></tr></thead>
|
|
@@ -164,8 +216,9 @@
|
|
|
164
216
|
</section>
|
|
165
217
|
|
|
166
218
|
<section class="wrap">
|
|
167
|
-
<h2>
|
|
219
|
+
<h2>Starting your team's library</h2>
|
|
168
220
|
<ol>
|
|
221
|
+
<li>Create a repository with the directory shape above. It holds no accounts, fixtures, credentials, or generated evidence.</li>
|
|
169
222
|
<li>Parameterize stable choices such as market, side, order type, and network.</li>
|
|
170
223
|
<li>Compose existing setup, assertion, and cleanup recipes before adding a new top-level recipe.</li>
|
|
171
224
|
<li>Add a platform variant only when the products genuinely differ.</li>
|
|
@@ -177,10 +230,15 @@
|
|
|
177
230
|
<li>Re-run every caller after a shared node changes and attach the fresh evidence.</li>
|
|
178
231
|
</ol>
|
|
179
232
|
|
|
233
|
+
<p>
|
|
234
|
+
Keep it small. Compose or repair the closest recipe before creating another one — a library that
|
|
235
|
+
grows a scenario per ticket stops being maintainable faster than the product does.
|
|
236
|
+
</p>
|
|
237
|
+
|
|
180
238
|
<div class="btn-row">
|
|
181
239
|
<a class="btn btn-primary" href="tutorials/v3.html">Install skills and the library →</a>
|
|
240
|
+
<a class="btn btn-ghost" href="ecosystem.html">Where this sits in the stack</a>
|
|
182
241
|
<a class="btn btn-ghost" href="recipes.html">How recipes prove claims</a>
|
|
183
|
-
<a class="btn btn-ghost" href="reviewers.html">How to review evidence</a>
|
|
184
242
|
</div>
|
|
185
243
|
</section>
|
|
186
244
|
</main>
|
|
@@ -191,6 +249,6 @@
|
|
|
191
249
|
<p>Written against the shared MetaMask Perps recipe library. Sample output moves between releases; trust your terminal over this page.</p>
|
|
192
250
|
</div>
|
|
193
251
|
</footer>
|
|
194
|
-
<script type="module" src="assets/progress.mjs"></script>
|
|
252
|
+
<script type="module" src="assets/progress.mjs?v=4"></script>
|
|
195
253
|
</body>
|
|
196
254
|
</html>
|
package/site/recipes.html
CHANGED
|
@@ -5,7 +5,8 @@
|
|
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
6
6
|
<title>What is a recipe?</title>
|
|
7
7
|
<meta name="description" content="The anatomy of a recipe: a JSON graph of typed actions, human-authored intent, first-class assertions, and a verdict derived from the trace.">
|
|
8
|
-
<link rel="
|
|
8
|
+
<link rel="icon" href="assets/metamask-fox.svg" type="image/svg+xml">
|
|
9
|
+
<link rel="stylesheet" href="assets/style.css?v=4">
|
|
9
10
|
</head>
|
|
10
11
|
<body data-progress-page="recipes">
|
|
11
12
|
<a class="skip" href="#anatomy">Skip to the anatomy</a>
|
|
@@ -13,18 +14,16 @@
|
|
|
13
14
|
<header class="topbar">
|
|
14
15
|
<div class="wrap topbar-inner">
|
|
15
16
|
<a class="brand" href="index.html">
|
|
16
|
-
<
|
|
17
|
+
<img class="brand-mark" src="assets/metamask-fox.svg" alt="" width="22" height="22">
|
|
17
18
|
<span class="brand-name">recipes</span>
|
|
18
19
|
</a>
|
|
19
20
|
<nav class="nav" aria-label="Main">
|
|
20
21
|
<a class="nav-cta" href="index.html#prompt">Quick start</a>
|
|
21
22
|
<a href="how-it-works.html">How it works</a>
|
|
22
|
-
<a href="
|
|
23
|
-
<a href="perps.html">Perps</a>
|
|
23
|
+
<a href="perps.html">Team / Perps</a>
|
|
24
24
|
<a href="cheatsheet.html">Cheatsheet</a>
|
|
25
25
|
<a href="architecture.html">Architecture</a>
|
|
26
26
|
<a href="tutorials/index.html">Tutorials</a>
|
|
27
|
-
<a href="reviewers.html">For Reviewers</a>
|
|
28
27
|
</nav>
|
|
29
28
|
</div>
|
|
30
29
|
</header>
|
|
@@ -419,6 +418,6 @@
|
|
|
419
418
|
</div>
|
|
420
419
|
</footer>
|
|
421
420
|
|
|
422
|
-
<script type="module" src="assets/progress.mjs"></script>
|
|
421
|
+
<script type="module" src="assets/progress.mjs?v=4"></script>
|
|
423
422
|
</body>
|
|
424
423
|
</html>
|
package/site/reviewers.html
CHANGED
|
@@ -5,7 +5,8 @@
|
|
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
6
6
|
<title>For Reviewers — how to read an evidence bundle</title>
|
|
7
7
|
<meta name="description" content="An annotated walkthrough of a real mm-harness evidence bundle: summary.json, trace.json, diagnostics, and what an honest degraded capture looks like.">
|
|
8
|
-
<link rel="
|
|
8
|
+
<link rel="icon" href="assets/metamask-fox.svg" type="image/svg+xml">
|
|
9
|
+
<link rel="stylesheet" href="assets/style.css?v=4">
|
|
9
10
|
</head>
|
|
10
11
|
<body data-progress-page="reviewers">
|
|
11
12
|
<a class="skip" href="#summary">Skip to the walkthrough</a>
|
|
@@ -13,18 +14,16 @@
|
|
|
13
14
|
<header class="topbar">
|
|
14
15
|
<div class="wrap topbar-inner">
|
|
15
16
|
<a class="brand" href="index.html">
|
|
16
|
-
<
|
|
17
|
+
<img class="brand-mark" src="assets/metamask-fox.svg" alt="" width="22" height="22">
|
|
17
18
|
<span class="brand-name">recipes</span>
|
|
18
19
|
</a>
|
|
19
20
|
<nav class="nav" aria-label="Main">
|
|
20
21
|
<a class="nav-cta" href="index.html#prompt">Quick start</a>
|
|
21
22
|
<a href="how-it-works.html">How it works</a>
|
|
22
|
-
<a href="
|
|
23
|
-
<a href="perps.html">Perps</a>
|
|
23
|
+
<a href="perps.html">Team / Perps</a>
|
|
24
24
|
<a href="cheatsheet.html">Cheatsheet</a>
|
|
25
25
|
<a href="architecture.html">Architecture</a>
|
|
26
26
|
<a href="tutorials/index.html">Tutorials</a>
|
|
27
|
-
<a href="reviewers.html" aria-current="page">For Reviewers</a>
|
|
28
27
|
</nav>
|
|
29
28
|
</div>
|
|
30
29
|
</header>
|
|
@@ -371,6 +370,6 @@ Nodes: 6/6 passed
|
|
|
371
370
|
</div>
|
|
372
371
|
</footer>
|
|
373
372
|
|
|
374
|
-
<script type="module" src="assets/progress.mjs"></script>
|
|
373
|
+
<script type="module" src="assets/progress.mjs?v=4"></script>
|
|
375
374
|
</body>
|
|
376
375
|
</html>
|
|
@@ -5,7 +5,8 @@
|
|
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
6
6
|
<title>Tutorials — the series</title>
|
|
7
7
|
<meta name="description" content="Seven tutorials taking a new engineer from an empty terminal to pull requests that carry proof.">
|
|
8
|
-
<link rel="
|
|
8
|
+
<link rel="icon" href="../assets/metamask-fox.svg" type="image/svg+xml">
|
|
9
|
+
<link rel="stylesheet" href="../assets/style.css?v=4">
|
|
9
10
|
</head>
|
|
10
11
|
<body data-progress-page="tutorials">
|
|
11
12
|
<a class="skip" href="#series">Skip to the series</a>
|
|
@@ -13,18 +14,16 @@
|
|
|
13
14
|
<header class="topbar">
|
|
14
15
|
<div class="wrap-wide topbar-inner">
|
|
15
16
|
<a class="brand" href="../index.html">
|
|
16
|
-
<
|
|
17
|
+
<img class="brand-mark" src="../assets/metamask-fox.svg" alt="" width="22" height="22">
|
|
17
18
|
<span class="brand-name">recipes</span>
|
|
18
19
|
</a>
|
|
19
20
|
<nav class="nav" aria-label="Main">
|
|
20
21
|
<a class="nav-cta" href="../index.html#prompt">Quick start</a>
|
|
21
22
|
<a href="../how-it-works.html">How it works</a>
|
|
22
|
-
<a href="../
|
|
23
|
-
<a href="../perps.html">Perps</a>
|
|
23
|
+
<a href="../perps.html">Team / Perps</a>
|
|
24
24
|
<a href="../cheatsheet.html">Cheatsheet</a>
|
|
25
25
|
<a href="../architecture.html">Architecture</a>
|
|
26
26
|
<a href="index.html" aria-current="page">Tutorials</a>
|
|
27
|
-
<a href="../reviewers.html">For Reviewers</a>
|
|
28
27
|
</nav>
|
|
29
28
|
</div>
|
|
30
29
|
</header>
|
|
@@ -177,6 +176,6 @@
|
|
|
177
176
|
</div>
|
|
178
177
|
</footer>
|
|
179
178
|
|
|
180
|
-
<script type="module" src="../assets/progress.mjs"></script>
|
|
179
|
+
<script type="module" src="../assets/progress.mjs?v=4"></script>
|
|
181
180
|
</body>
|
|
182
181
|
</html>
|
package/site/tutorials/v1.html
CHANGED
|
@@ -5,7 +5,8 @@
|
|
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
6
6
|
<title>V1 — Getting started with recipes</title>
|
|
7
7
|
<meta name="description" content="Video one of the series: one CLI drives the wallet and proves what happened. With the same checklist as the How it works walkthrough.">
|
|
8
|
-
<link rel="
|
|
8
|
+
<link rel="icon" href="../assets/metamask-fox.svg" type="image/svg+xml">
|
|
9
|
+
<link rel="stylesheet" href="../assets/style.css?v=4">
|
|
9
10
|
</head>
|
|
10
11
|
<body data-progress-page="start">
|
|
11
12
|
<a class="skip" href="#steps">Skip to the checklist</a>
|
|
@@ -13,18 +14,16 @@
|
|
|
13
14
|
<header class="topbar">
|
|
14
15
|
<div class="wrap topbar-inner">
|
|
15
16
|
<a class="brand" href="../index.html">
|
|
16
|
-
<
|
|
17
|
+
<img class="brand-mark" src="../assets/metamask-fox.svg" alt="" width="22" height="22">
|
|
17
18
|
<span class="brand-name">recipes</span>
|
|
18
19
|
</a>
|
|
19
20
|
<nav class="nav" aria-label="Main">
|
|
20
21
|
<a class="nav-cta" href="../index.html#prompt">Quick start</a>
|
|
21
22
|
<a href="../how-it-works.html">How it works</a>
|
|
22
|
-
<a href="../
|
|
23
|
-
<a href="../perps.html">Perps</a>
|
|
23
|
+
<a href="../perps.html">Team / Perps</a>
|
|
24
24
|
<a href="../cheatsheet.html">Cheatsheet</a>
|
|
25
25
|
<a href="../architecture.html">Architecture</a>
|
|
26
26
|
<a href="index.html" aria-current="page">Tutorials</a>
|
|
27
|
-
<a href="../reviewers.html">For Reviewers</a>
|
|
28
27
|
</nav>
|
|
29
28
|
</div>
|
|
30
29
|
</header>
|
|
@@ -208,6 +207,6 @@
|
|
|
208
207
|
</div>
|
|
209
208
|
</footer>
|
|
210
209
|
|
|
211
|
-
<script type="module" src="../assets/progress.mjs"></script>
|
|
210
|
+
<script type="module" src="../assets/progress.mjs?v=4"></script>
|
|
212
211
|
</body>
|
|
213
212
|
</html>
|