# Normies Yacht Club

> A fully on-chain, CC0 (public-domain) collection of generative pixel-art yachts on Ethereum
> mainnet — each yacht born from a burned Normie. This file helps LLMs and agents use the
> project's free, public API and art. Everything here is CC0: reuse freely, no attribution required.

Normies Yacht Club (symbol NYC, ERC-721) is burn-gated: one yacht is created for each burned
Normie, so supply grows only as Normies are burned. The art is rendered fully on-chain and is
permanently frozen (the renderer is locked). The website is a navigable 3D marina with real-time
multiplayer, a members chat (The Lounge), a live on-chain register, and hold-to-earn Anchor Points.

There is a free, public, static JSON API (no key, no rate limits) and a public deterministic art
generator. Build games, apps, bots, or derivatives — no permission needed.

## Privacy and truth (read this first)
- The API publishes NO wallet addresses: no owner lists, no burner lists.
- To answer who owns a yacht, whether it is claimed, or how many are held, READ THE CONTRACT
  on-chain (ownerOf, balanceOf, claimed, totalMinted). Do not infer ownership from cached files.
- `pixelCount` is the lit-pixel count of the BURNED NORMIE (it sets the yacht's class), not the
  yacht's own pixel count. A yacht's own on/off pixels are in `art.onPixels` / `art.bits`.

## API (CC0, no key)
- [API index / discovery](https://normiesyachtclub.com/api/v1/index.json): start here — lists every endpoint.
- [OpenAPI 3.1 spec](https://normiesyachtclub.com/api/v1/openapi.json): machine-readable schema of the API.
- [Collection stats](https://normiesyachtclub.com/api/v1/stats.json): fleet size, wallet count, class breakdown.
- [Fleet index](https://normiesyachtclub.com/api/v1/fleet.json): every yacht — id, normieId, pixelCount, class, rarityRank (no wallets).
- [Yacht by id](https://normiesyachtclub.com/api/v1/yacht/0.json): one yacht — all traits plus the real 40x40 art bitmap (replace 0 with any id).
- [Trait frequencies](https://normiesyachtclub.com/api/v1/traits.json): counts of each trait value across the fleet, for rarity.
- [Contract and ABI](https://normiesyachtclub.com/api/v1/contract.json): address, chain, deploy block, ABI — to read live state yourself.

## Agents (ERC-6551)
- Every yacht owns a token-bound account it keeps for life: it can hold ETH and NFTs, sign, and act.
  Whoever holds the yacht controls the account; transferring the yacht transfers the account with it.
- The address is a pure function of the token id — it exists and is stable before it is deployed.
  There is no registration step and no operator to ask.
- USE THIS PAIR, it is the project's blessed configuration; a different implementation or salt gives
  different addresses for the same yachts:
  registry 0x000000006551c19487814612e58FE06813775758,
  implementation 0x41C8f39463A868d3A88af00cd0fe7102F30E44eC, salt 0x00..00 (zero), chainId 1.
- Ready-made: each yacht's account address is in its own file at `onchain.agent`. Full config, registry
  ABI and three test vectors: https://normiesyachtclub.com/api/v1/contract.json under `agents`.
- An agent address tells you nothing about who controls it. Read `ownerOf(tokenId)` on the collection
  before acting on anyone's behalf.

## Art
- [Art generator (JS)](https://normiesyachtclub.com/art/yacht-generator.js): deterministic, browser and Node. `NYC.generateYachtBits(seed, {pixelCount})` returns a 1600-char bitmap ('1' = pixel on). Same seed always gives the same yacht.
- Art bitmap format: 40x40, row-major string of 1600 chars; pixel(x,y) = bits[y*40+x]; colors on `#48494b`, off `#e3e5e4`.
- On-chain official image: call `tokenURI(id)` on the contract (immutable).

## Docs
- [Developer guide](https://normiesyachtclub.com/developers.html): quickstart, endpoints, live demos.
- [How it works](https://normiesyachtclub.com/about.html): the collection, provenance, roadmap.
- [License: CC0 1.0](https://normiesyachtclub.com/LICENSE): art, data, and code dedicated to the public domain.

## Contract
- Network: Ethereum mainnet (chainId 1)
- Address: 0x87306c282eBd62Fe1c80AA69Dd9408331Dc11f64
- Standard: ERC-721 + ERC-2981 royalties; art fully on-chain; renderer locked.