Skip to content

Commit d576c30

Browse files
docs(readme): add Wrap (W) and Swap Init overview; update ports to 8083
1 parent 0f8fe34 commit d576c30

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

README.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,18 @@ The OPI (Operation Proposal Improvement) framework allows for seamless integrati
5858
- **Features:** Ordinals integration, witness data processing, external service validation
5959
- **Status:** Architecture complete, implementation in progress
6060

61+
#### **New: Wrap (W) and Swap Init**
62+
63+
- **Wrap (W)**
64+
- Locks BTC into a Taproot (P2TR) contract using a verifiable template (multisig + CSV branch).
65+
- A dedicated Wrap Validator reconstructs the expected P2TR address from witness data and verifies the mint amount.
66+
- API: `POST /v1/wrap/validate` for validation; related read endpoints under `/v1/wrap`.
67+
68+
- **Swap Init (intent creation)**
69+
- Creates a time-bound swap intent recorded as a `swap_position` with `status` in {`active`, `expired`, `closed`}.
70+
- Useful for liquidity and TVL estimates without moving funds across chains.
71+
- Query via swap endpoints and the `swap_positions` model introduced in the schema.
72+
6173
#### **How to Add New OPIs:**
6274

6375
1. **Create OPI Module:** Implement `BaseProcessor` interface
@@ -95,7 +107,7 @@ For maintainer-specific guidance, see [OPI Maintenance Guide](docs/architecture/
95107
```
96108
4. **Verify:**
97109
```bash
98-
curl http://localhost:8080/v1/indexer/brc20/health
110+
curl http://localhost:8083/v1/indexer/brc20/health
99111
# Expected output: { "status": "ok" }
100112
```
101113

@@ -155,21 +167,21 @@ make help # Show all available commands
155167

156168
## API Documentation
157169

158-
A comprehensive, interactive API documentation (Swagger UI) is available at `http://localhost:8080/docs` after launching the server.
170+
A comprehensive, interactive API documentation (Swagger UI) is available at `http://localhost:8083/docs` after launching the server.
159171

160172
For a static overview, see the [Full API Documentation](./docs/api/README.md).
161173

162174
### Core Endpoints
163175

164176
```bash
165177
# Health Check
166-
curl http://localhost:8080/v1/indexer/brc20/health
178+
curl http://localhost:8083/v1/indexer/brc20/health
167179
168180
# List all indexed tokens
169-
curl http://localhost:8080/v1/indexer/brc20/list
181+
curl http://localhost:8083/v1/indexer/brc20/list
170182
171183
# Get detailed information for a specific token
172-
curl http://localhost:8080/v1/indexer/brc20/{tick}
184+
curl http://localhost:8083/v1/indexer/brc20/{tick}
173185
```
174186

175187

0 commit comments

Comments
 (0)