Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
501 commits
Select commit Hold shift + click to select a range
aaf501c
cosmetic updates, dapp to app, sidebar collapse set to true
riseandshaheen Aug 28, 2025
6a194d0
honeypot application logic corrections
riseandshaheen Sep 4, 2025
aa03830
updates with review comments from lyno
riseandshaheen Sep 5, 2025
2497df5
Rename Computation-Hash-Rollups.jpg to computation-hash-rollups.jpg
riseandshaheen Sep 5, 2025
7aacd11
minor updates
riseandshaheen Sep 8, 2025
8995a3f
minor refinements
riseandshaheen Sep 8, 2025
583b3c7
Default to 1.5, removed outdated commands from quickstart and removed…
riseandshaheen Sep 19, 2025
5edef91
Hide 2.0 docs from the dropdown version list
riseandshaheen Sep 24, 2025
2cd6e16
Update vouchers.md
jplgarcia Sep 24, 2025
b3df546
Update yarn.lock
jplgarcia Sep 24, 2025
dd1a226
add: implemented a sidebar file for V2
Nonnyjoe Oct 10, 2024
d8bb5cf
update: Modified the Development folder for V2
Nonnyjoe Oct 10, 2024
c18c5d4
fix: Handled error relating to broken links
Nonnyjoe Oct 11, 2024
8d3f7c7
docs: restructuring the api reference
henriquemarlon Oct 15, 2024
bde27ef
modified: overview & quickstart merged in side-bar
riseandshaheen Oct 14, 2024
bb6e37d
docs: fix the reference for api-reference inside of getting-started
henriquemarlon Oct 15, 2024
2ed48ac
remapped pages
jplgarcia Nov 21, 2024
78a9cb6
setting redirects
jplgarcia Nov 21, 2024
6b7d140
remapped pages
jplgarcia Nov 21, 2024
669a4dd
setting redirects
jplgarcia Nov 21, 2024
6db3de2
add: implemented a sidebar file for V2
Nonnyjoe Oct 10, 2024
1a920d8
update: Modified the Development folder for V2
Nonnyjoe Oct 10, 2024
d6b15e9
fix: Handled error relating to broken links
Nonnyjoe Oct 11, 2024
2071b2a
update: modified application factory contract in line with V2.0
Nonnyjoe Nov 18, 2024
617312a
update: modified the different portals page in line with docs V2
Nonnyjoe Nov 18, 2024
8ec4ae3
mod: relayer page and also reference in sidebar
Nonnyjoe Nov 18, 2024
71e907d
mod: updated querry outputs inline with V2
Nonnyjoe Nov 25, 2024
d3dac83
merge: merged Joao's restructure with V2 updates
Nonnyjoe Nov 25, 2024
711628c
update: modified asssets-handling inline with V2
Nonnyjoe Nov 25, 2024
90335f1
add: Added an external resource section
Nonnyjoe Nov 7, 2024
13538df
update: restructured external resource position
Nonnyjoe Nov 7, 2024
9cc901c
add: Added an external resource section
Nonnyjoe Nov 7, 2024
3281086
update: restructured external resource position
Nonnyjoe Nov 7, 2024
d67e27b
update: added shour descriptions for different integratins
Nonnyjoe Nov 18, 2024
08337b8
add: added the integrations guide section
Nonnyjoe Nov 25, 2024
542a816
add: added the integrations guide section
Nonnyjoe Nov 25, 2024
668c7e5
update on structure, spliting architecture concepts and installation …
jplgarcia Dec 9, 2024
d4ec723
updated tutorials for v2
jplgarcia Dec 23, 2024
27b9520
admonition
jorka Dec 2, 2024
9a43fde
announcement bar
jorka Dec 2, 2024
af112d9
api item
jorka Dec 2, 2024
bd1be98
edit this page, custom icons
jorka Dec 9, 2024
b36db2f
footer
jorka Dec 10, 2024
559cb77
edit icon fix
jorka Dec 11, 2024
a03f86f
edit icon fix
jorka Dec 11, 2024
13e4948
remove console log
jorka Dec 12, 2024
d33358c
sidebar version
jorka Dec 12, 2024
a078a93
sidebar version
jorka Dec 12, 2024
7cc4f25
config and deps
jorka Dec 12, 2024
baae29f
remove DocVersionBadge
jorka Dec 12, 2024
e2c3639
open api config - enable generation of previos versions
jorka Dec 13, 2024
a5ed6d5
generate prev versions open api
jorka Dec 13, 2024
6787948
yarn lock
jorka Dec 13, 2024
713a0a5
remove log
jorka Dec 13, 2024
71cbc8f
add deps
jorka Dec 13, 2024
df14af7
fix mdx
jorka Dec 18, 2024
a521134
add missing page to fix broken links
jorka Dec 18, 2024
daad1f0
fix api folder for v2, comment missing redirects, switch to v2
jorka Dec 18, 2024
adfb34a
docs: application section updated to v2
henriquemarlon Dec 2, 2024
2b76828
docs: typos and solving requests for input-box and application consensus
henriquemarlon Mar 8, 2025
30e9f75
docs: update from json-rpc to contracts
henriquemarlon Mar 8, 2025
982089d
docs: update broken links
henriquemarlon Mar 8, 2025
48ae7e5
docs: update broken links
henriquemarlon Mar 8, 2025
86fa2d5
docs: update from json-rpc to contracts
henriquemarlon Mar 8, 2025
973196c
docs: solve broken links and wrong references
henriquemarlon Mar 8, 2025
03cad85
migration guide v1.5 to v2
riseandshaheen Mar 11, 2025
b710e13
feat: docs v2 products restructuring, rollups and coprocessor in navbar
riseandshaheen Apr 28, 2025
7c88b3f
fix: visibility of version dropdown and table of contents on coproces…
riseandshaheen Apr 29, 2025
2c07282
doc: added quickstart(rollups) to Get-Started tab
riseandshaheen Apr 30, 2025
68afb33
refactor: removed troubleshooting, differences with rollups and nonod…
riseandshaheen May 1, 2025
fcf3df4
revert: coprocessor content
riseandshaheen May 16, 2025
1fe9483
updated content for cartesi-machine and fraud-proofs
riseandshaheen May 16, 2025
800e08d
changed table font size for better fit
jplgarcia May 20, 2025
b1e31dd
docs(api): graphql reference update
henriquemarlon Mar 31, 2025
d1a7af3
queries update
henriquemarlon Apr 3, 2025
2118ab6
docs: more clear description and some broken links
henriquemarlon Apr 7, 2025
87d72f0
docs: add delegate call voucher docs
henriquemarlon Apr 8, 2025
717c9ad
docs: fix references for filters
henriquemarlon Apr 8, 2025
66f7cbc
docs: update inspect request reference
henriquemarlon Apr 8, 2025
b36260e
docs:add reference for delegate call vouchers on vouchers section
henriquemarlon Apr 8, 2025
20135ba
docs(api-reference): add exception and finish to backend
henriquemarlon Apr 8, 2025
76510be
docs(api-reference): chnage query for enum
henriquemarlon Apr 8, 2025
8619da8
docs(api-reference): add outputs on intro for backend apis
henriquemarlon Apr 9, 2025
bcfff41
docs(api-reference): update info for finish endpoint
henriquemarlon Apr 9, 2025
f0a86f3
docs: improve delegate call voucher description
henriquemarlon May 2, 2025
745a234
docs: json-rpc api section
henriquemarlon May 2, 2025
edfb2be
docs: improve description and references
henriquemarlon May 3, 2025
dff6efe
docs: improve description and references
henriquemarlon May 3, 2025
9dfb6cd
docs: fix sidebar
henriquemarlon May 3, 2025
6820d62
docs: update json-rpc api reference
henriquemarlon Jun 2, 2025
6b65e81
update contracts and json-rpc, consensus WIP
henriquemarlon Jun 26, 2025
d00c211
docs: modified development section images
Nonnyjoe Mar 16, 2025
6880632
docs: modified assets-handling section
Nonnyjoe Mar 16, 2025
c234bc3
docs: modified building section in line with v2 updates
Nonnyjoe Mar 16, 2025
c417e51
docs: partial update to the cli command section
Nonnyjoe Mar 16, 2025
9e35c55
docs: Modified graphQL queries and dapp reference in query section
Nonnyjoe Mar 16, 2025
0f84fe5
docs: updated send-inputs section in line with V2 updates
Nonnyjoe Mar 16, 2025
44205d0
docs: added page for managing devnet environment
Nonnyjoe Mar 18, 2025
c31634c
docs: modifying the deploying an app section
Nonnyjoe Mar 19, 2025
445f651
docs: updated cli-commands section inline with cli2.0
Nonnyjoe Mar 20, 2025
eee664d
docs: updated broken links in tutorial section referencing changes in…
Nonnyjoe Mar 20, 2025
77ddd86
docs: modified page title for building and deploying an application
Nonnyjoe Mar 20, 2025
bbd4b18
docs: reflected first stage of reviews
Nonnyjoe Mar 21, 2025
2894cb5
docs: updated cli commands in line with cli-aplha-9
Nonnyjoe Apr 21, 2025
ca2fa3e
docs: updated api-reference
Nonnyjoe Jun 5, 2025
dc22502
docs: restructured development section
Nonnyjoe Jun 5, 2025
7e76fe0
docs: Implemented reviews across development section
Nonnyjoe Jun 9, 2025
edaf696
docs: Rebased on staging and fixed broken links
Nonnyjoe Jun 9, 2025
fcb9f23
update delegatecall
henriquemarlon Aug 8, 2025
98c21ac
removed espresso, added react tutorials and app-chains page
riseandshaheen Jun 16, 2025
fee60a4
added diagrams and minor improvements
riseandshaheen Jul 3, 2025
46da465
added spacing on big square image
jplgarcia Jul 3, 2025
7973d1d
update application contract and add consensus section
henriquemarlon Aug 8, 2025
a81a9ae
minor improvements and cosmetic changes
henriquemarlon Aug 10, 2025
a578d0c
fix: id correspondence
henriquemarlon Aug 10, 2025
6419b98
fix: id correspondence
henriquemarlon Aug 10, 2025
c74902b
revert golang version for delegate call voucher
henriquemarlon Aug 10, 2025
6b97ba7
docs(development): Updated development section in line with updates o…
Nonnyjoe Aug 12, 2025
9f4760b
feat: src files and deployment tutorial for local node deployment
henriquemarlon Aug 11, 2025
df5c8d4
feat: change link for compose file
henriquemarlon Aug 11, 2025
8c3ca52
minor improvements and snapshot section with gh actions example
henriquemarlon Aug 14, 2025
09724f2
docs: update snapshot workflow description and minor updates on self-…
henriquemarlon Aug 21, 2025
c70a03d
Fraud Proofs Tab- Content
riseandshaheen Aug 25, 2025
d5ff4a3
cosmetic updates and review comments updated content
riseandshaheen Aug 27, 2025
c218b1d
cosmetic updates, dapp to app, sidebar collapse set to true
riseandshaheen Aug 28, 2025
a3df5bf
honeypot application logic corrections
riseandshaheen Sep 4, 2025
90aca73
updates with review comments from lyno
riseandshaheen Sep 5, 2025
1d0f677
Rename Computation-Hash-Rollups.jpg to computation-hash-rollups.jpg
riseandshaheen Sep 5, 2025
322f802
minor updates
riseandshaheen Sep 8, 2025
b8324bc
minor refinements
riseandshaheen Sep 8, 2025
fa71393
Default to 1.5, removed outdated commands from quickstart and removed…
riseandshaheen Sep 19, 2025
d40ae4d
add: implemented a sidebar file for V2
Nonnyjoe Oct 10, 2024
84beb77
update: Modified the Development folder for V2
Nonnyjoe Oct 10, 2024
e70ede2
fix: Handled error relating to broken links
Nonnyjoe Oct 11, 2024
b983428
docs: restructuring the api reference
henriquemarlon Oct 15, 2024
75e0043
modified: overview & quickstart merged in side-bar
riseandshaheen Oct 14, 2024
02c458b
remapped pages
jplgarcia Nov 21, 2024
5bbaf8d
setting redirects
jplgarcia Nov 21, 2024
716c707
fix: Handled error relating to broken links
Nonnyjoe Oct 11, 2024
cbb87bf
update: modified application factory contract in line with V2.0
Nonnyjoe Nov 18, 2024
f8cd3e0
update: modified the different portals page in line with docs V2
Nonnyjoe Nov 18, 2024
53a29df
mod: relayer page and also reference in sidebar
Nonnyjoe Nov 18, 2024
61be931
mod: updated querry outputs inline with V2
Nonnyjoe Nov 25, 2024
0ffb3fc
merge: merged Joao's restructure with V2 updates
Nonnyjoe Nov 25, 2024
e150039
update: modified asssets-handling inline with V2
Nonnyjoe Nov 25, 2024
3c32a3c
add: Added an external resource section
Nonnyjoe Nov 7, 2024
f03c59c
update: restructured external resource position
Nonnyjoe Nov 7, 2024
f56e9e2
add: Added an external resource section
Nonnyjoe Nov 7, 2024
100517a
update: restructured external resource position
Nonnyjoe Nov 7, 2024
e2d8502
update: added shour descriptions for different integratins
Nonnyjoe Nov 18, 2024
7cb4941
add: added the integrations guide section
Nonnyjoe Nov 25, 2024
99e20c6
update on structure, spliting architecture concepts and installation …
jplgarcia Dec 9, 2024
c9ff192
updated tutorials for v2
jplgarcia Dec 23, 2024
9555029
admonition
jorka Dec 2, 2024
2f2c453
announcement bar
jorka Dec 2, 2024
550b0bd
api item
jorka Dec 2, 2024
1dd5cea
edit this page, custom icons
jorka Dec 9, 2024
2718fc1
footer
jorka Dec 10, 2024
13f6a48
edit icon fix
jorka Dec 11, 2024
ee22f7f
edit icon fix
jorka Dec 11, 2024
7e44b4e
remove console log
jorka Dec 12, 2024
45ae4b0
sidebar version
jorka Dec 12, 2024
ca46035
sidebar version
jorka Dec 12, 2024
4402721
config and deps
jorka Dec 12, 2024
cd75234
remove DocVersionBadge
jorka Dec 12, 2024
bed181a
open api config - enable generation of previos versions
jorka Dec 13, 2024
ac7b604
generate prev versions open api
jorka Dec 13, 2024
0cb09b6
yarn lock
jorka Dec 13, 2024
acad7d9
remove log
jorka Dec 13, 2024
42c3e68
add deps
jorka Dec 13, 2024
db9d792
fix mdx
jorka Dec 18, 2024
4361314
add missing page to fix broken links
jorka Dec 18, 2024
d5a1407
fix api folder for v2, comment missing redirects, switch to v2
jorka Dec 18, 2024
db70e71
docs: application section updated to v2
henriquemarlon Dec 2, 2024
79c0b16
docs: typos and solving requests for input-box and application consensus
henriquemarlon Mar 8, 2025
37f1a5c
docs: update from json-rpc to contracts
henriquemarlon Mar 8, 2025
b0607d7
docs: update broken links
henriquemarlon Mar 8, 2025
097a3fc
docs: update broken links
henriquemarlon Mar 8, 2025
bcc2e6b
docs: update from json-rpc to contracts
henriquemarlon Mar 8, 2025
32485e6
docs: solve broken links and wrong references
henriquemarlon Mar 8, 2025
d442e8a
migration guide v1.5 to v2
riseandshaheen Mar 11, 2025
fd06ff8
feat: docs v2 products restructuring, rollups and coprocessor in navbar
riseandshaheen Apr 28, 2025
105128e
fix: visibility of version dropdown and table of contents on coproces…
riseandshaheen Apr 29, 2025
c58211e
doc: added quickstart(rollups) to Get-Started tab
riseandshaheen Apr 30, 2025
616cb7d
refactor: removed troubleshooting, differences with rollups and nonod…
riseandshaheen May 1, 2025
f9229b3
revert: coprocessor content
riseandshaheen May 16, 2025
0ca2ef0
updated content for cartesi-machine and fraud-proofs
riseandshaheen May 16, 2025
4cfe501
changed table font size for better fit
jplgarcia May 20, 2025
3c5cab8
docs(api): graphql reference update
henriquemarlon Mar 31, 2025
5471ae6
queries update
henriquemarlon Apr 3, 2025
a7eb86b
docs: more clear description and some broken links
henriquemarlon Apr 7, 2025
0cec95f
docs: add delegate call voucher docs
henriquemarlon Apr 8, 2025
8ecd63f
docs: fix references for filters
henriquemarlon Apr 8, 2025
2dc1b10
docs: update inspect request reference
henriquemarlon Apr 8, 2025
5291f51
docs:add reference for delegate call vouchers on vouchers section
henriquemarlon Apr 8, 2025
d33bdfb
docs(api-reference): add exception and finish to backend
henriquemarlon Apr 8, 2025
3f30d6d
docs(api-reference): chnage query for enum
henriquemarlon Apr 8, 2025
f55b9d0
docs(api-reference): add outputs on intro for backend apis
henriquemarlon Apr 9, 2025
dfda8d4
docs(api-reference): update info for finish endpoint
henriquemarlon Apr 9, 2025
695b94c
docs: improve delegate call voucher description
henriquemarlon May 2, 2025
8f7352f
docs: json-rpc api section
henriquemarlon May 2, 2025
7c4d56b
docs: improve description and references
henriquemarlon May 3, 2025
84e63e3
docs: improve description and references
henriquemarlon May 3, 2025
da686d5
docs: fix sidebar
henriquemarlon May 3, 2025
e381634
docs: update json-rpc api reference
henriquemarlon Jun 2, 2025
4812610
update contracts and json-rpc, consensus WIP
henriquemarlon Jun 26, 2025
0b52cd9
docs: modified development section images
Nonnyjoe Mar 16, 2025
94c7fec
docs: modified assets-handling section
Nonnyjoe Mar 16, 2025
03fcad8
docs: modified building section in line with v2 updates
Nonnyjoe Mar 16, 2025
2e59bc4
docs: partial update to the cli command section
Nonnyjoe Mar 16, 2025
736afcd
docs: Modified graphQL queries and dapp reference in query section
Nonnyjoe Mar 16, 2025
52f558c
docs: updated send-inputs section in line with V2 updates
Nonnyjoe Mar 16, 2025
ef0dc66
docs: added page for managing devnet environment
Nonnyjoe Mar 18, 2025
302a183
docs: modifying the deploying an app section
Nonnyjoe Mar 19, 2025
93c48b5
docs: updated cli-commands section inline with cli2.0
Nonnyjoe Mar 20, 2025
1066525
docs: updated broken links in tutorial section referencing changes in…
Nonnyjoe Mar 20, 2025
1606ab7
docs: modified page title for building and deploying an application
Nonnyjoe Mar 20, 2025
785a1a7
docs: reflected first stage of reviews
Nonnyjoe Mar 21, 2025
e840037
docs: updated cli commands in line with cli-aplha-9
Nonnyjoe Apr 21, 2025
4d045f0
docs: updated api-reference
Nonnyjoe Jun 5, 2025
f82f453
docs: restructured development section
Nonnyjoe Jun 5, 2025
636d4bc
docs: Implemented reviews across development section
Nonnyjoe Jun 9, 2025
a48cf5a
docs: Rebased on staging and fixed broken links
Nonnyjoe Jun 9, 2025
2e1c8bb
update delegatecall
henriquemarlon Aug 8, 2025
0042be1
removed espresso, added react tutorials and app-chains page
riseandshaheen Jun 16, 2025
e21aefb
added diagrams and minor improvements
riseandshaheen Jul 3, 2025
01d014a
added spacing on big square image
jplgarcia Jul 3, 2025
ce7c3e6
update application contract and add consensus section
henriquemarlon Aug 8, 2025
b861c03
minor improvements and cosmetic changes
henriquemarlon Aug 10, 2025
0c53db7
fix: id correspondence
henriquemarlon Aug 10, 2025
8beba01
fix: id correspondence
henriquemarlon Aug 10, 2025
5ceaae4
revert golang version for delegate call voucher
henriquemarlon Aug 10, 2025
63c7cff
docs(development): Updated development section in line with updates o…
Nonnyjoe Aug 12, 2025
e254fe1
feat: src files and deployment tutorial for local node deployment
henriquemarlon Aug 11, 2025
d5ec658
feat: change link for compose file
henriquemarlon Aug 11, 2025
fdbace4
minor improvements and snapshot section with gh actions example
henriquemarlon Aug 14, 2025
5254638
docs: update snapshot workflow description and minor updates on self-…
henriquemarlon Aug 21, 2025
a9944be
Fraud Proofs Tab- Content
riseandshaheen Aug 25, 2025
df9b67d
cosmetic updates and review comments updated content
riseandshaheen Aug 27, 2025
d574887
cosmetic updates, dapp to app, sidebar collapse set to true
riseandshaheen Aug 28, 2025
eeb9183
honeypot application logic corrections
riseandshaheen Sep 4, 2025
83b6f4e
updates with review comments from lyno
riseandshaheen Sep 5, 2025
be0031d
Rename Computation-Hash-Rollups.jpg to computation-hash-rollups.jpg
riseandshaheen Sep 5, 2025
56aa4cb
minor updates
riseandshaheen Sep 8, 2025
6f6ab27
minor refinements
riseandshaheen Sep 8, 2025
16c4c6e
Default to 1.5, removed outdated commands from quickstart and removed…
riseandshaheen Sep 19, 2025
9451aba
Hide 2.0 docs from the dropdown version list
riseandshaheen Sep 24, 2025
8a72781
Update vouchers.md
jplgarcia Sep 24, 2025
a919fc5
Update yarn.lock
jplgarcia Sep 24, 2025
b2be51c
Update compute.md
jplgarcia Sep 24, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
8 changes: 8 additions & 0 deletions .vscode/ltex.dictionary.en-US.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Cartesi
dApp
Rollups
Prevado
XMTP
Farcaster
onchain
Mugen
4 changes: 4 additions & 0 deletions .vscode/ltex.hiddenFalsePositives.en-US.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{"rule":"BASE_BASIS","sentence":"^\\QThis guide covers the Cartesi+Espresso integration and how to upgrade Cartesi application such that inputs can be submitted via Espresso instead of the regular base layer.\\E$"}
{"rule":"MORFOLOGIK_RULE_EN_US","sentence":"^\\QIntegrating Cartesi and Chronicle offers Cartesi applications access to onchain and offcahin data like, price feed without developers having to set up additional systems or intermediaries.\\E$"}
{"rule":"MORFOLOGIK_RULE_EN_US","sentence":"^\\QPrevado Id:\\E$"}
{"rule":"MORFOLOGIK_RULE_EN_US","sentence":"^\\QThe Devnet environment functions similarly to a mainnet.\\E$"}
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Cartesi Documentation

Welcome to the official Cartesi documentation repository. This documentation is built using [Docusaurus 2.4.3](https://docusaurus.io/).
Welcome to the official Cartesi documentation repository. This documentation is built using [Docusaurus 3.6.3](https://docusaurus.io/).

## Requirements

Expand Down
Original file line number Diff line number Diff line change
@@ -1,26 +1,48 @@
---
id: inspect-state-http-api-for-cartesi-rollups
title: "Inspect-state HTTP API for Cartesi Rollups"
description: "API that allows the dApp frontend to make inspect-state requests to the dApp backend.
"
description: "API that allows the dApp frontend to make inspect-state requests to the dApp backend."
sidebar_label: Introduction
sidebar_position: 0
hide_title: true
custom_edit_url: null
---

import ApiLogo from "@theme/ApiLogo";
import Tabs from "@theme/Tabs";
import Heading from "@theme/Heading";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";
import Export from "@theme/ApiExplorer/Export";

<span className={"theme-doc-version-badge badge badge--secondary"}>
Version: 0.4.0
<span
className={"theme-doc-version-badge badge badge--secondary"}
children={"Version: 0.4.0"}
>
</span>

# Inspect-state HTTP API for Cartesi Rollups
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Inspect-state HTTP API for Cartesi Rollups"}
>
</Heading>



API that allows the dApp frontend to make inspect-state requests to the dApp backend.

<div style={{ marginBottom: "var(--ifm-paragraph-margin-bottom)" }}>
<h3 style={{ marginBottom: "0.25rem" }}>License</h3>
<a href={"https://www.apache.org/licenses/LICENSE-2.0.html"}>Apache-2.0</a>

<div
style={{"marginBottom":"var(--ifm-paragraph-margin-bottom)"}}
>
<h3
style={{"marginBottom":"0.25rem"}}
>
License
</h3><a
href={"https://www.apache.org/licenses/LICENSE-2.0.html"}
>
Apache-2.0
</a>
</div>

100 changes: 59 additions & 41 deletions cartesi-rollups_versioned_docs/version-0.8/api/inspect/inspect.api.mdx

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1,31 +1,40 @@
---
id: add-notice
title: "Add a new notice"
description: "The dApp backend can call this method to add a new notice when processing advance-state request.
A notice describes any changes to the internal state of the dApp that may be relevant to the blockchain.
Between calls to the finish method, the notice method can be called at least 32k times.

The returned value is the index of the notice for the current advance request.
In other words, the index counting restarts at every request.
"
sidebar_label: Add a new notice
description: "The dApp backend can call this method to add a new notice when processing advance-state request."
sidebar_label: "Add a new notice"
hide_title: true
hide_table_of_contents: true
api: {"operationId":"addNotice","description":"The dApp backend can call this method to add a new notice when processing advance-state request.\nA notice describes any changes to the internal state of the dApp that may be relevant to the blockchain.\nBetween calls to the finish method, the notice method can be called at least 32k times.\n\nThe returned value is the index of the notice for the current advance request.\nIn other words, the index counting restarts at every request.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"payload":{"type":"string","description":"Payload in the Ethereum hex binary format.\nThe first two characters are '0x' followed by pairs of hexadecimal numbers that correspond to one byte.\nFor instance, '0xdeadbeef' corresponds to a payload with length 4 and bytes 222, 173, 190, 175.\nAn empty payload is represented by the string '0x'.\n","example":"0xdeadbeef"}}}}}},"responses":{"200":{"description":"Created the notice.","content":{"application/json":{"schema":{"type":"object","properties":{"index":{"type":"integer","format":"uint64","description":"Position in the Merkle tree.","example":123}}}}}},"default":{"description":"Error response.","content":{"text/plain":{"schema":{"type":"string","description":"Detailed error message.","example":"The request could not be understood by the server due to malformed syntax"}}}}},"method":"post","path":"/notice","servers":[{"url":"https://<dapp_rollup_url>"},{"url":"http://localhost:5005/rollup"}],"jsonRequestBodyExample":{"payload":"0xdeadbeef"},"info":{"title":"Cartesi Rollup HTTP API","version":"0.4.0","license":{"name":"Apache-2.0","url":"https://www.apache.org/licenses/LICENSE-2.0.html"},"description":"API that the Cartesi Rollup HTTP Server implements.\n\nIn the box below, there is an example of a dApp backend that uses the Rollup HTTP API.\n\n```\nimport requests\nimport sys\n\nrollup = sys.argv[1]\n\ndef check_status_code(response):\n if response.status_code not in range(200, 300):\n print(f'Error: invalid status code {response.status_code}')\n sys.exit(1)\n return response\n\nfinish = {'status': 'accept'}\nwhile True:\n print('Sending finish')\n r = check_status_code(requests.post(rollup + '/finish', json=finish))\n if r.status_code == 202:\n print('No pending rollup request, trying again')\n continue\n\n rollup_request = r.json()\n if rollup_request['request_type'] == 'advance_state':\n print('Sending voucher')\n voucher = {\n 'address': rollup_request['data']['metadata']['msg_sender'],\n 'payload': rollup_request['data']['payload']\n }\n check_status_code(requests.post(rollup + '/voucher', json=voucher))\n\n print('Sending notice')\n notice = {'payload': rollup_request['data']['payload']}\n check_status_code(requests.post(rollup + '/notice', json=notice))\n\n print('Sending report')\n report = {'payload': rollup_request['data']['payload']}\n check_status_code(requests.post(rollup + '/report', json=report))\n\n finish['status'] = 'accept'\n\n elif rollup_request['request_type'] == 'inspect_state':\n print('Sending report per inspect request')\n report = {'payload': rollup_request['data']['payload']}\n check_status_code(requests.post(rollup + '/report', json=report))\n\n else:\n print('Throwing rollup exception')\n exception = {'payload': rollup_request['data']['payload']}\n requests.post(rollup + '/exception', json=exception)\n break\n```\n"},"postman":{"name":"Add a new notice","description":{"content":"The dApp backend can call this method to add a new notice when processing advance-state request.\nA notice describes any changes to the internal state of the dApp that may be relevant to the blockchain.\nBetween calls to the finish method, the notice method can be called at least 32k times.\n\nThe returned value is the index of the notice for the current advance request.\nIn other words, the index counting restarts at every request.\n","type":"text/plain"},"url":{"path":["notice"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}}
api: eJztWG1v2zYQ/iuEvijBXNtx2g0LlgFpl2EBti5osk+OkdLS2VIjkxpJxTEM//c9R1K24qRd94JhA2YgNnU6Hp977ng8Zp3omox0pVYXeXKSyDx/q12ZUdJLcrKZKWt+hzfXBYn8rK7FVGZ3pHKRSYW/qhKuKK1YkCt0LpwWMCGkULQUylsSy4KUqI3OyNpSzaFwL1VGL6yTjoShXxuyrn+jztoJYeEpWSHVSmSFVHOMYdoBQ6kcGSUrEabrmZd6ZK6QTizkSkzZbEVYxrXTppXO7mCqVFjpNbklUYC/NTwrVWmL6EjPiyKe6Bs7DMs8ieCiExVJ68Tx6E64ckEWhm8U02TINUZB515WDRDbCDynhxZvtDzTxj9mjTEEsJGaDikXSmhoGLHUJre9jqVMN8oxnwaa0jjLkOiezKozHWGMD691vkpO1kmmQaByPJR1XZWZD/7gg+UorxObFbSQPHKrmhB3Pf1AmYMdRBCp4kqy/LaWq0rLvKNonQGaJ3lzGRQB2mM/Z2eoWYgCLkxLJQEXLCwko732YTAg1S01B97IDNGGZ4ZEOnxIoVpVeglqpytRS6gyoTAlc8rKBbJCNYspz/C5kGnQamutfGJqhTRYOcJC34P3UoE2kN1jyznJfEo0SztzfGZIET0Vy9IVCLma4+clMjP3xqwYjUY9cfTVMb6+HvLoFeeyErSo3Wo7G0lgqIZlcB/gMxuBM+9aCBY8WdQV07nDBLErnRdGMpPNZieL+3WzYWGAbkOMRsMh/zyOxxtDkhHssrCPBf6mrPCZ2VHjzTonA70QY4gayL58+TRNtC152ObJT2TuKhLOkMe35eVodLxz/cIv1yXDS95FEiInOc1kU7mnVJwbgzxoKdujwdGDG9QVCsazBHwk278jJ0suD+RtoypYOX/sQRJKhN+UvImrnOPAlaUBeCS/1rv8IIMNLXJUEeQi8ptphHW7Uk4+dBLDu+L9hcOhXkFaa+tjJF2Bp4FqK3swi4iN10ljKrwrnKvtyWDwTY7w3xrssqa+xatvk02vqwMVFFJZFbB88mo4fDUIuslm0ks4W97tqs1563GnWnTTGkhLNdOe1OjGG9QxsqV4542KH66vL8XZ5QUgM95A8bD/sj+EBElKHGRMV3LBs89qiTC9GPnXj/1aLpd96V/3tZkP4lw7+PHizfnbq3Oe0y/coko2+xHF8qGYcDyew3cVYlSyrwskTzgHLkIaTzWqHKFk+cpt/GGAYyQmAxcv+fhU9Us1lsKZsceDt/z+/fsbhdW0cW0a2a3ArizrhKCIU37uSzO/Hx9NWI6tgLJK2d0tn56Nvc10TgftDjg8uVECn3K22xQdPZ+m2J6Gz+MDFJeeOB4O20n8qbEn3MEs9dl4Al0cgGUugg3hbayfs7xJD3dGGDI9lO7gKArDcbqFxH7Es/pUrNNgJj0Rqcwyql26uVHLAntQXJuGIrgALL0Cw1xvw/R2UQM7z5ESqO3zJjqIhH4h0kGc3BOc7qfh6fBwx9wjyk5PxWg4ekJR+laLOoKJpuN6yBOz8l3SHKWnywvXplI13n8PO2zStpKcYmVGdNCB8khjnMbBLZewdMLY0thweM8pfYqzZexeN6DIdPFEEQdhJ+QPjOYIFsdkH0EunUwn4xQVSm7Hdn6LUxGlL5309izFuvEJS63GZDdz0+Hs88PaehjjGh85sB8lJdTTLiexreO8/APQ/xzguHrEG54+CRf9B0pEF26Q/DNw4+oRbnh6DDdspXG7o5Gg2z3dqlH1eWmN3q5Gf/K7aR0JqMm3gzyl3Yf/TpqosvTUm+vC6GWnlNADk4bjq+vEVvgX/Pgo6t2KEfhW0EEwRed5F88vPmfZyEKq7gG+d3Xcb686t5f/76P/1ftobKA7/fUmdmvr2KmOkxh+9JTcaLJkvZ5KS7+YarNhMewZXGfHGN5LU8opt4/jCSwVaC9x4+DW9o5W3FOGlHlxzeuyOjjg/3TsX3O40Q0zznzR+aTupNNlX/58dQ3labxgL7C/ITVyyZdvfJ8kGGifwv6S5GXrpEIaNbgc4H2wyZ/fAIpfDIM=
sidebar_class_name: "post api-method"
info_path: cartesi-rollups/api/rollup/cartesi-rollup-http-api
info_path: cartesi-rollups/_versioned_docs/version-0.8/api/rollup/cartesi-rollup-http-api
custom_edit_url: null
---

import ApiTabs from "@theme/ApiTabs";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
as={"h1"}
className={"openapi__heading"}
children={"Add a new notice"}
>
</Heading>

<MethodEndpoint
method={"post"}
path={"/notice"}
context={"endpoint"}
>

</MethodEndpoint>


## Add a new notice

The dApp backend can call this method to add a new notice when processing advance-state request.
A notice describes any changes to the internal state of the dApp that may be relevant to the blockchain.
Expand All @@ -34,16 +43,35 @@ Between calls to the finish method, the notice method can be called at least 32k
The returned value is the index of the notice for the current advance request.
In other words, the index counting restarts at every request.

<MimeTabs><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Request Body</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"payload"} required={false} schemaDescription={"Payload in the Ethereum hex binary format.\nThe first two characters are '0x' followed by pairs of hexadecimal numbers that correspond to one byte.\nFor instance, '0xdeadbeef' corresponds to a payload with length 4 and bytes 222, 173, 190, 175.\nAn empty payload is represented by the string '0x'.\n"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></ul></details></TabItem></MimeTabs><div><ApiTabs><TabItem label={"200"} value={"200"}><div>

Created the notice.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>

</div><div><MimeTabs groupId={"mime-type"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs groupId={"schema-tabs"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"index"} required={false} schemaDescription={"Position in the Merkle tree."} schemaName={"uint64"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"index\": 0\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"default"} value={"default"}><div>
<ParamsDetails
parameters={undefined}
>

</ParamsDetails>

Error response.
<RequestSchema
title={"Body"}
body={{"content":{"application/json":{"schema":{"type":"object","properties":{"payload":{"type":"string","description":"Payload in the Ethereum hex binary format.\nThe first two characters are '0x' followed by pairs of hexadecimal numbers that correspond to one byte.\nFor instance, '0xdeadbeef' corresponds to a payload with length 4 and bytes 222, 173, 190, 175.\nAn empty payload is represented by the string '0x'.\n","example":"0xdeadbeef","title":"Payload"}},"title":"Notice"}}}}}
>

</RequestSchema>

</div><div><MimeTabs groupId={"mime-type"}><TabItem label={"text/plain"} value={"text/plain"}><SchemaTabs groupId={"schema-tabs"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><li><div><strong>string</strong><div style={{"marginTop":"var(--ifm-table-cell-padding)"}}>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Created the notice.","content":{"application/json":{"schema":{"type":"object","properties":{"index":{"type":"integer","format":"uint64","description":"Position in the Merkle tree.","example":123,"title":"Index"}},"title":"IndexResponse"}}}},"default":{"description":"Error response.","content":{"text/plain":{"schema":{"type":"string","description":"Detailed error message.","example":"The request could not be understood by the server due to malformed syntax","title":"Error"}}}}}}
>

</StatusCodes>

Detailed error message.

</div></div></li></ul></details></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div>
Loading