Skip to content

Commit 21939b2

Browse files
author
Rotwang9000
committed
docs: surface x402 premium tier on docs.seneschal.space
Adds a "Premium tier (x402)" section to the public docs, lists the two new MCP tools in the tool reference table, and clarifies that the paywall is free to introspect via /v1/paywall before any paid call. Keeps the public surface honest: agents see the price and rails before they're asked to pay.
1 parent cdca219 commit 21939b2

1 file changed

Lines changed: 32 additions & 0 deletions

File tree

docs/index.html

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -238,8 +238,40 @@ <h2>MCP tool reference</h2>
238238
<tr><td><code>seneschal_builder_leaderboard</code></td><td>Ethereum builder market share.</td></tr>
239239
<tr><td><code>seneschal_stats_overview</code></td><td>One-call aggregate bundle powering the public dashboard.</td></tr>
240240
<tr><td><code>seneschal_flashloan_providers</code></td><td>Curated catalogue of mainnet flash-loan providers (Aave, Balancer, Morpho, Uniswap V3, FlashBank).</td></tr>
241+
<tr><td><code>seneschal_paywall_info</code></td><td><strong>Free.</strong> Describes the live x402 paywall (network, recipient, per-call price, MCP tool name) for the premium tier.</td></tr>
242+
<tr><td><code>seneschal_premium_opportunities</code></td><td><strong>Premium.</strong> Uncapped at-risk catalogue ranked by expected value, with realised 7d market intel. Paid via x402 at the REST surface.</td></tr>
241243
</table>
242244

245+
<h2>Premium tier (x402)</h2>
246+
<p>
247+
A small per-call USDC fee on Base mainnet unlocks
248+
<code>GET /v1/premium/opportunities</code>: the uncapped at-risk borrower
249+
catalogue plus realised 7-day market intel (top liquidators, win rate
250+
per market, our own attempt outcomes), ranked by expected liquidation
251+
value. Honest value-add over the free 500-row, snapshot-only
252+
<code>/v1/liquidations/atrisk</code>.
253+
</p>
254+
<p>
255+
Payment uses the <a href="https://docs.x402.org">x402 protocol</a>
256+
(spec v2). Unsigned requests get HTTP 402 with machine-readable
257+
<code>PaymentRequirements</code>; the client signs an EIP-3009
258+
<code>transferWithAuthorization</code> and retries with a
259+
<code>PAYMENT-SIGNATURE</code> header. The <a href="https://x402.org/facilitator">facilitator</a>
260+
verifies + settles on Base. No API keys, no subscriptions, gasless
261+
for the payer.
262+
</p>
263+
<p>
264+
Free metadata endpoint for budgeting before any paid call:
265+
</p>
266+
<pre><code>curl https://api.seneschal.space/v1/paywall</code></pre>
267+
<p>
268+
Returns <code>enabled: false</code> when the operator hasn't
269+
configured a recipient yet (current state) or the full network /
270+
recipient / route / price table once configured. Agents using
271+
<code>@x402/express</code>, <code>@x402/fastify</code> or the
272+
official client libraries pay automatically on 402.
273+
</p>
274+
243275
<h2>Data freshness &amp; coverage</h2>
244276
<ul>
245277
<li><strong>Aave V3 mainnet</strong> &mdash; live, latest health factor refreshed every block for borrowers with non-trivial debt.</li>

0 commit comments

Comments
 (0)