Skip to content
Open
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
74 changes: 74 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Seismic Network Documentation

This directory contains comprehensive documentation for integrating with and operating on the Seismic Network. The documentation is built using [Vocs](https://vocs.dev/) and provides organized, searchable guides for developers, node operators, and institutional partners.

## Documentation Structure

The documentation is organized into the following sections:

### Getting Started
- **[Introduction](./pages/introduction.mdx)** - Overview of Seismic, key features, and documentation structure
- **[Installation](./pages/install.mdx)** - Set up sforge, sanvil, and ssolc for local development

### Networks
- **[Mainnet](./pages/mainnet.mdx)** - Mainnet configuration, gas pricing, and network status
- **[Testnet](./pages/testnet.mdx)** - Testnet endpoints, faucet information, and testing resources

### Technical Documentation
- **[Differences from Ethereum](./pages/ethereum-differences.mdx)** - EVM enhancements, RPC modifications, SRC20 tokens, and transaction types
- **[Architecture](./pages/architecture.mdx)** - Node architecture, Intel TDX requirements, hardware specs, and storage
- **[Consensus](./pages/consensus.mdx)** - Summit consensus client, Simplex algorithm, and finality
- **[Development Tools](./pages/tools.mdx)** - Seismic Solidity, sforge, sanvil, and ssolc

### Operations
- **[Node Operator FAQ](./pages/node-operator-faq.mdx)** - RPC operations, storage, performance, and maintenance
- **[Third-Party Infrastructure](./pages/third-party.mdx)** - Bridges, oracles, RPC providers, and custody solutions

### Legal & Governance
- **[Governance](./pages/governance.mdx)** - Staking, governance mechanisms, vesting, and tokenomics
- **[Compliance](./pages/compliance.mdx)** - Regulatory information and compliance considerations

### Support
- **[Resources & Contact](./pages/resources.mdx)** - Documentation sites, GitHub repositories, community links, and contact information

## Development

### Running Locally

```bash
npm install
npm run dev
```

The documentation will be available at `http://localhost:5173` (or another port if 5173 is in use).

### Building for Production

```bash
npm run build
```

### Configuration

- **[vocs.config.ts](./vocs.config.ts)** - Main Vocs configuration including theme, title, and social links
- **[sidebar.ts](./sidebar.ts)** - Sidebar navigation structure with organized sections

## Features

- Structured sections with anchored headings for easy linking
- Code blocks with syntax highlighting
- Tables for quick reference
- Cross-references between related topics
- Organized sidebar navigation with collapsible sections
- Search functionality (provided by Vocs)
- Mobile-responsive design

## Contact

For questions not covered in these docs:
- **Email**: c@seismic.systems
- **Website**: https://seismic.systems
- **Documentation**: https://docs.seismic.systems
- **Status Page**: https://status.seismicdev.net
- **Discord**: https://discord.gg/MnMJ37JN
- **Twitter**: [@SeismicSys](https://x.com/SeismicSys)
1,482 changes: 1,482 additions & 0 deletions docs/bun.lock

Large diffs are not rendered by default.

17 changes: 17 additions & 0 deletions docs/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"name": "seismic-node-docs",
"private": true,
"type": "module",
"scripts": {
"dev": "vocs dev",
"build": "vocs build",
"preview": "vocs preview"
},
"devDependencies": {
"react": "^19",
"react-dom": "^19",
"tailwindcss": "^4.0.6",
"vocs": "^1",
"typescript": "^5.5.4"
}
}
143 changes: 143 additions & 0 deletions docs/pages/architecture.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
# Architecture

## What Makes Seismic Unique

Seismic runs on Intel TDX (Trusted Execution Environment), which enables secure, privacy-preserving computation. This is more complex than standard node deployments:

- Nodes run in secure enclaves
- The deployment uses a VHD image with three integrated components
- Shutting down requires careful handling due to TDX constraints

## Required Binaries

Three binaries work together:

1. **[Seismic Reth](https://github.com/SeismicSystems/seismic-reth)** - Execution layer (fork of [Reth](https://reth.rs/))
2. **[Summit](https://github.com/SeismicSystems/summit)** - Consensus layer
3. **[Enclave](https://github.com/SeismicSystems/enclave)** - Privacy/shielded computation

All three binaries are deployed together in a VHD (Virtual Hard Disk) image built via Yocto.

### Additional Software

Node images also include:
- **SGX/TDX libraries** - Required for trusted execution environment
- **Supervisor** - Process management
- **Nginx** - Reverse proxy for RPC endpoints
- **Certbot** - SSL certificate management
- **Rust toolchain** - For building and running Rust binaries

## Deployment Method

Nodes are deployed using a VHD image that contains all necessary binaries. Setup instructions and architecture documentation are available in the [deploy repository](https://github.com/SeismicSystems/deploy), which was open-sourced in October 2025.

## Hardware Requirements

### Intel TDX Requirement

Yes, Seismic nodes must run on **Intel TDX (Trust Domain Extensions)** for secure enclave execution. Internally, Azure has been used for deployments, and instructions for Azure deployment will be provided.

### Recommended Specifications

**Recommended specifications for Archive Nodes:**
- **CPU**: 4+ vCPUs (high-performance multi-core processor)
- **Memory**: 32GB+ RAM
- **Network**: High-bandwidth, low-latency connection
- **Storage**: Disk size depends on VHD image (blockchain data stored on OS disk)
- **Required Hardware**: Intel TDX (Trust Domain Extensions) support
- **Security Type**: Confidential virtual machines with secure boot and TPM enabled

:::info
All nodes currently run as archival nodes. Storage requirements will grow linearly with network usage. The OS disk size is determined by the VHD image and should include sufficient space for blockchain data growth.
:::

**Example Azure Configuration:**
- Size: Standard EC4es v5 (4 vCPUs, 32GB RAM)
- OS Disk: Size determined by VHD image, Standard LRS
- Security: Confidential VM with secure boot and vTPM (NonPersistedTPM)
- SKU: `standard_lrs` with `ConfidentialVM_NonPersistedTPM` security type

**Benchmarked Performance:**
Detailed system requirements and benchmark results are available in the [deploy repository](https://github.com/SeismicSystems/deploy).

## Network Architecture

### Special Requirements

Yes - the node requires Intel TDX support and runs three interconnected components. Unlike simpler blockchain nodes, you cannot easily run individual pieces separately.

### Multiple Client Support

Currently, Seismic uses the Reth-based stack. Multiple client support may be added in the future.

## Configuration

### Data Directory

Yes, Reth supports specifying custom data directories, though the default is built into the VHD image.

### Host and Port

- **Host**: Yes, customizable
- **Port**: No (fixed in VHD image)

## Storage

### Storage Requirements

**Archive nodes**: 1TB+ recommended

Storage requirements will grow linearly with network activity. Within the first year, expect approximately 12 hours of sync time for full archive history.

### Monthly Growth

TBD - this depends on network activity and will be monitored after mainnet launch.

### Sync Time

- **From genesis**: Approximately 12 hours for the first year of mainnet operation (likely much less in the first 6 months)
- **With snapshots**: TBD - snapshot solution is still being developed
- **Startup time**: About 1 minute after a clean shutdown/reboot

### Snapshots

Snapshot support is planned and will be made available in the future. Once available, snapshots will significantly reduce initial sync times. Check the documentation and status page for updates on snapshot availability.

## Operations

### Graceful Shutdown

Yes, but given the TDX deployment, shutting down nodes is more complex than standard deployments. The node will exit cleanly with SIGTERM.

**Expected restart time**: About 1 minute from machine reboot.

### Hard Forks

No hard forks have occurred yet (network is pre-mainnet). The frequency of future hard forks is TBD, but all upgrades will be communicated via Twitter, Discord, and direct partner outreach.

All changes are deployed to testnet before mainnet.

## Seismic REVM

The Seismic REVM is a modified version of the Rust Ethereum Virtual Machine (REVM) that supports shielded computation and the custom opcodes. More details: https://github.com/SeismicSystems/seismic-revm

## Performance

### Scalability

Seismic has been extensively stress-tested under high load. Performance targets:
- **P99 latency**: On the order of seconds under high load (1000+ QPS)
- **P50 latency**: Tens of milliseconds

Benchmarks will be made public soon.

### Is Seismic a ZK Chain?

No. Seismic uses trusted execution environments (TEE) via Intel TDX for privacy, not zero-knowledge proofs.

## Shielded Features

Seismic supports:
- **Shielded storage**: Data stored privately on-chain via `CLOAD`/`CSTORE` opcodes
- **Encrypted calldata**: Transaction type 0x4a encrypts calldata
- **Shielded types in Solidity**: New data types for private state
35 changes: 35 additions & 0 deletions docs/pages/compliance.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Regulatory & Compliance

## Token Classification

### Is the Seismic Token a Security?

**Status**: Legal classification and opinions have not been publicly disclosed. Institutional partners should consult with their legal teams and contact Seismic directly for regulatory discussions.

## Entity Information

### Entity Domicile

**Status**: Corporate structure, jurisdiction, and regulatory body information will be disclosed in official documentation closer to mainnet launch.

### Team Location

**Status**: Team location and office information have not been publicly disclosed. For business inquiries, see the [Resources & Contact](/resources) page.

## Compliance Programs

### Anti-Money Laundering (AML) Program

**Status**: Compliance programs and procedures have not been publicly disclosed. Institutional partners should contact the Seismic team for compliance discussions.

### New York Customers

**Status**: Regulatory strategy for US states, including New York, has not been publicly disclosed.

## USD Custody

**Status**: USD custody solutions have not been publicly disclosed.

---

*For contact information and institutional inquiries, see the [Resources & Contact](/resources) page.*
43 changes: 43 additions & 0 deletions docs/pages/consensus.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Consensus

## Summit Consensus Client

[Summit](https://github.com/SeismicSystems/summit) is Seismic's consensus client that coordinates with the execution layer (Seismic Reth) and the enclave server.

Summit is built on [Commonware](https://commonware.xyz/), a modular framework for building blockchain infrastructure. Commonware provides the core building blocks that power Summit's consensus implementation.

## Simplex Consensus Algorithm

Seismic uses the Simplex consensus algorithm to achieve fast finality and high throughput.

### Finality

Seismic achieves finality in 1-2 blocks, with total finality time under 2 seconds. This is significantly faster than Ethereum mainnet.

**Finality details:**
- **Block time**: 600ms - 1 second
- **Blocks to finality**: 1-2 blocks
- **Total time to finality**: < 2 seconds

### Block Production

- **Block Rate**: 1 block per ~600ms - 1s
- **Empty Blocks**: Yes, like Ethereum, Seismic will produce empty blocks when there are no pending transactions

### Finality Tags

Currently, Seismic does not support the `"finalized"` block parameter tag as specified in EIP-3675. However, given the extremely fast finality (< 2 seconds), using `"latest"` provides near-equivalent guarantees.

**Workaround**: Use `"latest"` or specify a block number minus 1-2 blocks for finalized state.

This feature may be added in future updates if there's demand from integrators.

## Node Participation

### Publishing Transactions

Yes, if properly staked, nodes can propagate and publish transactions on-chain.

### Outages

Not on mainnet (not yet launched). During testing, various issues have occurred, but these have been resolved prior to public release.
Loading