Skip to content

Commit 1abab5c

Browse files
committed
docs: drop '.gitignore missing' caution from demo pages (mzdc-cbz)
Companion to me-tau, which adds a .gitignore to vativ/mezo-hack. Once that lands, the 'caution: the repo ships no .gitignore, create one before any git add' block I added back in mzdc-4mv is actively wrong — the reader IS protected by the repo's own .gitignore. Replaced the caution Aside in each demo page's Step 2 (.env configuration) with a single reassurance sentence: The repo's .gitignore already excludes .env, so the secrets you pasted above won't accidentally land in a commit. Similarly compressed the Security section bullet on each page that previously told the reader to run 'echo ".env" > .gitignore' — it now reads: .env stays out of git. The repo's .gitignore excludes .env by default. If you copy the file elsewhere or into another repo, re-confirm it's ignored before any git add. The 'copy elsewhere' reminder survives because it's real (git hygiene outside the demo repo). The stale 'repo has no .gitignore' framing is gone. Files touched: - agentic-joke-buyer.mdx (Step 2 Aside + Security bullet) - trove-advisor.mdx (Step 2 Aside + Security bullet) - trove-mandate.mdx (Step 2 Aside only; Security section didn't carry a matching bullet) Branch: docs/drop-gitignore-caution, based on docs/x402-env-var-dx- demos tip per the bead brief. Fork-only, chained on top of the env-var DX pass. Verification: grep for 'Create a .gitignore', 'no .gitignore', 'repo does not ship a .gitignore', and 'echo ".env" > .gitignore' across the three demo pages — all zero hits post-edit. The 5 remaining .gitignore mentions are the new reassurance phrasing. NOTE on timing: this doc change assumes me-tau has merged the .gitignore into vativ/mezo-hack on all the relevant branches (main, feat/agentic-2-trove-advisor, feat/agentic-3-trove-mandate). If those haven't all merged yet, readers of an unmerged branch will still see 'no .gitignore' and our new prose will be premature. Flag in the completion nudge.
1 parent 6238f34 commit 1abab5c

3 files changed

Lines changed: 20 additions & 48 deletions

File tree

src/content/docs/docs/developers/getting-started/musd-payments-x402/agentic-joke-buyer.mdx

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -110,19 +110,8 @@ Every other value (`NETWORK`, `RPC_URL`, `EXPLORER_URL`,
110110
pre-filled for Mezo Testnet in `.env.example` — Step 3 pulls those
111111
straight from the environment.
112112

113-
<Aside type="caution" title="The repo does not ship a .gitignore">
114-
`vativ/mezo-hack` currently has **no** `.gitignore` at any level.
115-
If you plan to commit anything from your clone, create one first so
116-
your `.env` (and therefore your private key) cannot slip into a
117-
commit:
118-
119-
```bash
120-
echo ".env" > .gitignore
121-
```
122-
123-
Private-key leakage via a committed `.env` is how test wallets
124-
drain. Do this before your next `git add`.
125-
</Aside>
113+
The repo ships a `.gitignore` that already excludes `.env`, so the
114+
private key you paste above won't accidentally land in a commit.
126115

127116
## Step 3: One-time Permit2 approval
128117

@@ -267,10 +256,9 @@ Everything else is inside the library.
267256
holds only borrowed MUSD and faucet BTC is fine for this demo.
268257
Anything else goes in a hardware signer or MPC wallet. Rotate the
269258
testnet key after the demo if you shared the repo anywhere.
270-
- **Add `.env` to `.gitignore` before any commit.** The cloned
271-
`vativ/mezo-hack` repo does not ship a `.gitignore`; if you plan
272-
to commit anything from your clone, run
273-
`echo ".env" > .gitignore` first (see the caution in Step 2).
259+
- **`.env` stays out of git.** The repo's `.gitignore` excludes
260+
`.env` by default. If you copy the file elsewhere or into another
261+
repo, re-confirm it's ignored before any `git add`.
274262
- The `toClientEvmSigner` interface is swappable — production agentic
275263
flows replace it with a signer backed by a KMS, HSM, or threshold
276264
wallet. The rest of the pipeline (`wrapFetchWithPayment`, the x402

src/content/docs/docs/developers/getting-started/musd-payments-x402/trove-advisor.mdx

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
2-
title: Demo 2 — Trove advisor (multi-merchant, dynamic pricing)
2+
title: 'Demo 2 — Trove advisor (multi-merchant, dynamic pricing)'
33
description: >-
4-
A Claude tool-use agent that pays three Mezo-native data services
5-
over x402 to stress-test a Mezo trove — one on-chain MUSD settlement
6-
per tool call, three distinct merchant addresses, per-request
7-
dynamic pricing.
4+
A Claude tool-use agent that pays three Mezo-native data services over x402 to
5+
stress-test a Mezo trove — one on-chain MUSD settlement per tool call, three
6+
distinct merchant addresses, per-request dynamic pricing.
87
topic: developers
98
---
109

@@ -136,14 +135,8 @@ addresses — no one controls their keys. That's fine: receivers don't
136135
need keys to accept permit2 transfers. Override them in your `.env`
137136
if you want payments to land in wallets you control.
138137

139-
<Aside type="caution" title="The repo does not ship a .gitignore">
140-
`vativ/mezo-hack` currently has no `.gitignore` at any level. Create
141-
one before any `git add` to protect your `.env`:
142-
143-
```bash
144-
echo ".env" > .gitignore
145-
```
146-
</Aside>
138+
The repo's `.gitignore` already excludes `.env`, so the secrets you
139+
pasted above won't accidentally land in a commit.
147140

148141
## Step 3: Start the server (Terminal 1)
149142

@@ -314,8 +307,9 @@ directly to its operator's wallet; the host just runs the routing.
314307
the same either way.
315308
- **Anthropic API key.** Treat it like any paid API credential. If
316309
your `.env` is on a shared machine, rotate it after the demo.
317-
- **`.gitignore` first.** Create `.gitignore` with at minimum a
318-
`.env` entry before any `git add`; see the caution in Step 2.
310+
- **`.env` stays out of git.** The repo's `.gitignore` excludes
311+
`.env` by default. If you copy the file elsewhere or into another
312+
repo, re-confirm it's ignored before any `git add`.
319313

320314
## See also
321315

src/content/docs/docs/developers/getting-started/musd-payments-x402/trove-mandate.mdx

Lines changed: 6 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
---
22
title: Demo 3 — Trove mandate (spend-policy layer)
33
description: >-
4-
Demo 2's multi-merchant agent with guardrails. An
5-
onBeforePaymentCreation hook runs every outbound x402 payment
6-
through a plain-JS spend policy — merchant allowlist, per-call and
7-
per-merchant caps, session total, rate limit — before any MUSD
8-
moves on chain.
4+
Demo 2's multi-merchant agent with guardrails. An onBeforePaymentCreation hook
5+
runs every outbound x402 payment through a plain-JS spend policy — merchant
6+
allowlist, per-call and per-merchant caps, session total, rate limit — before
7+
any MUSD moves on chain.
98
topic: developers
109
---
1110

@@ -174,17 +173,8 @@ Everything else in `.env.example` is pre-filled for Mezo Testnet —
174173
the RPC, MUSD contract, facilitator, and the same three merchant
175174
addresses as Demo 2 (`ORACLE_PAYTO`, `RISK_PAYTO`, `HUNTER_PAYTO`).
176175

177-
<Aside type="caution" title="Create a .gitignore before any commit">
178-
`vativ/mezo-hack` has no root `.gitignore`. The Demo 3 app ships its
179-
own `.gitignore`, but if you plan to commit anything at the repo
180-
level, confirm `.env` is covered:
181-
182-
```bash
183-
cat apps/trove-advisor-mandate/.gitignore # verify .env is listed
184-
# or, at the repo root:
185-
echo ".env" > .gitignore
186-
```
187-
</Aside>
176+
The repo's `.gitignore` already excludes `.env`, so the secrets you
177+
pasted above won't accidentally land in a commit.
188178

189179
## Step 3: Start the server (Terminal 1)
190180

0 commit comments

Comments
 (0)