# MintFlow

> MintFlow is a browser-based creation flow for launching 1Sat Ordinals collections on BSV through a user-controlled BRC-100 wallet or MintFlow-hosted sales.

## When to use MintFlow

Use MintFlow when a user wants to prepare, review, mint, or later manage a 1Sat Ordinals collection. It is especially useful when another website or agent already knows the collection name, supply, tiers, traits, royalties, or artwork URL and wants to hand the user a prefilled wizard instead of asking them to re-enter that information. An agent can request either Mint to your wallet or MintFlow-hosted sales. MintFlow shows only launch paths it can fulfill and normalizes an unavailable hosted preference to Mint to your wallet before any action.

Do not use MintFlow's public API to sign, spend, mint, list, charge, broadcast, or commit on a user's behalf. The public API only validates metadata and prepares a URL. Open that URL for the user to edit and explicitly approve the selected launch path.

## Agent-safe workflow

1. Read the versioned capability index: https://mintflow.me/api/v1
2. Read the OpenAPI 3.1 contract: https://mintflow.me/openapi.json
3. POST collection metadata to https://mintflow.me/api/v1/mint/prepare
4. Open the returned `launchUrl` for the user.
5. Let the user review and edit every detail before committing. For Mint to your wallet, the BRC-100 wallet presents sensitive actions. For MintFlow-hosted sales, the user signs in with Sigma and explicitly approves the Stripe payment.

The prepare endpoint has no blockchain, wallet, payment, custody, or commitment side effects. Never ask a user for seed phrases, private keys, or raw wallet secrets.

Set `hostingOption` to `self` for Mint to your wallet: $0 MintFlow fee, plus Bitcoin network costs. The creator reviews and approves canonical BRC-100 actions in their wallet. When hosted sales are offered in the review, set it to `hosted` for MintFlow-hosted sales: $10 setup, including hosted on-chain setup costs. After Sigma sign-in and explicit Stripe payment, MintFlow provisions the collection, sale inventory, storefront, and delivery workflow; the creator does not approve collection or listing actions in a BRC-100 wallet. Setting either value only prefills the review and never commits it.

## Browser WebMCP

In supporting secure-context browsers, MintFlow registers three tools through `document.modelContext`:

- `get_mintflow_capabilities` reads the public capability index.
- `get_prism_pass_manifest` reads the reproducible Prism Pass metadata and canary launch gate.
- `prepare_mint_launch` validates metadata and returns a prefilled wizard URL.

These tools are read-only from the site's perspective. MintFlow does not expose WebMCP tools for minting, selling, buying, signing, spending, card charging, custody, or broadcasting. Tools are visible only to the same origin unless MintFlow has explicitly configured a trusted HTTPS origin allowlist.

## BRC-100 wallet boundary

MintFlow uses the BRC-100 wallet interface in the browser. Wallet discovery and connection happen in the user-visible wizard. Compatible wallets can include Yours Wallet and BSV Desktop when they expose the required BRC-100 capabilities. An agent should not assume a specific provider is active; it should let the user choose and confirm the wallet.

## Important links

- Product: https://mintflow.me/
- Mint wizard: https://mintflow.me/mint
- Human documentation: https://mintflow.me/docs
- Public capability index: https://mintflow.me/api/v1
- OpenAPI 3.1: https://mintflow.me/openapi.json

## Public API summary

`GET /api/v1` returns the machine-readable capability index.

`POST /api/v1/mint/prepare` accepts JSON collection metadata and returns a prefilled MintFlow wizard URL. It does not connect a wallet, sign, mint, list, charge, broadcast, or commit.

Stable operations live under `/api/v1`. Breaking changes use a new `/api/vN` path. Before removing a compatibility alias, MintFlow will publish `Deprecation`, `Sunset`, and `Link` response headers.

Example request:

```json
{
  "collectionName": "Prism Pass",
  "description": "A limited 1Sat Ordinals membership collection.",
  "totalQuantity": 100,
  "hostingOption": "self"
}
```

The returned URL opens the selected plan for review. No wallet connection, signature, transaction, listing, payment, broadcast, or commitment happens during preparation.

The endpoint returns structured JSON errors with stable `error.code` values for malformed or unsafe requests.