This commit is contained in:
@@ -56,7 +56,7 @@ Our ecosystem uses a multi-currency system to ensure both stability for utility
|
||||
|
||||
## Link to Revenue
|
||||
|
||||
- Hosters (farmers) are paid in TFP, which they can convert to TFT or hold for potential appreciation (80% of revenue)
|
||||
- Farmers (farmers) are paid in TFP, which they can convert to TFT or hold for potential appreciation (80% of revenue)
|
||||
- 10% of revenue is burned to reduce supply and maintain peg stability, burned TFT.
|
||||
- 10% of revenue goes to ThreeFold Foundation for ecosystem development and maintenance
|
||||
|
||||
@@ -70,4 +70,4 @@ This multi-token architecture solves several critical problems:
|
||||
- **Market Opportunity**: TFT remains tradable with upside potential
|
||||
- **Controlled Liquidity**: Prevents sudden token dumps while maintaining fairness
|
||||
- **Sustainable Growth**: Minting/burning mechanisms ensure backing and prevent inflation
|
||||
- **Operational Viability**: Farmers receive stable CC for planning while retaining TFT exposure options
|
||||
- **Operational Viability**: farmers receive stable CC for planning while retaining TFT exposure options
|
||||
|
@@ -45,7 +45,7 @@ Cloud Credits (CC) provide the stable utility currency needed for day-to-day ope
|
||||
|
||||
**Status**: Coming Soon
|
||||
|
||||
Farmers will be able to set their own pricing for capacity:
|
||||
farmers will be able to set their own pricing for capacity:
|
||||
|
||||
- **Flexible Pricing**: Set competitive rates for your node's resources
|
||||
- **Market-Driven**: Respond to demand and differentiate your offerings
|
||||
@@ -62,7 +62,7 @@ This feature is being designed to balance farmer autonomy with marketplace consi
|
||||
|
||||
The revenue distribution is farmer-first:
|
||||
|
||||
- **80% to Farmers**: Directly compensates capacity providers
|
||||
- **80% to farmers**: Directly compensates capacity providers
|
||||
- **10% Burned**: Reduces TFT supply, supporting token value
|
||||
- **10% to ThreeFold**: Funds ongoing development and operations
|
||||
|
||||
@@ -92,11 +92,11 @@ This is part of the TFGrid v4 rollout. See the [Node Economics section](/node-ec
|
||||
A marketplace where users can bid on capacity and farmers can accept offers:
|
||||
|
||||
- **Demand-Driven**: Users post requirements and budget
|
||||
- **Competitive**: Farmers compete to provide best value
|
||||
- **Competitive**: farmers compete to provide best value
|
||||
- **Transparent**: Clear matching between needs and offerings
|
||||
- **Flexible**: Supports both standard and custom configurations
|
||||
|
||||
### Income Clarity for Farmers
|
||||
### Income Clarity for farmers
|
||||
|
||||
**Status**: Documentation Complete | Tools in Development
|
||||
|
||||
@@ -218,7 +218,7 @@ We will share offtaker information and capacity commitments **as soon as commerc
|
||||
|
||||
## What This Means For You
|
||||
|
||||
### For Farmers
|
||||
### For farmers
|
||||
|
||||
- **Stable Income**: CC-based payments protect against TFT volatility
|
||||
- **Clear Economics**: Documented pricing and income projections
|
||||
@@ -244,17 +244,17 @@ We will share offtaker information and capacity commitments **as soon as commerc
|
||||
|
||||
## Timeline Summary
|
||||
|
||||
| Component | Status | Timeline |
|
||||
|-----------|--------|----------|
|
||||
| Token Economics Design | ✅ Designed | Awaiting implementation |
|
||||
| Slices System | 🚧 Designed | Part of TFGrid v4 |
|
||||
| Kubernetes Cloud | ✅ Running | Now |
|
||||
| Dutch Auction Mechanism | 🚧 In Development | Q4 2024 |
|
||||
| Marketplace Features | 🚧 In Development | Q4 2024 - Q1 2025 |
|
||||
| TFGrid v4 / ZOS v4 | 🚧 In Development | 2-3 months |
|
||||
| GPU Node Expansion | 🔨 Active Effort | Ongoing |
|
||||
| End-User Applications | 🔨 Active Development | Q1-Q2 2025 |
|
||||
| Offtaker Announcements | 🔒 Under NDA | When commercially ready |
|
||||
| Component | Status | Timeline |
|
||||
| ----------------------- | -------------------- | ----------------------- |
|
||||
| Token Economics Design | ✅ Designed | Awaiting implementation |
|
||||
| Slices System | 🚧 Designed | Part of TFGrid v4 |
|
||||
| Kubernetes Cloud | ✅ Running | Now |
|
||||
| Dutch Auction Mechanism | 🚧 In Development | Q4 2024 |
|
||||
| Marketplace Features | 🚧 In Development | Q4 2024 - Q1 2025 |
|
||||
| TFGrid v4 / ZOS v4 | 🚧 In Development | 2-3 months |
|
||||
| GPU Node Expansion | 🔨 Active Effort | Ongoing |
|
||||
| End-User Applications | 🔨 Active Development | Q1-Q2 2025 |
|
||||
| Offtaker Announcements | 🔒 Under NDA | When commercially ready |
|
||||
|
||||
:::tip Stay Updated
|
||||
Join the discussion and get the latest updates as implementation progresses:
|
||||
|
43
docs/node-economics/bids.md
Normal file
43
docs/node-economics/bids.md
Normal file
@@ -0,0 +1,43 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Bidding on ThreeFold Grid Capacity: Ensuring Farmer Revenue
|
||||
|
||||
The ThreeFold Grid's decentralized marketplace introduces a robust bidding system that allows not only ThreeFold itself but also other entities to bid on available compute, storage, and network capacity. This mechanism is crucial for farmers, as it provides a proactive way to secure revenue and optimize node utilization without solely relying on direct customer reservations.
|
||||
|
||||
## How Bidding Works
|
||||
|
||||
The bidding system enables various parties to express their demand for specific resource configurations on the ThreeFold Grid.
|
||||
|
||||
1. **ThreeFold's Role as a Bidder:**
|
||||
* ThreeFold, as the protocol developer and ecosystem facilitator, often places bids on capacity to ensure the grid has sufficient resources for its own operations, strategic partnerships, or to bootstrap demand for new node types.
|
||||
* These bids are typically structured as "Bid Tiers," as seen in the `overview.md` document. These tiers specify a certain number of nodes or slices with defined minimum performance, memory, and GPU requirements, along with a set price per month. This provides a stable revenue stream for farmers whose nodes meet these specifications.
|
||||
|
||||
2. **Other Entities as Bidders:**
|
||||
* Beyond ThreeFold, other large-scale users, enterprises, or even decentralized applications (dApps) can place bids for significant amounts of capacity. This could be for long-term infrastructure needs, burst capacity for specific events, or to secure resources for their own user base.
|
||||
* These bids act as a direct demand signal to farmers, allowing them to accept pre-negotiated terms for their available capacity.
|
||||
|
||||
## Benefits for Farmers: Yield Management and Consistent Revenue
|
||||
|
||||
The bidding system offers significant advantages for farmers:
|
||||
|
||||
1. **Proactive Revenue Generation:** Instead of passively waiting for individual customers to reserve their node slices, farmers can actively accept bids. This ensures a more consistent and predictable revenue stream, reducing idle capacity.
|
||||
|
||||
2. **Yield Management:** The bidding system allows farmers to practice "yield management." They can strategically accept bids, even at potentially lower prices than individual customer reservations, to ensure their nodes are always utilized. This is particularly valuable for filling off-peak capacity or securing long-term commitments.
|
||||
|
||||
3. **Flexible Durations:** Bids can be placed for various durations, ranging from short-term (minimum 1 hour) to long-term commitments (e.g., 1 month, or multiple months). This flexibility allows farmers to balance immediate income needs with long-term stability.
|
||||
|
||||
4. **Reduced Market Volatility:** By having a baseline of bids from ThreeFold and other large consumers, farmers are less exposed to the fluctuations of individual customer demand. This creates a more stable economic environment for node operators.
|
||||
|
||||
## The Marketplace Dynamics
|
||||
|
||||
The bidding process integrates seamlessly with the existing decentralized marketplace:
|
||||
|
||||
* **Transparency:** All bids are transparently listed on the grid, allowing farmers to see the demand for different resource types and adjust their offerings accordingly.
|
||||
* **Automated Matching:** Smart contracts facilitate the matching of bids with available farmer capacity, ensuring efficient allocation and automated payments.
|
||||
* **Farmer Choice:** Farmers retain the autonomy to accept or reject bids based on their own pricing strategies and desired utilization rates. While bids might sometimes offer lower prices, the benefit of guaranteed utilization and consistent income often outweighs the potential for higher, but less certain, individual customer rates.
|
||||
|
||||
## Conclusion
|
||||
|
||||
The bidding system on the ThreeFold Grid is a cornerstone of its node economics, providing a powerful mechanism for farmers to secure revenue and optimize their hardware investments. By enabling ThreeFold and other entities to proactively bid on capacity, the grid fosters a dynamic and resilient marketplace where farmers can effectively manage their yield and contribute to the growth of the decentralized internet with greater financial certainty.
|
45
docs/node-economics/explanation.md
Normal file
45
docs/node-economics/explanation.md
Normal file
@@ -0,0 +1,45 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Node Economics Explained: How Farmers Earn and the Decentralized Marketplace
|
||||
|
||||
The ThreeFold Grid offers a unique opportunity for individuals, known as "farmers," to monetize their hardware by contributing to a global, decentralized cloud infrastructure. This document explains the core economic principles, how farmers generate income, and the role of the decentralized marketplace.
|
||||
|
||||
## The Role of a Farmer
|
||||
|
||||
A farmer is an individual or entity that operates one or more "nodes" on the ThreeFold Grid. A node is essentially a physical or certified compute machine that provides resources like CPU, memory, and storage to the network. By making these resources available, farmers become integral to the decentralized cloud, enabling users worldwide to deploy applications, store data, and run various workloads without relying on centralized providers.
|
||||
|
||||
## How Farmers Make Money
|
||||
|
||||
Farmers earn income by renting out "slices" of their nodes. Each node can be logically divided into multiple slices, with each slice having its own allocated resources (e.g., a certain number of CPU cores, amount of RAM, and SSD storage).
|
||||
|
||||
1. **Node Acquisition and Setup:**
|
||||
* Farmers invest in hardware to set up their nodes. The `overview.md` document provides examples of various node configurations, including "Mini," "Mini AI," and "Nvidia" certified nodes, along with their estimated costs.
|
||||
* These nodes are then connected to the ThreeFold Grid, making their resources discoverable and available for reservation.
|
||||
|
||||
2. **Resource Slicing and Pricing:**
|
||||
* Farmers have the flexibility to divide their nodes into multiple slices. The `overview.md` shows examples like a "Mini 1" node potentially offering up to 25 slices, while a "Nvidia 6000 (1x)" node might offer 1 slice due to its specialized nature.
|
||||
* For each slice, farmers can set their own pricing within a defined minimum and maximum range. This allows them to compete in the marketplace while ensuring a fair return on their investment. The pricing can be set per hour, per month, or for longer durations, with shorter reservations typically incurring higher prices.
|
||||
|
||||
3. **Income Generation:**
|
||||
* When a user reserves a slice of a farmer's node, the farmer earns income. The `overview.md` highlights an income split: 80% of the revenue goes directly to the farmer, 10% is burned (reducing the total supply of the ThreeFold Token, TFT), and 10% goes to ThreeFold for protocol development and maintenance.
|
||||
* The income potential varies significantly based on the node type, its specifications, and the number of slices it can offer. For instance, a "Mini 1" node might generate a minimum of $10.92/month and a maximum of $126/month, while a "Nvidia 6000 (1x)" node could yield between $390 and $4,500/month. These figures illustrate the potential for substantial earnings, especially with higher-end or specialized hardware.
|
||||
|
||||
## The Decentralized Marketplace
|
||||
|
||||
The ThreeFold Grid operates as a decentralized marketplace where farmers and users interact directly.
|
||||
|
||||
1. **Farmers Offer Resources:** Farmers list their available node slices, specifying the resources (CPU, memory, SSD, AI, TPS) and their desired pricing. This information is broadcast across the grid.
|
||||
|
||||
2. **Users Reserve Resources:** Users, whether individuals or organizations, browse the available resources on the marketplace. They can search for specific configurations that meet their needs for deploying applications, hosting websites, or running AI workloads. Once a suitable slice is found, they can reserve it for a specified duration.
|
||||
|
||||
3. **Dynamic Pricing and Bid Tiers:**
|
||||
* The marketplace supports dynamic pricing, where prices can adjust based on factors like reservation length. Shorter reservations might have a higher hourly rate compared to longer-term commitments.
|
||||
* ThreeFold also sets "Bid Tiers" for various slice types (e.g., "Std Compute Slice," "Mem Heavy Slice," "AI Slice"). These tiers represent the prices ThreeFold is willing to pay for specific resource configurations, providing a baseline and ensuring a certain level of demand for farmers' resources. This mechanism helps stabilize the market and provides farmers with a clearer understanding of potential earnings.
|
||||
|
||||
4. **Transparency and Efficiency:** The decentralized nature of the marketplace ensures transparency in pricing and resource allocation. Smart contracts on the ThreeFold blockchain handle reservations and payments, eliminating intermediaries and reducing transaction costs. This creates a highly efficient and trustless environment for both farmers and users.
|
||||
|
||||
## Conclusion
|
||||
|
||||
The ThreeFold Grid's node economics model empowers farmers to become active participants in the decentralized internet. By providing essential compute, storage, and network resources, farmers not only earn a sustainable income but also contribute to building a more resilient, open, and accessible digital future. The decentralized marketplace facilitates this exchange, ensuring fair value and efficient resource utilization across the globe.
|
BIN
docs/node-economics/img/node_overview.png
Normal file
BIN
docs/node-economics/img/node_overview.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 592 KiB |
@@ -1,496 +0,0 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Node Specifications & Income Projections
|
||||
|
||||
This page provides detailed specifications for all node types, including hardware costs, resource allocations, and income projections based on the slices model.
|
||||
|
||||
:::info Price Assumptions
|
||||
- **Cloud Credits (CC)** pegged at 1/1000 gram of gold ≈ **$0.128 USD** (as of Oct 8, 2024)
|
||||
- **Hardware costs** amortized over **5-year lifespan**
|
||||
- **Revenue share**: 80% to farmer, 10% burned, 10% to ThreeFold
|
||||
- **No CPU oversubscription** in current calculations
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
## Non-Certified Nodes
|
||||
|
||||
Non-certified nodes are community-contributed hardware that meets minimum specifications but hasn't gone through the formal certification process.
|
||||
|
||||
### 3Node Home
|
||||
|
||||
**Target**: Home users, hobbyists, small-scale farmers
|
||||
|
||||
| Specification | Value |
|
||||
|--------------|-------|
|
||||
| **Estimate Cost** | $500 |
|
||||
| **CPU Cores** | 16 |
|
||||
| **Passmark** | 22,000 |
|
||||
| **Memory** | 32 GB |
|
||||
| **SSD Storage** | 1,000 GB |
|
||||
| **GPU Memory** | - |
|
||||
| **TPS** | - |
|
||||
|
||||
**Slices Economics**:
|
||||
|
||||
| Metric | Value |
|
||||
|--------|-------|
|
||||
| **Max Slices** | 25 |
|
||||
| **HW Cost/Month (5Y)** | 8 CC |
|
||||
| **Min Income/Month** | 10.92 CC |
|
||||
| **Max Income/Month** | 126 CC |
|
||||
| **Typical Active Slices** | 7 |
|
||||
|
||||
**Per Slice Resources**:
|
||||
- CPU: 2.3 cores
|
||||
- Performance: 3,143 Passmark
|
||||
- Memory: 4.0 GB
|
||||
- Storage: 143 GB
|
||||
- Price Range: 1.2 - 12.0 CC/month
|
||||
|
||||
**ROI Analysis**:
|
||||
- **Break-even**: ~3-4 years at minimum income
|
||||
- **Best case**: 6-8 months at maximum utilization
|
||||
- **Realistic**: 12-18 months at 50% utilization
|
||||
|
||||
---
|
||||
|
||||
### Large TFGrid Node
|
||||
|
||||
**Target**: Dedicated farmers, data center deployments
|
||||
|
||||
| Specification | Value |
|
||||
|--------------|-------|
|
||||
| **Estimate Cost** | $2,000 |
|
||||
| **CPU Cores** | 36 |
|
||||
| **Passmark** | 20,000 |
|
||||
| **Memory** | 512 GB |
|
||||
| **SSD Storage** | 4,000 GB |
|
||||
| **GPU Memory** | - |
|
||||
| **TPS** | - |
|
||||
|
||||
**Slices Economics**:
|
||||
|
||||
| Metric | Value |
|
||||
|--------|-------|
|
||||
| **Max Slices** | 100 |
|
||||
| **HW Cost/Month (5Y)** | 33 CC |
|
||||
| **Min Income/Month** | 198.12 CC |
|
||||
| **Max Income/Month** | 2,286 CC |
|
||||
| **Typical Active Slices** | 20 |
|
||||
|
||||
**Per Slice Resources**:
|
||||
- CPU: 1.8 cores
|
||||
- Performance: 1,000 Passmark
|
||||
- Memory: 25.4 GB
|
||||
- Storage: 200 GB
|
||||
- Price Range: 7.6 - 76.2 CC/month
|
||||
|
||||
**ROI Analysis**:
|
||||
- **Break-even**: ~10-12 months at minimum income
|
||||
- **Best case**: 1 month at maximum utilization
|
||||
- **Realistic**: 4-6 months at 40% utilization
|
||||
|
||||
:::tip High Memory Advantage
|
||||
This node's high memory (512 GB) makes it ideal for memory-heavy slices, commanding premium pricing.
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
### Large TFGrid Node 2
|
||||
|
||||
**Target**: Budget-conscious farmers, balanced workloads
|
||||
|
||||
| Specification | Value |
|
||||
|--------------|-------|
|
||||
| **Estimate Cost** | $1,200 |
|
||||
| **CPU Cores** | 36 |
|
||||
| **Passmark** | 20,000 |
|
||||
| **Memory** | 128 GB |
|
||||
| **SSD Storage** | 2,000 GB |
|
||||
| **GPU Memory** | - |
|
||||
| **TPS** | - |
|
||||
|
||||
**Slices Economics**:
|
||||
|
||||
| Metric | Value |
|
||||
|--------|-------|
|
||||
| **Max Slices** | 100 |
|
||||
| **HW Cost/Month (5Y)** | 20 CC |
|
||||
| **Min Income/Month** | 48.36 CC |
|
||||
| **Max Income/Month** | 558 CC |
|
||||
| **Typical Active Slices** | 20 |
|
||||
|
||||
**Per Slice Resources**:
|
||||
- CPU: 1.8 cores
|
||||
- Performance: 1,000 Passmark
|
||||
- Memory: 6.2 GB
|
||||
- Storage: 100 GB
|
||||
- Price Range: 1.9 - 18.6 CC/month
|
||||
|
||||
**ROI Analysis**:
|
||||
- **Break-even**: ~2-3 years at minimum income
|
||||
- **Best case**: 2-3 months at maximum utilization
|
||||
- **Realistic**: 8-12 months at 40% utilization
|
||||
|
||||
---
|
||||
|
||||
## Certified Nodes (New Batch Q4 2025)
|
||||
|
||||
Certified nodes are pre-configured, tested hardware packages from approved vendors, ensuring quality and reliability.
|
||||
|
||||
### Mini 1
|
||||
|
||||
**Target**: Entry-level certified farming
|
||||
|
||||
| Specification | Value |
|
||||
|--------------|-------|
|
||||
| **Estimate Cost** | $350 |
|
||||
| **CPU Cores** | 16 |
|
||||
| **Passmark** | 16,000 |
|
||||
| **Memory** | 32 GB |
|
||||
| **SSD Storage** | 1,000 GB |
|
||||
| **GPU Memory** | - |
|
||||
| **TPS** | - |
|
||||
|
||||
**Slices Economics**:
|
||||
|
||||
| Metric | Value |
|
||||
|--------|-------|
|
||||
| **Max Slices** | 25 |
|
||||
| **HW Cost/Month (5Y)** | 6 CC |
|
||||
| **Min Income/Month** | 11 CC |
|
||||
| **Max Income/Month** | 126 CC |
|
||||
| **Typical Active Slices** | 7 |
|
||||
|
||||
**Per Slice Resources**:
|
||||
- CPU: 2.3 cores
|
||||
- Performance: 2,286 Passmark
|
||||
- Memory: 4.0 GB
|
||||
- Storage: 143 GB
|
||||
- Price Range: 1.2 - 12.0 CC/month
|
||||
|
||||
**ROI Analysis**:
|
||||
- **Break-even**: ~3 years at minimum income
|
||||
- **Best case**: 3-4 months at maximum utilization
|
||||
- **Realistic**: 10-14 months at 50% utilization
|
||||
|
||||
---
|
||||
|
||||
### Mini 2
|
||||
|
||||
**Target**: Mid-range certified farming, small business
|
||||
|
||||
| Specification | Value |
|
||||
|--------------|-------|
|
||||
| **Estimate Cost** | $800 |
|
||||
| **CPU Cores** | 24 |
|
||||
| **Passmark** | 25,000 |
|
||||
| **Memory** | 64 GB |
|
||||
| **SSD Storage** | 2,000 GB |
|
||||
| **GPU Memory** | - |
|
||||
| **TPS** | - |
|
||||
|
||||
**Slices Economics**:
|
||||
|
||||
| Metric | Value |
|
||||
|--------|-------|
|
||||
| **Max Slices** | 25 |
|
||||
| **HW Cost/Month (5Y)** | 13 CC |
|
||||
| **Min Income/Month** | 23 CC |
|
||||
| **Max Income/Month** | 270 CC |
|
||||
| **Typical Active Slices** | 15 |
|
||||
|
||||
**Per Slice Resources**:
|
||||
- CPU: 1.6 cores
|
||||
- Performance: 1,667 Passmark
|
||||
- Memory: 4.0 GB
|
||||
- Storage: 133 GB
|
||||
- Price Range: 1.2 - 12.0 CC/month
|
||||
|
||||
**ROI Analysis**:
|
||||
- **Break-even**: ~2.5-3 years at minimum income
|
||||
- **Best case**: 3-4 months at maximum utilization
|
||||
- **Realistic**: 10-12 months at 55% utilization
|
||||
|
||||
---
|
||||
|
||||
### Mini 3
|
||||
|
||||
**Target**: Serious certified farmers, enterprise edge deployments
|
||||
|
||||
| Specification | Value |
|
||||
|--------------|-------|
|
||||
| **Estimate Cost** | $1,000 |
|
||||
| **CPU Cores** | 24 |
|
||||
| **Passmark** | 25,000 |
|
||||
| **Memory** | 128 GB |
|
||||
| **SSD Storage** | 4,000 GB |
|
||||
| **GPU Memory** | - |
|
||||
| **TPS** | - |
|
||||
|
||||
**Slices Economics**:
|
||||
|
||||
| Metric | Value |
|
||||
|--------|-------|
|
||||
| **Max Slices** | 25 |
|
||||
| **HW Cost/Month (5Y)** | 17 CC |
|
||||
| **Min Income/Month** | 48 CC |
|
||||
| **Max Income/Month** | 558 CC |
|
||||
| **Typical Active Slices** | 25 |
|
||||
|
||||
**Per Slice Resources**:
|
||||
- CPU: 1.0 cores
|
||||
- Performance: 1,000 Passmark
|
||||
- Memory: 5.0 GB
|
||||
- Storage: 160 GB
|
||||
- Price Range: 1.5 - 14.9 CC/month
|
||||
|
||||
**ROI Analysis**:
|
||||
- **Break-even**: ~1.5-2 years at minimum income
|
||||
- **Best case**: 2 months at maximum utilization
|
||||
- **Realistic**: 6-8 months at 60% utilization
|
||||
|
||||
:::tip Sweet Spot
|
||||
Mini 3 offers excellent balance of cost, performance, and storage. Strong ROI potential with good network utilization.
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
## AI-Focused Certified Nodes
|
||||
|
||||
These nodes include dedicated GPU hardware for AI/ML workloads, representing the future growth area of TFGrid.
|
||||
|
||||
### Mini AI 1
|
||||
|
||||
**Target**: Entry-level AI workloads, inference, development
|
||||
|
||||
| Specification | Value |
|
||||
|--------------|-------|
|
||||
| **Estimate Cost** | $2,000 |
|
||||
| **CPU Cores** | 32 |
|
||||
| **Passmark** | 50,000 |
|
||||
| **Memory** | 128 GB |
|
||||
| **SSD Storage** | 4,000 GB |
|
||||
| **GPU Memory** | 128 GB |
|
||||
| **TPS** | 20 |
|
||||
|
||||
**Slices Economics**:
|
||||
|
||||
| Metric | Value |
|
||||
|--------|-------|
|
||||
| **Max Slices** | 4 |
|
||||
| **HW Cost/Month (5Y)** | 33 CC |
|
||||
| **Min Income/Month** | 52 CC |
|
||||
| **Max Income/Month** | 600 CC |
|
||||
| **Typical Active Slices** | 4 |
|
||||
|
||||
**Per Slice Resources**:
|
||||
- CPU: 8.0 cores
|
||||
- Performance: 12,500 Passmark
|
||||
- Memory: 31.0 GB
|
||||
- Storage: 1,000 GB
|
||||
- GPU: Shared access
|
||||
- TPS: 5
|
||||
- Price Range: 10 - 100 CC/month
|
||||
|
||||
**ROI Analysis**:
|
||||
- **Break-even**: ~3 years at minimum income
|
||||
- **Best case**: 3-4 months at maximum utilization
|
||||
- **Realistic**: 8-12 months at 70% utilization
|
||||
|
||||
---
|
||||
|
||||
### Nvidia 6000 (Single GPU)
|
||||
|
||||
**Target**: Professional AI training, high-end inference
|
||||
|
||||
| Specification | Value |
|
||||
|--------------|-------|
|
||||
| **Estimate Cost** | $15,000 |
|
||||
| **CPU Cores** | 24 |
|
||||
| **Passmark** | 35,000 |
|
||||
| **Memory** | 128 GB |
|
||||
| **SSD Storage** | 4,000 GB |
|
||||
| **GPU Memory** | 96 GB |
|
||||
| **TPS** | 350 |
|
||||
|
||||
**Slices Economics**:
|
||||
|
||||
| Metric | Value |
|
||||
|--------|-------|
|
||||
| **Max Slices** | 1 (dedicated full node) |
|
||||
| **HW Cost/Month (5Y)** | 250 CC |
|
||||
| **Min Income/Month** | 390 CC |
|
||||
| **Max Income/Month** | 4,500 CC |
|
||||
| **Typical Active Slices** | 1 |
|
||||
|
||||
**Per Slice Resources**:
|
||||
- CPU: 24 cores (full node)
|
||||
- Performance: 35,000 Passmark
|
||||
- Memory: 124 GB
|
||||
- Storage: 4,000 GB
|
||||
- GPU: 96 GB dedicated
|
||||
- TPS: 350
|
||||
- Price Range: 300 - 3,000 CC/month
|
||||
|
||||
**ROI Analysis**:
|
||||
- **Break-even**: ~3 years at minimum income
|
||||
- **Best case**: 3-4 months at maximum utilization
|
||||
- **Realistic**: 10-14 months at 60% utilization
|
||||
|
||||
:::note High-Value Target
|
||||
These nodes target high-value AI workloads. Even at minimum pricing, they generate significant income if utilized.
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
### Nvidia 6000 (Dual GPU)
|
||||
|
||||
**Target**: Large-scale AI training, enterprise ML operations
|
||||
|
||||
| Specification | Value |
|
||||
|--------------|-------|
|
||||
| **Estimate Cost** | $30,000 |
|
||||
| **CPU Cores** | 24 |
|
||||
| **Passmark** | 35,000 |
|
||||
| **Memory** | 128 GB |
|
||||
| **SSD Storage** | 8,000 GB |
|
||||
| **GPU Memory** | 192 GB (2x 96GB) |
|
||||
| **TPS** | 700 |
|
||||
|
||||
**Slices Economics**:
|
||||
|
||||
| Metric | Value |
|
||||
|--------|-------|
|
||||
| **Max Slices** | 2 (can be sold separately) |
|
||||
| **HW Cost/Month (5Y)** | 500 CC |
|
||||
| **Min Income/Month** | 780 CC |
|
||||
| **Max Income/Month** | 9,000 CC |
|
||||
| **Typical Active Slices** | 2 |
|
||||
|
||||
**Per Slice Resources**:
|
||||
- CPU: 12 cores
|
||||
- Performance: 17,500 Passmark
|
||||
- Memory: 62 GB
|
||||
- Storage: 4,000 GB
|
||||
- GPU: 96 GB dedicated per slice
|
||||
- TPS: 350
|
||||
- Price Range: 300 - 3,000 CC/month per slice
|
||||
|
||||
**ROI Analysis**:
|
||||
- **Break-even**: ~3 years at minimum income
|
||||
- **Best case**: 3-4 months at maximum utilization
|
||||
- **Realistic**: 12-16 months at 50% utilization
|
||||
|
||||
---
|
||||
|
||||
### Tenstorrent 8x
|
||||
|
||||
**Target**: Cutting-edge AI acceleration, next-gen ML workloads
|
||||
|
||||
| Specification | Value |
|
||||
|--------------|-------|
|
||||
| **Estimate Cost** | $30,000 |
|
||||
| **CPU Cores** | 24 |
|
||||
| **Passmark** | 35,000 |
|
||||
| **Memory** | 128 GB |
|
||||
| **SSD Storage** | 8,000 GB |
|
||||
| **GPU Memory** | 192 GB |
|
||||
| **TPS** | 2,000 |
|
||||
|
||||
**Slices Economics**:
|
||||
|
||||
| Metric | Value |
|
||||
|--------|-------|
|
||||
| **Max Slices** | 2 |
|
||||
| **HW Cost/Month (5Y)** | 500 CC |
|
||||
| **Min Income/Month** | 780 CC |
|
||||
| **Max Income/Month** | 9,000 CC |
|
||||
| **Typical Active Slices** | 2 |
|
||||
|
||||
**Per Slice Resources**:
|
||||
- CPU: 12 cores
|
||||
- Performance: 17,500 Passmark
|
||||
- Memory: 62 GB
|
||||
- Storage: 4,000 GB
|
||||
- AI Memory: 96 GB dedicated per slice
|
||||
- TPS: 1,000
|
||||
- Price Range: 300 - 3,000 CC/month per slice
|
||||
|
||||
**ROI Analysis**:
|
||||
- **Break-even**: ~3 years at minimum income
|
||||
- **Best case**: 3-4 months at maximum utilization
|
||||
- **Realistic**: 12-16 months at 50% utilization
|
||||
|
||||
:::tip Tenstorrent Advantage
|
||||
With 2,000 TPS (vs 700 for Nvidia), Tenstorrent offers superior AI performance for specific workloads at the same price point.
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
## Comparison Table: All Nodes
|
||||
|
||||
| Node Type | Cost | Monthly HW Cost | Min Income | Max Income | Break-Even (Min) | Break-Even (Max) |
|
||||
|-----------|------|-----------------|------------|------------|------------------|------------------|
|
||||
| **Non-Certified** |
|
||||
| 3Node Home | $500 | 8 CC | 10.92 CC | 126 CC | 3-4 years | 6-8 months |
|
||||
| Large TFGrid | $2,000 | 33 CC | 198.12 CC | 2,286 CC | 10-12 months | 1 month |
|
||||
| Large TFGrid 2 | $1,200 | 20 CC | 48.36 CC | 558 CC | 2-3 years | 2-3 months |
|
||||
| **Certified Q4 2025** |
|
||||
| Mini 1 | $350 | 6 CC | 11 CC | 126 CC | 3 years | 3-4 months |
|
||||
| Mini 2 | $800 | 13 CC | 23 CC | 270 CC | 2.5-3 years | 3-4 months |
|
||||
| Mini 3 | $1,000 | 17 CC | 48 CC | 558 CC | 1.5-2 years | 2 months |
|
||||
| **AI Nodes** |
|
||||
| Mini AI 1 | $2,000 | 33 CC | 52 CC | 600 CC | 3 years | 3-4 months |
|
||||
| Nvidia 6000 1x | $15,000 | 250 CC | 390 CC | 4,500 CC | 3 years | 3-4 months |
|
||||
| Nvidia 6000 2x | $30,000 | 500 CC | 780 CC | 9,000 CC | 3 years | 3-4 months |
|
||||
| Tenstorrent 8x | $30,000 | 500 CC | 780 CC | 9,000 CC | 3 years | 3-4 months |
|
||||
|
||||
---
|
||||
|
||||
## Key Insights
|
||||
|
||||
### For Standard Compute Nodes
|
||||
|
||||
- **3Node Home / Mini 1**: Good for hobbyists, learning the ecosystem
|
||||
- **Mini 2 / Mini 3**: Best balance of cost and ROI for serious farmers
|
||||
- **Large TFGrid**: Premium option for those with high memory workload expectations
|
||||
|
||||
### For AI-Focused Farming
|
||||
|
||||
- **Mini AI 1**: Entry point for AI farming, lower risk
|
||||
- **Nvidia 6000**: Industry-standard, proven demand
|
||||
- **Tenstorrent 8x**: Higher TPS for specific AI workloads, emerging technology
|
||||
|
||||
### General Observations
|
||||
|
||||
1. **AI nodes have higher upfront costs** but command premium pricing
|
||||
2. **Certified nodes** coming Q4 2025 provide quality assurance
|
||||
3. **Memory-heavy configurations** can charge more per slice
|
||||
4. **Break-even highly dependent** on network utilization
|
||||
5. **80% revenue share** means farmers keep majority of value
|
||||
|
||||
---
|
||||
|
||||
## Important Notes
|
||||
|
||||
**(*) Revenue Distribution**: 80% to hoster/farmer, 10% burned, 10% to ThreeFold
|
||||
|
||||
**No CPU Oversubscription**: Current calculations assume no CPU oversubscription. In reality, users will have more CPU available during low-demand periods, and potential oversubscription could increase effective income.
|
||||
|
||||
**Cloud Credit Conversion**: CC can be acquired by converting 2 TFT or by purchasing at fiat equivalent of 1/1000 gram of gold price = ~$0.128 USD (price as of Oct 8, 2024)
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
- **[Pricing Model](/node-economics/pricing-model)** - Deep dive into income scenarios and ROI calculations
|
||||
- **[TF Bid Packages](/node-economics/tf-bid-packages)** - See what ThreeFold is willing to buy
|
||||
- **[Slices Overview](/node-economics/slices-overview)** - Understand the slice concept
|
||||
|
||||
:::tip Hardware Planning
|
||||
Use these specifications to plan your hardware investment based on your budget, risk tolerance, and market expectations.
|
||||
:::
|
@@ -1,97 +1,96 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Example Node Configurations (Q4 2025)
|
||||
|
||||
This document outlines example compute nodes, their specifications, estimated costs, performance profiles, and potential monthly income based on the **ThreeFold / GeoMind** model for decentralized AI, compute, and storage nodes.
|
||||

|
||||
|
||||
Nodes are divided into **Certified** and **Non-Certified** types, each with defined hardware specs and income models.
|
||||
|
||||
---
|
||||
|
||||
## ⚙️ Node Specifications
|
||||
## Node Specifications
|
||||
|
||||
| **Type** | **Estimate Cost (USD)** | **CPU Cores** | **Passmark** | **MEM (GB)** | **SSD (GB)** | **AI (GB)** | **TPS** |
|
||||
| --------------------------------- | ----------------------- | ------------- | ------------ | ------------ | ------------ | ----------- |
|
||||
| **Non-Certified** | | | | | | | |
|
||||
| --------------------------------- | ----------------------- | ------------- | ------------ | ------------ | ------------ | ----------- | ------- |
|
||||
| **Example Nodes TFGrid** | | | | | | | |
|
||||
| 3Node Home | $500 | 16 | 22,000 | 32 | 1,000 | – | – |
|
||||
| Large TFGrid Node | $2,000 | 36 | 20,000 | 512 | 4,000 | – | – |
|
||||
| Large TFGrid Node 2 | $1,200 | 36 | 20,000 | 128 | 2,000 | – | – |
|
||||
| **Certified (new batch Q4 2025)** | | | | | | | |
|
||||
| **New Nodes (market Q4 2025)** | | | | | | | |
|
||||
| Mini 1 | $350 | 16 | 16,000 | 32 | 1,000 | – | – |
|
||||
| Mini 2 | $800 | 24 | 25,000 | 64 | 2,000 | – | – |
|
||||
| Mini 3 | $1,000 | 24 | 25,000 | 128 | 4,000 | – | – |
|
||||
| Mini AI 1 | $2,000 | 32 | 50,000 | 128 | 4,000 | 128 | 20 |
|
||||
| **Certified (new batch Q4 2025)** | | | | | | | |
|
||||
| Nvidia 6000 (1x) | $15,000 | 24 | 35,000 | 128 | 4,000 | 96 | 350 |
|
||||
| Nvidia 6000 (2x) | $30,000 | 24 | 35,000 | 128 | 8,000 | 192 | 700 |
|
||||
| Tenstorrent 8x | $30,000 | 24 | 35,000 | 128 | 8,000 | 192 | 1,000 |
|
||||
|
||||
|
||||
Example nodes, certified and non-certified, with estimated costs and specifications as of Q4 2025.
|
||||
|
||||
---
|
||||
|
||||
## Node Economics
|
||||
|
||||
farmers can earn income by renting out slices of their nodes. Each node can be divided into multiple slices, each with its own resource allocation and pricing.
|
||||
farmers can set their own prince in between min and maximum range.
|
||||
|
||||
### Hardware Cost and Income Potential
|
||||
|
||||
| **Model** | **Max # Slices** | **HW Cost / month (5 Y)** | **Min Income / Month** | **Max Income / Month** | **Nr Slices** |
|
||||
| ---------------- | ---------------- | ------------------------- | ---------------------- | ---------------------- | ------------- |
|
||||
| Mini 1 | 25 | 8 | 10.92 | 126 | 7 |
|
||||
| Mini 2 | 25 | 13 | 23 | 270 | 15 |
|
||||
| Mini 3 | 25 | 17 | 48.36 | 558 | 25 |
|
||||
| Mini AI 1 | 4 | 33 | 52 | 600 | 4 |
|
||||
| Nvidia 6000 (1x) | 1 | 250 | 390 | 4,500 | 1 |
|
||||
| Nvidia 6000 (2x) | 2 | 500 | 780 | 9,000 | 2 |
|
||||
| Tenstorrent 8x | 2 | 500 | 780 | 9,000 | 2 |
|
||||
| Mini 1 | 25 | 8 | $10.92 | $126 | 7 |
|
||||
| Mini 2 | 25 | 13 | $23 | $270 | 15 |
|
||||
| Mini 3 | 25 | 17 | $48.36 | $558 | 25 |
|
||||
| Mini AI 1 | 4 | 33 | $52 | $600 | 4 |
|
||||
| Nvidia 6000 (1x) | 1 | 250 | $390 | $4,500 | 1 |
|
||||
| Nvidia 6000 (2x) | 2 | 500 | $780 | $9,000 | 2 |
|
||||
| Tenstorrent 8x | 2 | 500 | $780 | $9,000 | 2 |
|
||||
|
||||
> All prices in USD
|
||||
> 💡 **Income split:**
|
||||
> 80 % to hoster, 10 % burned, 10 % to ThreeFold (protocol).
|
||||
|
||||
---
|
||||
|
||||
## Cloud Credit (CC) Pricing
|
||||
|
||||
| **Currency Basis** | **Value** |
|
||||
| ----------------------- | -------------------------------- |
|
||||
| 1 CC = 1/1000 g of gold | ≈ 0.128 USD *(as of Oct 8 2025)* |
|
||||
| Equivalent | 2 TFT (TF token units) |
|
||||
> 80 % to farmer, 10 % burned, 10 % to ThreeFold (protocol).
|
||||
|
||||
---
|
||||
|
||||
## Pricing for 1 Slice
|
||||
|
||||
| **Cores** | **Perf** | **Mem (GB)** | **SSD (GB)** | **TPS** | **Min Price / Month (CC)** | **Max Price / Month (CC)** | **Min Price / Hour (CC)** | **Max Price / Hour (CC)** |
|
||||
| --------- | -------- | ------------ | ------------ | ------- | -------------------------- | -------------------------- | ------------------------- | ------------------------- |
|
||||
| 2.3 | 3,143 | 4 | 143 | 0 | 1.2 | 12 | 0.0033 | 0.0250 |
|
||||
| 1.8 | 1,000 | 25.4 | 200 | 0 | 7.6 | 76.2 | 0.0212 | 0.1588 |
|
||||
| 1.8 | 1,000 | 6.2 | 100 | 0 | 1.9 | 18.6 | 0.0052 | 0.0388 |
|
||||
| 2.3 | 2,286 | 4 | 143 | 0 | 1.2 | 12 | 0.0033 | 0.0250 |
|
||||
| 1.6 | 1,667 | 4 | 133 | 0 | 1.2 | 12 | 0.0033 | 0.0250 |
|
||||
| 1.0 | 1,000 | 5.0 | 160 | 0 | 1.5 | 14.9 | 0.0041 | 0.0310 |
|
||||
| 8.0 | 12,500 | 31 | 1,000 | 5 | 10 | 100 | 0.0278 | 0.2083 |
|
||||
| 24 | 35,000 | 124 | 4,000 | 350 | 300 | 3,000 | 0.8 | 6.3 |
|
||||
| 12 | 17,500 | 62 | 4,000 | 350 | 300 | 3,000 | 0.8 | 6.3 |
|
||||
| 12 | 17,500 | 62 | 4,000 | 1,000 | 300 | 3,000 | 0.8 | 6.3 |
|
||||
Pricing table for slices of various node types, showing minimum and maximum prices based on resource allocation.
|
||||
|
||||
> **Note:**
|
||||
| **Model** | **Cores** | **Perf** | **Mem (GB)** | **SSD (GB)** | **TPS** | **Min Price / Month ** | **Max Price / Month ** | **Min Price / HOUR ** | **Max Price / HOUR ** |
|
||||
| ------------------- | --------- | -------- | ------------ | ------------ | ------- | ---------------------- | ---------------------- | --------------------- | --------------------- |
|
||||
| Mini 1 | 2.3 | 3,143 | 4 | 143 | 0 | $1.2 | $12 | $0.0033 | $0.0250 |
|
||||
| Large TFGrid Node | 1.8 | 1,000 | 25.4 | 200 | 0 | $7.6 | $76.2 | $0.0212 | $0.1588 |
|
||||
| Large TFGrid Node 2 | 1.8 | 1,000 | 6.2 | 100 | 0 | $1.9 | $18.6 | $0.0052 | $0.0388 |
|
||||
| 3Node Home | 2.3 | 2,286 | 4 | 143 | 0 | $1.2 | $12 | $0.0033 | $0.0250 |
|
||||
| Mini 2 | 1.6 | 1,667 | 4 | 133 | 0 | $1.2 | $12 | $0.0033 | $0.0250 |
|
||||
| Mini 3 | 1.0 | 1,000 | 5.0 | 160 | 0 | $1.5 | $14.9 | $0.0041 | $0.0310 |
|
||||
| Mini AI 1 | 8.0 | 12,500 | 31 | 1,000 | 5 | $10 | $100 | $0.0278 | $0.2083 |
|
||||
| Nvidia 6000 (1x) | 24 | 35,000 | 124 | 4,000 | 350 | $300 | $3,000 | $0.8 | $6.3 |
|
||||
| Nvidia 6000 (2x) | 12 | 17,500 | 62 | 4,000 | 350 | $300 | $3,000 | $0.8 | $6.3 |
|
||||
| Tenstorrent 8x | 12 | 17,500 | 62 | 4,000 | 1,000 | $300 | $3,000 | $0.8 | $6.3 |
|
||||
|
||||
> All prices in USD
|
||||
> These calculations assume **no CPU oversubscription** — in real deployments, users can utilize higher effective CPU capacity.
|
||||
|
||||
---
|
||||
|
||||
## Bid Tiers (ThreeFold Willing to Set)
|
||||
|
||||
| **Type** | **# Nodes** | **Min Perf** | **MEM (GB)** | **GPU (GB)** | **Price / Month (CC)** |
|
||||
| --------------------------- | ----------- | ------------ | ------------ | ------------ | ---------------------- |
|
||||
| Std Compute Slice | 20,000 | 2,000 | 4 | 1.2 | |
|
||||
| Mem Heavy Slice | 2,000 | 2,000 | 8 | 2.4 | |
|
||||
| AI Slice | 2,000 | 25,000 | 124 | 50 | |
|
||||
| AI Slice Big Nvidia 1x | 50 | 35,000 | 124 | 96 | 500 |
|
||||
| AI Slice Big Nvidia 2x | 50 | 35,000 | 250 | 192 | 1,000 |
|
||||
| AI Slice Big Tenstorrent 8x | 50 | 35,000 | 250 | 192 | 1,000 |
|
||||
| **Type** | **# Nodes** | **Min Perf** | **MEM (GB)** | **GPU (GB)** | **Price / Month ** |
|
||||
| --------------------------- | ----------- | ------------ | ------------ | ------------ | ------------------ |
|
||||
| Std Compute Slice | 20,000 | 2,000 | 4 | 1.2 | $1.2 |
|
||||
| Mem Heavy Slice | 2,000 | 2,000 | 8 | 2.4 | $2.4 |
|
||||
| AI Slice | 2,000 | 25,000 | 124 | 50 | $50 |
|
||||
| AI Slice Big Nvidia 1x | 50 | 35,000 | 124 | 96 | $500 |
|
||||
| AI Slice Big Nvidia 2x | 50 | 35,000 | 250 | 192 | $1,000 |
|
||||
| AI Slice Big Tenstorrent 8x | 50 | 35,000 | 250 | 192 | $1,000 |
|
||||
|
||||
**Total:**
|
||||
|
||||
* **24,150 slices**
|
||||
* **253,800 GB total memory**
|
||||
* **≈ 3,965,625 CC monthly potential (≈ $507,600)**
|
||||
|
||||
> *Based on new AI 395+ nodes. Dedicated memory & GPU per slice (full node model).*
|
||||
> AI Slice: Based on new AI 395+ nodes. Dedicated memory & GPU per slice (full node model).
|
||||
|
||||
---
|
||||
|
||||
@@ -112,7 +111,6 @@ Nodes are divided into **Certified** and **Non-Certified** types, each with defi
|
||||
* A **capital cost** (hardware)
|
||||
* A **hardware amortization** over 5 years (monthly cost)
|
||||
* A potential **monthly income** based on slice sales (compute / AI / storage)
|
||||
* **Hosters** receive 80 % of income, 10 % is protocol burn, 10 % to ThreeFold.
|
||||
* **farmers** receive 80 % of income, 10 % is protocol burn, 10 % to ThreeFold.
|
||||
* The income range shows **minimum guaranteed** and **maximum potential** usage scenarios.
|
||||
* **Cloud Credits (CC)** are the internal accounting unit pegged to gold, maintaining stability and fairness.
|
||||
|
@@ -1,449 +0,0 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Pricing Model & Income Analysis
|
||||
|
||||
Understanding the economics of farming is essential for making informed hardware decisions. This page breaks down pricing, utilization scenarios, and ROI calculations.
|
||||
|
||||
---
|
||||
|
||||
## Pricing Components
|
||||
|
||||
### Per-Slice Pricing Structure
|
||||
|
||||
Each slice has two key price points:
|
||||
|
||||
**Minimum Price** (Floor):
|
||||
- Conservative market pricing
|
||||
- Ensures farmers can cover costs
|
||||
- Competitive with major cloud providers at bulk rates
|
||||
- Assumes moderate demand
|
||||
|
||||
**Maximum Price** (Ceiling):
|
||||
- Premium positioning
|
||||
- Comparable to retail cloud pricing
|
||||
- Assumes high demand and full utilization
|
||||
- Competitive advantage scenarios
|
||||
|
||||
**Example: Standard Compute Slice**
|
||||
- Min: 1.2 CC/month (~$0.15)
|
||||
- Max: 12.0 CC/month (~$1.54)
|
||||
- Range: 10x spread between floor and ceiling
|
||||
|
||||
---
|
||||
|
||||
## Revenue Share Breakdown
|
||||
|
||||
Every Cloud Credit (CC) spent on TFGrid capacity is distributed as follows:
|
||||
|
||||
```mermaid
|
||||
pie title Revenue Distribution per 100 CC
|
||||
"Farmer (You!)" : 80
|
||||
"TFT Burn (Deflationary)" : 10
|
||||
"ThreeFold Operations" : 10
|
||||
```
|
||||
|
||||
### What This Means
|
||||
|
||||
If a user pays **100 CC** for your slices:
|
||||
|
||||
| Recipient | Amount | Purpose |
|
||||
|-----------|--------|---------|
|
||||
| **Farmer** | 80 CC | Your income |
|
||||
| **TFT Burn** | 10 CC | Reduces TFT supply → supports token value |
|
||||
| **ThreeFold** | 10 CC | Platform development, operations, support |
|
||||
|
||||
:::tip Farmer-First Model
|
||||
With 80% going directly to farmers, you keep the vast majority of value generated by your infrastructure.
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
## Income Scenarios by Node Type
|
||||
|
||||
### Scenario Analysis Framework
|
||||
|
||||
We analyze three utilization scenarios for each node:
|
||||
|
||||
1. **Conservative** (20-30% utilization): Network still growing
|
||||
2. **Moderate** (50-60% utilization): Healthy network adoption
|
||||
3. **Optimistic** (80-100% utilization): High demand period
|
||||
|
||||
---
|
||||
|
||||
### Example: Mini 3 (Certified Node)
|
||||
|
||||
**Hardware Investment**: $1,000
|
||||
**Monthly HW Cost**: 17 CC
|
||||
**Maximum Slices**: 25
|
||||
**Typical Active Slices**: 25 (can provide full 25)
|
||||
|
||||
#### Conservative Scenario (30% utilization, min pricing)
|
||||
|
||||
```
|
||||
Active Slices: 25 × 30% = 7.5 slices
|
||||
Price per Slice: 1.5 CC (minimum)
|
||||
Gross Income: 7.5 × 1.5 = 11.25 CC/month
|
||||
Your Share (80%): 9 CC/month
|
||||
Net Profit: 9 - 17 = -8 CC/month (not profitable yet)
|
||||
```
|
||||
|
||||
**Status**: Needs higher utilization or pricing to be profitable
|
||||
|
||||
#### Moderate Scenario (60% utilization, mid pricing)
|
||||
|
||||
```
|
||||
Active Slices: 25 × 60% = 15 slices
|
||||
Price per Slice: 7.5 CC (midpoint)
|
||||
Gross Income: 15 × 7.5 = 112.5 CC/month
|
||||
Your Share (80%): 90 CC/month
|
||||
Net Profit: 90 - 17 = 73 CC/month
|
||||
Annual Profit: 73 × 12 = 876 CC (~$112/year)
|
||||
ROI: $1,000 investment / $112/year = 8.9 years
|
||||
```
|
||||
|
||||
**Status**: Profitable but slow ROI
|
||||
|
||||
#### Optimistic Scenario (100% utilization, premium pricing)
|
||||
|
||||
```
|
||||
Active Slices: 25 × 100% = 25 slices
|
||||
Price per Slice: 14.9 CC (maximum)
|
||||
Gross Income: 25 × 14.9 = 372.5 CC/month
|
||||
Your Share (80%): 298 CC/month
|
||||
Net Profit: 298 - 17 = 281 CC/month
|
||||
Annual Profit: 281 × 12 = 3,372 CC (~$432/year)
|
||||
ROI: $1,000 investment / $432/year = 2.3 years
|
||||
```
|
||||
|
||||
**Status**: Excellent ROI with strong demand
|
||||
|
||||
---
|
||||
|
||||
### Example: Large TFGrid Node
|
||||
|
||||
**Hardware Investment**: $2,000
|
||||
**Monthly HW Cost**: 33 CC
|
||||
**Maximum Slices**: 100
|
||||
**Typical Active Slices**: 20 (limited by resource balance)
|
||||
|
||||
#### Conservative Scenario (25% utilization, min pricing)
|
||||
|
||||
```
|
||||
Active Slices: 20 × 25% = 5 slices
|
||||
Price per Slice: 7.6 CC (minimum)
|
||||
Gross Income: 5 × 7.6 = 38 CC/month
|
||||
Your Share (80%): 30.4 CC/month
|
||||
Net Profit: 30.4 - 33 = -2.6 CC/month (slight loss)
|
||||
```
|
||||
|
||||
**Status**: Nearly break-even at low utilization
|
||||
|
||||
#### Moderate Scenario (50% utilization, mid pricing)
|
||||
|
||||
```
|
||||
Active Slices: 20 × 50% = 10 slices
|
||||
Price per Slice: 40 CC (midpoint)
|
||||
Gross Income: 10 × 40 = 400 CC/month
|
||||
Your Share (80%): 320 CC/month
|
||||
Net Profit: 320 - 33 = 287 CC/month
|
||||
Annual Profit: 287 × 12 = 3,444 CC (~$441/year)
|
||||
ROI: $2,000 investment / $441/year = 4.5 years
|
||||
```
|
||||
|
||||
**Status**: Solid profitability
|
||||
|
||||
#### Optimistic Scenario (100% utilization, premium pricing)
|
||||
|
||||
```
|
||||
Active Slices: 20 × 100% = 20 slices
|
||||
Price per Slice: 76.2 CC (maximum)
|
||||
Gross Income: 20 × 76.2 = 1,524 CC/month
|
||||
Your Share (80%): 1,219 CC/month
|
||||
Net Profit: 1,219 - 33 = 1,186 CC/month
|
||||
Annual Profit: 1,186 × 12 = 14,232 CC (~$1,822/year)
|
||||
ROI: $2,000 investment / $1,822/year = 1.1 years
|
||||
```
|
||||
|
||||
**Status**: Outstanding ROI
|
||||
|
||||
:::tip High-Memory Advantage
|
||||
Large TFGrid Node's 512 GB RAM enables premium memory-heavy slice pricing, driving higher income per active slice.
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
### Example: Nvidia 6000 (Dual GPU)
|
||||
|
||||
**Hardware Investment**: $30,000
|
||||
**Monthly HW Cost**: 500 CC
|
||||
**Maximum Slices**: 2 (dedicated GPU slices)
|
||||
**Typical Active Slices**: 2
|
||||
|
||||
#### Conservative Scenario (50% utilization, min pricing)
|
||||
|
||||
```
|
||||
Active Slices: 2 × 50% = 1 slice
|
||||
Price per Slice: 300 CC (minimum)
|
||||
Gross Income: 1 × 300 = 300 CC/month
|
||||
Your Share (80%): 240 CC/month
|
||||
Net Profit: 240 - 500 = -260 CC/month (loss)
|
||||
```
|
||||
|
||||
**Status**: Needs higher utilization for profitability
|
||||
|
||||
#### Moderate Scenario (75% utilization, mid pricing)
|
||||
|
||||
```
|
||||
Active Slices: 2 × 75% = 1.5 slices
|
||||
Price per Slice: 1,650 CC (midpoint)
|
||||
Gross Income: 1.5 × 1,650 = 2,475 CC/month
|
||||
Your Share (80%): 1,980 CC/month
|
||||
Net Profit: 1,980 - 500 = 1,480 CC/month
|
||||
Annual Profit: 1,480 × 12 = 17,760 CC (~$2,273/year)
|
||||
ROI: $30,000 investment / $2,273/year = 13.2 years
|
||||
```
|
||||
|
||||
**Status**: Profitable but requires patience
|
||||
|
||||
#### Optimistic Scenario (100% utilization, premium pricing)
|
||||
|
||||
```
|
||||
Active Slices: 2 × 100% = 2 slices
|
||||
Price per Slice: 3,000 CC (maximum)
|
||||
Gross Income: 2 × 3,000 = 6,000 CC/month
|
||||
Your Share (80%): 4,800 CC/month
|
||||
Net Profit: 4,800 - 500 = 4,300 CC/month
|
||||
Annual Profit: 4,300 × 12 = 51,600 CC (~$6,605/year)
|
||||
ROI: $30,000 investment / $6,605/year = 4.5 years
|
||||
```
|
||||
|
||||
**Status**: Excellent returns with AI demand
|
||||
|
||||
:::note AI Premium Pricing
|
||||
GPU nodes can command significantly higher prices due to AI/ML demand. Market pricing for comparable GPU cloud instances supports these ranges.
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
## Income Comparison: All Nodes at 50% Utilization
|
||||
|
||||
Assuming **50% utilization** and **mid-point pricing**:
|
||||
|
||||
| Node Type | HW Cost | Monthly Net | Annual Net | ROI (Years) | Annual % Return |
|
||||
|-----------|---------|-------------|------------|-------------|-----------------|
|
||||
| 3Node Home | $500 | ~35 CC | ~420 CC | ~10 | ~10% |
|
||||
| Large TFGrid | $2,000 | ~287 CC | ~3,444 CC | ~4.5 | ~22% |
|
||||
| Large TFGrid 2 | $1,200 | ~100 CC | ~1,200 CC | ~8 | ~12.5% |
|
||||
| Mini 1 | $350 | ~30 CC | ~360 CC | ~8 | ~12.5% |
|
||||
| Mini 2 | $800 | ~60 CC | ~720 CC | ~9 | ~11% |
|
||||
| Mini 3 | $1,000 | ~73 CC | ~876 CC | ~9 | ~11% |
|
||||
| Mini AI 1 | $2,000 | ~140 CC | ~1,680 CC | ~9.5 | ~10.5% |
|
||||
| Nvidia 6000 1x | $15,000 | ~875 CC | ~10,500 CC | ~11.4 | ~8.8% |
|
||||
| Nvidia 6000 2x | $30,000 | ~1,480 CC | ~17,760 CC | ~13.5 | ~7.4% |
|
||||
| Tenstorrent 8x | $30,000 | ~1,480 CC | ~17,760 CC | ~13.5 | ~7.4% |
|
||||
|
||||
*CC values converted to USD at $0.128/CC for ROI calculations*
|
||||
|
||||
---
|
||||
|
||||
## Key Factors Affecting Income
|
||||
|
||||
### 1. Network Utilization
|
||||
|
||||
**What drives it**:
|
||||
- Total TFGrid capacity available
|
||||
- Number of active users/applications
|
||||
- Seasonal demand fluctuations
|
||||
- Marketing and ecosystem growth
|
||||
|
||||
**Your influence**:
|
||||
- Limited direct control
|
||||
- Participate in community promotion
|
||||
- Ensure node uptime and reliability
|
||||
|
||||
### 2. Pricing Strategy
|
||||
|
||||
**Competitive considerations**:
|
||||
- AWS, GCP, Azure pricing benchmarks
|
||||
- Other TFGrid farmers' pricing
|
||||
- Your node's specifications (certified vs. non-certified)
|
||||
- Geographic location / latency advantages
|
||||
|
||||
**Your influence**:
|
||||
- Set competitive pricing when marketplace allows
|
||||
- Offer discounts for long-term commitments
|
||||
- Premium pricing for certified or high-spec nodes
|
||||
|
||||
### 3. Node Uptime & Reliability
|
||||
|
||||
**Impact**:
|
||||
- Downtime = no income during that period
|
||||
- Poor reliability = lost customers
|
||||
- Consistent uptime = reputation and repeat business
|
||||
|
||||
**Your influence**:
|
||||
- Invest in quality hardware
|
||||
- Ensure stable internet connection
|
||||
- Monitor and maintain proactively
|
||||
- Use UPS/backup power if possible
|
||||
|
||||
### 4. Resource Balance
|
||||
|
||||
**What matters**:
|
||||
- Nodes limited by weakest resource (CPU, RAM, or storage)
|
||||
- Well-balanced nodes can sell more slices
|
||||
- Bottlenecks reduce effective slice count
|
||||
|
||||
**Your influence**:
|
||||
- Choose balanced hardware configurations
|
||||
- Consider upgrading bottlenecks (e.g., add RAM)
|
||||
- Understand which resource constrains your node
|
||||
|
||||
---
|
||||
|
||||
## ROI Sensitivities
|
||||
|
||||
### Utilization Impact
|
||||
|
||||
For a **Mini 3** node ($1,000 investment):
|
||||
|
||||
| Utilization | Monthly Net Profit | Annual Profit | ROI Years |
|
||||
|-------------|-------------------|---------------|-----------|
|
||||
| 20% | -8 CC | -96 CC | Never (loss) |
|
||||
| 30% | 9 CC | 108 CC | 74 years |
|
||||
| 40% | 45 CC | 540 CC | 14.8 years |
|
||||
| 50% | 73 CC | 876 CC | 9.1 years |
|
||||
| 60% | 109 CC | 1,308 CC | 6.1 years |
|
||||
| 80% | 181 CC | 2,172 CC | 3.7 years |
|
||||
| 100% | 253 CC | 3,036 CC | 2.6 years |
|
||||
|
||||
*Assumes mid-point pricing at all utilization levels*
|
||||
|
||||
### Pricing Impact
|
||||
|
||||
For a **Large TFGrid Node** ($2,000 investment) at **50% utilization**:
|
||||
|
||||
| Price Point | Monthly Net Profit | Annual Profit | ROI Years |
|
||||
|-------------|-------------------|---------------|-----------|
|
||||
| Minimum | 99 CC | 1,188 CC | 13.4 years |
|
||||
| 25th percentile | 420 CC | 5,040 CC | 3.2 years |
|
||||
| Midpoint | 287 CC | 3,444 CC | 4.6 years |
|
||||
| 75th percentile | 756 CC | 9,072 CC | 1.8 years |
|
||||
| Maximum | 1,186 CC | 14,232 CC | 1.1 years |
|
||||
|
||||
---
|
||||
|
||||
## Comparative Cloud Pricing
|
||||
|
||||
To validate our pricing model, here's how TFGrid compares to major cloud providers:
|
||||
|
||||
### Standard Compute Instance
|
||||
|
||||
**TFGrid Standard Slice**:
|
||||
- 2 cores, 4 GB RAM, ~140 GB SSD
|
||||
- Price: 1.2 - 12.0 CC/month ($0.15 - $1.54/month)
|
||||
- Hourly: $0.005 - $0.05/hour
|
||||
|
||||
**AWS t3.medium**:
|
||||
- 2 vCPUs, 4 GB RAM
|
||||
- Price: ~$30/month (~$0.042/hour)
|
||||
|
||||
**GCP e2-medium**:
|
||||
- 2 vCPUs, 4 GB RAM
|
||||
- Price: ~$24/month (~$0.033/hour)
|
||||
|
||||
**TFGrid Advantage**: 50-95% cheaper than major clouds at similar specs
|
||||
|
||||
### AI/GPU Instance
|
||||
|
||||
**TFGrid AI Slice (Nvidia 6000)**:
|
||||
- 24 cores, 124 GB RAM, 96 GB GPU
|
||||
- Price: 300 - 3,000 CC/month ($38 - $384/month)
|
||||
- Hourly: $0.053 - $0.53/hour
|
||||
|
||||
**AWS p3.2xlarge** (V100 16GB):
|
||||
- 8 vCPUs, 61 GB RAM, 16 GB GPU
|
||||
- Price: ~$3.06/hour (~$2,200/month for full-time)
|
||||
|
||||
**GCP a2-highgpu-1g** (A100 40GB):
|
||||
- 12 vCPUs, 85 GB RAM, 40 GB GPU
|
||||
- Price: ~$3.67/hour (~$2,640/month for full-time)
|
||||
|
||||
**TFGrid Advantage**: 80-95% cheaper with larger GPU memory (96 GB vs 16-40 GB)
|
||||
|
||||
:::tip Competitive Positioning
|
||||
Even at maximum pricing, TFGrid undercuts major cloud providers significantly. At minimum pricing, it's dramatically cheaper while providing more resources.
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
## Risk Factors & Considerations
|
||||
|
||||
### Market Risks
|
||||
|
||||
- **Network adoption rate**: Slower than expected growth delays profitability
|
||||
- **Competition**: Other decentralized cloud platforms
|
||||
- **Pricing pressure**: Race to the bottom if oversupply occurs
|
||||
- **Technology shifts**: New hardware makes existing nodes obsolete faster
|
||||
|
||||
### Operational Risks
|
||||
|
||||
- **Electricity costs**: Not included in hardware cost calculations
|
||||
- **Internet costs**: Bandwidth charges in some regions
|
||||
- **Maintenance**: Hardware failures, replacements
|
||||
- **Obsolescence**: 5-year amortization assumes hardware remains competitive
|
||||
|
||||
### Mitigation Strategies
|
||||
|
||||
- **Start small**: Test with lower-cost nodes before scaling
|
||||
- **Diversify**: Mix node types (standard + AI)
|
||||
- **Stay informed**: Active participation in community
|
||||
- **Plan for upgrades**: Budget for hardware refresh cycles
|
||||
|
||||
---
|
||||
|
||||
## Total Capacity & Market Size
|
||||
|
||||
Based on ThreeFold's current bid commitments (see [TF Bid Packages](/node-economics/tf-bid-packages)):
|
||||
|
||||
**Total Potential Market**:
|
||||
- ~24,150 slices across all bid types
|
||||
- ~$253,800/month at minimum pricing
|
||||
- ~$3,965,625/month at maximum pricing
|
||||
- ~$507 million annual market at maximum pricing
|
||||
|
||||
**This represents committed ThreeFold demand**, not total market potential. Additional demand will come from:
|
||||
- End-user applications
|
||||
- Enterprise offtakers
|
||||
- Individual developers and projects
|
||||
- Partner ecosystems
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
### For Potential Farmers
|
||||
|
||||
1. **Review [Node Specifications](/node-economics/node-specifications)** - Choose hardware based on budget
|
||||
2. **Run your own calculations** - Use your local electricity/internet costs
|
||||
3. **Start conservative** - Plan for 30-40% utilization initially
|
||||
4. **Monitor and adjust** - Track real performance and optimize
|
||||
|
||||
### For Current Farmers
|
||||
|
||||
1. **Evaluate upgrade paths** - Consider certified nodes Q4 2025
|
||||
2. **Optimize pricing** - Balance competitiveness with profitability
|
||||
3. **Improve uptime** - Maximize income from existing hardware
|
||||
4. **Plan for AI** - GPU nodes represent significant growth opportunity
|
||||
|
||||
---
|
||||
|
||||
:::info Living Document
|
||||
As the network matures and real utilization data becomes available, these projections will be refined. Join the community to stay updated on actual farmer income reports.
|
||||
:::
|
||||
|
||||
:::tip Questions?
|
||||
Discuss pricing strategies and share experiences in the [ThreeFold Forum](https://forum.threefold.io) and [Telegram community](https://t.me/threefoldfarmers).
|
||||
:::
|
@@ -1,274 +0,0 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Understanding Slices
|
||||
|
||||
Slices are the fundamental unit of capacity allocation in TFGrid v4. Think of them as standardized "packages" of compute resources that make it easy to price, allocate, and utilize node capacity efficiently.
|
||||
|
||||
---
|
||||
|
||||
## What is a Slice?
|
||||
|
||||
A **slice** is a defined portion of a node's total resources, including:
|
||||
|
||||
- **CPU Cores**: Processing power allocated to the slice
|
||||
- **Performance (Passmark)**: Benchmark score indicating CPU performance
|
||||
- **Memory (RAM)**: Gigabytes of system memory
|
||||
- **Storage (SSD)**: Gigabytes of fast storage
|
||||
- **TPS (Tokens Per Second)**: For AI workloads, processing capability
|
||||
|
||||
Rather than selling "whole nodes" or arbitrary resource amounts, slices provide:
|
||||
- **Standardization**: Predictable resource bundles
|
||||
- **Flexibility**: Users can consume 1 slice or 100 slices
|
||||
- **Efficiency**: Better matching of supply to demand
|
||||
- **Clarity**: Transparent pricing per slice
|
||||
|
||||
---
|
||||
|
||||
## Why Slices?
|
||||
|
||||
### The Old Problem
|
||||
|
||||
**Without slices**:
|
||||
- Users need to understand complex hardware specifications
|
||||
- Pricing is inconsistent across different node types
|
||||
- Hard to compare value between providers
|
||||
- Resources often underutilized or over-provisioned
|
||||
|
||||
### The Slice Solution
|
||||
|
||||
**With slices**:
|
||||
- Simple, standardized packages (like buying "small", "medium", "large")
|
||||
- Consistent pricing model across the network
|
||||
- Easy comparison: "This slice costs X, provides Y resources"
|
||||
- Better utilization: Divide nodes into right-sized portions
|
||||
|
||||
---
|
||||
|
||||
## How Nodes Divide Into Slices
|
||||
|
||||
Each physical node can support a **maximum number of slices** based on its specifications.
|
||||
|
||||
### Example: 3Node Home
|
||||
|
||||
**Total Resources**:
|
||||
- 16 CPU cores
|
||||
- 22,000 Passmark score
|
||||
- 32 GB RAM
|
||||
- 1,000 GB SSD
|
||||
|
||||
**Maximum Slices**: 25
|
||||
|
||||
**Per Slice** (resources divided):
|
||||
- 2.3 cores (16 ÷ 7 slices actually used)
|
||||
- 3,143 Passmark performance
|
||||
- 4.0 GB RAM
|
||||
- 143 GB SSD
|
||||
|
||||
:::note Resource Allocation
|
||||
Not all nodes use their maximum slice count. The actual slices used depends on the node's resource constraints. For example, a 3Node Home is limited by RAM, so it provides 7 slices despite having capacity for 25.
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
## Slice Types
|
||||
|
||||
Different workloads need different resource balances. ThreeFold offers several slice configurations:
|
||||
|
||||
### Standard Compute Slice
|
||||
**Best for**: General applications, web services, APIs
|
||||
|
||||
**Resources**:
|
||||
- ~2,000 Passmark performance
|
||||
- 4 GB RAM
|
||||
- Standard storage
|
||||
|
||||
**Price**: ~1.2 CC/month minimum
|
||||
|
||||
### Memory-Heavy Slice
|
||||
**Best for**: Databases, caching, memory-intensive applications
|
||||
|
||||
**Resources**:
|
||||
- Standard performance
|
||||
- 8 GB RAM (double standard)
|
||||
- Standard storage
|
||||
|
||||
**Price**: ~2.4 CC/month minimum
|
||||
|
||||
### AI Slice (Standard)
|
||||
**Best for**: AI inference, small models, development
|
||||
|
||||
**Resources**:
|
||||
- Moderate performance
|
||||
- 124 GB RAM
|
||||
- Shared GPU access
|
||||
|
||||
**Price**: ~50 CC/month minimum
|
||||
|
||||
### AI Slice (Dedicated GPU)
|
||||
**Best for**: AI training, large models, high-performance inference
|
||||
|
||||
**Resources**:
|
||||
- High performance
|
||||
- 124-250 GB RAM
|
||||
- Dedicated GPU (96-192 GB GPU memory)
|
||||
|
||||
**Price**: 500-1,000 CC/month minimum
|
||||
|
||||
See [TF Bid Packages](/node-economics/tf-bid-packages) for complete specifications.
|
||||
|
||||
---
|
||||
|
||||
## Slices and Farmer Income
|
||||
|
||||
Slices directly determine farmer earnings:
|
||||
|
||||
### Income Calculation
|
||||
|
||||
```
|
||||
Monthly Income = (Number of Active Slices) × (Price Per Slice) × (Utilization Rate)
|
||||
```
|
||||
|
||||
**Example**:
|
||||
- Node: Large TFGrid Node with 20 slices
|
||||
- Price per slice: 7.6 CC (minimum pricing)
|
||||
- Utilization: 80% (16 slices rented)
|
||||
- **Monthly Income**: 16 × 7.6 = 121.6 CC/month (~$15.56 at 1 CC = $0.128)
|
||||
|
||||
### Income Ranges
|
||||
|
||||
Each node type has:
|
||||
- **Minimum Income**: Conservative pricing, partial utilization
|
||||
- **Maximum Income**: Premium pricing, full utilization
|
||||
|
||||
See [Pricing Model](/node-economics/pricing-model) for detailed projections and ROI analysis.
|
||||
|
||||
---
|
||||
|
||||
## Slices and the 80% Revenue Share
|
||||
|
||||
The slice pricing includes the revenue share model:
|
||||
|
||||
1. **User pays for slice**: Example: 10 CC/month
|
||||
2. **Revenue distribution**:
|
||||
- **80%** → Farmer (8 CC)
|
||||
- **10%** → TFT Burn (1 CC worth of TFT burned)
|
||||
- **10%** → ThreeFold Operations (1 CC)
|
||||
|
||||
:::tip Farmer-First Economics
|
||||
With 80% going directly to farmers, the slice model ensures capacity providers receive the majority of value generated.
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
## Oversubscription
|
||||
|
||||
One important note from the current calculation: **CPU oversubscription is not currently factored in**.
|
||||
|
||||
### What is Oversubscription?
|
||||
|
||||
In practice, most workloads don't use 100% of allocated CPU 100% of the time. Cloud providers often oversubscribe CPU (sell more CPU cores than physically exist) because:
|
||||
- Most workloads are bursty (high usage occasionally, low usage normally)
|
||||
- Statistical multiplexing: not all users peak at the same time
|
||||
- Better hardware utilization and economics
|
||||
|
||||
### Future Implementation
|
||||
|
||||
TFGrid may implement CPU oversubscription carefully:
|
||||
- **Benefit**: Higher effective income per node
|
||||
- **Risk**: Must ensure quality of service isn't degraded
|
||||
- **Balance**: Conservative ratios (e.g., 1.5x or 2x) rather than aggressive oversubscription
|
||||
|
||||
:::caution Current Status
|
||||
The income projections in this documentation assume **no CPU oversubscription**. Actual income could be higher if careful oversubscription is implemented in the future.
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
## Slices in Practice
|
||||
|
||||
### For Users
|
||||
|
||||
**Simple shopping experience**:
|
||||
1. Browse available slice types
|
||||
2. See clear pricing and resources
|
||||
3. Deploy workloads to slices
|
||||
4. Scale up or down as needed
|
||||
|
||||
**No complex calculations** about "how many cores do I need vs. RAM vs. storage?"
|
||||
|
||||
### For Farmers
|
||||
|
||||
**Predictable capacity planning**:
|
||||
1. Know your node specifications
|
||||
2. Calculate maximum slices
|
||||
3. Set competitive pricing
|
||||
4. Track utilization and income
|
||||
|
||||
**Clear comparison** between different hardware investments.
|
||||
|
||||
---
|
||||
|
||||
## Example Scenarios
|
||||
|
||||
### Scenario 1: Web Hosting Company
|
||||
|
||||
**Needs**: Run 50 WordPress sites
|
||||
|
||||
**Solution**:
|
||||
- Rent 10 Standard Compute Slices
|
||||
- Each slice hosts 5 sites
|
||||
- Cost: 10 × 1.2 CC = 12 CC/month (~$1.54)
|
||||
- Clear, predictable pricing
|
||||
|
||||
### Scenario 2: AI Startup
|
||||
|
||||
**Needs**: Train a medium language model
|
||||
|
||||
**Solution**:
|
||||
- Rent 2 AI Slice Big (Nvidia 2x)
|
||||
- Dedicated 192 GB GPU memory each
|
||||
- Cost: 2 × 1,000 CC = 2,000 CC/month (~$256)
|
||||
- Direct comparison to AWS/GCP alternatives
|
||||
|
||||
### Scenario 3: Farmer Planning
|
||||
|
||||
**Hardware**: Investing in Mini 3 node
|
||||
|
||||
**Capacity**: 25 slices maximum
|
||||
|
||||
**Income Target**:
|
||||
- Conservative: 48 CC/month minimum (partial utilization)
|
||||
- Optimistic: 558 CC/month maximum (full utilization, premium pricing)
|
||||
- Realistic: ~200-300 CC/month with good network adoption
|
||||
|
||||
See [Node Specifications](/node-economics/node-specifications) for all node types.
|
||||
|
||||
---
|
||||
|
||||
## Key Takeaways
|
||||
|
||||
✅ **Slices standardize capacity** into easy-to-understand packages
|
||||
|
||||
✅ **Better resource utilization** than whole-node or arbitrary allocations
|
||||
|
||||
✅ **Clear pricing model** for both users and farmers
|
||||
|
||||
✅ **Flexible scaling** - consume exactly what you need
|
||||
|
||||
✅ **Direct income correlation** - more slices rented = more income
|
||||
|
||||
✅ **Farmer-first revenue share** - 80% goes to capacity providers
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
- **[Node Specifications](/node-economics/node-specifications)** - See detailed specs for all node types
|
||||
- **[Pricing Model](/node-economics/pricing-model)** - Understand income projections and ROI
|
||||
- **[TF Bid Packages](/node-economics/tf-bid-packages)** - Explore standard ThreeFold offerings
|
||||
|
||||
:::tip Related Concept
|
||||
Slices work seamlessly with the [Cloud Credits (CC)](/core-concepts/token-system) stable pricing system, ensuring predictable economics for everyone.
|
||||
:::
|
@@ -1,418 +0,0 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
# ThreeFold Bid Packages
|
||||
|
||||
ThreeFold commits to purchasing specific capacity packages at defined minimum specifications and pricing. These "bids" represent guaranteed demand that farmers can fulfill by providing qualifying capacity.
|
||||
|
||||
:::info What Are Bids?
|
||||
Bids are ThreeFold's standing offers to purchase specific types of slices. If your node meets the minimum requirements, you can fulfill these bids and receive the stated pricing.
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
## Standard Bid Packages
|
||||
|
||||
### Standard Compute Slice
|
||||
|
||||
**Target Workloads**: General web applications, APIs, microservices, development environments
|
||||
|
||||
**Minimum Requirements**:
|
||||
|
||||
| Specification | Minimum Value |
|
||||
|--------------|---------------|
|
||||
| **Performance** | 2,000 Passmark |
|
||||
| **Memory** | 4 GB |
|
||||
| **GPU Memory** | - |
|
||||
|
||||
**Pricing**:
|
||||
- **1.2 CC/month** per slice
|
||||
- Can scale based on reservation duration (see [Reservation Pricing](#reservation-duration-pricing) below)
|
||||
|
||||
**Total ThreeFold Commitment**:
|
||||
- **20,000 slices** at this specification
|
||||
- **Total monthly value**: 24,000 CC (~$3,072 at $0.128/CC)
|
||||
|
||||
**Who Can Provide**:
|
||||
Most node types qualify:
|
||||
- 3Node Home ✅
|
||||
- All Mini series (1, 2, 3) ✅
|
||||
- Large TFGrid nodes ✅
|
||||
- AI nodes (but better used for AI bids) ✅
|
||||
|
||||
---
|
||||
|
||||
### Memory-Heavy Slice
|
||||
|
||||
**Target Workloads**: Databases (PostgreSQL, MySQL, Redis), caching layers, in-memory processing
|
||||
|
||||
**Minimum Requirements**:
|
||||
|
||||
| Specification | Minimum Value |
|
||||
|--------------|---------------|
|
||||
| **Memory** | 8 GB |
|
||||
|
||||
**Pricing**:
|
||||
- **2.4 CC/month** per slice (2x standard compute price)
|
||||
- Can scale based on reservation duration
|
||||
|
||||
**Total ThreeFold Commitment**:
|
||||
- **2,000 slices** at this specification
|
||||
- **Total monthly value**: 4,800 CC (~$614)
|
||||
|
||||
**Who Can Provide**:
|
||||
Nodes with higher memory configurations:
|
||||
- Mini 2 ✅
|
||||
- Mini 3 ✅
|
||||
- Large TFGrid Node ✅ (512 GB RAM - excellent fit)
|
||||
- All AI nodes ✅
|
||||
|
||||
:::tip High-Memory Premium
|
||||
Memory-heavy slices command 2x pricing of standard compute. If your node has abundant RAM, prioritize these bids.
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
## AI & GPU Bid Packages
|
||||
|
||||
### AI Slice (Standard)
|
||||
|
||||
**Target Workloads**: AI inference, small model training, ML development
|
||||
|
||||
**Minimum Requirements**:
|
||||
|
||||
| Specification | Minimum Value |
|
||||
|--------------|---------------|
|
||||
| **Memory** | 124 GB |
|
||||
|
||||
**Pricing**:
|
||||
- **50 CC/month** per slice
|
||||
- Based on full-node AI configuration (e.g., AI 395+ new nodes)
|
||||
|
||||
**Total ThreeFold Commitment**:
|
||||
- **2,000 slices** at this specification
|
||||
- **Total monthly value**: 100,000 CC (~$12,800)
|
||||
|
||||
**Who Can Provide**:
|
||||
High-spec AI nodes:
|
||||
- Mini AI 1 ✅ (entry point)
|
||||
- Nvidia 6000 variants ✅
|
||||
- Tenstorrent 8x ✅
|
||||
|
||||
**Note**: This represents full-node access for AI workloads with shared GPU resources.
|
||||
|
||||
---
|
||||
|
||||
### AI Slice Big (Nvidia 1x)
|
||||
|
||||
**Target Workloads**: Professional AI training, large model inference, production ML pipelines
|
||||
|
||||
**Minimum Requirements**:
|
||||
|
||||
| Specification | Minimum Value |
|
||||
|--------------|---------------|
|
||||
| **Memory** | 124 GB |
|
||||
| **GPU Memory** | 96 GB (dedicated) |
|
||||
|
||||
**Pricing**:
|
||||
- **500 CC/month** per slice
|
||||
- Dedicated GPU access (not shared)
|
||||
|
||||
**Total ThreeFold Commitment**:
|
||||
- **50 slices** at this specification
|
||||
- **Total monthly value**: 25,000 CC (~$3,200)
|
||||
|
||||
**Who Can Provide**:
|
||||
- Nvidia 6000 (Single GPU) ✅
|
||||
- Nvidia 6000 (Dual GPU) ✅ (can provide 2 slices)
|
||||
|
||||
**Key Feature**: **96 GB dedicated GPU memory** - significantly larger than typical cloud offerings (16-40 GB)
|
||||
|
||||
---
|
||||
|
||||
### AI Slice Big (Nvidia 2x)
|
||||
|
||||
**Target Workloads**: Large-scale AI training, multi-GPU model parallelism, enterprise ML operations
|
||||
|
||||
**Minimum Requirements**:
|
||||
|
||||
| Specification | Minimum Value |
|
||||
|--------------|---------------|
|
||||
| **Memory** | 250 GB |
|
||||
| **GPU Memory** | 192 GB (dedicated) |
|
||||
|
||||
**Pricing**:
|
||||
- **1,000 CC/month** per slice
|
||||
- Dual dedicated GPU access
|
||||
|
||||
**Total ThreeFold Commitment**:
|
||||
- **50 slices** at this specification
|
||||
- **Total monthly value**: 50,000 CC (~$6,400)
|
||||
|
||||
**Who Can Provide**:
|
||||
- Nvidia 6000 (Dual GPU) ✅
|
||||
|
||||
**Key Feature**: **192 GB AI Memory** for massive model training and inference
|
||||
|
||||
---
|
||||
|
||||
### AI Slice Big (Tenstorrent 8x)
|
||||
|
||||
**Target Workloads**: Next-generation AI acceleration, cutting-edge ML research, high-throughput inference
|
||||
|
||||
**Minimum Requirements**:
|
||||
|
||||
| Specification | Minimum Value |
|
||||
|--------------|---------------|
|
||||
| **Memory** | 250 GB |
|
||||
| **GPU Memory** | 192 GB (AI memory) |
|
||||
|
||||
**Pricing**:
|
||||
- **1,000 CC/month** per slice
|
||||
- 8x Tenstorrent accelerators
|
||||
|
||||
**Total ThreeFold Commitment**:
|
||||
- **50 slices** at this specification
|
||||
- **Total monthly value**: 50,000 CC (~$6,400)
|
||||
|
||||
**Who Can Provide**:
|
||||
- Tenstorrent 8x nodes ✅
|
||||
|
||||
**Key Advantage**: **2,000 TPS** (vs 700 for Nvidia) - significantly higher throughput for specific AI workloads
|
||||
|
||||
:::note Tenstorrent vs. Nvidia
|
||||
While Nvidia is industry-standard with broader ecosystem support, Tenstorrent offers superior performance (2,000 TPS vs 700 TPS) for certain AI workloads at the same price point.
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
## Total Market Summary
|
||||
|
||||
**Combined ThreeFold Commitments**:
|
||||
|
||||
| Bid Package | Slices | Monthly Value | Annual Value |
|
||||
|-------------|--------|---------------|--------------|
|
||||
| Standard Compute | 20,000 | 24,000 CC | 288,000 CC |
|
||||
| Memory-Heavy | 2,000 | 4,800 CC | 57,600 CC |
|
||||
| AI Slice (Standard) | 2,000 | 100,000 CC | 1,200,000 CC |
|
||||
| AI Big (Nvidia 1x) | 50 | 25,000 CC | 300,000 CC |
|
||||
| AI Big (Nvidia 2x) | 50 | 50,000 CC | 600,000 CC |
|
||||
| AI Big (Tenstorrent 8x) | 50 | 50,000 CC | 600,000 CC |
|
||||
| **TOTAL** | **24,150** | **253,800 CC** | **3,045,600 CC** |
|
||||
|
||||
**Annual Value in USD** (at $0.128/CC): ~$389,837
|
||||
|
||||
:::tip Guaranteed Demand
|
||||
These bids represent **committed ThreeFold demand**. This is baseline capacity the platform will purchase, providing farmers with guaranteed revenue opportunities.
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
## Reservation Duration Pricing
|
||||
|
||||
The pricing listed above is **baseline monthly pricing**. Actual prices vary based on minimum reservation duration:
|
||||
|
||||
### Pricing Tiers by Duration
|
||||
|
||||
**Example pricing structure**:
|
||||
|
||||
| Min Reservation | Price Modifier | Example (Standard Compute) |
|
||||
|-----------------|----------------|---------------------------|
|
||||
| **1 hour** | 1.0x - 10.0x | 1.2 - 12.0 CC/month |
|
||||
| **1 day** | 0.9x - 8.0x | 1.08 - 9.6 CC/month |
|
||||
| **1 week** | 0.8x - 6.0x | 0.96 - 7.2 CC/month |
|
||||
| **1 month** | 0.7x - 4.0x | 0.84 - 4.8 CC/month |
|
||||
| **3 months** | 0.6x - 3.0x | 0.72 - 3.6 CC/month |
|
||||
| **1 year** | 0.5x - 2.0x | 0.60 - 2.4 CC/month |
|
||||
|
||||
**Key Principle**: Longer commitments = lower per-unit pricing
|
||||
|
||||
**Benefits**:
|
||||
- **For farmers**: More predictable income, can offer discounts
|
||||
- **For users**: Cost savings for long-term workloads
|
||||
- **For platform**: Improved capacity planning
|
||||
|
||||
:::info Flexible Market
|
||||
These are baseline bids. Farmers can set custom pricing when the marketplace allows farmer price-setting (coming soon). See [Implementation Roadmap](/implementation-roadmap#farmer-price-setting-capability).
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
## How to Qualify for Bids
|
||||
|
||||
### 1. Meet Minimum Specifications
|
||||
|
||||
Your node must meet or exceed the minimum requirements for the bid package:
|
||||
- Check [Node Specifications](/node-economics/node-specifications) for your hardware
|
||||
- Ensure adequate CPU, RAM, storage, and GPU (if applicable)
|
||||
|
||||
### 2. Maintain Uptime
|
||||
|
||||
High-quality, reliable capacity:
|
||||
- Target: 99%+ uptime
|
||||
- Stable internet connection
|
||||
- Proactive monitoring and maintenance
|
||||
|
||||
### 3. Proper Node Configuration
|
||||
|
||||
- Correct slice partitioning in node setup
|
||||
- Accurate resource reporting
|
||||
- Compatible with TFGrid v4 (when released) or v3 (currently)
|
||||
|
||||
### 4. Pricing Within Range
|
||||
|
||||
- Set pricing at or below bid price ceiling
|
||||
- Competitive with other farmers
|
||||
- Consider reservation duration discounts
|
||||
|
||||
---
|
||||
|
||||
## Beyond ThreeFold Bids
|
||||
|
||||
These bids represent **ThreeFold's committed demand**, not the total market:
|
||||
|
||||
### Additional Demand Sources
|
||||
|
||||
**End-User Applications**:
|
||||
- Applications built on TFGrid by partner teams
|
||||
- Direct user deployments
|
||||
- Enterprise customers
|
||||
|
||||
**Marketplace Transactions**:
|
||||
- Custom capacity requests
|
||||
- Bid-based capacity allocation (vast.ai model coming)
|
||||
- Private arrangements between users and farmers
|
||||
|
||||
**Partner Ecosystems**:
|
||||
- Integration with other platforms
|
||||
- White-label cloud offerings
|
||||
- Reseller channels
|
||||
|
||||
**Offtaker Agreements**:
|
||||
- Large-scale enterprise commitments
|
||||
- To be announced when commercially appropriate
|
||||
- Potentially significantly larger than baseline bids
|
||||
|
||||
:::note Market Growth
|
||||
As the ecosystem matures, demand will expand beyond these baseline bids. Early farmers establishing reputation and capacity will be well-positioned for growth.
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
## Strategic Considerations for Farmers
|
||||
|
||||
### Capacity Planning
|
||||
|
||||
**Question**: Which bid packages should I target?
|
||||
|
||||
**Factors to consider**:
|
||||
1. **Hardware you can afford**: Start with budget constraints
|
||||
2. **Market competition**: Standard compute is crowded; AI is underserved
|
||||
3. **Growth potential**: AI demand is expanding rapidly
|
||||
4. **Risk tolerance**: Higher investment (AI) = higher potential returns but more risk
|
||||
|
||||
### Investment Strategies
|
||||
|
||||
**Conservative**:
|
||||
- Focus on Mini 1-3 nodes
|
||||
- Target standard compute and memory-heavy bids
|
||||
- Lower investment, proven demand
|
||||
- Slower but steadier ROI
|
||||
|
||||
**Balanced**:
|
||||
- Mix of standard nodes and entry AI (Mini AI 1)
|
||||
- Diversify across bid types
|
||||
- Moderate investment and risk
|
||||
- Flexible capacity allocation
|
||||
|
||||
**Aggressive**:
|
||||
- Focus on high-end AI nodes (Nvidia 6000, Tenstorrent)
|
||||
- Target AI bid packages
|
||||
- High investment, high potential returns
|
||||
- Bet on AI growth trajectory
|
||||
|
||||
### Geographic Considerations
|
||||
|
||||
**Latency-Sensitive Workloads**:
|
||||
- Closer to major population centers = potential pricing premium
|
||||
- Edge computing use cases value low latency
|
||||
- Consider location when pricing
|
||||
|
||||
**Energy Costs**:
|
||||
- High electricity costs reduce profitability
|
||||
- Consider renewable energy for cost savings
|
||||
- Factor into pricing strategy
|
||||
|
||||
---
|
||||
|
||||
## Worked Example: Fulfilling Bids
|
||||
|
||||
### Scenario: You Have a Large TFGrid Node
|
||||
|
||||
**Your Node Specs**:
|
||||
- 36 CPU cores, 20,000 Passmark
|
||||
- 512 GB RAM
|
||||
- 4,000 GB SSD
|
||||
- Max 100 slices, typically provides 20
|
||||
|
||||
**Bid Fulfillment Strategy**:
|
||||
|
||||
**Option A: All Memory-Heavy**
|
||||
- Leverage your 512 GB RAM advantage
|
||||
- Provide 20 memory-heavy slices at 8 GB each = 160 GB used
|
||||
- Income: 20 × 2.4 CC = 48 CC/month minimum
|
||||
- Premium positioning due to high RAM
|
||||
|
||||
**Option B: Mixed Strategy**
|
||||
- 10 memory-heavy slices: 10 × 2.4 = 24 CC
|
||||
- 10 standard compute slices: 10 × 1.2 = 12 CC
|
||||
- Total: 36 CC/month minimum
|
||||
- More flexibility, broader market
|
||||
|
||||
**Option C: Target Higher Pricing**
|
||||
- Compete in marketplace when available
|
||||
- Offer custom pricing for longer reservations
|
||||
- Potential: 40-100 CC/month with market pricing
|
||||
|
||||
**Recommendation**: Option A or C - leverage your high RAM to target premium memory-heavy demand.
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
### For New Farmers
|
||||
|
||||
1. **Review [Node Specifications](/node-economics/node-specifications)** - Choose hardware
|
||||
2. **Identify bid packages you can fulfill** - Match specs to bids
|
||||
3. **Calculate ROI with [Pricing Model](/node-economics/pricing-model)** - Ensure profitability
|
||||
4. **Acquire hardware and configure node** - Get started
|
||||
|
||||
### For Existing Farmers
|
||||
|
||||
1. **Evaluate which bids you currently fulfill** - Optimize allocation
|
||||
2. **Consider upgrades** - Add RAM for memory-heavy bids, or GPU for AI bids
|
||||
3. **Plan for certification** - Q4 2025 certified nodes coming
|
||||
4. **Set competitive pricing** - When marketplace allows
|
||||
|
||||
---
|
||||
|
||||
:::tip Community Resources
|
||||
- **[ThreeFold Forum](https://forum.threefold.io)** - Discuss strategies with other farmers
|
||||
- **[Telegram](https://t.me/threefoldfarmers)** - Real-time community support
|
||||
- **[Community Calls](https://bit.ly/tfcommunitycall)** - Weekly updates and Q&A
|
||||
|
||||
Share your experiences and learn from others building the decentralized cloud!
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
## Important Notes
|
||||
|
||||
**(*) Revenue Distribution**: All pricing listed is gross revenue. Farmers receive 80%, with 10% burned and 10% to ThreeFold operations.
|
||||
|
||||
**CC Acquisition**: Cloud Credits can be purchased at fiat equivalent of 1/1000 gram of gold ≈ $0.128 USD (Oct 8, 2024 pricing) or by converting 2 TFT per 1 CC.
|
||||
|
||||
**Pricing Flexibility**: Bids represent minimum commitments at stated prices. Marketplace implementation will allow farmers to set custom pricing for competitive differentiation.
|
||||
|
||||
**Duration Matters**: The pricing reflects monthly rates, but can vary significantly based on minimum reservation duration (hour, day, week, month, year).
|
@@ -1,8 +0,0 @@
|
||||
{
|
||||
"label": "Operations",
|
||||
"position": 4,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "Technical documentation for deployment, development, and content management."
|
||||
}
|
||||
}
|
@@ -1,586 +0,0 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Content Updates
|
||||
|
||||
This guide covers how to update content, add new documentation, and manage the site structure.
|
||||
|
||||
## Quick Reference
|
||||
|
||||
| Task | Action |
|
||||
|------|--------|
|
||||
| Edit existing page | Modify `.md` file in `docs/` |
|
||||
| Add new page | Create new `.md` file with frontmatter |
|
||||
| Add image | Place in `static/img/`, reference with `` |
|
||||
| Update navigation | Edit `sidebars.js` or frontmatter |
|
||||
| Deploy changes | Push to `main` branch |
|
||||
|
||||
---
|
||||
|
||||
## Editing Existing Pages
|
||||
|
||||
### 1. Locate the File
|
||||
|
||||
All documentation lives in `docs/`:
|
||||
|
||||
```
|
||||
docs/
|
||||
├── intro.md # Homepage content
|
||||
├── core-concepts/
|
||||
│ ├── token-system.md
|
||||
│ ├── position-based-lp.md
|
||||
│ ├── dutch-auction-exit.md
|
||||
│ └── yin-yang-currency.md
|
||||
└── ops/
|
||||
├── deployment.md
|
||||
├── local-development.md
|
||||
└── content-updates.md # This file
|
||||
```
|
||||
|
||||
### 2. Make Your Changes
|
||||
|
||||
Open the file in your text editor and modify the markdown:
|
||||
|
||||
```markdown
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Page Title
|
||||
|
||||
Your content here in **Markdown** format.
|
||||
|
||||
- Bullet points
|
||||
- More bullets
|
||||
|
||||
## Subheading
|
||||
|
||||
More content...
|
||||
```
|
||||
|
||||
### 3. Preview Changes
|
||||
|
||||
If running dev server (`npm start`), changes appear immediately in your browser.
|
||||
|
||||
### 4. Deploy
|
||||
|
||||
```bash
|
||||
git add docs/intro.md
|
||||
git commit -m "Update introduction page"
|
||||
git push origin main
|
||||
```
|
||||
|
||||
GitHub Actions automatically builds and deploys in ~3 minutes.
|
||||
|
||||
---
|
||||
|
||||
## Adding New Pages
|
||||
|
||||
### Create the File
|
||||
|
||||
```bash
|
||||
# Add to core concepts
|
||||
touch docs/core-concepts/new-topic.md
|
||||
|
||||
# Or to node economics
|
||||
touch docs/node-economics/new-resource.md
|
||||
```
|
||||
|
||||
### Add Frontmatter
|
||||
|
||||
Every page needs frontmatter at the top:
|
||||
|
||||
```markdown
|
||||
---
|
||||
sidebar_position: 5
|
||||
title: Custom Page Title (optional)
|
||||
---
|
||||
|
||||
# New Topic
|
||||
|
||||
Your content here...
|
||||
```
|
||||
|
||||
### Sidebar Position
|
||||
|
||||
- Lower numbers appear first (1, 2, 3...)
|
||||
- Pages without position appear after numbered pages
|
||||
- Categories have their own positions
|
||||
|
||||
### The Page Appears Automatically!
|
||||
|
||||
Docusaurus automatically adds the page to the sidebar based on:
|
||||
1. The folder it's in
|
||||
2. The `sidebar_position` value
|
||||
3. The first heading (`#`) as the title
|
||||
|
||||
---
|
||||
|
||||
## Working with Images
|
||||
|
||||
### Adding Images
|
||||
|
||||
1. **Place image in static folder:**
|
||||
```bash
|
||||
cp ~/Downloads/diagram.png static/img/
|
||||
```
|
||||
|
||||
2. **Reference in markdown:**
|
||||
```markdown
|
||||

|
||||
```
|
||||
|
||||
### Image Best Practices
|
||||
|
||||
✅ **Do**:
|
||||
- Use descriptive filenames: `token-flow-diagram.png`
|
||||
- Add alt text: ``
|
||||
- Optimize images (compress before adding)
|
||||
- Use PNG for diagrams, JPG for photos
|
||||
|
||||
❌ **Don't**:
|
||||
- Use absolute paths: `` ❌
|
||||
- Skip alt text: `` ❌
|
||||
- Use huge unoptimized images (slow loading)
|
||||
|
||||
### Image Locations
|
||||
|
||||
```
|
||||
static/img/
|
||||
├── logo.png # Site logo
|
||||
├── margin_distribution.png # Dutch auction images
|
||||
└── margin_distribution_1.png
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Organizing Content
|
||||
|
||||
### Category Structure
|
||||
|
||||
Each folder can have a `_category_.json` file:
|
||||
|
||||
```json
|
||||
{
|
||||
"label": "Core Concepts",
|
||||
"position": 2,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "Overview description here."
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Moving Pages
|
||||
|
||||
To move a page to a different section:
|
||||
|
||||
1. Move the file:
|
||||
```bash
|
||||
mv docs/core-concepts/old.md docs/appendix/old.md
|
||||
```
|
||||
|
||||
2. Update any links to it in other pages
|
||||
|
||||
3. Test build: `npm run build`
|
||||
|
||||
---
|
||||
|
||||
## Markdown Features
|
||||
|
||||
### Basic Syntax
|
||||
|
||||
```markdown
|
||||
# Heading 1
|
||||
## Heading 2
|
||||
### Heading 3
|
||||
|
||||
**Bold text**
|
||||
*Italic text*
|
||||
|
||||
[Link text](./other-page.md)
|
||||
[External link](https://example.com)
|
||||
|
||||
- Bullet list
|
||||
- More bullets
|
||||
|
||||
1. Numbered list
|
||||
2. More numbers
|
||||
```
|
||||
|
||||
### Tables
|
||||
|
||||
```markdown
|
||||
| Column 1 | Column 2 | Column 3 |
|
||||
|----------|----------|----------|
|
||||
| Data | Data | Data |
|
||||
| Data | Data | Data |
|
||||
```
|
||||
|
||||
### Code Blocks
|
||||
|
||||
````markdown
|
||||
```javascript
|
||||
const example = "code block with syntax highlighting";
|
||||
```
|
||||
|
||||
```bash
|
||||
npm install
|
||||
npm start
|
||||
```
|
||||
````
|
||||
|
||||
### Admonitions
|
||||
|
||||
```markdown
|
||||
:::note
|
||||
This is a note
|
||||
:::
|
||||
|
||||
:::tip
|
||||
This is a tip
|
||||
:::
|
||||
|
||||
:::info
|
||||
This is info
|
||||
:::
|
||||
|
||||
:::warning
|
||||
This is a warning
|
||||
:::
|
||||
|
||||
:::danger
|
||||
This is danger
|
||||
:::
|
||||
```
|
||||
|
||||
### Custom Styles
|
||||
|
||||
The site includes custom CSS classes:
|
||||
|
||||
```markdown
|
||||
<div className="feedback-box">
|
||||
|
||||
### Special Feedback Section
|
||||
|
||||
With custom styling!
|
||||
|
||||
</div>
|
||||
|
||||
<div className="open-questions">
|
||||
|
||||
### Open Questions
|
||||
|
||||
Highlighted questions section
|
||||
|
||||
</div>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Link Management
|
||||
|
||||
### Internal Links
|
||||
|
||||
**Between pages in same folder:**
|
||||
```markdown
|
||||
[See Token System](./token-system.md)
|
||||
```
|
||||
|
||||
**To different folder:**
|
||||
```markdown
|
||||
[See Deployment Guide](../ops/deployment.md)
|
||||
```
|
||||
|
||||
**Using path from root:**
|
||||
```markdown
|
||||
[See Deployment Guide](/ops/deployment)
|
||||
```
|
||||
|
||||
### External Links
|
||||
|
||||
```markdown
|
||||
[ThreeFold](https://threefold.io)
|
||||
[Forum](https://forum.threefold.io)
|
||||
```
|
||||
|
||||
External links automatically open in new tabs.
|
||||
|
||||
### Link Checking
|
||||
|
||||
Build process checks for broken links:
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
|
||||
Look for warnings about broken links in output.
|
||||
|
||||
---
|
||||
|
||||
## Common Content Tasks
|
||||
|
||||
### Update Open Questions (Intro Page)
|
||||
|
||||
Edit `docs/intro.md`, find the open questions section:
|
||||
|
||||
```markdown
|
||||
<div className="open-questions">
|
||||
|
||||
### Key Areas We're Seeking Feedback On:
|
||||
|
||||
- **Entry Price**: Should the fixed TFT to CC conversion rate be...
|
||||
- **New Question**: Add your new question here
|
||||
|
||||
</div>
|
||||
```
|
||||
|
||||
### Update Community Links
|
||||
|
||||
Edit `docusaurus.config.js`:
|
||||
|
||||
```javascript
|
||||
{
|
||||
href: 'https://t.me/threefoldfarmers',
|
||||
label: 'Telegram',
|
||||
position: 'right',
|
||||
}
|
||||
```
|
||||
|
||||
### Add to Footer
|
||||
|
||||
Edit `docusaurus.config.js` footer section:
|
||||
|
||||
```javascript
|
||||
footer: {
|
||||
links: [
|
||||
{
|
||||
title: 'New Section',
|
||||
items: [
|
||||
{
|
||||
label: 'New Link',
|
||||
href: 'https://example.com',
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
}
|
||||
```
|
||||
|
||||
### Update Announcement Bar
|
||||
|
||||
Edit `docusaurus.config.js`:
|
||||
|
||||
```javascript
|
||||
announcementBar: {
|
||||
id: 'new_announcement',
|
||||
content: 'Your new announcement here!',
|
||||
backgroundColor: '#20232a',
|
||||
textColor: '#fff',
|
||||
isCloseable: true,
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Content Workflow
|
||||
|
||||
### Standard Update Process
|
||||
|
||||
1. **Create a branch (optional but recommended):**
|
||||
```bash
|
||||
git checkout -b update-intro-page
|
||||
```
|
||||
|
||||
2. **Make changes:**
|
||||
- Edit markdown files
|
||||
- Add/update images
|
||||
- Test locally: `npm start`
|
||||
|
||||
3. **Test build:**
|
||||
```bash
|
||||
npm run build
|
||||
npm run serve
|
||||
```
|
||||
|
||||
4. **Commit changes:**
|
||||
```bash
|
||||
git add .
|
||||
git commit -m "Update intro page with new questions"
|
||||
```
|
||||
|
||||
5. **Push to GitHub:**
|
||||
```bash
|
||||
git push origin update-intro-page
|
||||
# Or if working directly on main:
|
||||
git push origin main
|
||||
```
|
||||
|
||||
6. **Create Pull Request (if using branches):**
|
||||
- Go to GitHub repository
|
||||
- Click "Pull Requests" → "New Pull Request"
|
||||
- Review changes, merge to main
|
||||
|
||||
7. **Automatic deployment:**
|
||||
- GitHub Actions builds and deploys
|
||||
- Monitor in Actions tab
|
||||
- Live in ~3 minutes
|
||||
|
||||
---
|
||||
|
||||
## Multiple Contributors
|
||||
|
||||
### Collaborative Workflow
|
||||
|
||||
**Before starting work:**
|
||||
```bash
|
||||
git pull origin main
|
||||
```
|
||||
|
||||
**After your changes:**
|
||||
```bash
|
||||
git add .
|
||||
git commit -m "Clear description of changes"
|
||||
git pull origin main # Get any new changes
|
||||
git push origin main
|
||||
```
|
||||
|
||||
### Handling Conflicts
|
||||
|
||||
If you get a merge conflict:
|
||||
|
||||
```bash
|
||||
# Open the conflicted file
|
||||
# Look for conflict markers:
|
||||
<<<<<<< HEAD
|
||||
Your changes
|
||||
=======
|
||||
Their changes
|
||||
>>>>>>> main
|
||||
|
||||
# Resolve by choosing one or combining both
|
||||
# Then:
|
||||
git add resolved-file.md
|
||||
git commit -m "Resolve merge conflict"
|
||||
git push origin main
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Content Guidelines
|
||||
|
||||
### Writing Style
|
||||
|
||||
✅ **Do**:
|
||||
- Write clear, concise sentences
|
||||
- Use active voice
|
||||
- Break up long paragraphs
|
||||
- Add examples where helpful
|
||||
- Use headings to organize
|
||||
|
||||
❌ **Avoid**:
|
||||
- Jargon without explanation
|
||||
- Very long paragraphs
|
||||
- Walls of text
|
||||
- Broken links
|
||||
|
||||
### Formatting Consistency
|
||||
|
||||
- Use `**bold**` for emphasis
|
||||
- Use `*italic*` for terminology
|
||||
- Use `` `code` `` for commands, filenames, code
|
||||
- Use proper heading hierarchy (H1 → H2 → H3)
|
||||
|
||||
### Accessibility
|
||||
|
||||
- Add alt text to all images
|
||||
- Use descriptive link text (not "click here")
|
||||
- Maintain proper heading structure
|
||||
- Ensure good color contrast
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Build Fails After Edit
|
||||
|
||||
**Check for:**
|
||||
- Broken markdown syntax
|
||||
- Invalid frontmatter
|
||||
- Broken links: `[text](./wrong-file.md)`
|
||||
- Unclosed code blocks
|
||||
- Special characters in YAML frontmatter
|
||||
|
||||
**Test locally:**
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
|
||||
Error messages show the problem file and line number.
|
||||
|
||||
### Changes Don't Appear Live
|
||||
|
||||
**Possible causes:**
|
||||
1. **Build failed** - Check GitHub Actions tab
|
||||
2. **Cache issue** - Hard refresh browser: Ctrl+Shift+R
|
||||
3. **Deployment lag** - Wait 3-5 minutes after push
|
||||
|
||||
### Images Not Loading
|
||||
|
||||
**Check:**
|
||||
- Image is in `static/img/`
|
||||
- Path is correct: ``
|
||||
- Image filename matches exactly (case-sensitive)
|
||||
- Image was committed: `git add static/img/name.png`
|
||||
|
||||
---
|
||||
|
||||
## Advanced Topics
|
||||
|
||||
### Custom React Components
|
||||
|
||||
Place in `src/components/`:
|
||||
|
||||
```jsx
|
||||
// src/components/CustomCard.js
|
||||
export default function CustomCard({title, children}) {
|
||||
return (
|
||||
<div className="custom-card">
|
||||
<h3>{title}</h3>
|
||||
{children}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
Use in markdown:
|
||||
|
||||
```markdown
|
||||
import CustomCard from '@site/src/components/CustomCard';
|
||||
|
||||
<CustomCard title="My Card">
|
||||
Content here
|
||||
</CustomCard>
|
||||
```
|
||||
|
||||
### Custom Styling
|
||||
|
||||
Edit `src/css/custom.css` to add global styles.
|
||||
|
||||
### Versioning (Future)
|
||||
|
||||
When ready to version docs:
|
||||
|
||||
```bash
|
||||
npm run docusaurus docs:version 1.0
|
||||
```
|
||||
|
||||
This creates a snapshot of current docs as version 1.0.
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
- [Deployment Guide](./deployment.md) - Deploy changes to production
|
||||
- [Local Development](./local-development.md) - Set up your dev environment
|
@@ -1,298 +0,0 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Deployment to plan.threefold.pro
|
||||
|
||||
This guide covers how to deploy the TFT Minting Transition Plan site to the custom domain `plan.threefold.pro` using GitHub Pages.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- GitHub repository: `https://github.com/mik-tf/minting_plan`
|
||||
- Access to DNS provider for `threefold.pro` domain
|
||||
- GitHub Pages enabled on the repository
|
||||
- Node.js 18+ installed locally (for testing before deployment)
|
||||
|
||||
---
|
||||
|
||||
## DNS Configuration
|
||||
|
||||
Configure your DNS settings at your domain provider to point `plan.threefold.pro` to GitHub Pages.
|
||||
|
||||
### Option 1: CNAME Record (Recommended)
|
||||
|
||||
Add the following DNS record:
|
||||
|
||||
```
|
||||
Type: CNAME
|
||||
Name: plan
|
||||
Value: mik-tf.github.io
|
||||
TTL: 3600 (or your provider's default)
|
||||
```
|
||||
|
||||
### Option 2: A Records (Alternative)
|
||||
|
||||
If your DNS provider doesn't support CNAME for subdomains, use A records:
|
||||
|
||||
```
|
||||
Type: A
|
||||
Name: plan
|
||||
Value: 185.199.108.153
|
||||
TTL: 3600
|
||||
|
||||
Type: A
|
||||
Name: plan
|
||||
Value: 185.199.109.153
|
||||
TTL: 3600
|
||||
|
||||
Type: A
|
||||
Name: plan
|
||||
Value: 185.199.110.153
|
||||
TTL: 3600
|
||||
|
||||
Type: A
|
||||
Name: plan
|
||||
Value: 185.199.111.153
|
||||
TTL: 3600
|
||||
```
|
||||
|
||||
:::tip DNS Propagation
|
||||
DNS changes can take anywhere from 5 minutes to 48 hours to propagate globally. Typically it's 15-30 minutes.
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
## GitHub Repository Settings
|
||||
|
||||
### 1. Enable GitHub Pages
|
||||
|
||||
1. Go to your repository: `https://github.com/mik-tf/minting_plan`
|
||||
2. Click **Settings** → **Pages** (left sidebar)
|
||||
3. Under "Source", select:
|
||||
- **Branch**: `gh-pages`
|
||||
- **Folder**: `/ (root)`
|
||||
4. Click **Save**
|
||||
|
||||
### 2. Configure Custom Domain
|
||||
|
||||
1. Still in the Pages settings
|
||||
2. Under "Custom domain", enter: `plan.threefold.pro`
|
||||
3. Click **Save**
|
||||
4. Wait for DNS check (green checkmark ✓ will appear)
|
||||
5. Once verified, check **Enforce HTTPS** (automatic SSL certificate)
|
||||
|
||||
:::warning Important
|
||||
The CNAME file in the `static/` folder ensures the custom domain persists after each deployment. Don't delete it!
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
## GitHub Actions Workflow
|
||||
|
||||
The repository includes an automated deployment workflow at `.github/workflows/deploy.yml`. This workflow:
|
||||
|
||||
- Triggers automatically on push to `main` branch
|
||||
- Installs dependencies
|
||||
- Builds the Docusaurus site
|
||||
- Deploys to `gh-pages` branch
|
||||
|
||||
### How It Works
|
||||
|
||||
```yaml
|
||||
name: Deploy to GitHub Pages
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
|
||||
jobs:
|
||||
deploy:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: 18
|
||||
cache: npm
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
- name: Build website
|
||||
run: npm run build
|
||||
- name: Deploy to GitHub Pages
|
||||
uses: peaceiris/actions-gh-pages@v3
|
||||
with:
|
||||
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
publish_dir: ./build
|
||||
```
|
||||
|
||||
### Manual Deployment (if needed)
|
||||
|
||||
If you need to deploy manually:
|
||||
|
||||
```bash
|
||||
# Build the site
|
||||
npm run build
|
||||
|
||||
# Deploy to GitHub Pages
|
||||
npm run deploy
|
||||
```
|
||||
|
||||
:::info Automatic Deployment
|
||||
With GitHub Actions, you don't need to manually deploy. Just push to `main` and the site updates automatically in 2-3 minutes.
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
## Verification Steps
|
||||
|
||||
After deployment, verify everything works:
|
||||
|
||||
### 1. Check GitHub Actions
|
||||
|
||||
1. Go to repository → **Actions** tab
|
||||
2. Verify the latest workflow run succeeded (green checkmark)
|
||||
3. If failed, click to see error logs
|
||||
|
||||
### 2. Check GitHub Pages Status
|
||||
|
||||
1. Go to repository → **Settings** → **Pages**
|
||||
2. You should see: "Your site is live at https://plan.threefold.pro"
|
||||
3. Green checkmark next to custom domain
|
||||
|
||||
### 3. Test the Website
|
||||
|
||||
Visit these URLs and verify they work:
|
||||
|
||||
- https://plan.threefold.pro (homepage/intro)
|
||||
- https://plan.threefold.pro/core-concepts/token-system
|
||||
- https://plan.threefold.pro/ops/deployment (this page!)
|
||||
|
||||
### 4. Verify SSL Certificate
|
||||
|
||||
- Ensure the site loads with `https://` (not `http://`)
|
||||
- Check browser shows padlock icon (secure connection)
|
||||
- Certificate should be issued by GitHub
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### DNS Not Resolving
|
||||
|
||||
**Symptoms**: Site doesn't load, "DNS_PROBE_FINISHED_NXDOMAIN" error
|
||||
|
||||
**Solutions**:
|
||||
1. Wait longer for DNS propagation (up to 48 hours)
|
||||
2. Check DNS records are correct using:
|
||||
```bash
|
||||
dig plan.threefold.pro
|
||||
```
|
||||
3. Try accessing from different network/device (might be local DNS cache)
|
||||
4. Flush your local DNS cache:
|
||||
```bash
|
||||
# Linux
|
||||
sudo systemd-resolve --flush-caches
|
||||
|
||||
# macOS
|
||||
sudo dscacheutil -flushcache
|
||||
```
|
||||
|
||||
### 404 Errors
|
||||
|
||||
**Symptoms**: Homepage loads but inner pages show 404
|
||||
|
||||
**Solutions**:
|
||||
1. Verify `trailingSlash: false` in `docusaurus.config.js`
|
||||
2. Check GitHub Pages is deploying from `gh-pages` branch root
|
||||
3. Wait a few minutes after deployment completes
|
||||
|
||||
### Build Failures
|
||||
|
||||
**Symptoms**: GitHub Actions workflow fails
|
||||
|
||||
**Solutions**:
|
||||
1. Check Actions tab for error logs
|
||||
2. Verify `package.json` has correct dependencies
|
||||
3. Test build locally: `npm run build`
|
||||
4. Check for broken links in markdown files
|
||||
|
||||
### Custom Domain Not Persisting
|
||||
|
||||
**Symptoms**: Custom domain resets after deployment
|
||||
|
||||
**Solutions**:
|
||||
1. Ensure `static/CNAME` file exists with content: `plan.threefold.pro`
|
||||
2. The CNAME file should be committed to git
|
||||
3. After build, verify `build/CNAME` exists
|
||||
|
||||
---
|
||||
|
||||
## Deployment Timeline
|
||||
|
||||
Understanding what happens when you push changes:
|
||||
|
||||
| Time | Event |
|
||||
|------|-------|
|
||||
| T+0s | Push commit to `main` branch |
|
||||
| T+10s | GitHub Actions workflow starts |
|
||||
| T+2min | Build completes, deploys to `gh-pages` branch |
|
||||
| T+3min | GitHub Pages processes update |
|
||||
| T+5min | Site live at plan.threefold.pro |
|
||||
|
||||
:::tip Quick Updates
|
||||
For urgent fixes, monitor the Actions tab to see when deployment completes, then verify changes immediately.
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
## Security Considerations
|
||||
|
||||
### HTTPS/SSL
|
||||
- GitHub Pages provides automatic SSL via Let's Encrypt
|
||||
- Certificate renews automatically
|
||||
- Always enforce HTTPS in settings
|
||||
|
||||
### Branch Protection
|
||||
Consider protecting the `main` branch:
|
||||
1. Settings → Branches → Add rule
|
||||
2. Require pull request reviews
|
||||
3. Require status checks to pass
|
||||
|
||||
### Access Control
|
||||
- Only repository collaborators can push to `main`
|
||||
- Manage access in Settings → Collaborators
|
||||
|
||||
---
|
||||
|
||||
## Maintenance
|
||||
|
||||
### Regular Updates
|
||||
|
||||
Keep Docusaurus and dependencies updated:
|
||||
|
||||
```bash
|
||||
# Check for updates
|
||||
npm outdated
|
||||
|
||||
# Update dependencies
|
||||
npm update
|
||||
|
||||
# Update Docusaurus to latest
|
||||
npm install @docusaurus/core@latest @docusaurus/preset-classic@latest
|
||||
```
|
||||
|
||||
### Monitoring
|
||||
|
||||
Monitor these regularly:
|
||||
- GitHub Actions workflow status
|
||||
- Site accessibility at plan.threefold.pro
|
||||
- SSL certificate validity (automatic but good to check)
|
||||
- Build times (should stay under 3 minutes)
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
- [Local Development](./local-development.md) - Test changes before deploying
|
||||
- [Content Updates](./content-updates.md) - How to edit and add content
|
@@ -1,391 +0,0 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Local Development
|
||||
|
||||
This guide covers how to set up and run the TFT Minting Transition Plan site locally for development and testing.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
### Required Software
|
||||
|
||||
- **Node.js**: Version 18.0 or higher
|
||||
- **npm**: Comes with Node.js
|
||||
- **Git**: For version control
|
||||
|
||||
### Check Your Versions
|
||||
|
||||
```bash
|
||||
node --version # Should be v18.0.0 or higher
|
||||
npm --version # Should be 8.0.0 or higher
|
||||
git --version # Any recent version
|
||||
```
|
||||
|
||||
### Installing Node.js
|
||||
|
||||
If you don't have Node.js 18+:
|
||||
|
||||
**Linux (Ubuntu/Debian)**:
|
||||
```bash
|
||||
curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash -
|
||||
sudo apt-get install -y nodejs
|
||||
```
|
||||
|
||||
**macOS**:
|
||||
```bash
|
||||
brew install node@18
|
||||
```
|
||||
|
||||
**Using nvm (recommended)**:
|
||||
```bash
|
||||
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
|
||||
nvm install 18
|
||||
nvm use 18
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Initial Setup
|
||||
|
||||
### 1. Clone the Repository
|
||||
|
||||
```bash
|
||||
git clone https://github.com/mik-tf/minting_plan.git
|
||||
cd minting_plan
|
||||
```
|
||||
|
||||
### 2. Install Dependencies
|
||||
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
This will install all required packages listed in `package.json`, including:
|
||||
- Docusaurus core
|
||||
- React
|
||||
- MDX support
|
||||
- Theme packages
|
||||
|
||||
:::info First Install
|
||||
The first `npm install` will take 1-2 minutes as it downloads all dependencies. Subsequent installs will be faster thanks to npm cache.
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
## Development Server
|
||||
|
||||
### Start the Dev Server
|
||||
|
||||
```bash
|
||||
npm start
|
||||
```
|
||||
|
||||
This command:
|
||||
- Starts a local development server
|
||||
- Opens your browser to `http://localhost:3000`
|
||||
- Enables hot reloading (changes appear immediately)
|
||||
- Shows build errors in the terminal and browser
|
||||
|
||||
### What You'll See
|
||||
|
||||
```
|
||||
[INFO] Starting the development server...
|
||||
[SUCCESS] Docusaurus website is running at: http://localhost:3000/
|
||||
```
|
||||
|
||||
:::tip Hot Reloading
|
||||
Edit any markdown file and save - your browser will automatically refresh with changes. No need to restart the server!
|
||||
:::
|
||||
|
||||
### Stop the Server
|
||||
|
||||
Press `Ctrl+C` in the terminal where the server is running.
|
||||
|
||||
---
|
||||
|
||||
## Building for Production
|
||||
|
||||
### Create Production Build
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
|
||||
This command:
|
||||
- Creates optimized production files in `build/` directory
|
||||
- Minifies JavaScript and CSS
|
||||
- Generates static HTML for all pages
|
||||
- Checks for broken links
|
||||
|
||||
### Preview Production Build
|
||||
|
||||
```bash
|
||||
npm run serve
|
||||
```
|
||||
|
||||
This serves the production build locally at `http://localhost:3000` so you can test it before deployment.
|
||||
|
||||
:::warning Test Before Push
|
||||
Always run `npm run build` before pushing to ensure there are no build errors. The production build is stricter than dev mode.
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
## Common Development Tasks
|
||||
|
||||
### Adding a New Page
|
||||
|
||||
1. Create a new `.md` file in the appropriate docs folder:
|
||||
```bash
|
||||
touch docs/core-concepts/new-concept.md
|
||||
```
|
||||
|
||||
2. Add frontmatter:
|
||||
```markdown
|
||||
---
|
||||
sidebar_position: 5
|
||||
---
|
||||
|
||||
# New Concept Title
|
||||
|
||||
Your content here...
|
||||
```
|
||||
|
||||
3. The page appears automatically in the sidebar!
|
||||
|
||||
### Editing Existing Content
|
||||
|
||||
1. Navigate to the file (e.g., `docs/intro.md`)
|
||||
2. Make your changes
|
||||
3. Save the file
|
||||
4. Browser auto-refreshes with changes
|
||||
|
||||
### Adding Images
|
||||
|
||||
1. Place images in `static/img/`:
|
||||
```bash
|
||||
cp ~/my-image.png static/img/
|
||||
```
|
||||
|
||||
2. Reference in markdown:
|
||||
```markdown
|
||||

|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
minting_plan/
|
||||
├── docs/ # All documentation content
|
||||
│ ├── intro.md # Homepage
|
||||
│ ├── core-concepts/ # Core concept docs
|
||||
│ ├── appendix/ # Meeting notes, etc.
|
||||
│ └── ops/ # Operations guides
|
||||
├── static/ # Static assets
|
||||
│ ├── img/ # Images
|
||||
│ └── CNAME # Custom domain file
|
||||
├── src/ # Custom React components
|
||||
│ ├── css/ # Custom styles
|
||||
│ └── pages/ # Custom pages (optional)
|
||||
├── docusaurus.config.js # Site configuration
|
||||
├── sidebars.js # Sidebar structure
|
||||
├── package.json # Dependencies
|
||||
└── .github/workflows/ # GitHub Actions
|
||||
└── deploy.yml # Auto-deployment
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Useful Commands
|
||||
|
||||
### Clear Cache
|
||||
|
||||
If you see weird behavior, clear the cache:
|
||||
|
||||
```bash
|
||||
npm run clear
|
||||
```
|
||||
|
||||
### Check for Build Issues
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
|
||||
Look for:
|
||||
- ✅ Success: Build completed
|
||||
- ❌ Errors: Broken links, invalid markdown, missing files
|
||||
|
||||
### Format Code (if using Prettier)
|
||||
|
||||
```bash
|
||||
npx prettier --write "docs/**/*.md"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Development Workflow
|
||||
|
||||
### Typical Workflow
|
||||
|
||||
1. **Pull latest changes**
|
||||
```bash
|
||||
git pull origin main
|
||||
```
|
||||
|
||||
2. **Start dev server**
|
||||
```bash
|
||||
npm start
|
||||
```
|
||||
|
||||
3. **Make changes**
|
||||
- Edit markdown files in `docs/`
|
||||
- See changes instantly in browser
|
||||
|
||||
4. **Test production build**
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
|
||||
5. **Commit and push**
|
||||
```bash
|
||||
git add .
|
||||
git commit -m "Description of changes"
|
||||
git push origin main
|
||||
```
|
||||
|
||||
6. **Auto-deployment**
|
||||
- GitHub Actions builds and deploys automatically
|
||||
- Check Actions tab for status
|
||||
- Site updates at plan.threefold.pro in ~3 minutes
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Port 3000 Already in Use
|
||||
|
||||
**Error**: `Something is already running on port 3000`
|
||||
|
||||
**Solution**:
|
||||
```bash
|
||||
# Find and kill the process
|
||||
lsof -i :3000
|
||||
kill -9 <PID>
|
||||
|
||||
# Or use a different port
|
||||
npm start -- --port 3001
|
||||
```
|
||||
|
||||
### Module Not Found Errors
|
||||
|
||||
**Error**: `Cannot find module '@docusaurus/...'`
|
||||
|
||||
**Solution**:
|
||||
```bash
|
||||
# Delete node_modules and reinstall
|
||||
rm -rf node_modules package-lock.json
|
||||
npm install
|
||||
```
|
||||
|
||||
### Build Fails Locally
|
||||
|
||||
**Error**: Build fails with various errors
|
||||
|
||||
**Solution**:
|
||||
```bash
|
||||
# Clear cache and rebuild
|
||||
npm run clear
|
||||
npm run build
|
||||
```
|
||||
|
||||
### Changes Not Appearing
|
||||
|
||||
**Problem**: Saved changes don't show in browser
|
||||
|
||||
**Solution**:
|
||||
1. Check the terminal for build errors
|
||||
2. Hard refresh browser: `Ctrl+Shift+R` (Linux/Win) or `Cmd+Shift+R` (Mac)
|
||||
3. Restart dev server: `Ctrl+C`, then `npm start`
|
||||
|
||||
### Node Version Issues
|
||||
|
||||
**Error**: `The engine "node" is incompatible with this module`
|
||||
|
||||
**Solution**:
|
||||
```bash
|
||||
# Check your version
|
||||
node --version
|
||||
|
||||
# Install correct version using nvm
|
||||
nvm install 18
|
||||
nvm use 18
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Best Practices
|
||||
|
||||
### Before Committing
|
||||
|
||||
✅ **Do**:
|
||||
- Test build locally: `npm run build`
|
||||
- Check for broken links in build output
|
||||
- Preview with `npm run serve`
|
||||
- Write clear commit messages
|
||||
|
||||
❌ **Don't**:
|
||||
- Commit `node_modules/` (it's in .gitignore)
|
||||
- Commit `build/` directory (it's generated)
|
||||
- Push without testing build
|
||||
- Use absolute URLs for internal links
|
||||
|
||||
### Writing Documentation
|
||||
|
||||
✅ **Good practices**:
|
||||
- Use relative links: `[link](./other-page.md)`
|
||||
- Add alt text to images: ``
|
||||
- Use frontmatter for sidebar position
|
||||
- Keep markdown files in appropriate folders
|
||||
|
||||
❌ **Avoid**:
|
||||
- Absolute URLs for internal pages
|
||||
- Missing alt text on images
|
||||
- Inconsistent heading levels
|
||||
- Very long lines (wrap at ~100 chars)
|
||||
|
||||
---
|
||||
|
||||
## IDE Setup
|
||||
|
||||
### VS Code (Recommended)
|
||||
|
||||
Install these extensions for better experience:
|
||||
|
||||
- **Markdown All in One**: Markdown preview and shortcuts
|
||||
- **Prettier**: Code formatting
|
||||
- **ESLint**: JavaScript linting
|
||||
|
||||
### Settings
|
||||
|
||||
Add to `.vscode/settings.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"editor.formatOnSave": true,
|
||||
"editor.defaultFormatter": "esbenp.prettier-vscode",
|
||||
"[markdown]": {
|
||||
"editor.wordWrap": "on"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
- [Deployment](./deployment.md) - Deploy to plan.threefold.pro
|
||||
- [Content Updates](./content-updates.md) - Learn content management workflows
|
Reference in New Issue
Block a user