Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add specter docs #218

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+70 −0
Open

feat: add specter docs #218

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e6bb3ac
feat: add specter docs
smuu Jan 19, 2025
34ac01e
Merge branch 'main' into smuu/20250117-devnet-docs
distractedm1nd Feb 5, 2025
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
1 change: 1 addition & 0 deletions doc/src/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
* [Jellyfish Merkle Proofs](jellyfish-merkle-proofs.md)
* [Development Status](state.md)
* [Architecture](architecture.md)
* [Specter Devnet](specter-devnet.md)

-----------
# Prerequites
Expand Down
69 changes: 69 additions & 0 deletions doc/src/specter-devnet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# 👻 Specter Devnet: Enter the Haunted Realm 👻

Welcome, valiant explorer, to the Prism Specter Devnet—your gateway to the powerful capabilities of the based rollup on Celestia's Mocha testnet. Proceed with caution! This devnet is currently populated with mock proofs and is intended solely for development and testing purposes. **It is not suitable for production use.** Please be aware that the Specter Devnet may undergo changes at any time, including breaking modifications that could affect your work.

---

## 🛠️ Used Versions 🛠️

- **Celestia DA**: `e11cd71`
- **Prism**: `pr-205`
Comment on lines +9 to +10
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Enhance version references with links and semantic versions.

The current version references using commit hash and PR number could be improved:

  1. Add links to the specific commits/PRs
  2. Include semantic versions where available
  3. Consider adding release tags instead of commit hashes
-- **Celestia DA**: `e11cd71`
-- **Prism**: `pr-205`
+- **Celestia DA**: [`e11cd71`](https://github.com/celestiaorg/celestia-node/commit/e11cd71) (v0.x.x)
+- **Prism**: [PR #205](https://github.com/deltadevsde/prism/pull/205) (upcoming v0.x.x)

Committable suggestion skipped: line range outside the PR's diff.


**Note:** These versions are current and may be updated as the devnet evolves.

---

## 🔑 The Enchanted Verifying Key 🔑

Unlock the secrets of the Specter Devnet with this verifying key (for testing purposes only):
`L2ilppK59Kq3aAMB/wpxdVGaI53DHPMdY6fcRodyFaA=`

Comment on lines +18 to +20
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Add context about the verifying key's format and usage.

The verifying key section would benefit from additional information about:

  1. The key's encoding format (base64)
  2. Instructions or examples of how to use this key
  3. Where this key should be configured

**Note:** This key is intended for development and testing within the Specter Devnet and should not be used in production environments.

---

## 🌌 Celestial Namespaces 🌌

The Prism Specter Devnet haunts the Celestia Mocha testnet, weaving its spectral web across two distinct namespaces:

- **Operations Namespace**:
`000000000000000000000000000000000000707269736d5350456f30`

- **SNARKs Namespace**:
`000000000000000000000000000000000000707269736d5350457330`

**Note:** These namespaces are subject to change as the devnet evolves.

---

## 🕸️ How to Use the Specter Devnet 🕸️

Coming soon: **Detailed instructions will soon materialize from the shadows. Stay tuned!**
Comment on lines +39 to +41
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Critical section marked as "Coming soon".

The "How to Use" section is essential for users to get started with the devnet. Consider:

  1. Adding basic usage instructions in this PR
  2. Creating a follow-up issue to track the detailed documentation
  3. Including temporary workarounds or references


---

## 🕯️ Network Endpoints: Paths to the Unknown 🕯️

To commune with the Specter Devnet, use the following network endpoints. **Please be aware that these endpoints may change without notice as the devnet is actively under development:**

### 🧙‍♂️ Prism API 🧙‍♂️

- **API Endpoint**:
[specter-api.prism.boo](https://specter-api.prism.boo)

- **Swapper UI**:
[specter-api.prism.boo/swagger-ui](https://specter-api.prism.boo/swagger-ui)

### 🧛 Celestia DA Bootnode 🧛

Connect with the Celestia DA Bootnode through this haunted multiaddress:

`/dnsaddr/specter-da.prism.boo/p2p/12D3KooWEZT41VXGhYJQEBEb3Hv9tzwCrWC9DtjYCJTsbXjTigLL`

---

## 🔧 Troubleshooting 🔧

Having spooky issues? 👻 Help us exorcise those bugs by reporting them on the [Prism GitHub repository](https://github.com/deltadevsde/prism/issues). Your feedback is invaluable in enhancing the devnet experience.

---
Loading