Skip to content

Commit 416b106

Browse files
Improve lead text throughout site. (#210)
* Adds basic lead text to concepts pages. * Improves leads for rest of site. * Removes old link to access modes. * Finishes off lead text for all pages.
1 parent c73cd2e commit 416b106

18 files changed

+21
-26
lines changed

content/basics/_index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: "Basics"
33
weight: 10
4+
lead: "The following sections explore the very basics of Entropy."
45
---
5-
6-
The following sections explore the very basics of Entropy:

content/basics/entrosplainer.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
---
22
title: "Entrosplainer"
3-
description: "Learn the basic core concepts of Entropy, and what it's built for."
3+
lead: "Learn the basic core concepts of Entropy, and what it's built for."
44
math: true
55
---
66

7-
Entropy is a layer-one chain for decentralized signing infrastructure.
8-
97
The Entropy network provides threshold signing as a service. It consists of a proof of stake application chain built with [Substrate](https://substrate.io/) where each validator node deploys a [threshold signing client](https://en.wikipedia.org/wiki/Threshold_cryptosystem) which holds secret key-shares. The decision as to whether the network will collectively sign a particular message is determined by a predefined program.
108

119
Entropy's [threshold signature scheme]({{< relref "../concepts/threshold-signature-scheme.md" >}}) uses the [Elliptic Curve Digital Signature Algorithm (ECDSA)](https://en.wikipedia.org/wiki/Elliptic_Curve_Digital_Signature_Algorithm), with support for signing [Ethereum Virtual Machine (EVM)](https://ethereum.org/en/developers/docs/evm/) transactions as well as arbitrary data. Support for other signature schemes is planned. This gives us a blockchain-agnostic programmable signing infrastructure.

content/basics/glossary.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Glossary"
3-
description: "Basic descriptions of some of the unique language found within this site."
3+
lead: "Basic descriptions of some of the unique language found within this site."
44
---
55

66
Here is a list of some unfamiliar words and phrases found throughout the Entropy documentation.

content/concepts/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Concepts"
33
weight: 20
4+
lead: "The following sections explore the core concepts of Entropy."
45
---
56

6-
The following sections explore the core concepts of Entropy:

content/concepts/access-modes.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: "Access modes"
3+
draft: true
34
---
45

56
![Access Modes](./images/public-private-permissioned.svg)

content/concepts/node-encryption-and-authentication.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
22
title: "Node encryption and authentication"
3+
lead: "When sending messages to threshold signature servers on the Entropy network, you must authenticate and encrypt the messages. This page covers that process."
34
---
45

5-
When sending messages to threshold signature servers on the Entropy network, you must authenticate and encrypt the messages.
6-
76
The authentication process is simple: each node has a substrate account stored on the chain, referred to as a TSS account.
87

98
Messages are signed using SR25519. This encryption requires using an X25519 public key which gets used in [Hybrid Public Key Encryption](https://www.rfc-editor.org/rfc/rfc9180.html), using the [`hpke-rs`](https://docs.rs/hpke-rs) crate.

content/concepts/proactive-refresh.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: "Proactive refresh"
3+
lead: "This page covers the process where key shares held by validators in a network are periodically updated to maintain the security of the network."
34
---
45

56
The concept here is that as validators enter and exit the network, their key shares should become invalid. Every session (2400 blocks, which is 4 hours), the chain will inform the TSS servers that a proactive refresh is happening. The network (registered keys) will be partitioned so as not to refresh the whole network and cause undue strain on the validators. One TSS server from each subgroup is selected deterministically using the current block number modulo the number of TSS servers in that subgroup, similar to the selection process for DKG when registering. The selected TSS servers (one in each subgroup) will connect to each other and run the proactive refresh protocol, producing a new set of key shares. The protocol is similar to the distributed key generation protocol used during registration. The selected TSS servers send the new key shares to the other members of their subgroup, and on receiving a key share, they replace their existing key share in their key-value store with the new one. All old key shares will now be incompatible with the refreshed key shares. However, the public validating key of the distributed signing keypair never changes. The private access mode, an individual trigger will exist where it is initiated by the user (not yet implemented).

content/concepts/registering.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
---
22
title: "Registering"
3+
lead: "A user needs to register in order to be able to use the Entropy network to sign messages. This page covers that process."
34
---
45

5-
A user needs to register in order to be able to use the Entropy network to sign messages.
6-
76
The SDK method for registering is [`Entropy.register`](https://github.com/entropyxyz/sdk/blob/main/README.md#register).
87

98
## The registering process
109

1110
![Register Flow](./images/register.svg)
1211

13-
1. The user registers with the Entropy chain by submitting a transaction from the 'signature request account' containing the 'Account Key', initial 'ProgramsData', and chosen [access mode]({{< relref "./access-modes.md" >}}).
12+
1. The user registers with the Entropy chain by submitting a transaction from the 'signature request account' containing the 'Account Key', and initial 'ProgramsData'.
1413
* ```ProgramsData``` - Is multiple Programs Instances. Which contain the ```program_pointer``` (the hash of the program you want to use) and the ```program_config``` for that program. On the evaluation of a signature request a threshold server will run all the programs and pass through the program config for that program.
1514

1615
1. The chain selects which nodes should perform a [distributed key generation (DKG)](https://docs.rs/synedrion/latest/synedrion/sessions/fn.make_key_gen_session.html) based on the current block number.

content/concepts/signing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: "Signing"
3+
lead: "The signing process can only take place when a user is already registered on Entropy. The process involves the user and a committee of validators collectively performing the signing."
34
---
45

5-
The signing process can only take place when a user is already registered on Entropy. The process involves the user and a committee of validators collectively performing the signing.
66

77
The committee requires one Validator from each signing group as well as the user. The current version of the program will be executed here to determine whether or not to proceed with the signing protocol.
88

content/concepts/threshold-signature-scheme.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: "Threshold Signature Scheme"
3+
lead: "This page covers what a threshold signature scheme is, and how they are used within the Entropy network."
34
---
45

56
- The TSS Implementation used by Entropy is **Synedrion** [src](https://github.com/entropyxyz/synedrion) [API](https://docs.rs/synedrion)

content/guides/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Guides"
33
weight: 30
4+
lead: "Use the following guides to discover how to best use the Entropy network."
45
---
56

6-
Use the following guides to discover how to best use the Entropy network:

content/guides/deploy-a-program.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
22
title: "Deploy a program"
3+
lead: "After writing a program, you'll need to deploy it to a network before you can interact with it. By the end of this guide, you will know how to deploy a program to an Entropy network."
34
---
45

5-
After writing a program, you'll need to deploy it to a network before you can interact with it. By the end of this guide, you will know how to deploy a program to an Entropy network.
6-
76
## Interactive CLI
87

98
Here is the process for deploying a program using the Entropy CLI's interactive text-based user interface (TUI).

content/guides/get-funds.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
22
title: "Get funds"
3+
lead: "You need funds to interact with the Entropy blockchain network. To get these testing funds, you will need a GitHub account."
34
---
45

5-
You need funds to interact with the Entropy blockchain network. To get these testing funds, you will need a GitHub account.
6-
76
## Mainnet
87

98
The Entropy main network (mainnet) has yet to be released; as such, mainnet funds are not available.

content/guides/manage-accounts.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
22
title: "Manage accounts"
3+
lead: "This page details some of the ways you can create and maintain your Entropy accounts."
34
---
45

5-
This page details some of the ways you can create and maintain your Entropy accounts.
6-
76
## Interactive CLI
87

98
The CLI has a built-in account manager. This is useful for running quick, one-time transactions. The CLI account manager can also be helpful for testing purposes. Here is the process for managing your accounts using the CLI's interactive text-based user interface (TUI).

content/guides/register-an-account.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
22
title: "Register an address"
3+
lead: "Registering an account is a feature unique to Entropy. Without going into too much detail, it advertises to the network that you own _this_ account and that you're ready to start signing things."
34
---
45

5-
Registering an account is a feature unique to Entropy. Without going into too much detail, it advertises to the network that you own _this_ account and that you're ready to start signing things.
6-
76
## Interactive CLI
87

98
Here is the process for registering an address using the Entropy CLI's interactive text-based user interface (TUI).

content/guides/transfer-funds.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
---
22
title: "Transfer funds"
3+
lead: "This page covers how to transfer funds between two addresses. There are several ways to complete a transfer; pick the process that best fits your situation."
34
---
45

5-
This page covers how to transfer funds between two addresses. There are several ways to complete a transfer; pick the process that best fits your situation. If you're unsure which process to follow, the [Substrate Explorer]({{< relref "#substrate-explorer" >}}) workflow is the easiest.
6+
If you're unsure which process to follow, the [Substrate Explorer]({{< relref "#substrate-explorer" >}}) workflow is the easiest.
67

78
## Substrate explorer
89

content/guides/use-the-explorer.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
---
22
title: "Use the explorer"
3+
lead: "A blockchain explorer is a web-based tool that functions like a search engine specifically designed for blockchain data. This page explains how to connect to one for Entropy."
34
---
45

5-
A blockchain explorer is a web-based tool that functions like a search engine specifically designed for blockchain data. Blockchains, like Entropy, store information in public databases called ledgers. These ledgers are transparent, meaning anyone can view them. However, the data can be complex and challenging to understand without assistance. Blockchain explorers act as an interface, allowing users to quickly search, retrieve, and analyze information on the blockchain.
6+
Blockchains, like Entropy, store information in public databases called ledgers. These ledgers are transparent, meaning anyone can view them. However, the data can be complex and challenging to understand without assistance. Blockchain explorers act as an interface, allowing users to quickly search, retrieve, and analyze information on the blockchain.
67

78
The [Polkadot\{.js\} Apps](https://polkadot.js.org/apps) is a user interface for interacting with Substrate blockchains. Since Entropy is built using Substrate, we can use this explorer to search and view chain data on the Entropy network.
89

content/reference/networks.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
22
title: "Networks"
3+
lead: "This page lists useful information about the Entropy network and all available test networks (testnets)."
34
---
45

5-
This page lists useful information about the Entropy network and all available test networks (testnets).
6-
76
## Mainnet
87

98
The Entropy main network (mainnet) has not been released yet. Details of mainnet will be available here shortly before launch.

0 commit comments

Comments
 (0)