Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion PRODUCTION_LAUNCH_CHECKLIST.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ This checklist must be completed before deploying the Dongle smart contract to S
## 6. Data Schema & Events

- [ ] Event schema (`EVENTS_SCHEMA.md`) matches emitted events in production code
- [ ] Review CID schema (`review-cid.schema.json`) validated against example (`review-cid.example.json`)
- [ ] Review CID schema (`docs/review-cid.schema.json`) validated against example (`docs/review-cid.example.json`)
- [ ] Data export guide (`DATA_EXPORT_GUIDE.md`) tested against Testnet data
- [ ] Indexers confirmed to be handling all event types in `EVENTS_SCHEMA.md`

Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,10 +105,10 @@ Projects can attach extended metadata via IPFS CIDs. Follow the JSON schema:

| Schema | Purpose |
|--------|---------|
| [`project-metadata.schema.json`](./project-metadata.schema.json) | Project metadata structure |
| [`project-metadata.example.json`](./project-metadata.example.json) | Example valid document |
| [`review-cid.schema.json`](./review-cid.schema.json) | Review content structure |
| [`review-cid.example.json`](./review-cid.example.json) | Example review document |
| [`project-metadata.schema.json`](./docs/project-metadata.schema.json) | Project metadata structure |
| [`project-metadata.example.json`](./docs/project-metadata.example.json) | Example valid document |
| [`review-cid.schema.json`](./docs/review-cid.schema.json) | Review content structure |
| [`review-cid.example.json`](./docs/review-cid.example.json) | Example review document |

**Key guidelines:**
- Pin metadata on IPFS and verify the CID matches on-chain `metadata_cid`
Expand Down
11 changes: 11 additions & 0 deletions docs/STORAGE_SCHEMA.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,17 @@ A project is stored under the key `Project(u64)` and contains the following fiel
| `created_at` | `u64` | Timestamp of project creation | No |
| `updated_at` | `u64` | Timestamp of last update | No |

## Off-Chain JSON Schemas

The following JSON schema and example files are co-located here in `docs/`:

| File | Purpose |
|------|---------|
| [`project-metadata.schema.json`](./project-metadata.schema.json) | Project metadata JSON schema |
| [`project-metadata.example.json`](./project-metadata.example.json) | Example valid project metadata document |
| [`review-cid.schema.json`](./review-cid.schema.json) | Review content JSON schema |
| [`review-cid.example.json`](./review-cid.example.json) | Example valid review document |

## Validation Rules

- `bounty_url`: If provided, must be a valid HTTP/HTTPS URL (starts with `http://` or `https://`).
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions dongle-smartcontract/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1734,8 +1734,8 @@ src/

- **Event Reference:** [EVENTS_SCHEMA.md](../EVENTS_SCHEMA.md) defines topics, payload structures, and compatibility patterns for all emitted contract events.
- **Threat Model:** [THREAT_MODEL.md](../THREAT_MODEL.md) documents trust boundaries, admin capabilities, mitigation steps, and unresolved risks.
- **Review CID Schema:** [review-cid.schema.json](../review-cid.schema.json) defines the off-chain JSON schema expected for review content CIDs.
- **Review Example:** [review-cid.example.json](../review-cid.example.json) provides a valid off-chain review document matching the schema.
- **Review CID Schema:** [review-cid.schema.json](../docs/review-cid.schema.json) defines the off-chain JSON schema expected for review content CIDs.
- **Review Example:** [review-cid.example.json](../docs/review-cid.example.json) provides a valid off-chain review document matching the schema.

## Contributing

Expand Down