Skip to content

docs(node): clarify v0.14 network note diagnostics #279

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

Open
BrianSeong99 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(node): clarify v0.14 network note diagnostics #279

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions versioned_docs/version-0.14/core-concepts/node/operator/architecture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,3 +66,8 @@ number of failures, preventing resource exhaustion. The threshold can be set wit
The builder also exposes an internal gRPC server that the RPC component uses to proxy debugging endpoints such as
`GetNoteError`. In bundled mode this is wired automatically; in distributed mode operators must set
`--ntx-builder.url` (or `MIDEN_NODE_NTX_BUILDER_URL`) on the RPC component.

Network transactions can read public foreign account state through foreign procedure invocation (FPI) while consuming a
network note. The foreign account must be public and retrievable from the store at the transaction's reference block. If
the foreign account is missing, private, or otherwise unavailable, the note execution can fail and the latest failure is
reported through [`GetNoteError`](../rpc#getnoteerror).
7 changes: 6 additions & 1 deletion versioned_docs/version-0.14/core-concepts/node/rpc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,10 +234,15 @@ Request the status of the node components. The response contains the current ver

### GetNoteError

Returns the latest execution error for a network note, if any. This is useful for debugging notes that are failing to be consumed by the network transaction builder.
Returns the latest execution error for a network note, if any. This is the v0.14 endpoint for debugging notes that are
failing to be consumed by the network transaction builder.

This endpoint is only available when the network transaction builder is enabled and connected. If it is not configured, the endpoint returns `UNAVAILABLE`.

Use this endpoint when a network note appears stuck or is repeatedly failing. For example, if a network account consumes
a note whose script performs FPI into another account, missing or unavailable foreign account data can surface here as
the latest execution error.

#### Request

```protobuf
Expand Down
Loading