Skip to content

Commit

Permalink
chore: Add caution message for inspect requests in backend and fronte…
Browse files Browse the repository at this point in the history
…nd documentation
  • Loading branch information
masiedu4 committed Jul 8, 2024
1 parent 5759b0e commit 2f1133d
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
4 changes: 4 additions & 0 deletions cartesi-rollups/development/send-requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,10 @@ Here is a [React.js + Typescript template](https://github.com/prototyp3-dev/fron

Inspect requests are directly made to the rollup server, and the Cartesi Machine is activated without modifying its state.

:::caution Inspect requests
Inspect requests are best suited for non-production use, such as debugging and testing. They may not function reliably in production environments, potentially leading to errors or disruptions.
:::

![img](../../static/img/v1.3/inspect.jpg)

You can make a simple inspect call from your frontend client to retrieve reports.
Expand Down
4 changes: 4 additions & 0 deletions cartesi-rollups/rollups-apis/backend/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ The backend of a Cartesi dApp retrieves a new request as follows:

- **Inspect** — This function submits a query about the application's current state. When running inside a Cartesi Machine, this operation is guaranteed to leave the state unchanged since the machine is reverted to its exact previous condition after processing. For Inspect requests, the input data has only a payload.

:::caution Inspect requests
Inspect requests are best suited for non-production use, such as debugging and testing. They may not function reliably in production environments, potentially leading to errors or disruptions.
:::

## Advance and Inspect

Here is a simple boilerplate application that handles Advance and Inspect requests:
Expand Down

0 comments on commit 2f1133d

Please sign in to comment.