Skip to content

Commit

Permalink
Fix casing of non title cased (#514)
Browse files Browse the repository at this point in the history
Co-authored-by: Chase Fleming <[email protected]>
  • Loading branch information
chasefleming and chasefleming authored Jan 12, 2024
1 parent c35d9f5 commit 2163720
Show file tree
Hide file tree
Showing 14 changed files with 48 additions and 47 deletions.
3 changes: 2 additions & 1 deletion docs/build/cadence-migration-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ We have created several resources to help developers update their applications.
- [Learn how to update your Flow CLI to test against Cadence 1.0](https://forum.flow.com/t/update-on-cadence-1-0/5197/7)
- [Check out the Cadence language 1.0 docs](https://cadencelang.dev/docs/1.0/)

## Get help with migrating your dapp to Cadence 1.0
## Get Help With Migrating Your Dapp to Cadence 1.0

If you have any questions related to Cadence 1.0 migration, or if you need help, please contact the Flow development community on [developer-questions Discord channel](https://discord.com/channels/613813861610684416/621847426201944074). Please use “C1.0 upgrade” at the beginning of the message to help us categorize questions related to Cadence 1.0.

We will soon start hosting regular "Cadence 1.0 upgrade office hours" events anyone can join to ask questions and get help with their dapp upgrade. These sessions will be scheduled in [Flow Webinars & Events calendar](https://calendar.google.com/calendar/u/0?cid=Y180Nzk3OGY1Y2Q5ZGE2MzZjYWRjNmI4NDczMTAyYjUwOTJjMWE4NjVkZDAxMDU1ODM5M2VjYjdmOWZkMGM5YWQwQGdyb3VwLmNhbGVuZGFyLmdvb2dsZS5jb20) and announced on [flow-events Discord channel](https://discord.com/channels/613813861610684416/1050190147100102787).
2 changes: 1 addition & 1 deletion docs/community-resources/wallets.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Store, manage, and interact securely with Flow tokens and digital assets on the

<div id="cards" className="cards">

## Flow Reference wallet
## Flow Reference Wallet

[Flow Reference Wallet](https://frw.gitbook.io/) is the first extension wallet on Flow.

Expand Down
6 changes: 3 additions & 3 deletions docs/networks/flow-networks/accessing-crescendo.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ func main() {
}
```

### Generating Crescendo key pair
### Generating Crescendo Key Pair

You can generate a new key pair with the [Flow CLI](https://github.com/onflow/flow-cli) as follows:

Expand All @@ -48,10 +48,10 @@ Public Key cc1c3d72...
**Note: By default, this command generates an ECDSA key pair on the P-256 curve. Keep in mind, the CLI is intended for development purposes only and is not recommended for production use. Handling keys using a Key Management Service is the best practice.**
## Account creation and token funding requests
## Account Creation and Token Funding Requests
Accounts and tokens for testing can be obtained through the [crescendo faucet](https://crescendo-faucet.onflow.org/). If you generated the keypair through the CLI, you can click on the URL provided to create an account and request crescendo FLOW tokens.
## Important smart contract addresses
## Important Smart Contract Addresses
You can review [all available core contracts](../../build/core-contracts/index.md) deployed to the Crescendo to identify which ones you want to import.
6 changes: 3 additions & 3 deletions docs/networks/flow-networks/accessing-mainnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 2
description: Guide to mainnet access
---

## Accessing Flow mainnet
## Accessing Flow Mainnet

The Flow Mainnet is available for access at this URL:

Expand All @@ -24,7 +24,7 @@ func main() {
}
```

## Account creation
## Account Creation

You can follow the [Flow Port account creation steps](../../networks/flow-port/index.md#blocto) to create a new mainnet account.

Expand All @@ -40,7 +40,7 @@ If you prefer watching a video, check out this tutorial:
allowfullscreen
></iframe>
## Generating a non-custodial account
## Generating a Non-Custodial Account

A non-custodial account will make sure you are the only one holding the keys to your account.

Expand Down
6 changes: 3 additions & 3 deletions docs/networks/flow-networks/accessing-testnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ func main() {
}
```

### Generating Testnet key pair
### Generating Testnet Key Pair

You can generate a new key pair with the [Flow CLI](https://github.com/onflow/flow-cli) as follows:

Expand All @@ -49,10 +49,10 @@ Public Key cc1c3d72...
**Note: By default, this command generates an ECDSA key pair on the P-256 curve. Keep in mind, the CLI is intended for development purposes only and is not recommended for production use. Handling keys using a Key Management Service is the best practice.**
## Account creation and token funding requests
## Account Creation and Token Funding Requests
Accounts and tokens for testing can be obtained through the [testnet faucet](https://testnet-faucet.onflow.org/). If you generated the keypair through the CLI, you can click on the URL provided to create an account and request testnet FLOW tokens.
## Important smart contract addresses
## Important Smart Contract Addresses
You can review [all available core contracts](../../build/core-contracts/index.md) deployed to the Testnet to identify which ones you want to import.
2 changes: 1 addition & 1 deletion docs/networks/flow-networks/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Other than the Flow mainnet network, Flow testnet can be used to test applicatio

During a round of network upgrade, Flow testnet is updated first. Hence, testnet can be used to test against the latest node software, Cadence and core contract changes which will eventually be available to mainnet.

### How to access these networks?
### How To Access These Networks?

- [Flow Testnet](./accessing-testnet.md)
- [Flow Mainnet](./accessing-mainnet.md)
Expand Down
8 changes: 4 additions & 4 deletions docs/networks/flow-port/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ In order to access Flow Port, you must have a valid Flow address. If you do not

2. If you do not have an existing Blocto Account, you have 2 different ways to create one: a) Through Flow Port and b) Through Blocto's mobile application. Below are instructions of how to do this in Flow Port.

#### Creating Account through Flow Port: Navigate to Flow Port
#### Creating Account Through Flow Port: Navigate To Flow Port

1. Using Google Chrome, Navigate to [Flow Port](https://port.onflow.org/).

Expand Down Expand Up @@ -90,7 +90,7 @@ Below are the various options you can choose. Please be aware, that at this time

Please see a list [here](https://github.com/onflow/flow/blob/master/nodeoperators/NodeOperatorList.md) for all node operators that you can delegate to. This list will be updated as new node operators are onboarded onto the network.'

### Staking your own Node
### Staking Your Own Node
1. Once you have navigated to the staking/delegating page in Flow Port, click on the 'Stake a Node' option.

2. Next, select the type of node you will be running.
Expand All @@ -108,12 +108,12 @@ Please see a list [here](https://github.com/onflow/flow/blob/master/nodeoperator

4. At this point, you can also cancel the pending delegation. On the pending delegation, you will see an `X` that you can click to initiate the cancelation transaction.

## I have successfully executed a Stake Transaction, now what?
## I Have Successfully Executed a Stake Transaction, Now What?
- Now that you have executed a stake transaction in either Flow Port or your custody provider’s portal, that transaction will sit in a pending status until it is processed, which will be at the next [Epoch](../../networks/staking/index.md#epochs) Date (which is currently weekly).
- During the next [Epoch](../../networks/staking/index.md#epochs), the transaction will be processed. If successful, the provided FLOW will be staked and the associated Node would be either **a)** included in the network protocol if it is a new node or **b)** continue to operate as is in the network protocol.
- You are now a part of Flow, and will begin to earn rewards for being a valued member of the network!

## What else can I do?
## What Else Can I Do?
- Add additional stake to your existing stake. Any added FLOW will again sit in a pending status and be processed at the next epoch.
- Withdraw/re-stake your earned rewards. If you decide to withdraw your rewards, this action will happen instantly. If you decide to re-stake your rewards, the request will again sit in a pending status and will be processed at the next [Epoch](../../networks/staking/index.md#epochs).
- Withdraw Rewards and send your earnings to other accounts. If you decide that you want to withdraw your rewards and send those earnings to other accounts via the 'Send FLOW' function, you should first withdraw your rewards. Once in your account, you can send these funds to any other account via the 'Send FLOW' option.
Expand Down
16 changes: 8 additions & 8 deletions docs/networks/node-ops/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_position: 1

Flow nodes are vital components of the Flow blockchain. These nodes are responsible for a variety of network operations to maintain the distributed ledger.

## Why run a node?
## Why Run a Node?

---

Expand All @@ -18,7 +18,7 @@ By running a node, you also directly contribute to the security and decentraliza
Flow multirole architecture makes it more scalable and provides several node types that you as a node operator can pick and choose from.


## Which node should you run?
## Which Node Should You Run?

---

Expand All @@ -28,7 +28,7 @@ The nodes are classified as follows,

![Flownodesdiagram.png](nodes/node-operation/Flownodesdiagram.png)

## Light node a.k.a. Observer node
## Light Node A.K.A. Observer Node

---

Expand All @@ -43,7 +43,7 @@ To run a light node, follow this [guide](./nodes/node-operation/observer-node.md

:::

## Archive node
## Archive Node

---

Expand All @@ -54,7 +54,7 @@ It also allows script execution and other read-only queries that require the exe

_The archive node is currently in beta and will be available as a GA release in H2 2023 (see [here](https://flow.com/post/flow-blockchain-node-operation-archive-node) for more)._

## Full node
## Full Node

---

Expand All @@ -63,7 +63,7 @@ In a nutshell, Full Nodes are staked network participants that drive network pro
- The Validator node (Collection, Consensus, Verification and Execution) is a full node that plays a role in block generation.


### Access node
### Access Node

---

Expand Down Expand Up @@ -96,7 +96,7 @@ Alternately, instead of running an access node, you can use the [Flow community]

:::

### Validator node
### Validator Node

---

Expand All @@ -108,7 +108,7 @@ You can also be a core participant in running the Flow network and contribute to

Nodes with these roles are staked and also receive staking rewards.

### Running a staked node
### Running a Staked Node

---

Expand Down
2 changes: 1 addition & 1 deletion docs/networks/node-ops/nodes/access-api-rate-limits.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Flow Access API rate limits
title: Flow Access API Rate Limits
sidebar_label: Access API Rate Limits
sidebar_position: 2
---
Expand Down
2 changes: 1 addition & 1 deletion docs/networks/node-ops/nodes/access-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ A language-agnostic specification for this API is defined using [Protocol Buffer

- [Flow Access API protobuf source files](https://github.com/onflow/flow/tree/master/protobuf)

## Flow access node endpoints
## Flow Access Node Endpoints

The Access Nodes hosted by DapperLabs are accessible at:

Expand Down
4 changes: 2 additions & 2 deletions docs/networks/node-ops/nodes/archive-access-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ A language-agnostic specification for this API is defined using [Protocol Buffer

- [Flow Archive Access API protobuf source files](https://github.com/onflow/flow/tree/master/protobuf)

## Flow archive node access endpoints
## Flow Archive Node Access Endpoints

The Archive Nodes hosted by DapperLabs are accessible at:

Expand All @@ -25,7 +25,7 @@ The Archive Nodes hosted by DapperLabs are accessible at:

`archive.canary.nodes.onflow.org:9000`

#### Rate limits for Dapper Labs archive nodes
#### Rate Limits for Dapper Labs Archive Nodes

Archive nodes operated by Dapper Labs are [rate limited](./archive-api-rate-limits.md).

Expand Down
2 changes: 1 addition & 1 deletion docs/networks/node-ops/nodes/archive-api-rate-limits.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Archive Access API rate limits on Dapper Labs Archive nodes
title: Archive Access API Rate Limits on Dapper Labs Archive Nodes
sidebar_label: Archive API Rate Limits
sidebar_position: 4
---
Expand Down
18 changes: 9 additions & 9 deletions docs/networks/node-ops/nodes/node-operation/access-node-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This guide is for running a permissonless Access node on Flow. If you are planni
Permissionless Access nodes allow any operator to run a Flow Access node.
Unlike the other staked nodes, a permissionless access node does not have to be approved by the service account before it can join the network, hence the term "permissionless". The goal is to make all node types permissionless and this is the first step towards achieving that goal.

## Who should run a Permissionless Access node?
## Who Should Run a Permissionless Access Node?
dApp developers can choose to run their own private permissionless access node and move away from using the community access nodes. This will also allow them to not be subjected to the API rate limits of the public access nodes.

Node operators can also run their own permissionless access node and provide access to that node as a service.
Expand Down Expand Up @@ -45,7 +45,7 @@ To summarize,
| 02/15/2023 | 08:00 UTC | 63 | Staking auction ends | Three of the nodes registered during this epoch are randomly selected to be a part of the network in the next epoch. No more nodes can register until the next epoch starts. |
| 02/15/2023 | 20:00 UTC | 64 | Epoch n+1 starts | The newly selected nodes can now participate in the network. Three new slots are opened. |

## How to run a Permissionless Access node?
## How To Run a Permissionless Access Node?

:::note

Expand All @@ -63,7 +63,7 @@ At a high level, to run a permissionless Access node, you will have to do the fo
Following is a detail explanation of these four steps.
If you want to run multiple access nodes, you will have to run through these steps for each node.

## Step 1 - Generate node information
## Step 1 - Generate Node Information

### Download the Bootstrapping Kit

Expand Down Expand Up @@ -148,7 +148,7 @@ All your private keys should be in the `bootstrap` folder created earlier. Pleas

:::

## Step 2 - Stake the node
## Step 2 - Stake the Node

You need to now register the node on chain by staking the node via [Flow Port](https://port.onflow.org/).

Expand Down Expand Up @@ -189,7 +189,7 @@ On the next screen, ensure that you stake 100 FLOW token.

Submit the Transaction.

## Step 3 - Verify that your node ID was selected
## Step 3 - Verify That Your Node ID Was Selected

On Wednesday at around 12:00 UTC, the staking auction for the current epoch will end and five nodes from candidate list of nodes will be chosen at random by the staking contract to be part of the next epoch.

Expand All @@ -204,7 +204,7 @@ There are several ways to verify whether your node was chosen as explained below
When you stake the node, the tokens will show up under the `tokensCommitted` bucket. After the staking auction ends, if the node is selected, the tokens remain in the `tokensCommitted` bucket and are moved to the `tokensStaked` bucket at the end of the epoch.
If the node is not selected, the tokens are moved to the `tokensUnstaked` bucket.

### Check using Flow Port
### Check Using Flow Port
You can check these balances on Flow Port before and after the epoch transition that will occur on Wednesday (see [timing](#Timing)).

When you stake the node, you should see the following on Flow Port under `Stake & Delegate`
Expand All @@ -219,7 +219,7 @@ Instead, if you see that your token balance is under the Unstaked Amount, then y

![Unstaked_node](Unstaked_FlowPort.png)

### Check using FlowCli
### Check Using Flow CLI

You can also check these balance using [Flow Cli](https://github.com/onflow/flow-cli). Once you have downloaded and installed Flow Cli, you can query the account balance using the command,
```shell
Expand Down Expand Up @@ -247,11 +247,11 @@ Account staking info:
Node Total Stake (including delegators): 0.00000000
```

### Epoch setup event
### Epoch Setup Event

Alternatively, if you can monitor events, look for [the epoch setup event](../../../staking/05-epoch-scripts-events.md#epochsetup) that gets emitted by the epoch contract. That event is emitted at the end of epoch N's staking auction and contains a list of node IDs that are confirmed for the next epoch.

## Step 4 - Start your node
## Step 4 - Start Your Node

If your node was selected as part of Step 3, you can now start your node.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Byzantine node attack response
sidebar_label: Byzantine attack response
title: Byzantine Node Attack Response
sidebar_label: Byzantine Attack Response
description: How to respond to a byzantine node attack on the network
sidebar_position: 3
---
Expand All @@ -25,13 +25,13 @@ Responding to an attack from a byzantine node requires the following:

This guide focuses on the first action.

## Admin server
## Admin Server

Flow nodes have an admin server which exposes a simple REST API for interacting with the node.
See the [README](https://github.com/onflow/flow-go/blob/master/admin/README.md) for some useful examples.
It is disabled by default.

### Enable the admin server
### Enable the Admin Server

To enable to admin server,

Expand All @@ -58,7 +58,7 @@ This should return a json response message as below.

If you instead get a connection rejected message then it’s not configured correctly.

## Detecting a byzantine node
## Detecting a Byzantine Node

There are 2 general categories of byzantine attacks:
1. Safety attacks - are attacks where a node attempts to corrupt or modify the state of the
Expand Down Expand Up @@ -120,7 +120,7 @@ is not authorized to send:
}
```

### Identifying the source of malicious traffic
### Identifying the Source of Malicious Traffic

Most log messages include either the node ID or peer ID. Peer ID is the ID used to identify nodes on
by the libp2p library. Peer IDs are derived from the node's networking public key, so there is a 1:1
Expand All @@ -140,15 +140,15 @@ If you cannot find any log messages at the current log level, you may need to en
See the admin server's [README](https://github.com/onflow/flow-go/blob/master/admin/README.md) for
an example.

## Reporting the byzantine node
## Reporting the Byzantine Node

Report the suspicious node on Discord in the `#flow-validators-alerts` channel along with all the
evidence you have collected (log messages, other networking related metrics, etc).
This will alert other node operators who can review their nodes to corroborate the report. Using
evidence from multiple operators, a consensus can be reached about the suspicious node, and
appropriate action can be taken.

## Blocking a byzantine node
## Blocking a Byzantine Node

Once a consensus is reached about the suspicious node on Discord among the node operators, the
suspicious node can be blocked using the admin command.
Expand All @@ -162,7 +162,7 @@ curl localhost: 9002/admin/run_command \
After blocking the node, all traffic coming from the node will be rejected and you should only see
logs about reject messages and connections for that node ID.

## Unblocking a node
## Unblocking a Node

If you need to unblock a node, you can use the same command to remove the node ID from the blocklist.
Simply run it again with an empty list to remove all blocked nodes, or an existing list with the
Expand Down

1 comment on commit 2163720

@vercel
Copy link

@vercel vercel bot commented on 2163720 Jan 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.