From dd2b02e0158013f8571103d550bbc7c1249beaec Mon Sep 17 00:00:00 2001 From: Alex Ni <12097569+nialexsan@users.noreply.github.com> Date: Thu, 7 Sep 2023 14:13:12 -0400 Subject: [PATCH 1/6] building on flow improvements --- .gitignore | 8 ++--- .../flow-ecosystem.png | Bin .../flow-ft/index.md | 2 +- .../flow-nft/index.md | 3 ++ .../fungible-tokens.md | 0 .../token-allocation.png | Bin .../token-distribution.png | Bin .../flow-networks/accessing-mainnet.md | 2 +- docs/building-on-flow/flow-networks/index.md | 2 +- docs/building-on-flow/network-information.md | 5 --- .../nodes/access-api-rate-limits.mdx | 0 .../{ => run-and-secure}/nodes/access-api.mdx | 30 +++++++++--------- .../nodes/archive-access-api.mdx | 4 +-- .../nodes/archive-api-rate-limits.mdx | 0 .../nodes/faq/_category_.json | 0 .../nodes/faq/backers.mdx | 6 ++-- .../nodes/faq/developers.mdx | 22 ++++++------- .../nodes/faq/operators.mdx | 16 +++++----- .../nodes/flow-port/index.md | 10 +++--- .../nodes/flow-port/machine-account.png | Bin .../nodes/flow-port/port-delegate-1.png | Bin .../nodes/flow-port/port-delegate-2.png | Bin .../nodes/flow-port/port-delegate-3.png | Bin .../nodes/flow-port/port-delegate-4.png | Bin .../nodes/flow-port/port-stake-0-00.png | Bin .../nodes/flow-port/port-stake-0-01.png | Bin .../nodes/flow-port/port-stake-0-02.png | Bin .../nodes/flow-port/port-stake-0-03.png | Bin .../nodes/flow-port/port-stake-0-04.png | Bin .../nodes/flow-port/port-stake-0-05.png | Bin .../nodes/flow-port/port-stake-0-06.png | Bin .../nodes/flow-port/port-stake-1.png | Bin .../nodes/flow-port/port-stake-2.png | Bin .../nodes/flow-port/port-stake-3.png | Bin .../nodes/flow-port/port-stake-4.png | Bin .../nodes/flow-port/port-stake-5.png | Bin .../nodes/flow-port/port-stake-6.png | Bin .../nodes/flow-port/staking-collection.png | Bin .../nodes/flow-port/staking-guide.md | 2 +- .../{ => run-and-secure}/nodes/index.md | 0 .../nodes/node-operation/FAQ.md | 4 +-- .../nodes/node-operation/Flownodesdiagram.jpg | Bin .../node-operation/Selected_FlowPort.png | Bin .../nodes/node-operation/Staked_FlowPort.png | Bin .../node-operation/Unstaked_FlowPort.png | Bin .../nodes/node-operation/_category_.json | 0 .../nodes/node-operation/access-node-setup.md | 8 ++--- .../byzantine-node-attack-response.mdx | 0 .../node-operation/choose_access_flowport.png | Bin .../db-encryption-existing-operator.mdx | 0 .../node-operation/flow-architecture.png | Bin .../node-operation/guides/_category_.json | 0 .../guides/genesis-bootstrap.mdx | 2 +- .../node-operation/guides/spork-practice.mdx | 0 .../node-operation/guides/starting-nodes.mdx | 0 .../nodes/node-operation/index.md | 0 .../machine-existing-operator.mdx | 4 +-- .../nodes/node-operation/monitoring-nodes.mdx | 0 .../nodes/node-operation/node-bootstrap.mdx | 10 +++--- .../nodes/node-operation/node-migration.mdx | 2 +- .../node-operation/node-provisioning.mdx | 0 .../nodes/node-operation/node-roles.mdx | 0 .../nodes/node-operation/node-setup.mdx | 0 .../node_details_permissionless_an.png | Bin .../nodes/node-operation/observer-node.mdx | 2 +- .../nodes/node-operation/observer.png | Bin .../nodes/node-operation/past-sporks.mdx | 0 .../nodes/node-operation/spork.mdx | 0 ...action_register_node_permissionless_an.png | Bin .../nodes/node-operation/upcoming-sporks.mdx | 0 .../{ => run-and-secure}/nodes/slashing.mdx | 0 .../run-and-secure/run-node.md | 5 --- .../staking/06-technical-overview.mdx | 2 +- .../staking/11-machine-account.mdx | 4 +-- .../run-and-secure/staking/index.md | 2 +- .../building-on-flow/token-standards/index.md | 23 -------------- docs/cadence/measuring-time.mdx | 2 +- docs/concepts/accounts.md | 2 +- docs/concepts/blocks.md | 2 +- docs/concepts/collections.md | 2 +- docs/concepts/fees.md | 2 +- docs/concepts/scripts.md | 2 +- docs/concepts/transactions.md | 2 +- docs/guides/deploying/mainnet-deployment.mdx | 4 +-- docs/guides/launchToken.md | 2 +- docs/guides/runningNode.mdx | 4 +-- docs/references/index.md | 2 +- docs/tools/clients/fcl-js/api.md | 2 +- docs/tools/clients/fcl-js/sdk-guidelines.mdx | 2 +- docs/tools/toolchains/flow-cli/README.md | 4 --- docs/tutorials/DappArchitectures.mdx | 4 +-- src/data/data-sources.json | 4 +-- 92 files changed, 94 insertions(+), 128 deletions(-) rename docs/building-on-flow/{token-standards => core-contracts}/flow-ecosystem.png (100%) rename docs/building-on-flow/{token-standards => core-contracts}/flow-ft/index.md (99%) rename docs/building-on-flow/{token-standards => core-contracts}/flow-nft/index.md (99%) rename docs/building-on-flow/{token-standards => core-contracts}/fungible-tokens.md (100%) rename docs/building-on-flow/{token-standards => core-contracts}/token-allocation.png (100%) rename docs/building-on-flow/{token-standards => core-contracts}/token-distribution.png (100%) delete mode 100644 docs/building-on-flow/network-information.md rename docs/building-on-flow/{ => run-and-secure}/nodes/access-api-rate-limits.mdx (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/access-api.mdx (96%) rename docs/building-on-flow/{ => run-and-secure}/nodes/archive-access-api.mdx (97%) rename docs/building-on-flow/{ => run-and-secure}/nodes/archive-api-rate-limits.mdx (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/faq/_category_.json (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/faq/backers.mdx (84%) rename docs/building-on-flow/{ => run-and-secure}/nodes/faq/developers.mdx (93%) rename docs/building-on-flow/{ => run-and-secure}/nodes/faq/operators.mdx (94%) rename docs/building-on-flow/{ => run-and-secure}/nodes/flow-port/index.md (93%) rename docs/building-on-flow/{ => run-and-secure}/nodes/flow-port/machine-account.png (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/flow-port/port-delegate-1.png (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/flow-port/port-delegate-2.png (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/flow-port/port-delegate-3.png (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/flow-port/port-delegate-4.png (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/flow-port/port-stake-0-00.png (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/flow-port/port-stake-0-01.png (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/flow-port/port-stake-0-02.png (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/flow-port/port-stake-0-03.png (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/flow-port/port-stake-0-04.png (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/flow-port/port-stake-0-05.png (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/flow-port/port-stake-0-06.png (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/flow-port/port-stake-1.png (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/flow-port/port-stake-2.png (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/flow-port/port-stake-3.png (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/flow-port/port-stake-4.png (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/flow-port/port-stake-5.png (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/flow-port/port-stake-6.png (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/flow-port/staking-collection.png (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/flow-port/staking-guide.md (98%) rename docs/building-on-flow/{ => run-and-secure}/nodes/index.md (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/node-operation/FAQ.md (91%) rename docs/building-on-flow/{ => run-and-secure}/nodes/node-operation/Flownodesdiagram.jpg (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/node-operation/Selected_FlowPort.png (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/node-operation/Staked_FlowPort.png (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/node-operation/Unstaked_FlowPort.png (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/node-operation/_category_.json (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/node-operation/access-node-setup.md (96%) rename docs/building-on-flow/{ => run-and-secure}/nodes/node-operation/byzantine-node-attack-response.mdx (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/node-operation/choose_access_flowport.png (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/node-operation/db-encryption-existing-operator.mdx (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/node-operation/flow-architecture.png (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/node-operation/guides/_category_.json (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/node-operation/guides/genesis-bootstrap.mdx (99%) rename docs/building-on-flow/{ => run-and-secure}/nodes/node-operation/guides/spork-practice.mdx (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/node-operation/guides/starting-nodes.mdx (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/node-operation/index.md (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/node-operation/machine-existing-operator.mdx (96%) rename docs/building-on-flow/{ => run-and-secure}/nodes/node-operation/monitoring-nodes.mdx (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/node-operation/node-bootstrap.mdx (97%) rename docs/building-on-flow/{ => run-and-secure}/nodes/node-operation/node-migration.mdx (95%) rename docs/building-on-flow/{ => run-and-secure}/nodes/node-operation/node-provisioning.mdx (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/node-operation/node-roles.mdx (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/node-operation/node-setup.mdx (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/node-operation/node_details_permissionless_an.png (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/node-operation/observer-node.mdx (99%) rename docs/building-on-flow/{ => run-and-secure}/nodes/node-operation/observer.png (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/node-operation/past-sporks.mdx (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/node-operation/spork.mdx (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/node-operation/transaction_register_node_permissionless_an.png (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/node-operation/upcoming-sporks.mdx (100%) rename docs/building-on-flow/{ => run-and-secure}/nodes/slashing.mdx (100%) delete mode 100644 docs/building-on-flow/run-and-secure/run-node.md delete mode 100644 docs/building-on-flow/token-standards/index.md delete mode 100644 docs/tools/toolchains/flow-cli/README.md diff --git a/.gitignore b/.gitignore index fa6943ed8e..41433ca75a 100644 --- a/.gitignore +++ b/.gitignore @@ -26,10 +26,10 @@ yarn-error.log* /docs/unsorted .idea/ -docs/building-on-flow/token-standards/flow-ft/* -!docs/building-on-flow/token-standards/flow-ft/index.md -docs/building-on-flow/token-standards/flow-nft/* -!docs/building-on-flow/token-standards/flow-nft/index.md +docs/building-on-flow/core-contracts/flow-ft/* +!docs/building-on-flow/core-contracts/flow-ft/index.md +docs/building-on-flow/core-contracts/flow-nft/* +!docs/building-on-flow/core-contracts/flow-nft/index.md docs/.obsidian diff --git a/docs/building-on-flow/token-standards/flow-ecosystem.png b/docs/building-on-flow/core-contracts/flow-ecosystem.png similarity index 100% rename from docs/building-on-flow/token-standards/flow-ecosystem.png rename to docs/building-on-flow/core-contracts/flow-ecosystem.png diff --git a/docs/building-on-flow/token-standards/flow-ft/index.md b/docs/building-on-flow/core-contracts/flow-ft/index.md similarity index 99% rename from docs/building-on-flow/token-standards/flow-ft/index.md rename to docs/building-on-flow/core-contracts/flow-ft/index.md index 9fc2957543..60a4ca5151 100644 --- a/docs/building-on-flow/token-standards/flow-ft/index.md +++ b/docs/building-on-flow/core-contracts/flow-ft/index.md @@ -1,6 +1,6 @@ --- title: Fungible Token (FT) Standard -sidebar_position: 5 +sidebar_position: 1 --- This is a description of the Flow standard for fungible token contracts. It is meant to contain the minimum requirements to implement a safe, secure, easy to understand, and easy to use fungible token contract. It also includes an example implementation to show how a concrete smart contract would actually implement the interface. diff --git a/docs/building-on-flow/token-standards/flow-nft/index.md b/docs/building-on-flow/core-contracts/flow-nft/index.md similarity index 99% rename from docs/building-on-flow/token-standards/flow-nft/index.md rename to docs/building-on-flow/core-contracts/flow-nft/index.md index 38b8df78ad..e407fa2819 100644 --- a/docs/building-on-flow/token-standards/flow-nft/index.md +++ b/docs/building-on-flow/core-contracts/flow-nft/index.md @@ -1,3 +1,6 @@ +--- +sidebar_position: 1 +--- # Flow Non-Fungible Token (NFT) Standard This standard defines the minimum functionality required to diff --git a/docs/building-on-flow/token-standards/fungible-tokens.md b/docs/building-on-flow/core-contracts/fungible-tokens.md similarity index 100% rename from docs/building-on-flow/token-standards/fungible-tokens.md rename to docs/building-on-flow/core-contracts/fungible-tokens.md diff --git a/docs/building-on-flow/token-standards/token-allocation.png b/docs/building-on-flow/core-contracts/token-allocation.png similarity index 100% rename from docs/building-on-flow/token-standards/token-allocation.png rename to docs/building-on-flow/core-contracts/token-allocation.png diff --git a/docs/building-on-flow/token-standards/token-distribution.png b/docs/building-on-flow/core-contracts/token-distribution.png similarity index 100% rename from docs/building-on-flow/token-standards/token-distribution.png rename to docs/building-on-flow/core-contracts/token-distribution.png diff --git a/docs/building-on-flow/flow-networks/accessing-mainnet.md b/docs/building-on-flow/flow-networks/accessing-mainnet.md index db0c6f3f1d..e3a67e5fd1 100644 --- a/docs/building-on-flow/flow-networks/accessing-mainnet.md +++ b/docs/building-on-flow/flow-networks/accessing-mainnet.md @@ -26,7 +26,7 @@ func main() { ## Account creation -You can follow the [Flow Port account creation steps](../nodes/flow-port/index.md#blocto) to create a new mainnet account. +You can follow the [Flow Port account creation steps](../run-and-secure/nodes/flow-port/index.md#blocto) to create a new mainnet account. If you prefer watching a video, check out this tutorial: diff --git a/docs/building-on-flow/flow-networks/index.md b/docs/building-on-flow/flow-networks/index.md index 807836534d..6de12b6de0 100644 --- a/docs/building-on-flow/flow-networks/index.md +++ b/docs/building-on-flow/flow-networks/index.md @@ -1,6 +1,6 @@ --- title: Flow Networks -sidebar_position: 10 +sidebar_position: 2 --- # Flow Networks diff --git a/docs/building-on-flow/network-information.md b/docs/building-on-flow/network-information.md deleted file mode 100644 index 4d15ce01b3..0000000000 --- a/docs/building-on-flow/network-information.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -sidebar_position: 2 -title: Network information -description: ---- diff --git a/docs/building-on-flow/nodes/access-api-rate-limits.mdx b/docs/building-on-flow/run-and-secure/nodes/access-api-rate-limits.mdx similarity index 100% rename from docs/building-on-flow/nodes/access-api-rate-limits.mdx rename to docs/building-on-flow/run-and-secure/nodes/access-api-rate-limits.mdx diff --git a/docs/building-on-flow/nodes/access-api.mdx b/docs/building-on-flow/run-and-secure/nodes/access-api.mdx similarity index 96% rename from docs/building-on-flow/nodes/access-api.mdx rename to docs/building-on-flow/run-and-secure/nodes/access-api.mdx index 210fc3da5d..fdd4b92afb 100644 --- a/docs/building-on-flow/nodes/access-api.mdx +++ b/docs/building-on-flow/run-and-secure/nodes/access-api.mdx @@ -517,7 +517,7 @@ message AccountResponse { `ExecuteScriptAtLatestBlock` executes a read-only Cadence script against the latest sealed execution state. -This method can be used to read execution state from the blockchain. The script is executed on an execution node and the return value is encoded using the [JSON-Cadence data interchange format](../../cadence/json-cadence-spec.md). +This method can be used to read execution state from the blockchain. The script is executed on an execution node and the return value is encoded using the [JSON-Cadence data interchange format](../../../cadence/json-cadence-spec.md). ```proto rpc ExecuteScriptAtLatestBlock (ExecuteScriptAtLatestBlockRequest) returns (ExecuteScriptResponse) @@ -556,7 +556,7 @@ message ExecuteScriptResponse { `ExecuteScriptAtBlockID` executes a ready-only Cadence script against the execution state at the block with the given ID. -This method can be used to read account state from the blockchain. The script is executed on an execution node and the return value is encoded using the [JSON-Cadence data interchange format](../../cadence/json-cadence-spec.md). +This method can be used to read account state from the blockchain. The script is executed on an execution node and the return value is encoded using the [JSON-Cadence data interchange format](../../../cadence/json-cadence-spec.md). ```proto rpc ExecuteScriptAtBlockID (ExecuteScriptAtBlockIDRequest) returns (ExecuteScriptResponse) @@ -589,7 +589,7 @@ message ExecuteScriptResponse { `ExecuteScriptAtBlockHeight` executes a ready-only Cadence script against the execution state at the given block height. -This method can be used to read account state from the blockchain. The script is executed on an execution node and the return value is encoded using the [JSON-Cadence data interchange format](../../cadence/json-cadence-spec.md). +This method can be used to read account state from the blockchain. The script is executed on an execution node and the return value is encoded using the [JSON-Cadence data interchange format](../../../cadence/json-cadence-spec.md). ```proto rpc ExecuteScriptAtBlockHeight (ExecuteScriptAtBlockHeightRequest) returns (ExecuteScriptResponse) @@ -850,7 +850,7 @@ message Block { | block_seals | List of [block seals](#block-seal) | | signatures | BLS signatures of consensus nodes | -The detailed semantics of block formation are covered in the [block formation guide](../../concepts/blocks.md). +The detailed semantics of block formation are covered in the [block formation guide](../../../concepts/blocks.md). ## Block Header @@ -971,24 +971,24 @@ message TransactionSignature { | Field | Description | | ----------------------------- | ---------------------------------------------------------------------------------------------------- | | script | Raw source code for a Cadence script, encoded as UTF-8 bytes | -| arguments | Arguments passed to the Cadence script, encoded as [JSON-Cadence](../../cadence/json-cadence-spec.md) bytes | +| arguments | Arguments passed to the Cadence script, encoded as [JSON-Cadence](../../../cadence/json-cadence-spec.md) bytes | | reference_block_id | Block ID used to determine transaction expiry | | [proposal_key](#proposal-key) | Account key used to propose the transaction | | payer | Address of the payer account | | authorizers | Addresses of the transaction authorizers | | signatures | [Signatures](#transaction-signatures) from all signer accounts | -The detailed semantics of transaction creation, signing and submission are covered in the [transaction submission guide](../../concepts/transactions.md#signing-a-transaction). +The detailed semantics of transaction creation, signing and submission are covered in the [transaction submission guide](../../../concepts/transactions.md#signing-a-transaction). ### Proposal Key -The proposal key is used to specify a sequence number for the transaction. Sequence numbers are covered in more detail [here](../../concepts/transactions.md#sequence-numbers). +The proposal key is used to specify a sequence number for the transaction. Sequence numbers are covered in more detail [here](../../../concepts/transactions.md#sequence-numbers). | Field | Description | | --------------- | ------------------------------------------------------------------------------------ | | address | Address of proposer account | | key_id | ID of proposal key on the proposal account | -| sequence_number | [Sequence number](../../concepts/transactions.md#sequence-numbers) for the proposal key | +| sequence_number | [Sequence number](../../../concepts/transactions.md#sequence-numbers) for the proposal key | ### Transaction Signature @@ -1044,7 +1044,7 @@ message Account { The `code` and `contracts` fields contain the raw Cadence source code, encoded as UTF-8 bytes. -More information on accounts can be found [here](../../concepts/accounts.md). +More information on accounts can be found [here](../../../concepts/accounts.md). ### Account Key @@ -1066,13 +1066,13 @@ message AccountKey { | --------------- | --------------------------------------------------------------------------------------- | | id | Index of the key within the account, used as a unique identifier | | public_key | Public key encoded as bytes | -| sign_algo | [Signature algorithm](../../concepts/accounts.md#signature-and-hash-algorithms) | -| hash_algo | [Hash algorithm](../../concepts/accounts.md#signature-and-hash-algorithms) | -| weight | [Weight assigned to the key](../../concepts/accounts.md#account-keys) | -| sequence_number | [Sequence number for the key](../../concepts/transactions.md#sequence-numbers) | +| sign_algo | [Signature algorithm](../../../concepts/accounts.md#signature-and-hash-algorithms) | +| hash_algo | [Hash algorithm](../../../concepts/accounts.md#signature-and-hash-algorithms) | +| weight | [Weight assigned to the key](../../../concepts/accounts.md#account-keys) | +| sequence_number | [Sequence number for the key](../../../concepts/transactions.md#sequence-numbers) | | revoked | Flag indicating whether or not the key has been revoked | -More information on account keys, key weights and sequence numbers can be found [here](../../concepts/accounts.md). +More information on account keys, key weights and sequence numbers can be found [here](../../../concepts/accounts.md). ## Event @@ -1094,7 +1094,7 @@ message Event { | transaction_id | ID of the transaction the event was emitted from | | transaction_index | Zero-based index of the transaction within the block | | event_index | Zero-based index of the event within the transaction | -| payload | Event fields encoded as [JSON-Cadence values](../../cadence/json-cadence-spec.md) | +| payload | Event fields encoded as [JSON-Cadence values](../../../cadence/json-cadence-spec.md) | ## Execution Result diff --git a/docs/building-on-flow/nodes/archive-access-api.mdx b/docs/building-on-flow/run-and-secure/nodes/archive-access-api.mdx similarity index 97% rename from docs/building-on-flow/nodes/archive-access-api.mdx rename to docs/building-on-flow/run-and-secure/nodes/archive-access-api.mdx index f3de2c6dd8..e1361b5429 100644 --- a/docs/building-on-flow/nodes/archive-access-api.mdx +++ b/docs/building-on-flow/run-and-secure/nodes/archive-access-api.mdx @@ -71,7 +71,7 @@ message AccountResponse { `ExecuteScriptAtBlockID` executes a ready-only Cadence script against the execution state at the block with the given ID. -This method can be used to read account state from the blockchain. The script is executed on an execution node and the return value is encoded using the [JSON-Cadence data interchange format](../../cadence/json-cadence-spec.md). +This method can be used to read account state from the blockchain. The script is executed on an execution node and the return value is encoded using the [JSON-Cadence data interchange format](../../../cadence/json-cadence-spec.md). ```proto rpc ExecuteScriptAtBlockID (ExecuteScriptAtBlockIDRequest) returns (ExecuteScriptResponse) @@ -104,7 +104,7 @@ message ExecuteScriptResponse { `ExecuteScriptAtBlockHeight` executes a ready-only Cadence script against the execution state at the given block height. -This method can be used to read account state from the blockchain. The script is executed on an execution node and the return value is encoded using the [JSON-Cadence data interchange format](../../cadence/json-cadence-spec.md). +This method can be used to read account state from the blockchain. The script is executed on an execution node and the return value is encoded using the [JSON-Cadence data interchange format](../../../cadence/json-cadence-spec.md). ```proto rpc ExecuteScriptAtBlockHeight (ExecuteScriptAtBlockHeightRequest) returns (ExecuteScriptResponse) diff --git a/docs/building-on-flow/nodes/archive-api-rate-limits.mdx b/docs/building-on-flow/run-and-secure/nodes/archive-api-rate-limits.mdx similarity index 100% rename from docs/building-on-flow/nodes/archive-api-rate-limits.mdx rename to docs/building-on-flow/run-and-secure/nodes/archive-api-rate-limits.mdx diff --git a/docs/building-on-flow/nodes/faq/_category_.json b/docs/building-on-flow/run-and-secure/nodes/faq/_category_.json similarity index 100% rename from docs/building-on-flow/nodes/faq/_category_.json rename to docs/building-on-flow/run-and-secure/nodes/faq/_category_.json diff --git a/docs/building-on-flow/nodes/faq/backers.mdx b/docs/building-on-flow/run-and-secure/nodes/faq/backers.mdx similarity index 84% rename from docs/building-on-flow/nodes/faq/backers.mdx rename to docs/building-on-flow/run-and-secure/nodes/faq/backers.mdx index e3b491713e..e1ea2cfbc4 100644 --- a/docs/building-on-flow/nodes/faq/backers.mdx +++ b/docs/building-on-flow/run-and-secure/nodes/faq/backers.mdx @@ -16,7 +16,7 @@ Once you complete a successful staking or delegation request, your tokens are se ## Is it possible to add multiple public keys to a given account/address so that it can be controlled by more than one private key? -Yes, accounts support multiple, weighted keys, [here](../../../cadence/language/accounts.mdx) +Yes, accounts support multiple, weighted keys, [here](../../../../cadence/language/accounts.mdx) using `AuthAccount`’s `fun addPublicKey(_ publicKey: [UInt8])`and 
`fun removePublicKey(_ index: Int)` functions. ## How do keys and accounts work on Flow? @@ -25,8 +25,8 @@ Accounts are created with associated keys. There can be multiple keys on an acco FLOW supports a variety of signature schemes for adding keys to an account. -Details: [concepts/accounts-and-keys](../../../concepts/accounts.md) +Details: [concepts/accounts-and-keys](../../../../concepts/accounts.md) ## How do I create a Flow account if I do not have a service account? -Instructions to generate an address are here: [flow-go-sdk/creating-accounts](../../../tools/clients/flow-go-sdk/index.mdx#create-accounts). You don't need a service account. +Instructions to generate an address are here: [flow-go-sdk/creating-accounts](../../../../tools/clients/flow-go-sdk/index.mdx#create-accounts). You don't need a service account. diff --git a/docs/building-on-flow/nodes/faq/developers.mdx b/docs/building-on-flow/run-and-secure/nodes/faq/developers.mdx similarity index 93% rename from docs/building-on-flow/nodes/faq/developers.mdx rename to docs/building-on-flow/run-and-secure/nodes/faq/developers.mdx index 44b5766faf..576add7efc 100644 --- a/docs/building-on-flow/nodes/faq/developers.mdx +++ b/docs/building-on-flow/run-and-secure/nodes/faq/developers.mdx @@ -37,7 +37,7 @@ You can query historical data and fetch contract code using the SDKs. Flow allows you to actively query the state of the blockchain using scripts written in the Cadence programming language. You can find out more about Cadence here: -[cadence](../../../cadence/intro.md) +[cadence](../../../../cadence/intro.md) Running scripts and parsing their output is supported by the SDKs. @@ -105,11 +105,11 @@ Events are implemented within Flow smart contracts using the Cadence programming You can find out more about events in Cadence here: -[cadence/language/events/](../../../cadence/language/events.md) +[cadence/language/events/](../../../../cadence/language/events.md) As an example of the kinds of information events can contain, see the documentation of the events that the staking protocol emits: -[staking/events](../../../building-on-flow/run-and-secure/staking/07-staking-scripts-events.md) +[staking/events](../../staking/07-staking-scripts-events.md) ### Consuming Events @@ -171,7 +171,7 @@ Starting on October 16, 2021 at 7:30am PT (2:30pm UTC), there will be a flat fee ## How can I deploy a contract? -To deploy a contract, please follow the steps outlined in the [Dapp Deployment guide](../../../tools/toolchains/flow-cli/accounts/account-add-contract.md). +To deploy a contract, please follow the steps outlined in the [Dapp Deployment guide](../../../../tools/toolchains/flow-cli/accounts/account-add-contract.md). ## How can I create my first account for mainnet? @@ -179,19 +179,19 @@ New accounts can be created using Flow Port. You can [follow these guidelines to ## How can I deploy a contract to mainnet? -Please review the [Dapp Deployment guide](../../../tools/toolchains/flow-cli/accounts/account-add-contract.md) for all details. +Please review the [Dapp Deployment guide](../../../../tools/toolchains/flow-cli/accounts/account-add-contract.md) for all details. ## Is there a testnet/devnet? -There is an access node for you to develop against on the testnet/devnet. You can learn more about it [here](../../flow-networks) +There is an access node for you to develop against on the testnet/devnet. You can learn more about it [here](../../../flow-networks) ## Is there a public node? -Yes, an access node is publicly accessible to submit transactions and read data from the blockchain. If you’d like to access the devnet access node to build against, you can do so [here](../../flow-networks/accessing-testnet.md#accessing-flow-testnet) +Yes, an access node is publicly accessible to submit transactions and read data from the blockchain. If you’d like to access the devnet access node to build against, you can do so [here](../../../flow-networks/accessing-testnet.md#accessing-flow-testnet) ## Is it possible to add multiple public keys to a given account/address so that it can be controlled by more than one private key? -Yes, accounts support multiple, weighted keys, [here](../../../cadence/language/accounts.mdx) +Yes, accounts support multiple, weighted keys, [here](../../../../cadence/language/accounts.mdx) using `AuthAccount`’s `fun addPublicKey(_ publicKey: [UInt8])`and 
`fun removePublicKey(_ index: Int)` functions. ## How do keys and accounts work on Flow? @@ -200,7 +200,7 @@ Accounts are created with associated keys. There can be multiple keys on an acco FLOW supports a variety of signature schemes for adding keys to an account. -Details: [concepts/accounts-and-keys](../../../concepts/accounts.md) +Details: [concepts/accounts-and-keys](../../../../concepts/accounts.md) ## How can I see what Fungible-Tokens an account has? @@ -216,11 +216,11 @@ Flow doesn't yet provide functionality to inspect all of the resources on an acc ## How do I create a Flow account if I do not have a service account? -Instructions to generate an address are here: [flow-go-sdk#create-accounts](../../../tools/clients/flow-go-sdk/index.mdx#create-accounts). You don't need a service account. +Instructions to generate an address are here: [flow-go-sdk#create-accounts](../../../../tools/clients/flow-go-sdk/index.mdx#create-accounts). You don't need a service account. ## Is there a tutorial about how to access flow testnet? From scratch, getting testnet, Flow token etc..? -Yes: [testnet-deployment](../../../guides/deploying/testnet-deployment) +Yes: [testnet-deployment](../../../../guides/deploying/testnet-deployment.mdx) ## Can you query events between a block range? diff --git a/docs/building-on-flow/nodes/faq/operators.mdx b/docs/building-on-flow/run-and-secure/nodes/faq/operators.mdx similarity index 94% rename from docs/building-on-flow/nodes/faq/operators.mdx rename to docs/building-on-flow/run-and-secure/nodes/faq/operators.mdx index ee636ea9b1..0f9cb018b6 100644 --- a/docs/building-on-flow/nodes/faq/operators.mdx +++ b/docs/building-on-flow/run-and-secure/nodes/faq/operators.mdx @@ -41,7 +41,7 @@ You can query historical data and fetch contract code using the SDKs. Flow allows you to actively query the state of the blockchain using scripts written in the Cadence programming language. You can find out more about Cadence here: -[cadence](../../../cadence/intro.md) +[cadence](../../../../cadence/intro.md) Running scripts and parsing their output is supported by the SDKs. @@ -109,11 +109,11 @@ Events are implemented within Flow smart contracts using the Cadence programming You can find out more about events in Cadence here: -[cadence/language/events/](../../../cadence/language/events.md) +[cadence/language/events/](../../../../cadence/language/events.md) As an example of the kinds of information events can contain, see the documentation of the events that the staking protocol emits: -[staking/events](../../../building-on-flow/run-and-secure/staking/07-staking-scripts-events.md) +[staking/events](../../staking/07-staking-scripts-events.md) ### Consuming Events @@ -162,15 +162,15 @@ No errors should be considered acceptable. If there are errors that are constant ## Is there a testnet/devnet? -There is an access node for you to develop against on the testnet/devnet. You can learn more about it here [testnet-deployment#accessing-flow-testnet](../../../guides/deploying/testnet-deployment.mdx#accessing-flow-testnet) +There is an access node for you to develop against on the testnet/devnet. You can learn more about it here [testnet-deployment#accessing-flow-testnet](../../../../guides/deploying/testnet-deployment.mdx#accessing-flow-testnet) ## Is there a public node? -Yes, an access node is publicly accessible to submit transactions and read data from the blockchain. If you’d like to access the devnet access node to build against, you can do so [here](../../flow-networks/accessing-testnet.md) +Yes, an access node is publicly accessible to submit transactions and read data from the blockchain. If you’d like to access the devnet access node to build against, you can do so [here](../../../flow-networks/accessing-testnet.md) ## Is it possible to add multiple public keys to a given account/address so that it can be controlled by more than one private key? -Yes, accounts support multiple, weighted keys, [here](../../../cadence/language/accounts.mdx) +Yes, accounts support multiple, weighted keys, [here](../../../../cadence/language/accounts.mdx) using `AuthAccount`’s `fun addPublicKey(_ publicKey: [UInt8])`and 
`fun removePublicKey(_ index: Int)` functions. ## How do keys and accounts work on Flow? @@ -179,11 +179,11 @@ Accounts are created with associated keys. There can be multiple keys on an acco FLOW supports a variety of signature schemes for adding keys to an account. -Details: [concepts/accounts-and-keys](../../../concepts/accounts.md) +Details: [concepts/accounts-and-keys](../../../../concepts/accounts.md) ## How do I create a Flow account if I do not have a service account? -Instructions to generate an address are here: [flow-go-sdk#create-accounts](../../../tools/clients/flow-go-sdk/index.mdx#create-accounts). You don't need a service account. +Instructions to generate an address are here: [flow-go-sdk#create-accounts](../../../../tools/clients/flow-go-sdk/index.mdx#create-accounts). You don't need a service account. ## Can you query events between a block range? diff --git a/docs/building-on-flow/nodes/flow-port/index.md b/docs/building-on-flow/run-and-secure/nodes/flow-port/index.md similarity index 93% rename from docs/building-on-flow/nodes/flow-port/index.md rename to docs/building-on-flow/run-and-secure/nodes/flow-port/index.md index a43ee14d87..c2bc0f2f6f 100644 --- a/docs/building-on-flow/nodes/flow-port/index.md +++ b/docs/building-on-flow/run-and-secure/nodes/flow-port/index.md @@ -75,14 +75,14 @@ So you have decided you want to be a part of the Flow Network. Welcome! You are If you are using a custody provider who controls your account and private keys for you, such as Kraken, Finoa, or Coinlist, they all have different policies and processes for what you need to do to stake your tokens, the rewards you receive, and the fees that they take from your staking rewards. ### Starting a Manual Staking Transaction - 1. You need to have FLOW in order to stake. Please see the [FLOW Token](../../core-contracts/03-flow-token.md) reference for information on how to become a FLOW holder. + 1. You need to have FLOW in order to stake. Please see the [FLOW Token](../../../core-contracts/03-flow-token.md) reference for information on how to become a FLOW holder. 2. Once you have FLOW tokens in your account, you can start staking through [Flow Port](https://port.onflow.org/) or, if applicable, with your [custody provider](#staking-via-a-custody-provider). 3. If you are using Flow Port, log-in with your Flow account address and navigate to the Stake/Delegate page. See the Manual Staking/Delegating section below for more information about what to do next. ### Manual Staking/Delegating -If you are not using a custody provider, there is more responsibility that you have to accept, because you have complete control of your tokens. You need to ensure that you are well informed about the staking process and potentially node operation process because you will have to manage those on your own. Please read the [staking documentation](../../../building-on-flow/run-and-secure/staking/index.md) before continuing with this guide. +If you are not using a custody provider, there is more responsibility that you have to accept, because you have complete control of your tokens. You need to ensure that you are well informed about the staking process and potentially node operation process because you will have to manage those on your own. Please read the [staking documentation](../../staking/index.md) before continuing with this guide. Below are the various options you can choose. Please be aware, that at this time you can only have 1 stake or 1 delegate per account. This means that if you want to do multiple stakes, multiple delegates, or a mixture of stakes and delegates, you will need to create multiple accounts to do so. Please read them carefully as it will help you understand which route is best for your situation: - Staking your own Node: You are responsible for running and maintaining a Flow Node. You are also solely responsible for providing the minimum stake for your selected node (minimum 135,000 FLOW) and you have the technical know-how and bandwidth to run and operate a node in the Flow protocol. @@ -109,13 +109,13 @@ 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? - - 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](../../../building-on-flow/run-and-secure/staking/index.md#epochs) Date (which is currently weekly). - - During the next [Epoch](../../../building-on-flow/run-and-secure/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. + - 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](../../staking/index.md#epochs) Date (which is currently weekly). + - During the next [Epoch](../../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? - 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](../../../building-on-flow/run-and-secure/staking/index.md#epochs). + - 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](../../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. - Request to be unstaked from the network. The unstake request will sit in a pending status for two epochs. Once it is processed, the amount that has been unstaked will sit in your unstaked FLOW amount and can now be withdrawn or re-staked. - Change the node you are staked/delegated to. If your staked/delegated node has no FLOW actively staked and you have completely withdrawn all unstaked amounts and rewards associated with the node, then you can move your stake to a different node. Click on the `Change Node` button to initiate this process. Please note that this feature is only visible once you get your active stake/delegate into the appropriate status. diff --git a/docs/building-on-flow/nodes/flow-port/machine-account.png b/docs/building-on-flow/run-and-secure/nodes/flow-port/machine-account.png similarity index 100% rename from docs/building-on-flow/nodes/flow-port/machine-account.png rename to docs/building-on-flow/run-and-secure/nodes/flow-port/machine-account.png diff --git a/docs/building-on-flow/nodes/flow-port/port-delegate-1.png b/docs/building-on-flow/run-and-secure/nodes/flow-port/port-delegate-1.png similarity index 100% rename from docs/building-on-flow/nodes/flow-port/port-delegate-1.png rename to docs/building-on-flow/run-and-secure/nodes/flow-port/port-delegate-1.png diff --git a/docs/building-on-flow/nodes/flow-port/port-delegate-2.png b/docs/building-on-flow/run-and-secure/nodes/flow-port/port-delegate-2.png similarity index 100% rename from docs/building-on-flow/nodes/flow-port/port-delegate-2.png rename to docs/building-on-flow/run-and-secure/nodes/flow-port/port-delegate-2.png diff --git a/docs/building-on-flow/nodes/flow-port/port-delegate-3.png b/docs/building-on-flow/run-and-secure/nodes/flow-port/port-delegate-3.png similarity index 100% rename from docs/building-on-flow/nodes/flow-port/port-delegate-3.png rename to docs/building-on-flow/run-and-secure/nodes/flow-port/port-delegate-3.png diff --git a/docs/building-on-flow/nodes/flow-port/port-delegate-4.png b/docs/building-on-flow/run-and-secure/nodes/flow-port/port-delegate-4.png similarity index 100% rename from docs/building-on-flow/nodes/flow-port/port-delegate-4.png rename to docs/building-on-flow/run-and-secure/nodes/flow-port/port-delegate-4.png diff --git a/docs/building-on-flow/nodes/flow-port/port-stake-0-00.png b/docs/building-on-flow/run-and-secure/nodes/flow-port/port-stake-0-00.png similarity index 100% rename from docs/building-on-flow/nodes/flow-port/port-stake-0-00.png rename to docs/building-on-flow/run-and-secure/nodes/flow-port/port-stake-0-00.png diff --git a/docs/building-on-flow/nodes/flow-port/port-stake-0-01.png b/docs/building-on-flow/run-and-secure/nodes/flow-port/port-stake-0-01.png similarity index 100% rename from docs/building-on-flow/nodes/flow-port/port-stake-0-01.png rename to docs/building-on-flow/run-and-secure/nodes/flow-port/port-stake-0-01.png diff --git a/docs/building-on-flow/nodes/flow-port/port-stake-0-02.png b/docs/building-on-flow/run-and-secure/nodes/flow-port/port-stake-0-02.png similarity index 100% rename from docs/building-on-flow/nodes/flow-port/port-stake-0-02.png rename to docs/building-on-flow/run-and-secure/nodes/flow-port/port-stake-0-02.png diff --git a/docs/building-on-flow/nodes/flow-port/port-stake-0-03.png b/docs/building-on-flow/run-and-secure/nodes/flow-port/port-stake-0-03.png similarity index 100% rename from docs/building-on-flow/nodes/flow-port/port-stake-0-03.png rename to docs/building-on-flow/run-and-secure/nodes/flow-port/port-stake-0-03.png diff --git a/docs/building-on-flow/nodes/flow-port/port-stake-0-04.png b/docs/building-on-flow/run-and-secure/nodes/flow-port/port-stake-0-04.png similarity index 100% rename from docs/building-on-flow/nodes/flow-port/port-stake-0-04.png rename to docs/building-on-flow/run-and-secure/nodes/flow-port/port-stake-0-04.png diff --git a/docs/building-on-flow/nodes/flow-port/port-stake-0-05.png b/docs/building-on-flow/run-and-secure/nodes/flow-port/port-stake-0-05.png similarity index 100% rename from docs/building-on-flow/nodes/flow-port/port-stake-0-05.png rename to docs/building-on-flow/run-and-secure/nodes/flow-port/port-stake-0-05.png diff --git a/docs/building-on-flow/nodes/flow-port/port-stake-0-06.png b/docs/building-on-flow/run-and-secure/nodes/flow-port/port-stake-0-06.png similarity index 100% rename from docs/building-on-flow/nodes/flow-port/port-stake-0-06.png rename to docs/building-on-flow/run-and-secure/nodes/flow-port/port-stake-0-06.png diff --git a/docs/building-on-flow/nodes/flow-port/port-stake-1.png b/docs/building-on-flow/run-and-secure/nodes/flow-port/port-stake-1.png similarity index 100% rename from docs/building-on-flow/nodes/flow-port/port-stake-1.png rename to docs/building-on-flow/run-and-secure/nodes/flow-port/port-stake-1.png diff --git a/docs/building-on-flow/nodes/flow-port/port-stake-2.png b/docs/building-on-flow/run-and-secure/nodes/flow-port/port-stake-2.png similarity index 100% rename from docs/building-on-flow/nodes/flow-port/port-stake-2.png rename to docs/building-on-flow/run-and-secure/nodes/flow-port/port-stake-2.png diff --git a/docs/building-on-flow/nodes/flow-port/port-stake-3.png b/docs/building-on-flow/run-and-secure/nodes/flow-port/port-stake-3.png similarity index 100% rename from docs/building-on-flow/nodes/flow-port/port-stake-3.png rename to docs/building-on-flow/run-and-secure/nodes/flow-port/port-stake-3.png diff --git a/docs/building-on-flow/nodes/flow-port/port-stake-4.png b/docs/building-on-flow/run-and-secure/nodes/flow-port/port-stake-4.png similarity index 100% rename from docs/building-on-flow/nodes/flow-port/port-stake-4.png rename to docs/building-on-flow/run-and-secure/nodes/flow-port/port-stake-4.png diff --git a/docs/building-on-flow/nodes/flow-port/port-stake-5.png b/docs/building-on-flow/run-and-secure/nodes/flow-port/port-stake-5.png similarity index 100% rename from docs/building-on-flow/nodes/flow-port/port-stake-5.png rename to docs/building-on-flow/run-and-secure/nodes/flow-port/port-stake-5.png diff --git a/docs/building-on-flow/nodes/flow-port/port-stake-6.png b/docs/building-on-flow/run-and-secure/nodes/flow-port/port-stake-6.png similarity index 100% rename from docs/building-on-flow/nodes/flow-port/port-stake-6.png rename to docs/building-on-flow/run-and-secure/nodes/flow-port/port-stake-6.png diff --git a/docs/building-on-flow/nodes/flow-port/staking-collection.png b/docs/building-on-flow/run-and-secure/nodes/flow-port/staking-collection.png similarity index 100% rename from docs/building-on-flow/nodes/flow-port/staking-collection.png rename to docs/building-on-flow/run-and-secure/nodes/flow-port/staking-collection.png diff --git a/docs/building-on-flow/nodes/flow-port/staking-guide.md b/docs/building-on-flow/run-and-secure/nodes/flow-port/staking-guide.md similarity index 98% rename from docs/building-on-flow/nodes/flow-port/staking-guide.md rename to docs/building-on-flow/run-and-secure/nodes/flow-port/staking-guide.md index 78c49a865a..7e403deacb 100644 --- a/docs/building-on-flow/nodes/flow-port/staking-guide.md +++ b/docs/building-on-flow/run-and-secure/nodes/flow-port/staking-guide.md @@ -4,7 +4,7 @@ title: Flow Port Staking Guide This guide provides step-by-step instructions for using the Flow Port to stake your FLOW tokens and start earning rewards. Currently, Flow Port only supports staking or delegating using tokens held in Blocto or Ledger wallets. -If you're new to the concepts of staking and delegating you can [read this guide](../../../building-on-flow/run-and-secure/staking/index.md) to learn more. +If you're new to the concepts of staking and delegating you can [read this guide](../../staking/index.md) to learn more. ## First Step diff --git a/docs/building-on-flow/nodes/index.md b/docs/building-on-flow/run-and-secure/nodes/index.md similarity index 100% rename from docs/building-on-flow/nodes/index.md rename to docs/building-on-flow/run-and-secure/nodes/index.md diff --git a/docs/building-on-flow/nodes/node-operation/FAQ.md b/docs/building-on-flow/run-and-secure/nodes/node-operation/FAQ.md similarity index 91% rename from docs/building-on-flow/nodes/node-operation/FAQ.md rename to docs/building-on-flow/run-and-secure/nodes/node-operation/FAQ.md index 3145befd5f..56fc562766 100644 --- a/docs/building-on-flow/nodes/node-operation/FAQ.md +++ b/docs/building-on-flow/run-and-secure/nodes/node-operation/FAQ.md @@ -27,7 +27,7 @@ Please follow the instructions provided here: [Monitoring nodes](./monitoring-no ### Can I bootstrap and run a node at any time? Flow allows nodes to join/leave the network each time a new epoch begins (roughly once per week). -See [Staking & Epochs](../../../building-on-flow/run-and-secure/staking/index.md#epochs) for general information and [Node Setup](./node-bootstrap.mdx#timing) for a guide to running a new node. +See [Staking & Epochs](../../staking/index.md#epochs) for general information and [Node Setup](./node-bootstrap.mdx#timing) for a guide to running a new node. ### Would it hurt the network to have a node that constantly spins up and down? @@ -54,7 +54,7 @@ More on this [here](./node-migration.mdx) ### Where can I find how many nodes are currently running Flow? -If you are running a node, then you most definitely have this information on your node in the file `/public-root-information/node-infos.pub.json`. If you are not running a node, you can find this information by using a Cadence script to query the [Staking Smart Contract](../../core-contracts/06-staking-contract-reference.md) (or check [Flowscan](https://flowscan.org/staking/overview)) +If you are running a node, then you most definitely have this information on your node in the file `/public-root-information/node-infos.pub.json`. If you are not running a node, you can find this information by using a Cadence script to query the [Staking Smart Contract](../../../core-contracts/06-staking-contract-reference.md) (or check [Flowscan](https://flowscan.org/staking/overview)) ### Why do I need to update my node's ulimit? diff --git a/docs/building-on-flow/nodes/node-operation/Flownodesdiagram.jpg b/docs/building-on-flow/run-and-secure/nodes/node-operation/Flownodesdiagram.jpg similarity index 100% rename from docs/building-on-flow/nodes/node-operation/Flownodesdiagram.jpg rename to docs/building-on-flow/run-and-secure/nodes/node-operation/Flownodesdiagram.jpg diff --git a/docs/building-on-flow/nodes/node-operation/Selected_FlowPort.png b/docs/building-on-flow/run-and-secure/nodes/node-operation/Selected_FlowPort.png similarity index 100% rename from docs/building-on-flow/nodes/node-operation/Selected_FlowPort.png rename to docs/building-on-flow/run-and-secure/nodes/node-operation/Selected_FlowPort.png diff --git a/docs/building-on-flow/nodes/node-operation/Staked_FlowPort.png b/docs/building-on-flow/run-and-secure/nodes/node-operation/Staked_FlowPort.png similarity index 100% rename from docs/building-on-flow/nodes/node-operation/Staked_FlowPort.png rename to docs/building-on-flow/run-and-secure/nodes/node-operation/Staked_FlowPort.png diff --git a/docs/building-on-flow/nodes/node-operation/Unstaked_FlowPort.png b/docs/building-on-flow/run-and-secure/nodes/node-operation/Unstaked_FlowPort.png similarity index 100% rename from docs/building-on-flow/nodes/node-operation/Unstaked_FlowPort.png rename to docs/building-on-flow/run-and-secure/nodes/node-operation/Unstaked_FlowPort.png diff --git a/docs/building-on-flow/nodes/node-operation/_category_.json b/docs/building-on-flow/run-and-secure/nodes/node-operation/_category_.json similarity index 100% rename from docs/building-on-flow/nodes/node-operation/_category_.json rename to docs/building-on-flow/run-and-secure/nodes/node-operation/_category_.json diff --git a/docs/building-on-flow/nodes/node-operation/access-node-setup.md b/docs/building-on-flow/run-and-secure/nodes/node-operation/access-node-setup.md similarity index 96% rename from docs/building-on-flow/nodes/node-operation/access-node-setup.md rename to docs/building-on-flow/run-and-secure/nodes/node-operation/access-node-setup.md index efcb2c50d5..04ebcf36ef 100644 --- a/docs/building-on-flow/nodes/node-operation/access-node-setup.md +++ b/docs/building-on-flow/run-and-secure/nodes/node-operation/access-node-setup.md @@ -21,7 +21,7 @@ Chain analytics, audit and exploration applications can run such an access node New nodes are able to join the network each time a new epoch begins. An epoch is a period of time (approximately one week) when the node operators in the network are constant. At epoch boundaries, newly staked node operators are able to join the network and existing node operators which have unstaked may exit the network. -You can read more about epochs [here](../../../building-on-flow/run-and-secure/staking/03-schedule.mdx). +You can read more about epochs [here](../../staking//03-schedule.mdx). In order to join the network at epoch N+1, the access node **must** be registered with at least 100 FLOW staked prior to the end of epoch N's Staking Auction Phase. @@ -29,7 +29,7 @@ In order to join the network at epoch N+1, the access node **must** be registere Currently on mainnet, the staking auction starts every Wednesday at around 20:00 UTC and ends on the next Wednesday at around 12:00 UTC. Since this deadline may shift slightly from epoch to epoch, we recommend the node be staked by _Wednesday, 8:00 UTC_ to be able to join the network in the next epoch. -Confirmation of a new node's inclusion in epoch N+1 is included in the [`EpochSetup` event](../../../building-on-flow/run-and-secure/staking/05-epoch-scripts-events.md#epochsetup). +Confirmation of a new node's inclusion in epoch N+1 is included in the [`EpochSetup` event](../../staking//05-epoch-scripts-events.md#epochsetup). ![Flow Epoch Schedule](https://storage.googleapis.com/flow-resources/documentation-assets/epoch-startup-order.png) @@ -140,7 +140,7 @@ e737ec6efbd26ef43bf676911cdc5a11ba15fc6562d05413e6589fccdd6c06d5 You need to now register the node on chain by staking the node via [Flow Port](https://port.onflow.org/). [Here](../flow-port/staking-guide.md) is a guide on how to use Flow port if you are not familiar with it. -If you are staking via a custody provider or would like to directly submit a staking transaction instead follow this [guide](../../../building-on-flow/run-and-secure/staking/index.md#how-do-i-stake). +If you are staking via a custody provider or would like to directly submit a staking transaction instead follow this [guide](../../staking//index.md#how-do-i-stake). Fund you Flow account with at least 100.01 FLOW tokens, which covers the required stake plus the storage deposit. @@ -232,7 +232,7 @@ Account staking info: ### Epoch setup event -Alternatively, if you can monitor events, look for [the epoch setup event](../../../building-on-flow/run-and-secure/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. +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 diff --git a/docs/building-on-flow/nodes/node-operation/byzantine-node-attack-response.mdx b/docs/building-on-flow/run-and-secure/nodes/node-operation/byzantine-node-attack-response.mdx similarity index 100% rename from docs/building-on-flow/nodes/node-operation/byzantine-node-attack-response.mdx rename to docs/building-on-flow/run-and-secure/nodes/node-operation/byzantine-node-attack-response.mdx diff --git a/docs/building-on-flow/nodes/node-operation/choose_access_flowport.png b/docs/building-on-flow/run-and-secure/nodes/node-operation/choose_access_flowport.png similarity index 100% rename from docs/building-on-flow/nodes/node-operation/choose_access_flowport.png rename to docs/building-on-flow/run-and-secure/nodes/node-operation/choose_access_flowport.png diff --git a/docs/building-on-flow/nodes/node-operation/db-encryption-existing-operator.mdx b/docs/building-on-flow/run-and-secure/nodes/node-operation/db-encryption-existing-operator.mdx similarity index 100% rename from docs/building-on-flow/nodes/node-operation/db-encryption-existing-operator.mdx rename to docs/building-on-flow/run-and-secure/nodes/node-operation/db-encryption-existing-operator.mdx diff --git a/docs/building-on-flow/nodes/node-operation/flow-architecture.png b/docs/building-on-flow/run-and-secure/nodes/node-operation/flow-architecture.png similarity index 100% rename from docs/building-on-flow/nodes/node-operation/flow-architecture.png rename to docs/building-on-flow/run-and-secure/nodes/node-operation/flow-architecture.png diff --git a/docs/building-on-flow/nodes/node-operation/guides/_category_.json b/docs/building-on-flow/run-and-secure/nodes/node-operation/guides/_category_.json similarity index 100% rename from docs/building-on-flow/nodes/node-operation/guides/_category_.json rename to docs/building-on-flow/run-and-secure/nodes/node-operation/guides/_category_.json diff --git a/docs/building-on-flow/nodes/node-operation/guides/genesis-bootstrap.mdx b/docs/building-on-flow/run-and-secure/nodes/node-operation/guides/genesis-bootstrap.mdx similarity index 99% rename from docs/building-on-flow/nodes/node-operation/guides/genesis-bootstrap.mdx rename to docs/building-on-flow/run-and-secure/nodes/node-operation/guides/genesis-bootstrap.mdx index d638b1b2da..c4a08dc448 100644 --- a/docs/building-on-flow/nodes/node-operation/guides/genesis-bootstrap.mdx +++ b/docs/building-on-flow/run-and-secure/nodes/node-operation/guides/genesis-bootstrap.mdx @@ -112,7 +112,7 @@ Join the [Flow discord server](https://chat.onflow.org) if you haven't already a For the Genesis Block, your nodes will start pre-staked, which means no action on your part is needed to get your nodes staked. - For more details on staking check the guide on [Staking and Rewards](../../../../building-on-flow/run-and-secure/staking/08-staking-rewards.md). + For more details on staking check the guide on [Staking and Rewards](../../../staking//08-staking-rewards.md). ## Receive Your Random Beacon Keys diff --git a/docs/building-on-flow/nodes/node-operation/guides/spork-practice.mdx b/docs/building-on-flow/run-and-secure/nodes/node-operation/guides/spork-practice.mdx similarity index 100% rename from docs/building-on-flow/nodes/node-operation/guides/spork-practice.mdx rename to docs/building-on-flow/run-and-secure/nodes/node-operation/guides/spork-practice.mdx diff --git a/docs/building-on-flow/nodes/node-operation/guides/starting-nodes.mdx b/docs/building-on-flow/run-and-secure/nodes/node-operation/guides/starting-nodes.mdx similarity index 100% rename from docs/building-on-flow/nodes/node-operation/guides/starting-nodes.mdx rename to docs/building-on-flow/run-and-secure/nodes/node-operation/guides/starting-nodes.mdx diff --git a/docs/building-on-flow/nodes/node-operation/index.md b/docs/building-on-flow/run-and-secure/nodes/node-operation/index.md similarity index 100% rename from docs/building-on-flow/nodes/node-operation/index.md rename to docs/building-on-flow/run-and-secure/nodes/node-operation/index.md diff --git a/docs/building-on-flow/nodes/node-operation/machine-existing-operator.mdx b/docs/building-on-flow/run-and-secure/nodes/node-operation/machine-existing-operator.mdx similarity index 96% rename from docs/building-on-flow/nodes/node-operation/machine-existing-operator.mdx rename to docs/building-on-flow/run-and-secure/nodes/node-operation/machine-existing-operator.mdx index ff6c9cbf11..57a44d336e 100644 --- a/docs/building-on-flow/nodes/node-operation/machine-existing-operator.mdx +++ b/docs/building-on-flow/run-and-secure/nodes/node-operation/machine-existing-operator.mdx @@ -4,8 +4,8 @@ sidebar_label: Machine Accounts for Existing Node Operators description: Instructions for existing Node Operators to follow to create a machine account for their collection or consensus nodes. --- -The [Flow Epoch Preparation Protocol](../../../building-on-flow/run-and-secure/staking/04-epoch-preparation.mdx) requires that -`collection` and `consensus` nodes use an automated [machine account](../../../building-on-flow/run-and-secure/staking/09-qc-dkg.mdx#machine-accounts) +The [Flow Epoch Preparation Protocol](../../staking/04-epoch-preparation.mdx) requires that +`collection` and `consensus` nodes use an automated [machine account](../../staking/09-qc-dkg.mdx#machine-accounts) to participate in important processes required to start the next epoch. (QC and DKG, respectively) Starting on Thursday, August 26th 2021, all collector and consensus nodes who register with Flow Port will diff --git a/docs/building-on-flow/nodes/node-operation/monitoring-nodes.mdx b/docs/building-on-flow/run-and-secure/nodes/node-operation/monitoring-nodes.mdx similarity index 100% rename from docs/building-on-flow/nodes/node-operation/monitoring-nodes.mdx rename to docs/building-on-flow/run-and-secure/nodes/node-operation/monitoring-nodes.mdx diff --git a/docs/building-on-flow/nodes/node-operation/node-bootstrap.mdx b/docs/building-on-flow/run-and-secure/nodes/node-operation/node-bootstrap.mdx similarity index 97% rename from docs/building-on-flow/nodes/node-operation/node-bootstrap.mdx rename to docs/building-on-flow/run-and-secure/nodes/node-operation/node-bootstrap.mdx index 1b9442ea61..62efa7052b 100644 --- a/docs/building-on-flow/nodes/node-operation/node-bootstrap.mdx +++ b/docs/building-on-flow/run-and-secure/nodes/node-operation/node-bootstrap.mdx @@ -11,7 +11,7 @@ This guide is for getting a new node staked and running on Flow other than a per New nodes are able to join the network each time a new epoch begins. In order to join the network at epoch N+1, the node must be registered with sufficient stake and authorized by the service account prior to the end of epoch N's Staking Auction Phase. -Confirmation of a new node's inclusion in epoch N+1 is included in the [`EpochSetup` event](../../../building-on-flow/run-and-secure/staking/05-epoch-scripts-events.md#epochsetup). +Confirmation of a new node's inclusion in epoch N+1 is included in the [`EpochSetup` event](../../staking/05-epoch-scripts-events.md#epochsetup). Nodes registered for epoch N+1 are able to participate in network communication on a limited basis starting in the `Epoch Setup Phase` of epoch N. @@ -20,7 +20,7 @@ Nodes registered for epoch N+1 are able to participate in network communication Once registered and confirmed to join the network at epoch N+1, the node must start up **before** epoch N+1 begins. * Verification & Access nodes may start up any time during the `Epoch Setup Phase`. * Consensus & Collection nodes must start up within the first **1000 views (~30mins)** -of the `Epoch Setup Phase` to participate in the [Epoch Preparation Protocol](../../../building-on-flow/run-and-secure/staking/04-epoch-preparation.mdx#phase-1-epoch-setup). +of the `Epoch Setup Phase` to participate in the [Epoch Preparation Protocol](../../staking/04-epoch-preparation.mdx#phase-1-epoch-setup). ## Step 1 - Run Genesis Bootstrap @@ -136,7 +136,7 @@ For all other node types this will not be needed. If you are running a collection and consensus node, you will have an additional private key file (`node-machine-account-key.priv.json`) which contains the private key for your node's machine account. You can learn more about machine -accounts [here](../../../building-on-flow/run-and-secure/staking/machine-account). +accounts [here](../../staking/machine-account). In Step 2 of this guide, when you submit a transaction to stake your node, you will need to provide the machine account public key, which can be found in the output of the previous `bootstrap key` command. @@ -250,7 +250,7 @@ Ensure you have configured your node using the [Node Setup guide](./node-setup). ### Confirming authorization -You can confirm your node's successful registration and authorization by executing a Cadence script to query the [Staking Contract](../../core-contracts/06-staking-contract-reference.md#contract). +You can confirm your node's successful registration and authorization by executing a Cadence script to query the [Staking Contract](../../../core-contracts/06-staking-contract-reference.md#contract). At the end of the `Staking Auction Phase`, the members of the Proposed Identity Table are confirmed as authorized participants in the next epoch. Therefore, if your node ID appears in the Proposed Identity Table during the `Staking Auction Phase`, your node will be a participant in the next epoch. @@ -291,7 +291,7 @@ Once the node has bootstrapped, these flags may be removed. ### Manually Provisioned Root Snapshot You can also provision the root snapshot file manually, then start the node without configuring Dynamic Startup. -A snapshot can be obtained from any Access Node using [Flow CLI](../../../tools/toolchains/flow-cli/index.md). +A snapshot can be obtained from any Access Node using [Flow CLI](../../../../tools/toolchains/flow-cli/index.md). ```shell RetrieveRootSnapshot flow snapshot save /path/to/root/snapshot --network mainnet ``` diff --git a/docs/building-on-flow/nodes/node-operation/node-migration.mdx b/docs/building-on-flow/run-and-secure/nodes/node-operation/node-migration.mdx similarity index 95% rename from docs/building-on-flow/nodes/node-operation/node-migration.mdx rename to docs/building-on-flow/run-and-secure/nodes/node-operation/node-migration.mdx index 9537d7d4ec..08775e2ec6 100644 --- a/docs/building-on-flow/nodes/node-operation/node-migration.mdx +++ b/docs/building-on-flow/run-and-secure/nodes/node-operation/node-migration.mdx @@ -43,6 +43,6 @@ If the node after migration will be using new staking or networking keys then it 3. Run the new node with the new keys and network address. It should be able to join the network at the next epoch (see [timing](./node-bootstrap.mdx#timing)) -Unstaking a node will result in the node [not earning rewards](../../../building-on-flow/run-and-secure/staking/06-technical-overview.mdx#staking-operations-available-to-all-stakers) for the next epoch. +Unstaking a node will result in the node [not earning rewards](../../staking/06-technical-overview.mdx#staking-operations-available-to-all-stakers) for the next epoch. Delegators to the old node will have their tokens unstaked automatically. They will also stop earning rewards unless they withdraw their unstaked tokens and delegate them to a different node. \ No newline at end of file diff --git a/docs/building-on-flow/nodes/node-operation/node-provisioning.mdx b/docs/building-on-flow/run-and-secure/nodes/node-operation/node-provisioning.mdx similarity index 100% rename from docs/building-on-flow/nodes/node-operation/node-provisioning.mdx rename to docs/building-on-flow/run-and-secure/nodes/node-operation/node-provisioning.mdx diff --git a/docs/building-on-flow/nodes/node-operation/node-roles.mdx b/docs/building-on-flow/run-and-secure/nodes/node-operation/node-roles.mdx similarity index 100% rename from docs/building-on-flow/nodes/node-operation/node-roles.mdx rename to docs/building-on-flow/run-and-secure/nodes/node-operation/node-roles.mdx diff --git a/docs/building-on-flow/nodes/node-operation/node-setup.mdx b/docs/building-on-flow/run-and-secure/nodes/node-operation/node-setup.mdx similarity index 100% rename from docs/building-on-flow/nodes/node-operation/node-setup.mdx rename to docs/building-on-flow/run-and-secure/nodes/node-operation/node-setup.mdx diff --git a/docs/building-on-flow/nodes/node-operation/node_details_permissionless_an.png b/docs/building-on-flow/run-and-secure/nodes/node-operation/node_details_permissionless_an.png similarity index 100% rename from docs/building-on-flow/nodes/node-operation/node_details_permissionless_an.png rename to docs/building-on-flow/run-and-secure/nodes/node-operation/node_details_permissionless_an.png diff --git a/docs/building-on-flow/nodes/node-operation/observer-node.mdx b/docs/building-on-flow/run-and-secure/nodes/node-operation/observer-node.mdx similarity index 99% rename from docs/building-on-flow/nodes/node-operation/observer-node.mdx rename to docs/building-on-flow/run-and-secure/nodes/node-operation/observer-node.mdx index 27b510c3b3..bda11002e4 100644 --- a/docs/building-on-flow/nodes/node-operation/observer-node.mdx +++ b/docs/building-on-flow/run-and-secure/nodes/node-operation/observer-node.mdx @@ -114,7 +114,7 @@ Primary key fingerprint: 7D23 8D1A E6D3 2A71 8ECD 8611 CB52 64F7 FD4C DD27 Subkey fingerprint: 40CD 9571 7AC4 63E6 1EE3 B285 B718 CA31 0EDB 542F ``` -Alternately, if you don't care about the blocks before the current block, you can request the current root-snapshot file via the [Flow CLI](../../../tools/toolchains/flow-cli/index.md). +Alternately, if you don't care about the blocks before the current block, you can request the current root-snapshot file via the [Flow CLI](../../../../tools/toolchains/flow-cli/index.md). For mainnet ```shell diff --git a/docs/building-on-flow/nodes/node-operation/observer.png b/docs/building-on-flow/run-and-secure/nodes/node-operation/observer.png similarity index 100% rename from docs/building-on-flow/nodes/node-operation/observer.png rename to docs/building-on-flow/run-and-secure/nodes/node-operation/observer.png diff --git a/docs/building-on-flow/nodes/node-operation/past-sporks.mdx b/docs/building-on-flow/run-and-secure/nodes/node-operation/past-sporks.mdx similarity index 100% rename from docs/building-on-flow/nodes/node-operation/past-sporks.mdx rename to docs/building-on-flow/run-and-secure/nodes/node-operation/past-sporks.mdx diff --git a/docs/building-on-flow/nodes/node-operation/spork.mdx b/docs/building-on-flow/run-and-secure/nodes/node-operation/spork.mdx similarity index 100% rename from docs/building-on-flow/nodes/node-operation/spork.mdx rename to docs/building-on-flow/run-and-secure/nodes/node-operation/spork.mdx diff --git a/docs/building-on-flow/nodes/node-operation/transaction_register_node_permissionless_an.png b/docs/building-on-flow/run-and-secure/nodes/node-operation/transaction_register_node_permissionless_an.png similarity index 100% rename from docs/building-on-flow/nodes/node-operation/transaction_register_node_permissionless_an.png rename to docs/building-on-flow/run-and-secure/nodes/node-operation/transaction_register_node_permissionless_an.png diff --git a/docs/building-on-flow/nodes/node-operation/upcoming-sporks.mdx b/docs/building-on-flow/run-and-secure/nodes/node-operation/upcoming-sporks.mdx similarity index 100% rename from docs/building-on-flow/nodes/node-operation/upcoming-sporks.mdx rename to docs/building-on-flow/run-and-secure/nodes/node-operation/upcoming-sporks.mdx diff --git a/docs/building-on-flow/nodes/slashing.mdx b/docs/building-on-flow/run-and-secure/nodes/slashing.mdx similarity index 100% rename from docs/building-on-flow/nodes/slashing.mdx rename to docs/building-on-flow/run-and-secure/nodes/slashing.mdx diff --git a/docs/building-on-flow/run-and-secure/run-node.md b/docs/building-on-flow/run-and-secure/run-node.md deleted file mode 100644 index f4f6e20a5d..0000000000 --- a/docs/building-on-flow/run-and-secure/run-node.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Run a node \ No newline at end of file diff --git a/docs/building-on-flow/run-and-secure/staking/06-technical-overview.mdx b/docs/building-on-flow/run-and-secure/staking/06-technical-overview.mdx index 78487f6e7f..53622be49d 100644 --- a/docs/building-on-flow/run-and-secure/staking/06-technical-overview.mdx +++ b/docs/building-on-flow/run-and-secure/staking/06-technical-overview.mdx @@ -73,7 +73,7 @@ and democratically by all the stakers in the network. For a node to stake, node operators first need to generate their staking key, staking key proof-of-possesion, networking address, and networking key. -The [node operation guide](../../../building-on-flow/nodes/node-operation/index.md) +The [node operation guide](../../../building-on-flow/run-and-secure/nodes/node-operation/index.md) describes how to run a node and generate node information. To generate a node ID, simply hash the staking key. diff --git a/docs/building-on-flow/run-and-secure/staking/11-machine-account.mdx b/docs/building-on-flow/run-and-secure/staking/11-machine-account.mdx index 6d33b29d08..fdeafa947e 100644 --- a/docs/building-on-flow/run-and-secure/staking/11-machine-account.mdx +++ b/docs/building-on-flow/run-and-secure/staking/11-machine-account.mdx @@ -23,9 +23,9 @@ Currently Machine Accounts are required only for `collection` and `consensus` no #### Creation -For new node operators, Machine Accounts are created during the [staking process](../../../building-on-flow/nodes/flow-port/staking-guide.md) in Flow Port. +For new node operators, Machine Accounts are created during the [staking process](../../run-and-secure/nodes/flow-port/staking-guide.md) in Flow Port. For node operators who initially staked prior to the introduction of Machine Accounts, Machine Accounts can be -created for your staked nodes by following [this guide](../../../building-on-flow/nodes/node-operation/machine-existing-operator.mdx). +created for your staked nodes by following [this guide](../../run-and-secure/nodes/node-operation/machine-existing-operator.mdx). #### Funding diff --git a/docs/building-on-flow/run-and-secure/staking/index.md b/docs/building-on-flow/run-and-secure/staking/index.md index 63b9b46394..2a7ef5c5d9 100644 --- a/docs/building-on-flow/run-and-secure/staking/index.md +++ b/docs/building-on-flow/run-and-secure/staking/index.md @@ -139,7 +139,7 @@ is compatible with Flow Port. If you created your account using [Flow Port](https://port.onflow.org/), you can also stake and earn rewards using the Flow Port. -Follow this [step-by-step guide](../../../building-on-flow/nodes/flow-port/staking-guide.md) to stake using Flow Port. +Follow this [step-by-step guide](../nodes/flow-port/staking-guide.md) to stake using Flow Port. Flow Port currently supports staking as a node, delegating, and reward withdrawal using **Blocto**, **Ledger**, **Lilico**, and **NuFi** accounts / wallets. diff --git a/docs/building-on-flow/token-standards/index.md b/docs/building-on-flow/token-standards/index.md deleted file mode 100644 index c9c421a72a..0000000000 --- a/docs/building-on-flow/token-standards/index.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Token Standards -sidebar_position: 15 ---- - - This section is designed to provide you with comprehensive information and guidance on the various token standards available on the Flow blockchain. These standards establish a unified framework for developers, ensuring seamless interoperability and compatibility between tokens, applications, and wallets. - -## Overview -Flow is a fast, secure, and developer-friendly blockchain that supports the next generation of decentralized applications (dApps). One of the primary use cases for dApps is the creation, management, and exchange of digital tokens, which can represent anything from in-game items to digital art to cryptocurrencies. - -To facilitate this, the Flow community has developed a set of token standards that provide a consistent interface and structure for creating, transferring, and managing tokens on the Flow blockchain. These standards help ensure that developers can focus on building unique features and user experiences, rather than reinventing the wheel when it comes to basic token functionality. - -## Token Standards -In this documentation section, we'll cover the following Flow token standards: - -**Fungible Token Standard (FT)**: The FT is a specification for creating and managing fungible tokens, which are tokens with equal value and interchangeable. This standard is most commonly used for creating cryptocurrencies and other digital assets with uniform value. - -**Non-Fungible Token Standard (NFT)**: The NFT is a specification for creating and managing non-fungible tokens, which are unique and indivisible digital assets. This standard is used for creating digital art, in-game items, and other one-of-a-kind digital assets. - -## Getting Started -To begin exploring the Flow Token Standards documentation, navigate to the desired token standard using the sidebar on the left. Each standard's documentation includes an overview, detailed specification, sample code, and best practices to help you successfully implement and deploy tokens on the Flow blockchain. - -By adhering to these token standards, you'll ensure that your tokens are easily accessible and compatible with the broader Flow ecosystem, including wallets, marketplaces, and other dApps. \ No newline at end of file diff --git a/docs/cadence/measuring-time.mdx b/docs/cadence/measuring-time.mdx index 5aecd631b0..aa9616c670 100644 --- a/docs/cadence/measuring-time.mdx +++ b/docs/cadence/measuring-time.mdx @@ -26,7 +26,7 @@ and further optimizations are needed to achieve that. As of Feb 2021, the rate of block finalization on Mainnet is more than 0.5 blocks/s; with a standard deviation of ±0.1 blocks/s. Hence, a new block is finalized on average every 2 seconds. Note that block height only has a loose correlation with time, -as [the block rate naturally fluctuates](../building-on-flow/nodes/faq/operators.mdx#does-the-blockheight-go-up-1-every-second). +as [the block rate naturally fluctuates](../building-on-flow/run-and-secure/nodes/faq/operators.mdx#does-the-blockheight-go-up-1-every-second). In addition to the natural variation described above, there are several theoretical block production attacks that could skew this relationship even further. diff --git a/docs/concepts/accounts.md b/docs/concepts/accounts.md index 325b0e77ec..a3eed5d178 100644 --- a/docs/concepts/accounts.md +++ b/docs/concepts/accounts.md @@ -172,7 +172,7 @@ Find [more about the command in the CLI docs](../tools/toolchains/flow-cli/accou Accounts can be obtained from the access node APIs, currently, there are two gRPC and REST APIs. You can find more information about them here: -**gRPC API** [concepts/nodes/access-api#accounts](../building-on-flow/nodes/access-api.mdx#accounts) +**gRPC API** [concepts/nodes/access-api#accounts](../building-on-flow/run-and-secure/nodes/access-api.mdx#accounts) **REST API** [http-api#tag/Accounts](/http-api#tag/Accounts) diff --git a/docs/concepts/blocks.md b/docs/concepts/blocks.md index 474e5a4a59..34e2a1f6dc 100644 --- a/docs/concepts/blocks.md +++ b/docs/concepts/blocks.md @@ -63,7 +63,7 @@ Find [more about the command in the CLI docs](../tools/toolchains/flow-cli/get-f Blocks can be obtained from the access node APIs, currently, there are two gRPC and REST APIs. You can find more information about them here: -[**gRPC Block API**](../building-on-flow/nodes/access-api.mdx#blocks) +[**gRPC Block API**](../building-on-flow/run-and-secure/nodes/access-api.mdx#blocks) [**REST Block API**](/http-api#tag/Blocks) diff --git a/docs/concepts/collections.md b/docs/concepts/collections.md index 062a773d76..a01831fb1b 100644 --- a/docs/concepts/collections.md +++ b/docs/concepts/collections.md @@ -20,7 +20,7 @@ Find [more about the command in the CLI docs](../tools/toolchains/flow-cli/get-f Collections can be obtained from the access node APIs, currently, there are two gRPC and REST APIs. You can find more information about them here: -[**gRPC Collection API**](../building-on-flow/nodes/access-api.mdx#collections) +[**gRPC Collection API**](../building-on-flow/run-and-secure/nodes/access-api.mdx#collections) [**REST Collection API**](/http-api#tag/Collections) diff --git a/docs/concepts/fees.md b/docs/concepts/fees.md index 633c743ad9..c6f7e11293 100644 --- a/docs/concepts/fees.md +++ b/docs/concepts/fees.md @@ -355,7 +355,7 @@ There are several places to learn more about transaction fees: **When will the fee update go into effect?** -The updates were rolled out with the [Spork on April 6, 2022](../building-on-flow/nodes/node-operation/past-sporks.mdx#mainnet-17), and were enabled on [June 1st](https://forum.onflow.org/t/permissionless-contract-deployment-progress/2981) during the [weekly epoch transition](https://github.com/onflow/service-account/tree/main/transactions/set-execution-effort-weights/2022/jun-1). +The updates were rolled out with the [Spork on April 6, 2022](../building-on-flow/run-and-secure/nodes/node-operation/past-sporks.mdx#mainnet-17), and were enabled on [June 1st](https://forum.onflow.org/t/permissionless-contract-deployment-progress/2981) during the [weekly epoch transition](https://github.com/onflow/service-account/tree/main/transactions/set-execution-effort-weights/2022/jun-1). **Why are fees collected even when transactions fail?** diff --git a/docs/concepts/scripts.md b/docs/concepts/scripts.md index ad3f7cdc16..06df4ed091 100644 --- a/docs/concepts/scripts.md +++ b/docs/concepts/scripts.md @@ -46,7 +46,7 @@ Scripts can be run against previous blocks, allowing you to query historic data Scripts are executed by being submitted to the Access Node APIs. Currently, there’s support for two APIs: -[**gRPC Script API**](../building-on-flow/nodes/access-api.mdx#scripts) +[**gRPC Script API**](../building-on-flow/run-and-secure/nodes/access-api.mdx#scripts) [**REST Script API**](/http-api#tag/Scripts) diff --git a/docs/concepts/transactions.md b/docs/concepts/transactions.md index 8ed03b186d..fab0b9af43 100644 --- a/docs/concepts/transactions.md +++ b/docs/concepts/transactions.md @@ -376,7 +376,7 @@ A user can define their own transactions or it can use already defined transacti Transactions can be submitted and obtained from the access node APIs, currently, there are two gRPC and REST APIs. You can find more information about them here: -[**gRPC Transaction API**](../building-on-flow/nodes/access-api.mdx#transactions) +[**gRPC Transaction API**](../building-on-flow/run-and-secure/nodes/access-api.mdx#transactions) [**REST Transaction API**](/http-api#tag/Transactions) diff --git a/docs/guides/deploying/mainnet-deployment.mdx b/docs/guides/deploying/mainnet-deployment.mdx index d837b1054a..4b58f37afa 100644 --- a/docs/guides/deploying/mainnet-deployment.mdx +++ b/docs/guides/deploying/mainnet-deployment.mdx @@ -46,6 +46,6 @@ Once all your contracts are deployed, you can visit [flow-view-source](https://f ### Sporks -Currently, **historical event data is not migrated between sporks,** so you'll need to design your application with this in mind. We recognize the usefulness of historical event data and plan on adding a means of accessing it in the near future. Past spork transactional data is available, [See Previous Spork Access Node Info](../../building-on-flow/nodes/node-operation/past-sporks) +Currently, **historical event data is not migrated between sporks,** so you'll need to design your application with this in mind. We recognize the usefulness of historical event data and plan on adding a means of accessing it in the near future. Past spork transactional data is available, [See Previous Spork Access Node Info](../../building-on-flow/run-and-secure/nodes/node-operation/past-sporks) -More Information on [Sporks](../../building-on-flow/nodes/node-operation/spork) \ No newline at end of file +More Information on [Sporks](../../building-on-flow/run-and-secure/nodes/node-operation/spork) \ No newline at end of file diff --git a/docs/guides/launchToken.md b/docs/guides/launchToken.md index 3d81fd1f50..7455db5ab4 100644 --- a/docs/guides/launchToken.md +++ b/docs/guides/launchToken.md @@ -9,7 +9,7 @@ sidebar_custom_props: ## Token Standards -It is important that Flow has [Token Standards](../building-on-flow/token-standards/index.md) for Fungible and Non-fungible tokens. This allows applications and other smart contracts to interact with your token in a predictable way. +It is important that Flow has Token Standards for [Fungible tokens](../building-on-flow/core-contracts/flow-ft/index.md) and [Non-fungible](../building-on-flow/core-contracts/flow-nft/index.md) tokens. This allows applications and other smart contracts to interact with your token in a predictable way. ### Non-Fungible Tokens (NFTs) diff --git a/docs/guides/runningNode.mdx b/docs/guides/runningNode.mdx index 80f55258dd..4983dade1a 100644 --- a/docs/guides/runningNode.mdx +++ b/docs/guides/runningNode.mdx @@ -37,11 +37,11 @@ There are community access nodes available to use, but they are rate limited. Al ## Setup -First make sure your node has the needed resources, here are the requirements, and step by step instructions to get up and running. [Light Node Documentation](../building-on-flow/nodes/node-operation/observer-node#running-an-observer-node). Light node can be run in a Docker container, it's available for testnet and mainnet. +First make sure your node has the needed resources, here are the requirements, and step by step instructions to get up and running. [Light Node Documentation](../building-on-flow/run-and-secure/nodes/node-operation/observer-node#running-an-observer-node). Light node can be run in a Docker container, it's available for testnet and mainnet. ## Running -For high usage applications on Flow, that have many user interactions, it might be necessary to run your own Light node. Here are the step by step instructions to [run an observer node](../building-on-flow/nodes/node-operation/observer-node#steps-to-run-an-observer-node). The benefit is, no staked FLOW and no register is required. Also, already mentioned you have untrottled access to the blockchain data. +For high usage applications on Flow, that have many user interactions, it might be necessary to run your own Light node. Here are the step by step instructions to [run an observer node](../building-on-flow/run-and-secure/nodes/node-operation/observer-node#steps-to-run-an-observer-node). The benefit is, no staked FLOW and no register is required. Also, already mentioned you have untrottled access to the blockchain data. diff --git a/docs/references/index.md b/docs/references/index.md index c4911688ec..0b65669094 100644 --- a/docs/references/index.md +++ b/docs/references/index.md @@ -17,7 +17,7 @@ Quick references to very helpful parts of developer documentation. Languages to ## Network Get Flow blockchain data from Access Nodes, both REST and gRPC endpoints are available. Get the current status of mainnet and testnet networks. -- [Flow Access API](../building-on-flow/nodes/access-api.mdx) +- [Flow Access API](../building-on-flow/run-and-secure/nodes/access-api.mdx) - [Mainnet](../building-on-flow/flow-networks/accessing-mainnet.md): `access.mainnet.nodes.onflow.org:9000` - [Testnet](../building-on-flow/flow-networks/accessing-testnet.md): `access.devnet.nodes.onflow.org:9000` - [Status Page](https://status.onflow.org/) - Network status page diff --git a/docs/tools/clients/fcl-js/api.md b/docs/tools/clients/fcl-js/api.md index 4b317a811c..e04d6b7ffd 100644 --- a/docs/tools/clients/fcl-js/api.md +++ b/docs/tools/clients/fcl-js/api.md @@ -742,7 +742,7 @@ The callback sent to `subscribe` will be called with a list of `authn` services. > 📣 **These methods can be used in browsers and NodeJS.** -These methods allows dapps to interact directly with the Flow blockchain via a set of functions that currently use the [Access Node API](../../../building-on-flow/nodes/access-api.mdx). +These methods allows dapps to interact directly with the Flow blockchain via a set of functions that currently use the [Access Node API](../../../building-on-flow/run-and-secure/nodes/access-api.mdx). ### Methods diff --git a/docs/tools/clients/fcl-js/sdk-guidelines.mdx b/docs/tools/clients/fcl-js/sdk-guidelines.mdx index 6dbe9294b9..8de49d54da 100644 --- a/docs/tools/clients/fcl-js/sdk-guidelines.mdx +++ b/docs/tools/clients/fcl-js/sdk-guidelines.mdx @@ -52,7 +52,7 @@ config({ }) ``` -📖 **gRPC Access API URLs** can be found [here](../../../building-on-flow/nodes/access-api.mdx#flow-access-node-endpoints). `sdk.transport` must be specified if you wish to use the gRPC API. The public Flow gRPC access nodes are accessible at: +📖 **gRPC Access API URLs** can be found [here](../../../building-on-flow/run-and-secure/nodes/access-api.mdx#flow-access-node-endpoints). `sdk.transport` must be specified if you wish to use the gRPC API. The public Flow gRPC access nodes are accessible at: - Testnet `https://access-testnet.onflow.org` - Mainnet `https://access-mainnet.onflow.org` - Local Emulator `127.0.0.1:3569` diff --git a/docs/tools/toolchains/flow-cli/README.md b/docs/tools/toolchains/flow-cli/README.md deleted file mode 100644 index 8a4f0439e7..0000000000 --- a/docs/tools/toolchains/flow-cli/README.md +++ /dev/null @@ -1,4 +0,0 @@ -# Flow CLI - -This directory contains the source files for the Flow CLI documentation. -Read the full version on the [Flow documentation website](./index.md). diff --git a/docs/tutorials/DappArchitectures.mdx b/docs/tutorials/DappArchitectures.mdx index a4a56f8e6a..39ec7a775a 100644 --- a/docs/tutorials/DappArchitectures.mdx +++ b/docs/tutorials/DappArchitectures.mdx @@ -38,8 +38,8 @@ In some cases, Tatum will totally obviate the need to use the Flow SDK, or imple One option is to listen to the events, maintain them, and index them. Third-party services like [Graffle](https://graffle.io/) and Tatum also provide REST APIs, and programmatic notifications/webhooks to receive Flow blockchain data such as events and transactions. Specifically, Graffle can provide easy access to the past and real-time events on the Flow blockchain. -These third-party services can insulate your application from the requirement of being aware of [sporks](../building-on-flow/nodes/node-operation/spork.mdx#past-and-upcoming-sporks). -Otherwise, you will have to add logic in your application to navigate across [past sporks](../building-on-flow/nodes/node-operation/spork.mdx#past-and-upcoming-sporks) when looking up past blockchain data. +These third-party services can insulate your application from the requirement of being aware of [sporks](../building-on-flow/run-and-secure/nodes/node-operation/spork.mdx#past-and-upcoming-sporks). +Otherwise, you will have to add logic in your application to navigate across [past sporks](../building-on-flow/run-and-secure/nodes/node-operation/spork.mdx#past-and-upcoming-sporks) when looking up past blockchain data. With any of these payment rails choices, dapp developers should do their own legal/compliance due diligence. diff --git a/src/data/data-sources.json b/src/data/data-sources.json index 0f46fcbe7d..5ff3e464b1 100644 --- a/src/data/data-sources.json +++ b/src/data/data-sources.json @@ -7,7 +7,7 @@ "data": [ { "source": "docs/", - "destination": "building-on-flow/token-standards/flow-ft/", + "destination": "building-on-flow/core-contracts/flow-ft/", "doCopy": true } ] @@ -21,7 +21,7 @@ "data": [ { "source": "docs/", - "destination": "building-on-flow/token-standards/flow-nft/", + "destination": "building-on-flow/core-contracts/flow-nft/", "doCopy": true } ] From 9b599a3e7b2abd2a140dab4f0a86ee0ece2c61b2 Mon Sep 17 00:00:00 2001 From: Alex Ni <12097569+nialexsan@users.noreply.github.com> Date: Thu, 7 Sep 2023 14:25:44 -0400 Subject: [PATCH 2/6] icons --- docs/building-on-flow/app-architecture/_category_.yml | 3 --- docs/building-on-flow/app-architecture/index.md | 4 +++- docs/building-on-flow/core-contracts/index.md | 2 ++ docs/building-on-flow/eth-vs-flow.md | 2 ++ docs/building-on-flow/flow-networks/index.md | 2 ++ docs/building-on-flow/governance.mdx | 2 ++ docs/building-on-flow/mobile/index.md | 2 ++ docs/building-on-flow/run-and-secure/_category_.yml | 2 ++ 8 files changed, 15 insertions(+), 4 deletions(-) delete mode 100644 docs/building-on-flow/app-architecture/_category_.yml diff --git a/docs/building-on-flow/app-architecture/_category_.yml b/docs/building-on-flow/app-architecture/_category_.yml deleted file mode 100644 index 42b643e320..0000000000 --- a/docs/building-on-flow/app-architecture/_category_.yml +++ /dev/null @@ -1,3 +0,0 @@ -position: 3 -customProps: - description: Describes building self-custody and app custody applications on Flow Blockchain. diff --git a/docs/building-on-flow/app-architecture/index.md b/docs/building-on-flow/app-architecture/index.md index d6d839f97f..d1a431ffc4 100644 --- a/docs/building-on-flow/app-architecture/index.md +++ b/docs/building-on-flow/app-architecture/index.md @@ -1,7 +1,9 @@ --- -sidebar_position: 1 +sidebar_position: 2 title: App Architecture description: Describes building self-custody and app custody applications on Flow Blockchain. +sidebar_custom_props: + icon: 🏗️ --- # App Architecture on Flow Blockchain diff --git a/docs/building-on-flow/core-contracts/index.md b/docs/building-on-flow/core-contracts/index.md index f234400649..0008b4c3f7 100644 --- a/docs/building-on-flow/core-contracts/index.md +++ b/docs/building-on-flow/core-contracts/index.md @@ -3,6 +3,8 @@ title: Flow Core Contracts description: The smart contracts that power the Flow protocol sidebar_title: Core Protocol Smart Contracts sidebar_position: 13 +sidebar_custom_props: + icon: 📝 --- Flow relies on a set of core contracts that define key portions of the diff --git a/docs/building-on-flow/eth-vs-flow.md b/docs/building-on-flow/eth-vs-flow.md index ed42419cc8..be49d73725 100644 --- a/docs/building-on-flow/eth-vs-flow.md +++ b/docs/building-on-flow/eth-vs-flow.md @@ -2,4 +2,6 @@ sidebar_position: 3 title: Differences between Ethereum and Flow description: +sidebar_custom_props: + icon: ↔️ --- diff --git a/docs/building-on-flow/flow-networks/index.md b/docs/building-on-flow/flow-networks/index.md index 6de12b6de0..ac7fda1531 100644 --- a/docs/building-on-flow/flow-networks/index.md +++ b/docs/building-on-flow/flow-networks/index.md @@ -1,6 +1,8 @@ --- title: Flow Networks sidebar_position: 2 +sidebar_custom_props: + icon: 🌐 --- # Flow Networks diff --git a/docs/building-on-flow/governance.mdx b/docs/building-on-flow/governance.mdx index a0aa72817c..b7b20cd2b7 100644 --- a/docs/building-on-flow/governance.mdx +++ b/docs/building-on-flow/governance.mdx @@ -1,5 +1,7 @@ --- title: Governance +sidebar_custom_props: + icon: 🏛️ --- ## Participation diff --git a/docs/building-on-flow/mobile/index.md b/docs/building-on-flow/mobile/index.md index 1125d3df6b..a967a6ac11 100644 --- a/docs/building-on-flow/mobile/index.md +++ b/docs/building-on-flow/mobile/index.md @@ -1,6 +1,8 @@ --- title: Flow Mobile sidebar_position: 20 +sidebar_custom_props: + icon: 📱 --- Building mobile native applications that interact with the blockchain enables a much richer end user experiences and provides access to OS capabilities. With Flow Mobile, developers can build native applications for iOS and Android leveraging SDKs and mobile wallets. diff --git a/docs/building-on-flow/run-and-secure/_category_.yml b/docs/building-on-flow/run-and-secure/_category_.yml index b9c4966c56..74de54527b 100644 --- a/docs/building-on-flow/run-and-secure/_category_.yml +++ b/docs/building-on-flow/run-and-secure/_category_.yml @@ -1,2 +1,4 @@ label: Running and Securing Flow position: 6 +customProps: + icon: 🔐 \ No newline at end of file From c74d0911a5fef50036747ea5d2b14f764dbb15a2 Mon Sep 17 00:00:00 2001 From: Alex Ni <12097569+nialexsan@users.noreply.github.com> Date: Thu, 7 Sep 2023 14:52:43 -0400 Subject: [PATCH 3/6] fixes --- docs/building-on-flow/app-architecture/index.md | 2 +- .../core-contracts/10-nft-storefront.md | 2 +- .../core-contracts/scenario_1.png | Bin 0 -> 14124 bytes .../nodes/node-operation/access-node-setup.md | 8 ++++---- .../node-operation/guides/genesis-bootstrap.mdx | 2 +- .../flow-cli/transactions/build-transactions.md | 2 +- .../version-stable/tooling/fcl-js/api.md | 2 +- 7 files changed, 9 insertions(+), 9 deletions(-) create mode 100644 docs/building-on-flow/core-contracts/scenario_1.png diff --git a/docs/building-on-flow/app-architecture/index.md b/docs/building-on-flow/app-architecture/index.md index d1a431ffc4..bd1efe161b 100644 --- a/docs/building-on-flow/app-architecture/index.md +++ b/docs/building-on-flow/app-architecture/index.md @@ -1,5 +1,5 @@ --- -sidebar_position: 2 +sidebar_position: 3 title: App Architecture description: Describes building self-custody and app custody applications on Flow Blockchain. sidebar_custom_props: diff --git a/docs/building-on-flow/core-contracts/10-nft-storefront.md b/docs/building-on-flow/core-contracts/10-nft-storefront.md index f317e683a5..460a02d5ce 100644 --- a/docs/building-on-flow/core-contracts/10-nft-storefront.md +++ b/docs/building-on-flow/core-contracts/10-nft-storefront.md @@ -50,7 +50,7 @@ The `NFTStorefrontV2` contract doesn’t support selling an NFT for multiple dif **Example -** Alice wants to sell a kitty and is open to receiving FLOW and USDC -![scenario_1](https://user-images.githubusercontent.com/14581509/190966672-e1793fa3-112c-4273-b2a3-e81b8c94fd70.png) +![scenario_1](./scenario_1.png) Putting an NFT on sell called listing, seller can create a listing using [sell_item](https://github.com/onflow/nft-storefront/blob/main/transactions/sell_item.cdc) transaction by providing some required details to list an NFT, i.e. Receiving currency type, [Capability](../../cadence/language/capability-based-access-control.md) from where NFT will be deducted etc. If interested look [here](#fun-createListing()) for more details. diff --git a/docs/building-on-flow/core-contracts/scenario_1.png b/docs/building-on-flow/core-contracts/scenario_1.png new file mode 100644 index 0000000000000000000000000000000000000000..aaa112803647d90df382e15ee4ea5fda2e1d407f GIT binary patch literal 14124 zcmeHucU05aw=d|RGlEzLP(v3{A%xHqnu@4&5Tu17ga84OKxm0u1rkpztcRqke zT{!8~vq!>D%z3~*thKM`#jj+t`#~-T7xh(ekm= zbLaR^s#h#56HZ&c`LrwYfD6nA*cczKBn>NGaWsmx_iQ~7hmN1IyVf#kT-PDyd*Y+O z*u$n4smb$~*has3MzB~fjVU$n4kf2rx57Ane)y@dMG`f3bZkb4^0`6}U?XBCq9V#C zKNI{Z!oox;aNNSf?DNYL(veA`_~T)9oW{`DDD80EV}*1l=mfi2#GN)+0zosJu-ItL z(>5p8Y>{zB{bZPF@J}a>I9*IV5Kp_TCR%qbZvB+X&WV1|Gc7@rGfx2QZ?D~-r`7C! z_AWNI!G6>_BKq4RH))fH?OOSj!bOEq624oBHMspl)X2KYxeqO(GiyXH#RG?k_rm6g z>GP~HiXXm43dR?Ru_2EW(T2h?C3do=Uy8EC#Y;ZudyYLP_8;Uf5M~Pe`tZB4-n4A6$F-$1ffu% zzs_*?Q1@bh{9x$6oZ)W7a8%H3ggeF)3rDDXAe$ zZ81CepLDLCSeJboJ2(j8feDwEvf~{>Izh$i6s#WrVTZpZI^H{zLYC zVg{9t4)i((?zy+9#&u<(J$|8f7&y`ny8jg+ZHthWma+v($|B%E8HBVX&_-6u4k&FS zX>V&MZzn4wCHWU94Ya$54H}NvgJOV7AQ?C^V2Gq0TuK3GkFW;=Wgv`i3UD|ACjS1)!|FJOj#J&K?MnlClTN$iSt+ zQecE6ToSPlwYLw@tNI$sLQ)b;{`PzHU2Ht;F<6wckd6&pK+o`Bv_?o2!qCHJPitT~ zhzuAkB`XhxNP}f075+tJjKI1xEN%}JEGZ!^vp-@7hu&a7+Au5!iL!A(fLzfI`vZIX z0%b_U(5%g#p)!#7`x(MO)vyQ~4-D1_gK<$7+G9;%5Ax4p9fm*I*?8DoxA8zQR+E&H zhDt)9lJZ7i8K?{dDh&oo%0MOmLXWXS+WY)>)O+3|pv2tsTS#}t`ab(zOqVi5xG`JI zrVDc4mjnd%y#i_jXNur%=aYfO9D+OApdAp5@bSZ5|L8~l7q(z81(uRmkVODx zA+n4ORIrl0h^z$qPfAhRC-_U4Va#LpF~S!k8iM`|hd-3I z7kK^$e|~Jn|KJJ?=zkXZxAgmuy8cnuzomhHi})Yw`bS;=mInSU;(x5`|Czdu{Odx6 zKr@a(-i+(g7zbZAg-dl{u zFRr)D+*w$7;`e@8H9YUXV00e#(9lsoJoU@rlVJXXY3Yo-g8+-h^{YlW^1^VKSA5yY z-)ye@EV!tQ8r{8fOj?-LYkr70JkYqCO(>@f)Dxv@e-_j?VBq}o^Fss2-n<96O3S)E z<_Bc7H_N{c|B&q=cwH}H%%OfpIwm-00m(Kb^(G`|<&SlGZQ@8LZGG1{h`NO`)Ji^AoWBd%36kk~-4`A8PVxK6m5k7~J$L4YU zV--0Y{4s>lE`cf2z%6rp@1|^PGpTvu?r{Hje)+`rwWsh;m)^2jcX3U`{p9WuErEhG z*A!X@5qH!g3bzXm1x;Vp$~fM}SB;yuoEsl5GjPatn;C%Z%=a&}M)lWXhaY!yH-=23 zpD|%NxdIE${~V@Xdf^eK`sfF3_H6|K<44-{J|xhMo5p*6 z6RIXm9fwcKBs(pjj%KfY5ptk5fX7bv1cRKyjJs`I(rVMdAXN@IAu>|588Q{tmEM`A z!8P+OR?%h(!X*MkT=Xgu?N@he$d_twa`!5-G{+PA4j*JPlS{GX2t8#(;0<=}069B( zuE)m66l&*R|2E^c-Jb@?I&T(Jqf1Vl8nB@1n$vDJt$ZEv0etr%{I;j_DwNxE!R3gm zfws!Q>G#&lqs0J4r4fske5vqSxfmL(H5%vhyjb}<{)f7779ITVE_2=x+0)N$TaiI? z)Nf%^RR3R5+8fvKb=(lSNH~>e&p={`>d^JYEZ-q)OK9!W={T0e_LoHwwZ`0jE}?Uf zfKk&OtM+`6N^1eq4^5!LZW!LWFscK?r`<@F|129jvi zd9+X^=iEd4TM%MZdM3Rtr#D8-%OcTbVT?HV zPAVSMVB`{@t5g{x`g?5@v@?BYBAk4#L<^E$T4w*U_2A2rkWeNM1w2xT z2(6m^Sn;GTZ#|>$Nf@m<BHj50XK+TV^7%o1lY{*Z+OiouQ_qd}}nHw2} zaswA_&mH5&Ow@i)Iwqa|dn80?XeErfz&(@!5j*T~#_(pCAL}WG$G&A#%?DEbttlZM zmdAJ{#vbqO=S|{+?nrM`lXxHJd4@OZvj^J2UbK}uDSo!saoZ>PjmYAro)Emvk7C_x z(^bg__T2VA#{*>x7>CZ2?Tk@}=VG)%aQ$~0TT7Q9hmmq(9i zPqhywT95}gmi&E`tezQG2lj6`JuAO1QF~Zo%0GW|L8l8ACHrz+*ok$|HUcQu(DagZ zBn>4PVHar4KmSIJYTXPTrRo$3fFN)h#4vaYMOEP9Sie{97@Tm+j-u+gs^;j zx_ZPIZ=P)at7mTe`(dd&sXKLM0~^aRf|dyoV=Y2u1<$a|QF7LEQnPQs#mTgvvphsM zQvg(vO^qt==BH3wV*a&q!#Q`lCwxSul!9$(BzcC5>qv1dN3G7eW=wWZaK8aR*Vc*>V6xgaz4vGC^euqbFrNFb|`W?HyY8( zO=r=fykDAkfI-jas$^k0G*8A5*Ke7aA4YfGga#o2eJVx?x0m!s?8E^9c}x22dz-tM z437poTin=$J*i#@8c%||x8<7&8P{4xrgW~x&*ynBJYNtC8W>;3&eYC?+|=RU^jT$vWi`^20kY; z6X2Dc?X#B+I@g}dIxoF@3y~4gWAdiqTVTY2OwXH z>N!=Q1AB_CsO^0!?PO9`s>;&GttUlNcO1?@=FUaJN7I=*CQq_hG_Y*QuhSu$9U*Sv zVgiTW>?*dtmLd@*Ord#RXTP^~r4IF_=#V~V%#r#$7u=0MZU36{m7sfWNGekdYh~G< zf3-WX2ytsx>2jDuE^{wh^JTuD0Zo`D>Bm6fo08?4H>qHe8>PH382%0=JtIK4s-gLM zDfcOrLuNiiWoz%g#yDa#?IB7^B)9)&&QvU>o5iITv!mF1U@unFCru5gYCU3*3v*!^ z-QJ-^+JefB$x&;++j0i__!rf5DwAe`0U?F(r2*otRxDLzS! zV|i2ZyNOH}=$|k}+^i#IptrMit%Y}2I|DsRt7ZG^F&dKTaMw*|K!sORblC{jMYSlV z)6`@GhSyn|#xzbk?3R{J;@ZrwFdjp$@c`#G_ZIFc?l07gNwv>I+h&H@nxGOT&T{W; z?8ydJ`uj{V?vCP5)db$SA-M%&BP64%P^US`Vfg zN>BEv7XVCV}4&uC*LnL z{Lbta$4j2EmHf)1r%$Urp^`V4-moi4@(A_-P>IR% zus$@z3y|dLb;p4++p^Hc7YB^5FLPV!GJ4|$OJnb&^U4QUCna6tQ zB1`)nrtK%dBkOje0Ae&bODIyfsMU)<)&q)ylqN~1bz_y*iNfyX7d^DPb?K(dZ;);M z?&~vzE>QRV?RDB(!VI}xC?J?&=!;B4H%1wx(~AaL4VJ5^$vMRGj0)VlRfnOI6HZAl z{O1k^1irk0=>3EY+LWwIzr5kC5ucUL6Tf;W@FCXZE(jy|$UFy@7xUtdg>R`z3+`h}Tn>Y4<@@Alc#q(k}10``8QO_Y)8~ldUf1So;tc+%jg@^VC)ov!jUZEgK`Y z!+tYoId1Z|#%>x=X(jR7Pt0|bP_NmW(qCe$R8mfSQ~2TOsLp}bD$P=uCNJLcx{@wX zfbn20!N3}Hc(ZP!-)Z5$xH<2~Zc9pvwmfd>dn;EwO0KA`^uEAuI7M0iDbu+#K$W}aiCdB=ng ztG$>i!me_(>~>c67a7WI;PXH?M;8N5>=VZ6^(qk8WqurWZ*kU6=i64(YJW}iVHYBy z(%H}D1%gK9n-6RICQRBp2loVvX0u^ChIsp*RX&BQiybBh!U(eH+^8f|%l__0-)sTW zUc^m$&(+XaJdq8Ef0NNW*Xi{vccqa%LX`KY4&%(sINhRvw@O!i@ln{X%4S&0MlinY z(LOlFik-?+o;=Z#IB5(=a$klxSv%S=rC00;#wEcgeDFsFKgsl+T{vFRXE5k^cvxhG z@MG>B_8TuBPqky;JFZY&EQ=JQ?_{~l+4XIt?8dfDIrI=*?0V8zNO5f2%%haUJGMH& zvi_VPDg9L>(GY*eM>j^Vu`;$8)z7LPU~ES_#MGn(;jSZy8p}~memF;?YOHAQW^Nqo z8ysaE;1~x4^RF*Z&oC`geOQ-@;qR$Wlp8SwUACfjZ%aHyHUl4_ceh2}Sy3&~jR zN9@i$Xc=7uJyq3P|Hk_f=fAmH+HOheL*wK&KyuKDbHf($ys95H#;aGj<>~?s1pJy? zb!TP~wF7V8H0>gQ>aS73a)by9N*1*$uq(h0Yo#~xBOJnlh)mgP8#N;wL0T}$grB8r^I5K<7Q$;eyuuMYf^WK zATR`PG|m0igE0v+rqj;%yT9+@-X;Me>5;vJ?1wv@=bq1qicfV+^hb4~gA38Qy7k3{ z@E23S*WFV=>0ICQM6Pc)#Up_{o~h%T!gHkc6|r)HC}W#vCKQx&*{ayxE(Q$hW%CJo zE%R=Vs)pyR3FOZ96@2ZdSKr|d{B>rn((2~_hh=ygvlF9d=al+#Mc{HCqn~| z6F%R7$ngcGLdfd?%Hj~u{6=oE|0Tm%t8LVa^(XmCzZa=Ka;5LyodHkLIlN~A0xTK# z3a9qWxtTkC{Udal&l1&Jc^JNS70nrQ2YTmBhi%-IWmb?K$+SNgabrl;-Y1hQVMK9- z+C6`>DJ4DZ=Ef-4u?rgri9Us4E772myeFc<*CTtMg_yfG1H`z`Xe6L~-d;Tf zoXi|@*X9JN&GJ#f`j}8s;B$CmP8VF49;I6l+(T>9FiuFMr#$cJ9369nKZTPEwhApr zGum!e(V9G_E747!w5$I4!$$Rs3b_zt{$nvfl7GBPsz-lCm0J90?px2sQ*&n_-d<;W ziB^+~NgOes^mQmPx<~Ui;^!^|P^?t$VLXl#f4T2j4(bioEbhR~+({pf8CI)S9{d(T z15JOfs?{Laub3V7#?yOo-Ef>3lb)DirO3M*l;F*XgG+Sj7D{&$L&&&hk7jE-o zugVj4Y+$)`!n5_2BXHXH3Fn*kJ;4#hbfujA9v>}{;W zFD+|Pmd5nt9lG_qz1xnK>~Lx#~+F*Pjks zG^2TI4=bMmK6-7bCN1((JZa2U#dN)EuqYrix&N5>%OP!dN{+$cgJ!}NGV-Nog%Bt% z1p-Yg*8T<>y)4(qK}$6{VwX6w#oAY$Q(l{wQQ-gi(i*IPsf^Db)a{ZH-0oac7H*b4 z)U!jzBJS zTNa6t0O&fPlzAZTd4V6$<}RnE2v;806a*gKR&k%L)h>Nr;pZ4>{xyksQI<1J3u=1p zXo0cOOLvzJ!0f_J2x-3PrJcG7c`2`WIC9IeC@DD1YgvLfqxmw`igp3KcK*D6U;lS= z+w1t_itO;CXJ(WMaKxo$DbhOkf`&Aij^l0b^^T>rd9j?#93i1p-N2+n=fpcDLhW9} zJnJr0x7im5RNJ>Y>@xMA~&O##Xc>&bz} z)`#w09=`rc)5cw*Pw#Y`3wTr)H=kzRGTRJu+Nkm^+Ad9c(t5M-WY8VX`l3@g)Jr4K z?6WItjiuvV2L{t-1;Rv)mn&3C2CLqw_8dsYFZnsA#C9RKtz(uA+po!y+HB7LJhRd^ zL}|!I46m6Bl)um=LD%^!=@p~gj626_h#T2D>1NN3jg1N}?XFkm$0Zm6+_gDEQ;bdh ztkF9|#dYE+f4iTgFHtOUavBfzea-deWHBI6reeb}de3Bd)=ViAqqi*~GeUI&T}H1`U+lOZA7k_s7NB6CkUU#}c?TWZU{ zxqECDKCy*96_Rkl7e4Whn3?ZSU0Qn@!Q(y&>J%ubG&ttnNf?Dm>J zEx@VjbUgU-nsLtbtyNgCwzBTf^I{98n*tjQxi2_xR26br2f@_hP(|J$_|ayHYFAN5 zL7!Yu7T5HXx8vFi-S=IcYJyN*_{m zejMjwNvOxAh%pU({TbqwD<~&`9BTv9?*h)weXI_8a*_YF@p9Vz z>kIm)MU_)%9=m~E_s^`d^vU}PSDCZdizJsbaxEKsDI@VhOsCnCFW%PP23aSpSFp~m_ry=!xL<>GQ% zucvgol4OF_wnw}Nxr#!JvrC^>?>;?D?w)uL9&lc-*;*ef9k*bYu}s(BT%*J|-}1Im z%3=%j3-`a*r=sq?#S-ImuZ?YXt@ZGkTb(N?QluZKom<>TVe=8=BEyhxjq(#9$SY~u z8+vAW#GT|8zuPfulCa?DwH;_kQ<#`A*KhWTh}EldI^j!(h&wV>P1zaUE zagu|L&1o_62@chXnuXu_4cXIbXMF(gWyjsBgYvmJ=0Z?;qT2^_>mN?8n0HJiT-GH$ ze0P{}+u4imK|T)F$(FfmVp}SiY}KoNJC)E3nPb067(b0!8=hRzc+2fvLvudUsxeQDbSmHh>(Xad| zJWV;P$M4e{H?lIxR>kE7yyf!IFXZ1V8=*RBPfj#n1w5G4Y&B5rxf7?STQTQQ#FqrlcqtrabY0F5k)SgjdQf!ZUTsCYpab0$M; z$24q_9<)6eiXO`6+R}ilRBt%9?j%?^8>dar&$}1{BQ?%#KasoGOLr#RU8pHhx{50j zQck;Pw2eyaIl#L%8@6IPG4xHxU3-$ewkDHNX*})1w=o7(cj8T15ZBgo*A5&Qcv5k> zj==We0if`p=b6^UHg}g!wef}3SCbFVql=D>Rp5UXN6v#MVxLH+Qw&4YLN6tY_q3n% z4S(sIxM4Jj)C;ZrOG80a*$ymQ($nZ7v6z z11T^amz@jzFlhkDnR>Lo-i5#4Ca-K^{WSdzen#H)EgOZms?Wq6?F`b%XC9+iKM{-|Z_g8CuPouPT%iW2xj!CBEB| z8LJYck>S9zZ5htk^R}}ugf>4>R>ubXZgEc(MN4&+=5IHq0mQm5b$E%lVc(A~HOpl* zhu$W#ReI%1xWo?dy1U@qj_N_h9A4&G*9u>fPnQnQ4pJu7%lL{(Z%?F1P+}+P{(<}j zw?}mkfnw5P%<$mh?r$Fn_Rx0;)#kr0Kh#&4OVB#iT4?F?A|zb=81+i@=uYRIG6PU4x=15#T=1%2U|0$w#|{E)|0WrKfj9a zB5a2OB4NOcc%aE97i%3^7}}n%yW< zOp5P$ou747chPJiw2two{g4x9O=4ir3>y#jXL*p9(55Yrr}(9Tb9t+Cm?HA}%P(?z zJFf3u?ZG9$hwhK@O;OjaH`79MdT5uuJe$AI0J36aWNE?>V_fm4j{3Ur_OoZoqQm{h2rdu1 z`A=jxxCuEA`rqw5>QtlJmJhP@BC3q!ZJdHku5)ZtJx%mx2m4FT>jtH)UGcIFZw_q% zs}8~41|tH4v#U)MH#)^365K0f&2OW5JSD0*K~EW3pGVyrviB{!w1Kz^z`_5sVn;wT zk!QJXWy)X2Z_MV8D#b_33Y9`9Y7(SX->OOZdBlD~={qao!;-wD|4X}Ghn$SV%v6dU z;fmpVnB9X4 ziOpk!n5b3=5%{=rr*=ZNxE<>PoirWc6P;itt3;i`s#+mN-%CV$!T|AMJ5Bi;8u*Dw zoR6#*v(Ve#!Bv%P4_nm0$H$l9Ga$sC8&eK%WM9{pUY5;z6W^CejdjVTFHfX?9cJ#E zs$PsR34^noktmP8d`L<2G9{_sAalS zP3DUuw;KYi(iPU|k(Q^pV?cBB@oAuC>8!Qg9Xr2_6=LGZHljncA8+WjFDL7NSLyrT zRsJLXPfLaWV*pETWZU=6YwZPmYwdBwk7|9)N(@n*LpSMo%FY=_F(teGRJ8!<%Kqo) zfphy7cz}GM=fH0zDZnd0mWN{hzck7)Fl{%}UBK9zpe}n{%Z~yK@nKElscSu|2T>0~ z-|r_!SBsg_y!yXozf2D%4mOtI;H&&22^(^p{5-nme*eBA6^rWtAFnlku3_f(6DhU} zu53^X+$xi^DdMZz2ckbpu;{SMzrRecNoCHY6YCmkF~Kp`)jYSGr{W zU~H6Vdd<=CtdcKtJ!e?MYj2(IKg0;22!&i>|MKO}f<=1yA5t*Nvt=+`$Pe*$j4j=T z?<(!M?Nv5dQTO<**;&RO6Ilo>0y&QC`u|Sj!~HP!{a0`FEZObJEXCZ17_a4kbdv`g zgzlA8LUGI%d8qSj2_aor_uHxQ)y!iY For the Genesis Block, your nodes will start pre-staked, which means no action on your part is needed to get your nodes staked. - For more details on staking check the guide on [Staking and Rewards](../../../staking//08-staking-rewards.md). + For more details on staking check the guide on [Staking and Rewards](../../../staking/08-staking-rewards.md). ## Receive Your Random Beacon Keys diff --git a/docs/tools/toolchains/flow-cli/transactions/build-transactions.md b/docs/tools/toolchains/flow-cli/transactions/build-transactions.md index 70bd4ca350..2c8068396b 100644 --- a/docs/tools/toolchains/flow-cli/transactions/build-transactions.md +++ b/docs/tools/toolchains/flow-cli/transactions/build-transactions.md @@ -123,7 +123,7 @@ Specify key index for the proposer account. - Default: service account Additional authorizer addresses to add to the transaction. -Read more about authorizers [here](../../../../concepts//transactions.md). +Read more about authorizers [here](../../../../concepts/transactions.md). ### Arguments JSON diff --git a/versioned_docs/version-stable/tooling/fcl-js/api.md b/versioned_docs/version-stable/tooling/fcl-js/api.md index 38bf67f12f..61f25e256e 100644 --- a/versioned_docs/version-stable/tooling/fcl-js/api.md +++ b/versioned_docs/version-stable/tooling/fcl-js/api.md @@ -737,7 +737,7 @@ The callback sent to `subscribe` will be called with a list of `authn` services. > 📣 **These methods can be used in browsers and NodeJS.** -These methods allows dapps to interact directly with the Flow blockchain via a set of functions that currently use the [Access Node API](../../concepts//nodes/access-api.mdx). +These methods allows dapps to interact directly with the Flow blockchain via a set of functions that currently use the [Access Node API](../../concepts/nodes/access-api.mdx). ### Methods From c2c397efcdea6eca0bea18eb9be7cfa9f45d694c Mon Sep 17 00:00:00 2001 From: Alex Ni <12097569+nialexsan@users.noreply.github.com> Date: Thu, 7 Sep 2023 16:02:36 -0400 Subject: [PATCH 4/6] fix link --- docs/building-on-flow/building-vs-other-chains.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/building-on-flow/building-vs-other-chains.md b/docs/building-on-flow/building-vs-other-chains.md index 30c1991643..07547a6a59 100644 --- a/docs/building-on-flow/building-vs-other-chains.md +++ b/docs/building-on-flow/building-vs-other-chains.md @@ -159,7 +159,7 @@ Access Nodes are the node type that are most useful for developers, as they prov - gRPC - Mainnet: `access.mainnet.nodes.onflow.org:9000` - Testnet: `access.devnet.nodes.onflow.org:9000` - - [Specification](./nodes/access-api.mdx) + - [Specification](./run-and-secure/nodes/access-api.mdx) ### Running Your Own Node From 3e5e9b5d025c3908da11d69ce4b3a29687608b21 Mon Sep 17 00:00:00 2001 From: Alex Ni <12097569+nialexsan@users.noreply.github.com> Date: Thu, 7 Sep 2023 17:48:36 -0400 Subject: [PATCH 5/6] fix link --- docs/building-on-flow/building-vs-other-chains.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/building-on-flow/building-vs-other-chains.md b/docs/building-on-flow/building-vs-other-chains.md index 07547a6a59..c973a0fa10 100644 --- a/docs/building-on-flow/building-vs-other-chains.md +++ b/docs/building-on-flow/building-vs-other-chains.md @@ -165,7 +165,7 @@ Access Nodes are the node type that are most useful for developers, as they prov If you’re getting started you don’t need to run your own node and you can use the above public nodes. The public access nodes are rate-limited, so as your product matures you might want to run your own node. There are multiple options available: -- Start with a [Light (Observer) Node](./nodes/node-operation/observer-node.mdx). +- Start with a [Light (Observer) Node](./run-and-secure/nodes/node-operation/observer-node.mdx). - You can also use a third-party provider like [Quicknode](https://www.quicknode.com/docs/flow). Check out [Running a Node](../guides/runningNode.mdx) for more information. From edad34a401fd31cda62f2d8f6bebb5de0aa871c6 Mon Sep 17 00:00:00 2001 From: Alex Ni <12097569+nialexsan@users.noreply.github.com> Date: Fri, 8 Sep 2023 14:12:58 -0400 Subject: [PATCH 6/6] fix links --- docs/guides/runningNode.mdx | 27 +++++++++---------- docusaurus.config.js | 8 +++--- .../version-stable/cadence/measuring-time.mdx | 2 +- .../tutorials/DappArchitectures.mdx | 6 ++--- 4 files changed, 21 insertions(+), 22 deletions(-) diff --git a/docs/guides/runningNode.mdx b/docs/guides/runningNode.mdx index a43114e49c..cfe2d41ae0 100644 --- a/docs/guides/runningNode.mdx +++ b/docs/guides/runningNode.mdx @@ -8,17 +8,17 @@ sidebar_custom_props: --- ## Node Types -Flow network is made up of many node types. Here is more information on the different [Node Types](../building-on-flow/nodes/node-operation/node-roles#collection). For a quick reference here are the types: +Flow network is made up of many node types. Here is more information on the different [Node Types](../building-on-flow/run-and-secure/nodes/node-operation/node-roles.mdx#collection). For a quick reference here are the types: | Node Type | Stake Required in FLOW | Permissionless| Description | Running a Node | | --- | --- | --- | --- | -- | -| Light | Zero | Yes | Best node for application developers that need high throught-put. This node is used to observe the network and get the latest blockchain data. | [Setup](../building-on-flow/nodes/node-operation/observer-node) | -| Archive | Zero | Yes | Scalable and efficient way to access the history of Flow protocol. | [Setup](../building-on-flow/nodes/node-operation/node-setup) | -| Access | 100 | Yes | Provides access to the Flow network. Public nodes, that rate limits, is used to send transactions to the network and provide Flow blockchain data. | [Setup](../building-on-flow/nodes/node-operation/access-node-setup) | -| Verification | 135,000 | No | Verify the correctness of blocks proposed by the Consensus nodes. | [Setup](../building-on-flow/nodes/node-operation/node-setup) | -| Collection | 250,000 | No | Bandwidth-optimized nodes divided by the protocol into several cooperating Clusters. | [Setup](../building-on-flow/nodes/node-operation/node-setup) | -| Consensus | 500,000 | No | Form and propose blocks in a manner similar to traditionally-structured proof-of-stake blockchains. | [Setup](../building-on-flow/nodes/node-operation/node-setup) | -| Execution | 1,250,000 | No | Most resource-intensive nodes on the Flow network, responsible for executing transactions and maintaining the Execution State. | [Setup](../building-on-flow/nodes/node-operation/node-setup) | +| Light | Zero | Yes | Best node for application developers that need high throught-put. This node is used to observe the network and get the latest blockchain data. | [Setup](../building-on-flow/run-and-secure/nodes/node-operation/observer-node.mdx) | +| Archive | Zero | Yes | Scalable and efficient way to access the history of Flow protocol. | [Setup](../building-on-flow/run-and-secure/nodes/node-operation/node-setup.mdx) | +| Access | 100 | Yes | Provides access to the Flow network. Public nodes, that rate limits, is used to send transactions to the network and provide Flow blockchain data. | [Setup](../building-on-flow/run-and-secure/nodes/node-operation/access-node-setup.md) | +| Verification | 135,000 | No | Verify the correctness of blocks proposed by the Consensus nodes. | [Setup](../building-on-flow/run-and-secure/nodes/node-operation/node-setup.mdx) | +| Collection | 250,000 | No | Bandwidth-optimized nodes divided by the protocol into several cooperating Clusters. | [Setup](../building-on-flow/run-and-secure/nodes/node-operation/node-setup.mdx) | +| Consensus | 500,000 | No | Form and propose blocks in a manner similar to traditionally-structured proof-of-stake blockchains. | [Setup](../building-on-flow/run-and-secure/nodes/node-operation/node-setup.mdx) | +| Execution | 1,250,000 | No | Most resource-intensive nodes on the Flow network, responsible for executing transactions and maintaining the Execution State. | [Setup](../building-on-flow/run-and-secure/nodes/node-operation/node-setup.mdx) | ### Permissioned vs Permissionless @@ -31,17 +31,17 @@ On Flow there is no requirement to run a node to develop applications. For many # Running a Light Node -There are community access nodes available to use, but they are rate limited. Alternative to an Access node, anyone can run their own Light node. This is a good option if you want to have untrottled access to current Flow blockchain data. [More information](../building-on-flow/nodes#which-node-should-you-run) +There are community access nodes available to use, but they are rate limited. Alternative to an Access node, anyone can run their own Light node. This is a good option if you want to have untrottled access to current Flow blockchain data. [More information](../building-on-flow/run-and-secure/nodes/index.md#which-node-should-you-run) ![Light nodes](observer-node-arch.png) ## Setup -First make sure your node has the needed resources, here are the requirements, and step by step instructions to get up and running. [Light Node Documentation](../building-on-flow/run-and-secure/nodes/node-operation/observer-node#running-an-observer-node). Light node can be run in a Docker container, it's available for testnet and mainnet. +First make sure your node has the needed resources, here are the requirements, and step by step instructions to get up and running. [Light Node Documentation](../building-on-flow/run-and-secure/nodes/node-operation/observer-node.mdx#running-an-observer-node). Light node can be run in a Docker container, it's available for testnet and mainnet. ## Running -For high usage applications on Flow, that have many user interactions, it might be necessary to run your own Light node. Here are the step by step instructions to [run an observer node](../building-on-flow/run-and-secure/nodes/node-operation/observer-node#steps-to-run-an-observer-node). The benefit is, no staked FLOW and no register is required. Also, already mentioned you have untrottled access to the blockchain data. +For high usage applications on Flow, that have many user interactions, it might be necessary to run your own Light node. Here are the step by step instructions to [run an observer node](../building-on-flow/run-and-secure/nodes/node-operation/observer-node.mdx#steps-to-run-an-observer-node). The benefit is, no staked FLOW and no register is required. Also, already mentioned you have untrottled access to the blockchain data. @@ -54,9 +54,8 @@ Application developers can choose to run their own private permissionless access ## Setup -Make sure you have the needed resources, here are the requirements, and step by step instructions to get up and running. [Access Node Documentation](../building-on-flow/nodes/node-operation/access-node-setup#limitations). Access node can be run in a Docker container, it's available for testnet and mainnet. +Make sure you have the needed resources, here are the requirements, and step by step instructions to get up and running. [Access Node Documentation](../building-on-flow/run-and-secure/nodes/node-operation/access-node-setup.md#limitations). Access node can be run in a Docker container, it's available for testnet and mainnet. ## Running -If you want to run an access node, you will need to stake FLOW and register your node. Here are the step by step instructions to [run an access node](../building-on-flow/nodes/node-operation/access-node-setup). There are benefit to running an Access node. - +If you want to run an access node, you will need to stake FLOW and register your node. Here are the step by step instructions to [run an access node](../building-on-flow/run-and-secure/nodes/node-operation/access-node-setup.md). There are benefit to running an Access node. diff --git a/docusaurus.config.js b/docusaurus.config.js index d04030beec..6b0227a885 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -439,19 +439,19 @@ const config = { label: 'Flowscan Testnet', }, { - to: '/building-on-flow/nodes/node-operation/past-sporks/', + to: '/building-on-flow/run-and-secure/nodes/node-operation/past-sporks/', label: 'Past Sporks', }, { - to: '/building-on-flow/nodes/node-operation/upcoming-sporks', + to: '/building-on-flow/run-and-secure/nodes/node-operation/upcoming-sporks', label: 'Upcoming Sporks', }, { - to: '/building-on-flow/nodes/node-operation/', + to: '/building-on-flow/run-and-secure/nodes/node-operation/', label: 'Node Operation', }, { - to: '/building-on-flow/nodes/node-operation/spork/', + to: '/building-on-flow/run-and-secure/nodes/node-operation/spork/', label: 'Spork Information', }, ], diff --git a/versioned_docs/version-stable/cadence/measuring-time.mdx b/versioned_docs/version-stable/cadence/measuring-time.mdx index 5aecd631b0..aa9616c670 100644 --- a/versioned_docs/version-stable/cadence/measuring-time.mdx +++ b/versioned_docs/version-stable/cadence/measuring-time.mdx @@ -26,7 +26,7 @@ and further optimizations are needed to achieve that. As of Feb 2021, the rate of block finalization on Mainnet is more than 0.5 blocks/s; with a standard deviation of ±0.1 blocks/s. Hence, a new block is finalized on average every 2 seconds. Note that block height only has a loose correlation with time, -as [the block rate naturally fluctuates](../building-on-flow/nodes/faq/operators.mdx#does-the-blockheight-go-up-1-every-second). +as [the block rate naturally fluctuates](../building-on-flow/run-and-secure/nodes/faq/operators.mdx#does-the-blockheight-go-up-1-every-second). In addition to the natural variation described above, there are several theoretical block production attacks that could skew this relationship even further. diff --git a/versioned_docs/version-stable/tutorials/DappArchitectures.mdx b/versioned_docs/version-stable/tutorials/DappArchitectures.mdx index b5423e4e88..39ec7a775a 100644 --- a/versioned_docs/version-stable/tutorials/DappArchitectures.mdx +++ b/versioned_docs/version-stable/tutorials/DappArchitectures.mdx @@ -1,6 +1,6 @@ --- title: Dapp Architectures on the Flow Blockchain -sidebar_title: Dapp Architectures on the Flow Blockchain +sidebar_label: Dapp Architectures on the Flow Blockchain --- ## Introduction @@ -38,8 +38,8 @@ In some cases, Tatum will totally obviate the need to use the Flow SDK, or imple One option is to listen to the events, maintain them, and index them. Third-party services like [Graffle](https://graffle.io/) and Tatum also provide REST APIs, and programmatic notifications/webhooks to receive Flow blockchain data such as events and transactions. Specifically, Graffle can provide easy access to the past and real-time events on the Flow blockchain. -These third-party services can insulate your application from the requirement of being aware of [sporks](../building-on-flow/nodes/node-operation/spork.mdx#past-and-upcoming-sporks). -Otherwise, you will have to add logic in your application to navigate across [past sporks](../building-on-flow/nodes/node-operation/spork.mdx#past-and-upcoming-sporks) when looking up past blockchain data. +These third-party services can insulate your application from the requirement of being aware of [sporks](../building-on-flow/run-and-secure/nodes/node-operation/spork.mdx#past-and-upcoming-sporks). +Otherwise, you will have to add logic in your application to navigate across [past sporks](../building-on-flow/run-and-secure/nodes/node-operation/spork.mdx#past-and-upcoming-sporks) when looking up past blockchain data. With any of these payment rails choices, dapp developers should do their own legal/compliance due diligence.