Skip to content

Commit a3c5b2a

Browse files
melvincarvalhomelvincarvalho
committed
Initial commit: Bitmark Documentation Site
Comprehensive documentation for the Bitmark cryptocurrency featuring: - Stunning landing page with "Spendable Karma" branding - Royal purple theme matching official branding - Mermaid diagrams for technical concepts - Full documentation coverage: - Getting Started guides - Marking system (MRK Protocol) - Technical reference (8 PoW algorithms, DGWv3, emission model) - Ecosystem (wallets, explorers, mining) - BIPs (100, 101, 102) - API references (RPC & REST) - GitHub Pages deployment workflow - Open Graph social cards - Mobile responsive design Built with Docusaurus 3.x
0 parents  commit a3c5b2a

57 files changed

Lines changed: 29643 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/deploy.yml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches: [main, gh-pages]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: "pages"
15+
cancel-in-progress: true
16+
17+
jobs:
18+
build:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- uses: actions/checkout@v4
22+
- uses: actions/setup-node@v4
23+
with:
24+
node-version: 20
25+
cache: npm
26+
- run: npm ci
27+
- run: npm run build
28+
- uses: actions/upload-pages-artifact@v3
29+
with:
30+
path: build
31+
32+
deploy:
33+
environment:
34+
name: github-pages
35+
url: ${{ steps.deployment.outputs.page_url }}
36+
runs-on: ubuntu-latest
37+
needs: build
38+
steps:
39+
- uses: actions/deploy-pages@v4
40+
id: deployment

‎.gitignore‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Dependencies
2+
node_modules/
3+
4+
# Build
5+
build/
6+
.docusaurus/
7+
8+
# IDE
9+
.idea/
10+
.vscode/
11+
*.swp
12+
*.swo
13+
14+
# OS
15+
.DS_Store
16+
Thumbs.db
17+
18+
# Logs
19+
npm-debug.log*
20+
yarn-debug.log*
21+
yarn-error.log*
22+
23+
# Environment
24+
.env
25+
.env.local
26+
.env.*.local

‎README.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Website
2+
3+
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
4+
5+
## Installation
6+
7+
```bash
8+
yarn
9+
```
10+
11+
## Local Development
12+
13+
```bash
14+
yarn start
15+
```
16+
17+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
18+
19+
## Build
20+
21+
```bash
22+
yarn build
23+
```
24+
25+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
26+
27+
## Deployment
28+
29+
Using SSH:
30+
31+
```bash
32+
USE_SSH=true yarn deploy
33+
```
34+
35+
Not using SSH:
36+
37+
```bash
38+
GIT_USER=<Your GitHub username> yarn deploy
39+
```
40+
41+
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

‎docs/bips/bip-100.md‎

Lines changed: 185 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,185 @@
1+
---
2+
sidebar_position: 2
3+
title: "BIP-100: Original Design"
4+
description: Bitmark Original Design - Fair Launch and Core Principles
5+
---
6+
7+
# BIP-100: Original Design
8+
9+
```
10+
BIP: 100
11+
Title: Bitmark Original Design - Fair Launch and Core Principles
12+
Author: Bitmark Development Team
13+
Status: Final
14+
Type: Informational
15+
Created: 2014-07-13
16+
License: MIT
17+
```
18+
19+
## Abstract
20+
21+
This document describes the original design philosophy and technical parameters of Bitmark as launched on July 13, 2014. Bitmark was designed as a fair-launch cryptocurrency with a focus on accessibility, stability, and balanced stakeholder interests.
22+
23+
## Motivation
24+
25+
In 2014, the cryptocurrency landscape was dominated by Bitcoin and its early forks. Many new cryptocurrencies launched with premines, instamines, or other mechanisms that concentrated initial supply in the hands of developers or early insiders.
26+
27+
Bitmark was conceived as an alternative approach: a cryptocurrency with a genuinely fair launch, designed to balance the interests of all participants—users, miners, investors, and developers.
28+
29+
The genesis block timestamp captures this philosophy:
30+
31+
> "13/July/2014, with memory of the past, we look to the future. TDR"
32+
33+
## Design Principles
34+
35+
### Fair Distribution
36+
37+
- **No Premine**: Zero coins were created before the public launch
38+
- **No ICO/Token Sale**: All coins distributed through proof-of-work mining
39+
- **Earned Value**: Every aspect of Bitmark focuses on earned, not allocated, value
40+
- **Accessible Mining**: Scrypt algorithm chosen for GPU accessibility (ASICs were not yet dominant for Scrypt in 2014)
41+
42+
### Stakeholder Balance
43+
44+
Bitmark was explicitly designed to balance the interests of:
45+
46+
1. **Users**: Fast confirmation times, low fees, stable operation
47+
2. **Miners**: Fair reward distribution, accessible mining
48+
3. **Investors**: Predictable monetary policy, no surprise emissions
49+
4. **Developers**: Sustainable development funding through community support
50+
51+
### Technical Stability
52+
53+
- **Conservative Innovation**: Implement proven technologies rather than experimental features
54+
- **Reliability**: Prioritize network stability over cutting-edge features
55+
- **Longevity**: Design for long-term operation and sustainability
56+
57+
## Technical Specification
58+
59+
### Genesis Block
60+
61+
| Parameter | Value |
62+
|-----------|-------|
63+
| Timestamp | 1405274442 (July 13, 2014 12:00:42 UTC) |
64+
| Message | "13/July/2014, with memory of the past, we look to the future. TDR" |
65+
| Hash | `0xc1fb746e87e89ae75bdec2ef0639a1f6786744639ce3d0ece1dcf979b79137cb` |
66+
| Merkle Root | `0xd4715adf41222fae3d4bf41af30c675bc27228233d0f3cfd4ae0ae1d3e760ba8` |
67+
| nBits | `0x1d00ffff` |
68+
| nNonce | 14385103 |
69+
| Initial Subsidy | 20 MARKS |
70+
71+
### Network Parameters
72+
73+
| Parameter | Mainnet | Testnet |
74+
|-----------|---------|---------|
75+
| Default Port | 9265 | 19265 |
76+
| RPC Port | 9266 | 19266 |
77+
| Message Magic | `0xf9beb4d9` | `0x0b110907` |
78+
| Address Prefix | 85 (`b`) | 130 (`u`) |
79+
| PoW Limit | 2^224 - 1 | 2^248 - 1 |
80+
81+
### Proof-of-Work
82+
83+
| Parameter | Value | Rationale |
84+
|-----------|-------|-----------|
85+
| Algorithm | Scrypt | GPU-accessible, ASIC-resistant (in 2014) |
86+
| N Parameter | 1024 | Standard Litecoin parameters |
87+
| r Parameter | 1 | |
88+
| p Parameter | 1 | |
89+
90+
### Block Timing
91+
92+
| Parameter | Value | Comparison |
93+
|-----------|-------|------------|
94+
| Target Block Time | 120 seconds (2 minutes) | Bitcoin: 600 seconds |
95+
| Difficulty Adjustment | Every 720 blocks | ~24 hours |
96+
| Retarget Window | 720 blocks | |
97+
98+
The 2-minute block time was chosen as a balance between:
99+
- Fast enough for practical transaction confirmation
100+
- Slow enough to minimize orphan rates and ensure network stability
101+
- Compatible with existing mining pool infrastructure
102+
103+
### Monetary Policy
104+
105+
| Parameter | Value |
106+
|-----------|-------|
107+
| Maximum Supply | ~27,580,000 MARKS |
108+
| Initial Block Reward | 20 MARKS |
109+
| Halving Interval | 788,000 blocks (~3 years) |
110+
| Interim Quartering | 394,000 blocks (~1.5 years) |
111+
| Minimum Reward | 0.1 MARKS (after 18 halvings) |
112+
113+
### Reward Schedule (Pre-Fork)
114+
115+
The original reward schedule combined halving with interim quartering for smoother emission:
116+
117+
| Block Range | Subsidy (MARKS) | Note |
118+
|-------------|-----------------|------|
119+
| 0 - 393,999 | 20 | Initial |
120+
| 394,000 - 787,999 | 15 | First quartering |
121+
| 788,000 - 1,181,999 | 10 | First halving |
122+
| 1,182,000 - 1,575,999 | 7.5 | Second quartering |
123+
| 1,576,000 - 1,969,999 | 5 | Second halving |
124+
| ... | ... | Continues with halving/quartering pattern |
125+
126+
## Rationale
127+
128+
### Why Scrypt?
129+
130+
In July 2014, Scrypt offered several advantages:
131+
132+
1. **ASIC Resistance**: Scrypt ASICs were just emerging; GPU mining was still viable
133+
2. **Proven Security**: Litecoin had operated safely with Scrypt since 2011
134+
3. **Mining Accessibility**: Consumer GPUs could participate effectively
135+
4. **Pool Infrastructure**: Existing Scrypt mining pools could support Bitmark
136+
137+
### Why 2-Minute Blocks?
138+
139+
The 2-minute block time represents a careful trade-off:
140+
141+
- **Faster than Bitcoin (10 min)**: Better user experience for transaction confirmation
142+
- **Slower than some altcoins (30-60 sec)**: Reduced orphan rate, better security
143+
- **Network Propagation**: Sufficient time for blocks to propagate globally
144+
- **Miner Fairness**: Reduces advantage of geographically proximate miners
145+
146+
### Why Halving + Quartering?
147+
148+
The combined halving/quartering schedule provides:
149+
150+
1. **Smoother Emission Curve**: Avoids dramatic reward cliffs
151+
2. **Predictability**: Regular, known reduction schedule
152+
3. **Miner Adaptation**: More time to adjust to reduced rewards
153+
4. **Economic Stability**: Gradual transition reduces market shock
154+
155+
## Security Considerations
156+
157+
### 51% Attack Resistance
158+
159+
- Scrypt's memory-hard properties increase attack costs
160+
- 2-minute blocks provide reasonable confirmation security
161+
- Network hashrate grew steadily post-launch
162+
163+
### Fair Launch Verification
164+
165+
- Genesis block publicly announced before mining began
166+
- No hidden mining period
167+
- Community-verified launch process
168+
169+
## Backward Compatibility
170+
171+
This BIP documents the original protocol as launched. These parameters remained in effect until Fork 1 ([BIP-101](/bips/bip-101)) at block 450,947.
172+
173+
## See Also
174+
175+
- [BIP-101: Multi-Algorithm Proof-of-Work](/bips/bip-101)
176+
- [BIP-102: Coin Emission Model](/bips/bip-102)
177+
178+
## References
179+
180+
- [Original Bitcointalk Announcement](https://bitcointalk.org/index.php?topic=660544.0)
181+
- [Bitmark Source Code](https://github.com/project-bitmark/bitmark)
182+
183+
## Copyright
184+
185+
This document is licensed under the MIT License.

0 commit comments

Comments
 (0)