Skip to content

Commit

Permalink
reverted structure changes
Browse files Browse the repository at this point in the history
  • Loading branch information
hasanza committed Aug 31, 2024
1 parent 43f87bc commit c0cb4f4
Show file tree
Hide file tree
Showing 33 changed files with 64 additions and 64 deletions.
4 changes: 2 additions & 2 deletions docs/learn/poet.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ id: poet
title: PoET Servers
---

Calculating the [PoET](./post.md#proof-of-elapsed-time) requires performing repeated, computationally intensive calculations. Such work cannot be parallelized and must be performed sequentially, using the previous output as the input for the next iteration. As a result, PoET generation is not performed by individual smeshers but by specialized [**PoET servers**](../guides/smeshing/smeshing_adv/poet.md). Many smeshers can rely on a single PoET server to generate a PoET for them. Ultimately, by chaining together [proofs of space](./post.md#proof-of-space) with [proofs of elapsed time](./post.md#proof-of-elapsed-time), a smesher is able to cryptographically prove to the network that they have committed a certain amount of space-time to the network, thereby asserting their eligibility to participate in the consensus and earn rewards.
Calculating the [PoET](./post.md#proof-of-elapsed-time) requires performing repeated, computationally intensive calculations. Such work cannot be parallelized and must be performed sequentially, using the previous output as the input for the next iteration. As a result, PoET generation is not performed by individual smeshers but by specialized [**PoET servers**](../start/smeshing/smeshing_adv/poet.md). Many smeshers can rely on a single PoET server to generate a PoET for them. Ultimately, by chaining together [proofs of space](./post.md#proof-of-space) with [proofs of elapsed time](./post.md#proof-of-elapsed-time), a smesher is able to cryptographically prove to the network that they have committed a certain amount of space-time to the network, thereby asserting their eligibility to participate in the consensus and earn rewards.

In practice, PoET does not measure clock time. Instead, the passage of time is inferred from the sequential calculations performed by the PoET server, through an abstract unit of time called a **tick**. Thus, a tick is an arbitrary but meaningful, minimal unit of time in Spacemesh, and ticks from one PoET server can be compared directly to ticks from another PoET server. A faster PoET server (i.e., one with a faster CPU) that is able to run the underlying sequential hash calculations faster, will be able to generate more ticks per unit time. Spacemesh operates several [public PoET servers](../guides/smeshing/smeshing_adv/poet.md#timing) on specialized hardware that has been fine-tuned to be as fast as possible. Currently, it is infeasible to run a faster PoET without a fundamental breakthrough in technology (e.g., novel hardware).
In practice, PoET does not measure clock time. Instead, the passage of time is inferred from the sequential calculations performed by the PoET server, through an abstract unit of time called a **tick**. Thus, a tick is an arbitrary but meaningful, minimal unit of time in Spacemesh, and ticks from one PoET server can be compared directly to ticks from another PoET server. A faster PoET server (i.e., one with a faster CPU) that is able to run the underlying sequential hash calculations faster, will be able to generate more ticks per unit time. Spacemesh operates several [public PoET servers](../start/smeshing/smeshing_adv/poet.md#timing) on specialized hardware that has been fine-tuned to be as fast as possible. Currently, it is infeasible to run a faster PoET without a fundamental breakthrough in technology (e.g., novel hardware).

If someone were to develop and run a faster PoET, it would be visible to the rest of the network in the form of ATXs with a higher tick count. However, there is currently no in-protocol incentivization to run a PoET server (rewards, fees), but we intend to provide it in the future. This is so that if someone were to develop a faster PoET, it would be in their interest (i.e., incentive compatible) for them to make it available for public use in exchange for fees.

Expand Down
2 changes: 1 addition & 1 deletion docs/learn/rewards.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ The only sanctionable offense in Spacemesh is equivocation, otherwise known as d

Note that, unlike in proof of stake networks, **there is no slashing in Spacemesh.** In other words the coins earned by a smesher will not be reduced, and all coins earned prior to the moment of malfeasance are still valid and spendable.

However, once a malfeasance proof has been generated and broadcast for that smesher, its identity is effectively burnt. The only option is to delete the PoST files and generate them again from scratch using a new identity. Therefore it's essential that miners use caution when moving identities, and they must **never run two nodes attached to the same identity at the same time.** There's more information on how to avoid this in [our Advanced Smeshing Guide](../guides/smeshing/smeshing_adv/equivocation.md).
However, once a malfeasance proof has been generated and broadcast for that smesher, its identity is effectively burnt. The only option is to delete the PoST files and generate them again from scratch using a new identity. Therefore it's essential that miners use caution when moving identities, and they must **never run two nodes attached to the same identity at the same time.** There's more information on how to avoid this in [our Advanced Smeshing Guide](../start/smeshing/smeshing_adv/equivocation.md).
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/guides/integration.md → docs/start/integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -600,6 +600,6 @@ Note that, unlike other blockchains, blocks in Spacemesh do not contain pointers

## Resources

- [Smeshing guide](../guides/smeshing/start.md)
- [Smeshing guide](../start/smeshing/start.md)
- [Awesome Spacemesh: A collection of useful Spacemesh resources](https://github.com/lrettig/awesome-spacemesh/)
- [Spacemesh block explorer](https://explorer.spacemesh.io/overview)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ using `postcli`. This process generates a new private key, so a new identity.
### Detailed Steps

1. **Initialized PoST Data** : We assume that the data is already initialized. If it's not the case yet then please
visit [docs for that](https://docs.spacemesh.io/docs/guides/smeshing/smeshing_adv/post_init).
visit [docs for that](https://docs.spacemesh.io/docs/start/smeshing/smeshing_adv/post_init).
2. **Store The Private Key** : Upon initialization, `postcli` generates a new private key stored as `identity.key` in
the PoST data directory. This key should then be moved to your `./node_data/identities/` directory, renamed for
unique identification.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ Either way, you should now have a Spacemesh-compatible address in bech32 format

### Running Multiple Nodes

It is possible to run multiple `go-spacemesh` processes on a single system. This is of course subject to the [resource requirements](https://docs.spacemesh.io/docs/guides/smeshing/requirements) outlined above; in particular, make sure that the system has high enough bandwidth to support many nodes. You'll need to change a few parameters to enable this:
It is possible to run multiple `go-spacemesh` processes on a single system. This is of course subject to the [resource requirements](https://docs.spacemesh.io/docs/start/smeshing/requirements) outlined above; in particular, make sure that the system has high enough bandwidth to support many nodes. You'll need to change a few parameters to enable this:

1. Node data directory: each node must have its own data directory to store network state. Specify it on the command line using the `-d datadir` flag or in the config in `{"main":{"data-folder":"<node-data-location>"}}`.
1. Smeshing data directory: each smeshing node must point to a different PoST data directory. Specify in the config using `{"smeshing":{"smeshing-opts":{"smeshing-opts-datadir":"<post-data-location>"}}}`. **See note below about avoiding equivocation!**
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Follow the instructions on this page to download, install and run the App.

## Step 1 - Downloading the Installer

> Before installing, please confirm that your computer meets the [minimum system requirements](https://docs.spacemesh.io/docs/guides/smeshing/requirements).
> Before installing, please confirm that your computer meets the [minimum system requirements](https://docs.spacemesh.io/docs/start/smeshing/requirements).
Next, download the App Installer for your OS by visiting our [main website](https://spacemesh.io/start).

Expand Down
File renamed without changes.
File renamed without changes.
56 changes: 28 additions & 28 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -48,42 +48,42 @@ module.exports = {
type: 'category',
label: 'Smeshing Guide',
items: [
'guides/smeshing/start',
'guides/smeshing/requirements',
'guides/considerations',
'guides/smeshing/netconfig',
'start/smeshing/start',
'start/smeshing/requirements',
'start/considerations',
'start/smeshing/netconfig',
{
'Basic Smeshing Guide': [
'guides/smeshing/smeshing_basic/install',
'guides/smeshing/smeshing_basic/additional',
'guides/smeshing/smeshing_basic/advanced_config',
'guides/smeshing/smeshing_basic/advanced-wallet',
'guides/smeshing/smeshing_basic/setup',
'guides/smeshing/smeshing_basic/smeshing',
'guides/smeshing/smeshing_basic/status',
'guides/smeshing/smeshing_basic/wallet',
'start/smeshing/smeshing_basic/install',
'start/smeshing/smeshing_basic/additional',
'start/smeshing/smeshing_basic/advanced_config',
'start/smeshing/smeshing_basic/advanced-wallet',
'start/smeshing/smeshing_basic/setup',
'start/smeshing/smeshing_basic/smeshing',
'start/smeshing/smeshing_basic/status',
'start/smeshing/smeshing_basic/wallet',
],
'Advanced Smeshing Guide': [
'guides/smeshing/smeshing_adv/setup',
'guides/smeshing/smeshing_adv/post_init',
'guides/smeshing/smeshing_adv/api',
'guides/smeshing/smeshing_adv/poet',
'guides/smeshing/smeshing_adv/networking',
'guides/smeshing/smeshing_adv/performance',
'guides/smeshing/smeshing_adv/equivocation',
'guides/smeshing/smeshing_adv/verification',
'guides/smeshing/smeshing_adv/quicksync',
'guides/smeshing/smeshing_adv/advanced',
'guides/smeshing/smeshing_adv/post_1n',
'guides/smeshing/smeshing_adv/multigpu',
'guides/smeshing/smeshing_adv/troubleshooting'
'start/smeshing/smeshing_adv/setup',
'start/smeshing/smeshing_adv/post_init',
'start/smeshing/smeshing_adv/api',
'start/smeshing/smeshing_adv/poet',
'start/smeshing/smeshing_adv/networking',
'start/smeshing/smeshing_adv/performance',
'start/smeshing/smeshing_adv/equivocation',
'start/smeshing/smeshing_adv/verification',
'start/smeshing/smeshing_adv/quicksync',
'start/smeshing/smeshing_adv/advanced',
'start/smeshing/smeshing_adv/post_1n',
'start/smeshing/smeshing_adv/multigpu',
'start/smeshing/smeshing_adv/troubleshooting'
],
}
],
},
'guides/rewards',
'guides/integration',
'guides/ledger'
'start/rewards',
'start/integration',
'start/ledger'
],
ecosystem: [ 'ecosystem/construction-eco',
'ecosystem/smapp',
Expand Down
56 changes: 28 additions & 28 deletions sitemap.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<priority>1.0</priority>
</url>
<url>
<loc>https://docs.spacemesh.io/docs/guides/smeshing/start</loc>
<loc>https://docs.spacemesh.io/docs/start/smeshing/start</loc>
<lastmod>2024-08-30</lastmod>
<changefreq>daily</changefreq>
<priority>0.9</priority>
Expand Down Expand Up @@ -37,55 +37,55 @@
<priority>0.8</priority>
</url>
<url>
<loc>https://docs.spacemesh.io/docs/guides/considerations</loc>
<loc>https://docs.spacemesh.io/docs/start/considerations</loc>
<lastmod>2024-08-30</lastmod>
<changefreq>daily</changefreq>
<priority>0.8</priority>
</url>
<url>
<loc>https://docs.spacemesh.io/docs/guides/smeshing/smeshing_basic/install</loc>
<loc>https://docs.spacemesh.io/docs/start/smeshing/smeshing_basic/install</loc>
<lastmod>2024-08-30</lastmod>
<changefreq>daily</changefreq>
<priority>0.8</priority>
</url>
<url>
<loc>https://docs.spacemesh.io/docs/guides/smeshing/smeshing_adv/setup</loc>
<loc>https://docs.spacemesh.io/docs/start/smeshing/smeshing_adv/setup</loc>
<lastmod>2024-08-30</lastmod>
<changefreq>daily</changefreq>
<priority>0.8</priority>
</url>
<url>
<loc>https://docs.spacemesh.io/docs/guides/smeshing/netconfig</loc>
<loc>https://docs.spacemesh.io/docs/start/smeshing/netconfig</loc>
<lastmod>2024-08-30</lastmod>
<changefreq>daily</changefreq>
<priority>0.8</priority>
</url>
<url>
<loc>https://docs.spacemesh.io/docs/guides/rewards</loc>
<loc>https://docs.spacemesh.io/docs/start/rewards</loc>
<lastmod>2024-08-30</lastmod>
<changefreq>daily</changefreq>
<priority>0.8</priority>
</url>
<url>
<loc>https://docs.spacemesh.io/docs/guides/ledger</loc>
<loc>https://docs.spacemesh.io/docs/start/ledger</loc>
<lastmod>2024-08-30</lastmod>
<changefreq>daily</changefreq>
<priority>0.8</priority>
</url>
<url>
<loc>https://docs.spacemesh.io/docs/guides/smeshing/requirements</loc>
<loc>https://docs.spacemesh.io/docs/start/smeshing/requirements</loc>
<lastmod>2024-08-30</lastmod>
<changefreq>daily</changefreq>
<priority>0.8</priority>
</url>
<url>
<loc>https://docs.spacemesh.io/docs/guides/smeshing/smeshing_adv/poet</loc>
<loc>https://docs.spacemesh.io/docs/start/smeshing/smeshing_adv/poet</loc>
<lastmod>2024-08-30</lastmod>
<changefreq>daily</changefreq>
<priority>0.8</priority>
</url>
<url>
<loc>https://docs.spacemesh.io/docs/guides/integration</loc>
<loc>https://docs.spacemesh.io/docs/start/integration</loc>
<lastmod>2024-08-30</lastmod>
<changefreq>daily</changefreq>
<priority>0.8</priority>
Expand Down Expand Up @@ -139,109 +139,109 @@
<priority>0.7</priority>
</url>
<url>
<loc>https://docs.spacemesh.io/docs/guides/smeshing/smeshing_adv/verification</loc>
<loc>https://docs.spacemesh.io/docs/start/smeshing/smeshing_adv/verification</loc>
<lastmod>2024-08-30</lastmod>
<changefreq>daily</changefreq>
<priority>0.7</priority>
</url>
<url>
<loc>https://docs.spacemesh.io/docs/guides/smeshing/smeshing_adv/post_1n</loc>
<loc>https://docs.spacemesh.io/docs/start/smeshing/smeshing_adv/post_1n</loc>
<lastmod>2024-08-30</lastmod>
<changefreq>daily</changefreq>
<priority>0.7</priority>
</url>
<url>
<loc>https://docs.spacemesh.io/docs/guides/smeshing/smeshing_adv/troubleshooting</loc>
<loc>https://docs.spacemesh.io/docs/start/smeshing/smeshing_adv/troubleshooting</loc>
<lastmod>2024-08-30</lastmod>
<changefreq>daily</changefreq>
<priority>0.7</priority>
</url>
<url>
<loc>https://docs.spacemesh.io/docs/guides/smeshing/smeshing_adv/performance</loc>
<loc>https://docs.spacemesh.io/docs/start/smeshing/smeshing_adv/performance</loc>
<lastmod>2024-08-30</lastmod>
<changefreq>daily</changefreq>
<priority>0.7</priority>
</url>
<url>
<loc>https://docs.spacemesh.io/docs/guides/smeshing/smeshing_adv/equivocation</loc>
<loc>https://docs.spacemesh.io/docs/start/smeshing/smeshing_adv/equivocation</loc>
<lastmod>2024-08-30</lastmod>
<changefreq>daily</changefreq>
<priority>0.7</priority>
</url>
<url>
<loc>https://docs.spacemesh.io/docs/guides/smeshing/smeshing_adv/api</loc>
<loc>https://docs.spacemesh.io/docs/start/smeshing/smeshing_adv/api</loc>
<lastmod>2024-08-30</lastmod>
<changefreq>daily</changefreq>
<priority>0.7</priority>
</url>
<url>
<loc>https://docs.spacemesh.io/docs/guides/smeshing/smeshing_adv/quicksync</loc>
<loc>https://docs.spacemesh.io/docs/start/smeshing/smeshing_adv/quicksync</loc>
<lastmod>2024-08-30</lastmod>
<changefreq>daily</changefreq>
<priority>0.7</priority>
</url>
<url>
<loc>https://docs.spacemesh.io/docs/guides/smeshing/smeshing_adv/post_init</loc>
<loc>https://docs.spacemesh.io/docs/start/smeshing/smeshing_adv/post_init</loc>
<lastmod>2024-08-30</lastmod>
<changefreq>daily</changefreq>
<priority>0.7</priority>
</url>
<url>
<loc>https://docs.spacemesh.io/docs/guides/smeshing/smeshing_adv/multigpu</loc>
<loc>https://docs.spacemesh.io/docs/start/smeshing/smeshing_adv/multigpu</loc>
<lastmod>2024-08-30</lastmod>
<changefreq>daily</changefreq>
<priority>0.7</priority>
</url>
<url>
<loc>https://docs.spacemesh.io/docs/guides/smeshing/smeshing_adv/networking</loc>
<loc>https://docs.spacemesh.io/docs/start/smeshing/smeshing_adv/networking</loc>
<lastmod>2024-08-30</lastmod>
<changefreq>daily</changefreq>
<priority>0.7</priority>
</url>
<url>
<loc>https://docs.spacemesh.io/docs/guides/smeshing/smeshing_basic/advanced_config</loc>
<loc>https://docs.spacemesh.io/docs/start/smeshing/smeshing_basic/advanced_config</loc>
<lastmod>2024-08-30</lastmod>
<changefreq>daily</changefreq>
<priority>0.7</priority>
</url>
<url>
<loc>https://docs.spacemesh.io/docs/guides/smeshing/smeshing_basic/smeshing</loc>
<loc>https://docs.spacemesh.io/docs/start/smeshing/smeshing_basic/smeshing</loc>
<lastmod>2024-08-30</lastmod>
<changefreq>daily</changefreq>
<priority>0.7</priority>
</url>
<url>
<loc>https://docs.spacemesh.io/docs/guides/smeshing/smeshing_basic/status</loc>
<loc>https://docs.spacemesh.io/docs/start/smeshing/smeshing_basic/status</loc>
<lastmod>2024-08-30</lastmod>
<changefreq>daily</changefreq>
<priority>0.7</priority>
</url>
<url>
<loc>https://docs.spacemesh.io/docs/guides/smeshing/smeshing_basic/additional</loc>
<loc>https://docs.spacemesh.io/docs/start/smeshing/smeshing_basic/additional</loc>
<lastmod>2024-08-30</lastmod>
<changefreq>daily</changefreq>
<priority>0.7</priority>
</url>
<url>
<loc>https://docs.spacemesh.io/docs/guides/smeshing/smeshing_basic/setup</loc>
<loc>https://docs.spacemesh.io/docs/start/smeshing/smeshing_basic/setup</loc>
<lastmod>2024-08-30</lastmod>
<changefreq>daily</changefreq>
<priority>0.7</priority>
</url>
<url>
<loc>https://docs.spacemesh.io/docs/guides/smeshing/smeshing_basic/advanced-wallet</loc>
<loc>https://docs.spacemesh.io/docs/start/smeshing/smeshing_basic/advanced-wallet</loc>
<lastmod>2024-08-30</lastmod>
<changefreq>daily</changefreq>
<priority>0.7</priority>
</url>
<url>
<loc>https://docs.spacemesh.io/docs/guides/smeshing/smeshing_basic/wallet</loc>
<loc>https://docs.spacemesh.io/docs/start/smeshing/smeshing_basic/wallet</loc>
<lastmod>2024-08-30</lastmod>
<changefreq>daily</changefreq>
<priority>0.7</priority>
</url>
<url>
<loc>https://docs.spacemesh.io/docs/guides/smeshing/smeshing_adv/advanced</loc>
<loc>https://docs.spacemesh.io/docs/start/smeshing/smeshing_adv/advanced</loc>
<lastmod>2024-08-30</lastmod>
<changefreq>daily</changefreq>
<priority>0.7</priority>
Expand Down
2 changes: 1 addition & 1 deletion src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ function HomepageHeader() {
</Link>
<Link
className="intro-card"
to="docs/guides/smeshing/start">
to="docs/start/smeshing/start">
<div class='intro-card-title'>GUIDES</div>
<div class='intro-card-content'>Start smeshing on Spacemesh.</div>
</Link>
Expand Down

0 comments on commit c0cb4f4

Please sign in to comment.