Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor Node ops nav content relating to Accessing Onchain Data #1095

Merged
merged 18 commits into from
Jan 18, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/build/advanced-concepts/scaling.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ We can leverage this model to design an ideal system transaction architecture as

To simplify the system further, we can reuse the same cryptographic key multiple times within the same account by adding it as a new key. These additional keys can have a weight of 0 since they do not need to authorize transactions.

Here’s a visual example of how such an [account configuration](https://www.flowdiver.io/account/0x18eb4ee6b3c026d2?tab=keys) might look:
Here’s a visual example of how such an [account configuration](https://www.flowscan.io/account/18eb4ee6b3c026d2?tab=keys) might look:

![Example.Account](scaling-example-account.png "Example Account")

Expand Down
2 changes: 1 addition & 1 deletion docs/build/basics/accounts.md
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ Find [more about the command in the CLI docs](../../tools/flow-cli/accounts/get-

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** [building-on-flow/nodes/access-api#accounts](../../networks/node-ops/access-onchain-data/access-nodes/accessing-data/access-api.md#accounts)
**gRPC API** [building-on-flow/nodes/access-api#accounts](../../networks/access-onchain-data/index.md#accounts)

**REST API** [http-api#tag/Accounts](/http-api#tag/Accounts)

Expand Down
2 changes: 1 addition & 1 deletion docs/build/basics/blocks.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Find [more about the command in the CLI docs](../../tools/flow-cli/get-flow-data

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**](../../networks/node-ops/access-onchain-data/access-nodes/accessing-data/access-api.md#blocks)
[**gRPC Block API**](../../networks/access-onchain-data/index.md#blocks)

[**REST Block API**](/http-api#tag/Blocks)

Expand Down
2 changes: 1 addition & 1 deletion docs/build/basics/collections.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Find [more about the command in the CLI docs](../../tools/flow-cli/get-flow-data

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**](../../networks/node-ops/access-onchain-data/access-nodes/accessing-data/access-api.md#collections)
[**gRPC Collection API**](../../networks/access-onchain-data/index.md#collections)

[**REST Collection API**](/http-api#tag/Collections)

Expand Down
2 changes: 1 addition & 1 deletion docs/build/basics/fees.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ You should see the `computationUsed` field. Take a note of the value, you will u

**On testnet or mainnet**

Once a transaction is completed, you can use an explorer like [Flowdiver](https://flowdiver.io/) to review the transaction details and events emitted. For Flowdiver, you can open the transaction in question and look for the event `FeesDeducted` from the [`FlowFees`](https://github.com/onflow/flow-core-contracts/blob/master/contracts/FlowFees.cdc) contract:
Once a transaction is completed, you can use an explorer like [Flowscan](https://flowscan.io/) to review the transaction details and events emitted. For Flowscan, you can open the transaction in question and look for the event `FeesDeducted` from the [`FlowFees`](https://github.com/onflow/flow-core-contracts/blob/master/contracts/FlowFees.cdc) contract:

![flowscan-fees](./_fees_images/flowscan-fees.png)

Expand Down
2 changes: 1 addition & 1 deletion docs/build/basics/flow-token.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ Transactions are submitted using a Flow SDK via the Access API.

On Flow, a transaction is identified by its hash - the hash that exists as soon as that transaction is signed and submitted to an Access or Collection node.
Results of transactions can be queried by transaction hash through the Access API.
A user can check the status of a transaction at any time via the [Flow Block Explorer](https://www.flowdiver.io/).
A user can check the status of a transaction at any time via the [Flow Block Explorer](https://flowscan.io/).

To expose these results natively in your app, you can use a Flow SDK to fetch transaction results,
[for example using the Flow Go SDK](https://github.com/onflow/flow-go-sdk#querying-transaction-results).
Expand Down
2 changes: 1 addition & 1 deletion docs/build/basics/scripts.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Scripts can be used for the following:

A script can be executed by submitting it to the Access API provided by access nodes. Currently, there are three API endpoints that allow a user to execute scripts at the latest sealed block, a previous block height, or a previous block ID.

[**gRPC Script API**](../../networks/node-ops/access-onchain-data/access-nodes/accessing-data/access-api.md#scripts)
[**gRPC Script API**](../../networks/access-onchain-data/index.md#scripts)

[**REST Script API**](/http-api#tag/Scripts)

Expand Down
2 changes: 1 addition & 1 deletion docs/build/basics/transactions.md
Original file line number Diff line number Diff line change
Expand Up @@ -437,7 +437,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**](../../networks/node-ops/access-onchain-data/access-nodes/accessing-data/access-api.md#transactions)
[**gRPC Transaction API**](../../networks/access-onchain-data/index.md#transactions)

[**REST Transaction API**](/http-api#tag/Transactions)

Expand Down
2 changes: 1 addition & 1 deletion docs/build/guides/mobile/react-native-quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -448,7 +448,7 @@ const styles = StyleSheet.create({

```

Press the "Init Account" button you should see the wallet ask you to approve a transaction. After approving, you will see a transaction response appear in your console (make sure to have that open). It may take a few moments. With the transaction result printed, you can use the `transactionId` to look up the details of the transaction using a [block explorer](https://testnet.flowdiver.io/).
Press the "Init Account" button you should see the wallet ask you to approve a transaction. After approving, you will see a transaction response appear in your console (make sure to have that open). It may take a few moments. With the transaction result printed, you can use the `transactionId` to look up the details of the transaction using a [block explorer](https://testnet.flowscan.io/).

## Mutating the Blockchain

Expand Down
6 changes: 3 additions & 3 deletions docs/ecosystem/block-explorers.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Block explorers are user-friendly online tools that visually present blockchain

## Flow Diver

[Flow Diver](https://www.flowdiver.io/) provides various tools to explore the blockchain, including:
[Flowscan](https://flowscan.io/) provides various tools to explore the blockchain, including:

- Blocks
- Transactions
Expand All @@ -25,8 +25,8 @@ Block explorers are user-friendly online tools that visually present blockchain

### Supported networks:

- [Mainnet](https://www.flowdiver.io/)
- [Testnet](https://testnet.flowdiver.io/)
- [Mainnet](https://flowscan.io/)
- [Testnet](https://testnet.flowscan.io/)

## Flow View

Expand Down
2 changes: 1 addition & 1 deletion docs/ecosystem/projects.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ Explore an array of exciting, grassroots initiatives, and projects that thrive w
},
{
type: 'link',
label: 'Flowdiver historical API',
label: 'Flow historical API',
href: 'https://findonflow.github.io/findlabs-api/',
description: 'It is an Api to allow users to fetch historical data of Flow blockchain from the findlabs database.',
customProps: {
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
position: 3
label: Accessing Data
Original file line number Diff line number Diff line change
Expand Up @@ -1193,7 +1193,7 @@ message Block {
| block_header | A summary of a [block](#block-header) |
| protocol_state_id | The root hash of protocol state. |

The detailed semantics of block formation are covered in the [block formation guide](../../../../../build/basics/blocks.md).
The detailed semantics of block formation are covered in the [block formation guide](../../build/basics/blocks.md).

### Block Header

Expand Down Expand Up @@ -1349,17 +1349,17 @@ message TransactionSignature {
| authorizers | Addresses of the transaction authorizers |
| signatures | [Signatures](#transaction-signature) from all signer accounts |

The detailed semantics of transaction creation, signing and submission are covered in the [transaction submission guide](../../../../../build/basics/transactions.md#signing-a-transaction).
The detailed semantics of transaction creation, signing and submission are covered in the [transaction submission guide](../../build/basics/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](../../../../../build/basics/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](../../build/basics/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](../../../../../build/basics/transactions.md#sequence-numbers) for the proposal key |
| Field | Description |
| --------------- | ------------------------------------------------------------------------------------------- |
| address | Address of proposer account |
| key_id | ID of proposal key on the proposal account |
| sequence_number | [Sequence number](../../build/basics/transactions.md#sequence-numbers) for the proposal key |

#### Transaction Signature

Expand Down Expand Up @@ -1415,7 +1415,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](../../../../../build/basics/accounts.md).
More information on accounts can be found [here](../../build/basics/accounts.md).

#### Account Key

Expand All @@ -1433,17 +1433,17 @@ message AccountKey {
}
```

| Field | Description |
| --------------- | -------------------------------------------------------------------------------------------- |
| id | Index of the key within the account, used as a unique identifier |
| public_key | Public key encoded as bytes |
| sign_algo | [Signature algorithm](../../../../../build/basics/accounts.md#signature-and-hash-algorithms) |
| hash_algo | [Hash algorithm](../../../../../build/basics/accounts.md#signature-and-hash-algorithms) |
| weight | [Weight assigned to the key](../../../../../build/basics/accounts.md#account-keys) |
| sequence_number | [Sequence number for the key](../../../../../build/basics/transactions.md#sequence-numbers) |
| revoked | Flag indicating whether or not the key has been revoked |
| Field | Description |
| --------------- |---------------------------------------------------------------------------|
| id | Index of the key within the account, used as a unique identifier |
| public_key | Public key encoded as bytes |
| sign_algo | [Signature algorithm](../../build/basics/accounts.md#signature-and-hash-algorithms) |
| hash_algo | [Hash algorithm](../../build/basics/accounts.md#signature-and-hash-algorithms) |
| weight | [Weight assigned to the key](../../build/basics/accounts.md#account-keys) |
| sequence_number | [Sequence number for the key](../../build/basics/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](../../../../../build/basics/accounts.md).
More information on account keys, key weights and sequence numbers can be found [here](../../build/basics/accounts.md).

### Event

Expand Down
6 changes: 3 additions & 3 deletions docs/networks/flow-networks/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ For more information on how to access these networks, refer to the following gui

There are two primary ways to access on-chain data within the Flow network; Access Nodes and Light nodes. Access Nodes are the node type that are most useful for developers, as they provide access to the Flow network via the following API endpoints:

- [Flow Access API](../node-ops/access-onchain-data/access-nodes/accessing-data/access-api.md)
- [Flow Access API](../access-onchain-data/index.md)
- [Mainnet](./accessing-mainnet.md): `access.mainnet.nodes.onflow.org:9000`
- [Testnet](./accessing-testnet.md): `access.devnet.nodes.onflow.org:9000`
- [Status Page](https://status.onflow.org/) - Network status page
Expand All @@ -44,7 +44,7 @@ Rate limits for Flow Public Access nodes hosted by QuickNode are detailed [here]

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](../node-ops/access-onchain-data/light-nodes/observer-node.md).
- Start with a [Light (Observer) Node](../node-ops/light-nodes/observer-node.md).
- You can also use a third-party provider like [Quicknode](https://www.quicknode.com/docs/flow).

Check out [Running a Node](../node-ops/access-onchain-data/light-nodes/observer-node.md) for more information.
Check out [Running a Node](../node-ops/light-nodes/observer-node.md) for more information.
1 change: 1 addition & 0 deletions docs/networks/node-ops/access-nodes/_category_.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
label: Access Nodes
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Serving execution data
sidebar_label: Execution Data
sidebar_position: 3
sidebar_position: 2
---

Flow chain data comprises of two parts,
Expand Down Expand Up @@ -100,7 +100,7 @@ gsutil ls "gs://flow-genesis-bootstrap/checkpoints/"
The checkpoint paths are in the format `flow-genesis-bootstrap/checkpoints/[network]/[epoch number]-[block height]/`.
Where
* `[network]` is the network the checkpoint is from. For example, `mainnet` or `testnet`.
* `[epoch number]` is the epoch number when the checkpoint was taken. You can find the current epoch number on the [flowdiver](https://www.flowdiver.io/) home page.
* `[epoch number]` is the epoch number when the checkpoint was taken. You can find the current epoch number on the [flowscan.io](https://flowscan.io/) home page.
* `[block height]` is the block height at which the checkpoint was taken.
Make sure that the checkpoint you select is from an epoch when your node was part of the network.

Expand Down
Loading
Loading