Skip to content

Commit 75a2117

Browse files
authored
Fix Diagram Typos and Glossary Headers (#130)
Minor fixes: - Glossary headers should be much smaller given their number - Incorrect header level for steps - Diagrams typo of State -> Stake
1 parent 16fb896 commit 75a2117

File tree

9 files changed

+115
-110
lines changed

9 files changed

+115
-110
lines changed

.github/workflows/verify-pr.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@ name: Verify PR
22

33
on:
44
pull_request:
5+
6+
# Set default permissions as restrictive
7+
permissions:
8+
contents: read
9+
510
jobs:
611
verify:
712
runs-on: ubuntu-latest

pages/Glossary.md

Lines changed: 55 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -2,305 +2,305 @@
22

33
<!-- General rule of thumb: Glossary links OUT, nothing really links INTO the Glossary -->
44

5-
## Account
5+
#### Account
66

77
An account on the blockchain, represented by a public key.
88
Accounts may hold a token balance, transfer tokens, and pay transaction fees.
99
Not to be confused with Message Source Accounts, which are unique to Frequency and ensure that user-generated data has verifiable authorship.
1010
See [Identity Management](./Identity/index.md).
1111

12-
## Autonomous User
12+
#### Autonomous User
1313

1414
An end user who spends tokens to perform transactions directly on Frequency, in contrast to a coinless user, who delegates to Providers in order to pay transaction fees.
1515
See [Autonomous Users](./Delegation/Benefits.md#autonomous-users).
1616

17-
## Batch
17+
#### Batch
1818

1919
See [Message Batch](#message-batch).
2020

21-
## Capacity
21+
#### Capacity
2222

2323
An alternate payment mechanism for certain classes of transactions that allows Messages to be sent and on-chain work to occur over time.
2424
Capacity allows Providers a rate-limited continuous stream of transactions and provides an alternative to using tokens to perform individual transactions.
2525
Capacity is generated via Capacity Staking and Provider Boosting.
2626
See [Capacity Staking](./Tokenomics/CapacityStaking.md).
2727

28-
## Capacity Allocation
28+
#### Capacity Allocation
2929

3030
The amount of Capacity generated for a Provider per Capacity Epoch.
3131
See [Capacity Renewal](./Tokenomics/CapacityStaking.md#renewal).
3232

33-
## Capacity Epoch
33+
#### Capacity Epoch
3434

3535
The number of blocks before Capacity refills.
3636
In other words, it is the number of blocks before a Provider may reuse their Capacity Allocation.
3737
See [Capacity Renewal](./Tokenomics/CapacityStaking.md#renewal).
3838

39-
## Capacity Staking
39+
#### Capacity Staking
4040

4141
A form of staking that allows Providers to use FRQCY as efficiently as possible, optimizing their generated Capacity for serving end users.
4242
Capacity Staking generates more Capacity per token staked than Provider Boosting.
4343
See [Capacity Staking](./Tokenomics/CapacityStaking.md).
4444

45-
## Capacity Staking Ratio
45+
#### Capacity Staking Ratio
4646
The ratio of the number of FRQCY tokens that must be staked per unit of Capacity generated each Capacity Epoch from Capacity Staking.
4747
See [Capacity Staking](./Tokenomics/CapacityStaking.md).
4848

49-
## Coinless User
49+
#### Coinless User
5050

5151
An end user who doesn’t use tokens to interact with Frequency.
5252
While coinless users maintain User Accounts that enable them to directly control their authentication and authorization data on chain, they delegate transaction handling to a Provider who will in turn manage data transactions (such as sending Messages) on their behalf.
5353
See [Benefits of Delegation](./Delegation/Benefits.md).
5454

55-
## Collator
55+
#### Collator
5656

5757
A Frequency Node that generates blocks and submits them to the Relay Chain.
5858
Frequency currently operates using Invulnerable Collators, but intends to transition to Public Collators in the future.
5959
See [Collator](./Architecture/Collators.md).
6060

61-
## Collator Nodes
61+
#### Collator Nodes
6262

6363
Servers that participate in the Frequency Network and are configured to form blocks.
6464
See [Operational Model](./Architecture/OperationalModel.md).
6565

66-
## Collator Rewards
66+
#### Collator Rewards
6767

6868
FRQCY awarded to Frequency-specific Public Collators for staking to the Frequency Network and participating in block formation activities.
6969
See [Collator Incentives](./Tokenomics/CollatorRewards.md).
7070

71-
## Content Identifier (CID)
71+
#### Content Identifier (CID)
7272

7373
A unique identifier used with IPFS derived from the content of a file.
7474
See [Schema Payload Location](./Data/Schemas.md#payload-location).
7575

76-
## Control Key
76+
#### Control Key
7777

7878
The public key of the User's Account used to identify the control an MSA.
7979
See [Identity Management](./Identity/ControlKeys.md).
8080

81-
## Delegation Model
81+
#### Delegation Model
8282

8383
The mechanism whereby end users can grant permission to perform tasks that require significant blockchain knowledge or token ownership to Providers, reducing friction and enabling Message Batching to improve scalability. Also includes the concept of Revocation, where a user can revoke permission to perform those tasks from a Provider.
8484
Revocation does not have any on-chain transaction fees associated with the transaction, ensuring that [Coinless Users](#coinless-users) can invoke it without Provider permission.
8585
See [Delegation Model](./Delegation/index.md).
8686

87-
## End User
87+
#### End User
8888

8989
A user who owns an MSA but is not acting as a Provider.
9090
An end user may choose to own tokens to participate in Provider Boosting to support services and participate in on-chain governance with Capacity.
9191
See [Delegation Model](./Delegation/index.md)
9292
However, end users typically delegate other tasks to Providers who perform actions on the user's behalf.
9393
See [Coinless Users](#coinless-users) and [Delegation](#delegation-model).
9494

95-
## Existential Deposit
95+
#### Existential Deposit
9696

9797
The minimum token amount an Account that is not associated with an MSA may have and still be considered alive.
9898
See [Message Source Accounts](./Identity/MessageSourceAccounts.md).
9999

100-
## Frequency Council
100+
#### Frequency Council
101101

102102
The set of Frequency accounts that are responsible for certain governance actions, including Provider approval.
103103
See [Governance](./Governance/index.md).
104104

105-
## Frequency Node
105+
#### Frequency Node
106106

107107
A server that participates in the Frequency network.
108108
See [Interaction Model](Architecture/InteractionModel.md).
109109

110-
## FRQCY
110+
#### FRQCY
111111

112112
The native coin on Frequency Mainnet, which can be used to pay any Frequency transaction fees, or staked for Capacity.
113113
Sometimes referred to as "FRQCY Token" or simply "tokens".
114114
Holders of FRQCY are often referred to as token holders.
115115
See [Tokenomics](./Tokenomics/index.md).
116116

117-
## Handle
117+
#### Handle
118118

119119
See [User Handle](#user-handle).
120120

121-
## Handle Base
121+
#### Handle Base
122122

123123
The user-selected portion of the Handle Display.
124124
See [Handle Creation](./Identity/Handles.md#handle-creation).
125125

126126

127-
## Handle Display
127+
#### Handle Display
128128

129129
A user’s entire User Handle as displayed by the system including the user-selected Handle Base and the system-selected Handle Suffix, separated by a "." character.
130130
See [Handle Creation](./Identity/Handles.md#handle-creation).
131131

132-
## Handle Suffix
132+
#### Handle Suffix
133133

134134
The system-selected numeric portion of the Handle Display.
135135
See [Handle Creation](./Identity/Handles.md#handle-creation).
136136

137-
## InterPlanetary File System (IPFS)
137+
#### InterPlanetary File System (IPFS)
138138

139139
A decentralized content-addressed file system protocol.
140140
See https://docs.ipfs.tech/ for more detail.
141141

142-
## Invulnerable Collator
142+
#### Invulnerable Collator
143143

144144
A collator that cannot be removed without governance action.
145145
<!--
146146
See [Collator Decentralization Roadmap](./Networks/Decentralization.md).
147147
-->
148-
## Key pair
148+
#### Key pair
149149

150150
A matching public key and private key.
151151
The private key can be used to generate cryptographic signatures which third parties may verify with the public key.
152152
See [Identity Management](./Identity/index.md).
153153

154-
## Message
154+
#### Message
155155

156156
A protocol related data item that is indexed by its Schema Id and block number.
157157
See [Messages](./Data/Messages.md).
158158

159159

160-
## Message Batch
160+
#### Message Batch
161161

162162
A collection of Messages, possibly from many different Message Source Accounts (MSAs), that allows Providers to publish a single on-chain transaction that references large quantities of data off chain, thereby reducing the transaction fee.
163163
See [Batching](./Data/Batching.md).
164164

165165

166-
## Message Source Account (MSA)
166+
#### Message Source Account (MSA)
167167

168168
Message Source Accounts (MSAs) are distinct from Token Accounts and unique to Frequency.
169169
They ensure protocol related data items have verifiable authorship.
170170
End users with MSAs are not required to have FRQCY or Capacity to interact with Frequency, but may instead choose to delegate tasks that require Capacity to Providers.
171171
See [Message Source Accounts](./Identity/MessageSourceAccounts.md).
172172

173-
## MSA Id
173+
#### MSA Id
174174

175175
The unique 64-bit unsigned integer identifier associated with an MSA.
176176
See [Message Source Accounts](./Identity/MessageSourceAccounts.md).
177177

178178

179-
## On-Chain Message
179+
#### On-Chain Message
180180

181181
A Message that has its payload stored on the Frequency blockchain.
182182
See [Payload Location](./Data/Schemas.md#payload-location).
183183

184-
## Off-Chain Message
184+
#### Off-Chain Message
185185

186186
A Message that has its payload stored on IPFS.
187187
See [Payload Location](./Data/Schemas.md).
188188

189-
## Payload
189+
#### Payload
190190

191191
The data within a protocol related data item.
192192
The format of the payload is defined by the corresponding Schema Model.
193193
See [Schemas](./Data/Schemas.md).
194194

195-
## Payload Location
195+
#### Payload Location
196196

197197
The attribute of a Frequency Schema that specifies how and where data will be stored.
198198
See [Schema Models](./Data/Schemas.md#schema-models).
199199

200-
## Provider
200+
#### Provider
201201

202202
The holder of an MSA that can allow others to delegate to it such as applications and services that use the Capacity economic system.
203203
Providers utilize Capacity to serve the end users that delegate to them.
204204
See [Providers](./Delegation/Providers.md).
205205

206-
## Provider Boosting
206+
#### Provider Boosting
207207

208208
Provider Boosting allows users to stake FRQCY they hold to support specific Providers.
209209
Providers who are "boosted" by end users receive additional Capacity, while Users who "boost" Providers receive a reward (in the form of additional FRQCY).
210210

211211
See [Boosting](./Tokenomics/ProviderBoosting.md).
212212

213-
## Provider Boosting Ratio
213+
#### Provider Boosting Ratio
214214

215215
The ratio of the number of FRQCY tokens that must be staked per unit of Capacity generated each Capacity Epoch from Provider Boosting.
216216

217-
## Public Collator
217+
#### Public Collator
218218

219219
A Collator who bonds FRQCY in order to participate in block formation, and receives rewards for participation.
220220
Public Collators who behave improperly risk losing their position and their bond.
221221
See [Collator Incentives](./Tokenomics/CollatorRewards.md).
222222

223-
## Reward Epoch
223+
#### Reward Epoch
224224

225225
The number of blocks between distributions of Provider Boosting rewards.
226226
See [Boosting](./Tokenomics/ProviderBoosting.md).
227227

228-
## Revocation
228+
#### Revocation
229229

230230
See [Delegation Model](./Delegation/index.md).
231231

232232

233-
## Schema
233+
#### Schema
234234

235235
Registered data structures for Messages and Stateful Storage items.
236236
Frequency Schemas define where Payloads are stored and how end users can parse the data within.
237237
See also On-Chain Message and Off-Chain Message.
238238
See [Schemas](./Data/Schemas.md).
239239

240240

241-
## Schema Id
241+
#### Schema Id
242242

243243
The unique identifier of a Schema on Frequency.
244244
See [Schemas](./Data/Schemas.md).
245245

246-
## Schema Model
246+
#### Schema Model
247247

248248
Metadata about a Frequency Schema that defines the format and structure of the Schema itself, from which applications can determine how to serialize and deserialize data using the Schema.
249249
Frequency supports two model types for data: Parquet and Avro.
250250
See [Schema Models](./Data/Schemas.md#schema-models).
251251

252-
## Schema Registry
252+
#### Schema Registry
253253

254254
The Schema Registry is the on-chain repository for Frequency Schemas.
255255
See [Schemas](./Data/Schemas.md).
256256

257-
## Staking
257+
#### Staking
258258

259259
Staking refers to the process of temporarily locking tokens in order to accomplish a specific action.
260260
FRQCY can be staked for specific purposes, including serving as [Public Collators](#public-collator), [Capacity Staking](#capacity-staking) and [Provider Boosting](#provider-boosting).
261261

262-
## Staking Ratio
262+
#### Staking Ratio
263263

264264
See [Capacity Staking Ratio](#capacity-staking-ratio).
265265

266-
## Stateful Storage
266+
#### Stateful Storage
267267

268268
A mode of storing on-chain protocol related data items so that they can be easily retrieved, modified, and removed, indexed by the data controller's MSA and a Schema Id.
269269
See [Stateful Storage](./Data/StatefulStorage.md).
270270

271-
## Thaw Period
271+
#### Thaw Period
272272

273273
The period of time between token unstaking and token liquidity during which those tokens cannot be used, transferred or sold.
274274
See [Thaw Period](./Tokenomics/CapacityStaking.md).
275275

276-
## Token Account
276+
#### Token Account
277277

278278
An Account that is secured with FRQCY.
279279
See [Visibility](./Tokenomics/ProviderBoosting.md#visibility).
280280

281281

282-
## Unstaking
282+
#### Unstaking
283283

284284
The process of allowing tokens that have been staked to be made available again.
285285
When a user unstakes their FRQCY, there is a Thaw Period before the tokens are unlocked.
286286
See [Unstaking](./Tokenomics/CapacityStaking.md#unstaking).
287287

288-
## User
288+
#### User
289289

290290
Any entity with an Account on Frequency.
291291
See [Identity Management](./Identity/index.md).
292292

293-
## User Account
293+
#### User Account
294294

295295
The cryptographic keys that the user uses as Control Keys to control an MSA.
296296
See [Identity Management](./Identity/ControlKeys.md).
297297

298-
## User Handle
298+
#### User Handle
299299

300300
A unique identifier for users on Frequency, consisting of a user-selected Handle Base and a chain-selected Handle Suffix.
301301
See [User Handles](./Identity/Handles.md).
302302

303-
## XRQCY
303+
#### XRQCY
304304

305305
The Frequency Testnet Token.
306306
This token is only for testing and holds no value.

0 commit comments

Comments
 (0)