From 6549caa54963baaee0c6f345d951c3b83da93af1 Mon Sep 17 00:00:00 2001 From: Shaheen Date: Wed, 11 Sep 2024 21:05:38 +0530 Subject: [PATCH 1/2] fix: inspect usage warning --- .../version-1.3/development/send-requests.md | 2 +- .../version-1.5/development/send-requests.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/cartesi-rollups_versioned_docs/version-1.3/development/send-requests.md b/cartesi-rollups_versioned_docs/version-1.3/development/send-requests.md index 3c8c3b60..39d0a443 100644 --- a/cartesi-rollups_versioned_docs/version-1.3/development/send-requests.md +++ b/cartesi-rollups_versioned_docs/version-1.3/development/send-requests.md @@ -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) diff --git a/cartesi-rollups_versioned_docs/version-1.5/development/send-requests.md b/cartesi-rollups_versioned_docs/version-1.5/development/send-requests.md index 525b33b9..f826bcc1 100644 --- a/cartesi-rollups_versioned_docs/version-1.5/development/send-requests.md +++ b/cartesi-rollups_versioned_docs/version-1.5/development/send-requests.md @@ -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) From dff60ea1571d8a07cab5a6e1c47e33a3ed9e761e Mon Sep 17 00:00:00 2001 From: Shaheen Date: Wed, 11 Sep 2024 21:25:40 +0530 Subject: [PATCH 2/2] fix: corrected types of OutputValidityProof --- .../version-1.0/api/json-rpc/sol-output.md | 8 ++++---- .../version-1.3/rollups-apis/json-rpc/application.md | 8 ++++---- .../version-1.5/rollups-apis/json-rpc/application.md | 8 ++++---- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/cartesi-rollups_versioned_docs/version-1.0/api/json-rpc/sol-output.md b/cartesi-rollups_versioned_docs/version-1.0/api/json-rpc/sol-output.md index dcb5d078..f372929b 100644 --- a/cartesi-rollups_versioned_docs/version-1.0/api/json-rpc/sol-output.md +++ b/cartesi-rollups_versioned_docs/version-1.0/api/json-rpc/sol-output.md @@ -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; @@ -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 | diff --git a/cartesi-rollups_versioned_docs/version-1.3/rollups-apis/json-rpc/application.md b/cartesi-rollups_versioned_docs/version-1.3/rollups-apis/json-rpc/application.md index ffe89278..6c4daba7 100644 --- a/cartesi-rollups_versioned_docs/version-1.3/rollups-apis/json-rpc/application.md +++ b/cartesi-rollups_versioned_docs/version-1.3/rollups-apis/json-rpc/application.md @@ -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; @@ -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 | diff --git a/cartesi-rollups_versioned_docs/version-1.5/rollups-apis/json-rpc/application.md b/cartesi-rollups_versioned_docs/version-1.5/rollups-apis/json-rpc/application.md index ffe89278..6c4daba7 100644 --- a/cartesi-rollups_versioned_docs/version-1.5/rollups-apis/json-rpc/application.md +++ b/cartesi-rollups_versioned_docs/version-1.5/rollups-apis/json-rpc/application.md @@ -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; @@ -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 |