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

Fix inspect warning and correct OutputValidityProof structure #225

Merged
merged 2 commits into from
Sep 11, 2024
Merged

Fix inspect warning and correct OutputValidityProof structure #225

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6549caa
fix: inspect usage warning
riseandshaheen Sep 11, 2024
dff60ea
fix: corrected types of OutputValidityProof
riseandshaheen Sep 11, 2024
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
8 changes: 4 additions & 4 deletions cartesi-rollups_versioned_docs/version-1.0/api/json-rpc/sol-output.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,8 +234,8 @@ Data used to prove the validity of an output (notices and vouchers)

```solidity
struct OutputValidityProof {
uint256 inputIndexWithinEpoch;
uint256 outputIndexWithinInput;
uint64 inputIndexWithinEpoch;
uint64 outputIndexWithinInput;
bytes32 outputHashesRootHash;
bytes32 vouchersEpochRootHash;
bytes32 noticesEpochRootHash;
Expand All @@ -249,8 +249,8 @@ struct OutputValidityProof {

| Name | Type | Description |
| -------------------------------- | --------- | ----------------------------------------------------------------- |
| inputIndexWithinEpoch | uint256 | Which input, inside the epoch, the output belongs to |
| outputIndexWithinInput | uint256 | Index of output emitted by the input |
| inputIndexWithinEpoch | uint64 | Which input, inside the epoch, the output belongs to |
| outputIndexWithinInput | uint64 | Index of output emitted by the input |
| outputHashesRootHash | bytes32 | Merkle root of hashes of outputs emitted by the input |
| vouchersEpochRootHash | bytes32 | Merkle root of all epoch's voucher metadata hashes |
| noticesEpochRootHash | bytes32 | Merkle root of all epoch's notice metadata hashes |
Expand Down
2 changes: 1 addition & 1 deletion cartesi-rollups_versioned_docs/version-1.3/development/send-requests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ 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.
Inspect requests should be used cautiously in production environments with heavy traffic or limited resources. Performing thorough stress testing in a staging environment is recommended to assess the impact of Inspect calls on node performance.
:::

![img](../../../static/img/v1.3/inspect.jpg)
Expand Down
8 changes: 4 additions & 4 deletions cartesi-rollups_versioned_docs/version-1.3/rollups-apis/json-rpc/application.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,8 +226,8 @@ Data used to prove the validity of an output (notices and vouchers)

```solidity
struct OutputValidityProof {
uint256 inputIndexWithinEpoch;
uint256 outputIndexWithinInput;
uint64 inputIndexWithinEpoch;
uint64 outputIndexWithinInput;
bytes32 outputHashesRootHash;
bytes32 vouchersEpochRootHash;
bytes32 noticesEpochRootHash;
Expand All @@ -241,8 +241,8 @@ struct OutputValidityProof {

| Name | Type | Description |
| -------------------------------- | --------- | ----------------------------------------------------------------- |
| inputIndexWithinEpoch | uint256 | Which input, inside the epoch, the output belongs to |
| outputIndexWithinInput | uint256 | Index of output emitted by the input |
| inputIndexWithinEpoch | uint64 | Which input, inside the epoch, the output belongs to |
| outputIndexWithinInput | uint64 | Index of output emitted by the input |
| outputHashesRootHash | bytes32 | Merkle root of hashes of outputs emitted by the input |
| vouchersEpochRootHash | bytes32 | Merkle root of all epoch's voucher metadata hashes |
| noticesEpochRootHash | bytes32 | Merkle root of all epoch's notice metadata hashes |
Expand Down
2 changes: 1 addition & 1 deletion cartesi-rollups_versioned_docs/version-1.5/development/send-requests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ Follow [the React.js tutorial to build a frontend for your application](../tutor
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.
Inspect requests should be used cautiously in production environments with heavy traffic or limited resources. Performing thorough stress testing in a staging environment is recommended to assess the impact of Inspect calls on node performance.
:::

![img](../../../static/img/v1.3/inspect.jpg)
Expand Down
8 changes: 4 additions & 4 deletions cartesi-rollups_versioned_docs/version-1.5/rollups-apis/json-rpc/application.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,8 +226,8 @@ Data used to prove the validity of an output (notices and vouchers)

```solidity
struct OutputValidityProof {
uint256 inputIndexWithinEpoch;
uint256 outputIndexWithinInput;
uint64 inputIndexWithinEpoch;
uint64 outputIndexWithinInput;
bytes32 outputHashesRootHash;
bytes32 vouchersEpochRootHash;
bytes32 noticesEpochRootHash;
Expand All @@ -241,8 +241,8 @@ struct OutputValidityProof {

| Name | Type | Description |
| -------------------------------- | --------- | ----------------------------------------------------------------- |
| inputIndexWithinEpoch | uint256 | Which input, inside the epoch, the output belongs to |
| outputIndexWithinInput | uint256 | Index of output emitted by the input |
| inputIndexWithinEpoch | uint64 | Which input, inside the epoch, the output belongs to |
| outputIndexWithinInput | uint64 | Index of output emitted by the input |
| outputHashesRootHash | bytes32 | Merkle root of hashes of outputs emitted by the input |
| vouchersEpochRootHash | bytes32 | Merkle root of all epoch's voucher metadata hashes |
| noticesEpochRootHash | bytes32 | Merkle root of all epoch's notice metadata hashes |
Expand Down
Loading