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.

Sign up for GitHub

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

Jump to bottom

Fix docs links #1420

Merged
merged 2 commits into from
Oct 7, 2021
Merged

Fix docs links #1420

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9b1835f
docs: fix dead links
mjudeikis Oct 4, 2021
55410a7
re-point links from content/ to the rendered page
huitseeker Oct 6, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 5 additions & 5 deletions cmd/access/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Access Node

The access node provides a single point of contact to interact with the Flow network. It implements the [Access API](https://github.com/onflow/flow/blob/master/docs/access-api-spec.md)
The access node provides a single point of contact to interact with the Flow network. It implements the [Access API](https://github.com/onflow/flow/blob/master/docs/content/access-api.md)
Copy link
Member

Choose a reason for hiding this comment

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

Thank you for fixing the links!

It might be even better to link to the rendered page instead of the source, here and for the other links below

Suggested change
The access node provides a single point of contact to interact with the Flow network. It implements the [Access API](https://github.com/onflow/flow/blob/master/docs/content/access-api.md)
The access node provides a single point of contact to interact with the Flow network. It implements the [Access API](https://docs.onflow.org/access-api/)


It is a GRPC server which also connects to a collection node and an execution node via GRPC.

Expand Down Expand Up @@ -40,10 +40,10 @@ At a high level it does the following:
## Processes

### Transaction Lifecycle
1. Transactions are received by the access node via the [SendTransaction API call](https://github.com/onflow/flow/blob/master/docs/access-api-spec.md#sendtransaction).
1. Transactions are received by the access node via the [SendTransaction API call](https://github.com/onflow/flow/blob/master/docs/content/access-api.md#sendtransaction).
2. The access node forwards the transaction to one of the Collection node in the Collection node cluster to which this transaction belongs to and stores it locally as well.
3. If a [GetTransaction](https://github.com/onflow/flow/blob/master/docs/access-api-spec.md#gettransaction) request is received, the transaction is read from local storage and returned if found.
4. If a [GetTransactionResult](https://github.com/onflow/flow/blob/master/docs/access-api-spec.md#gettransactionresult) request is received,
3. If a [GetTransaction](https://github.com/onflow/flow/blob/master/docs/content/access-api-spec.md#gettransaction) request is received, the transaction is read from local storage and returned if found.
4. If a [GetTransactionResult](https://github.com/onflow/flow/blob/master/docs/content/access-api-spec.md#gettransactionresult) request is received,
an execution node is requested for events for the transaction and the transaction status is derived as follows:
1. If the collection containing the transaction and the block containing that collection is found locally, but the transaction has expired then its status is returned as `expired`.
2. If either the collection or the block is not found locally, but the transaction has not expired, then its status is returned as `pending`
Expand Down Expand Up @@ -73,7 +73,7 @@ The `requester` engine requests collections from the collection nodes on behalf

### [RPC](../../engine/access/rpc)

The `rpc` engine is the GRPC server which responds to the [Access API](https://github.com/onflow/flow/blob/master/docs/access-api-spec.md) requests from clients.
The `rpc` engine is the GRPC server which responds to the [Access API](https://github.com/onflow/flow/blob/master/docs/content/access-api-spec.md) requests from clients.
It also supports GRPCWebproxy requests.

### [Ping](../../engine/access/ping)
Expand Down