Updates
This commit is contained in:
@@ -1,28 +1,39 @@
|
||||
# hyper-p2p-auction-gossip
|
||||
|
||||
**Status:** scaffold (`0.0.0-scaffold`) · **Protocol:** `auction-gossip/v1` · **Wave:** 8
|
||||
Distributed auction room over Hyperswarm gossip: open auctions, place bids, close with winner.
|
||||
|
||||
Auction gossip rounds.
|
||||
**Category:** Applications (economy)
|
||||
|
||||
## Holepunch references (inspiration only)
|
||||
**Composes with:** `hyper-p2p-decentralized-oracle`, `hyper-p2p-credit-ledger`
|
||||
|
||||
- `hyper-p2p-gossip-mesh`
|
||||
**Protocol:** `auction-gossip/v1`
|
||||
|
||||
> This module composes on Hyperswarm/Hypercore — it does **not** re-implement upstream packages.
|
||||
## When to use
|
||||
|
||||
## Composes with
|
||||
P2P marketplaces that need bid visibility across peers on a shared topic.
|
||||
|
||||
- `hyper-p2p-decentralized-oracle`
|
||||
## When not to use
|
||||
|
||||
## Planned API
|
||||
Centralized auction houses or single-node simulations without `topic`.
|
||||
|
||||
- `constructor(opts)` — topic, optional keyPair
|
||||
- `getStats()` — scaffold counters
|
||||
- `ready()` — no-op until implemented
|
||||
- Domain methods — throw `not implemented: scaffold` until Wave 8+ pass
|
||||
## Quick start
|
||||
|
||||
## Layout
|
||||
```js
|
||||
const { HyperP2PAuctionGossip } = require('hyper-p2p-auction-gossip')
|
||||
const auction = new HyperP2PAuctionGossip({ topic: 'my-auction-topic' })
|
||||
await auction.ready()
|
||||
auction.openAuction('lot-1', { item: 'vintage-bike' })
|
||||
auction.placeBid('lot-1', 42)
|
||||
await auction.close()
|
||||
```
|
||||
|
||||
`modules/applications-economy/hyper-p2p-auction-gossip/`
|
||||
## Docs
|
||||
|
||||
See [`modules/_shared/MODULE_SYSTEM.md`](../../_shared/MODULE_SYSTEM.md).
|
||||
- [docs/api.md](docs/api.md)
|
||||
- [docs/architecture.md](docs/architecture.md)
|
||||
|
||||
## Test
|
||||
|
||||
```bash
|
||||
npm install && npm test
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user