Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
504 commits
Select commit Hold shift + click to select a range
bec6e53
Rename Computation-Hash-Rollups.jpg to computation-hash-rollups.jpg
riseandshaheen Sep 5, 2025
25e6748
minor updates
riseandshaheen Sep 8, 2025
fc4ea12
minor refinements
riseandshaheen Sep 8, 2025
2c64199
Default to 1.5, removed outdated commands from quickstart and removed…
riseandshaheen Sep 19, 2025
ed63dcc
Hide 2.0 docs from the dropdown version list
riseandshaheen Sep 24, 2025
527c618
Update vouchers.md
jplgarcia Sep 24, 2025
3e4f32d
Update yarn.lock
jplgarcia Sep 24, 2025
d1220c0
add: implemented a sidebar file for V2
Nonnyjoe Oct 10, 2024
3a74efb
update: Modified the Development folder for V2
Nonnyjoe Oct 10, 2024
a96fa2f
fix: Handled error relating to broken links
Nonnyjoe Oct 11, 2024
cb0e13b
docs: restructuring the api reference
henriquemarlon Oct 15, 2024
ff80bf4
modified: overview & quickstart merged in side-bar
riseandshaheen Oct 14, 2024
8fae474
docs: fix the reference for api-reference inside of getting-started
henriquemarlon Oct 15, 2024
5fe0478
remapped pages
jplgarcia Nov 21, 2024
391007b
setting redirects
jplgarcia Nov 21, 2024
9a76d1c
remapped pages
jplgarcia Nov 21, 2024
7965fe1
setting redirects
jplgarcia Nov 21, 2024
b181dc7
add: implemented a sidebar file for V2
Nonnyjoe Oct 10, 2024
207cdf5
update: Modified the Development folder for V2
Nonnyjoe Oct 10, 2024
f88d077
fix: Handled error relating to broken links
Nonnyjoe Oct 11, 2024
1a6bbc7
update: modified application factory contract in line with V2.0
Nonnyjoe Nov 18, 2024
e400c08
update: modified the different portals page in line with docs V2
Nonnyjoe Nov 18, 2024
73a5ebe
mod: relayer page and also reference in sidebar
Nonnyjoe Nov 18, 2024
1e09a0d
mod: updated querry outputs inline with V2
Nonnyjoe Nov 25, 2024
c4ab5ec
merge: merged Joao's restructure with V2 updates
Nonnyjoe Nov 25, 2024
0c95f70
update: modified asssets-handling inline with V2
Nonnyjoe Nov 25, 2024
8a2f5fe
add: Added an external resource section
Nonnyjoe Nov 7, 2024
6933ac2
update: restructured external resource position
Nonnyjoe Nov 7, 2024
284f856
add: Added an external resource section
Nonnyjoe Nov 7, 2024
11ae62e
update: restructured external resource position
Nonnyjoe Nov 7, 2024
ea2fc63
update: added shour descriptions for different integratins
Nonnyjoe Nov 18, 2024
5291a76
add: added the integrations guide section
Nonnyjoe Nov 25, 2024
b7f2399
add: added the integrations guide section
Nonnyjoe Nov 25, 2024
da7c107
update on structure, spliting architecture concepts and installation …
jplgarcia Dec 9, 2024
5f9676a
updated tutorials for v2
jplgarcia Dec 23, 2024
4789e69
admonition
jorka Dec 2, 2024
ab6ac74
announcement bar
jorka Dec 2, 2024
5d47fb1
api item
jorka Dec 2, 2024
5fbf133
edit this page, custom icons
jorka Dec 9, 2024
bf1672d
footer
jorka Dec 10, 2024
2d405e2
edit icon fix
jorka Dec 11, 2024
e9ca31a
edit icon fix
jorka Dec 11, 2024
dc2ce28
remove console log
jorka Dec 12, 2024
0c97293
sidebar version
jorka Dec 12, 2024
d136bd5
sidebar version
jorka Dec 12, 2024
087f225
config and deps
jorka Dec 12, 2024
4611369
remove DocVersionBadge
jorka Dec 12, 2024
53bcf84
open api config - enable generation of previos versions
jorka Dec 13, 2024
de3d198
generate prev versions open api
jorka Dec 13, 2024
b5f1d4b
yarn lock
jorka Dec 13, 2024
e27d5a7
remove log
jorka Dec 13, 2024
bc18ad4
add deps
jorka Dec 13, 2024
8c69eb0
fix mdx
jorka Dec 18, 2024
8aab397
add missing page to fix broken links
jorka Dec 18, 2024
5a9ca52
fix api folder for v2, comment missing redirects, switch to v2
jorka Dec 18, 2024
481bbf2
docs: application section updated to v2
henriquemarlon Dec 2, 2024
e9a53f3
docs: typos and solving requests for input-box and application consensus
henriquemarlon Mar 8, 2025
f4c7e19
docs: update from json-rpc to contracts
henriquemarlon Mar 8, 2025
9c2c67f
docs: update broken links
henriquemarlon Mar 8, 2025
96f7a28
docs: update broken links
henriquemarlon Mar 8, 2025
08d3410
docs: update from json-rpc to contracts
henriquemarlon Mar 8, 2025
dacfd2b
docs: solve broken links and wrong references
henriquemarlon Mar 8, 2025
f5c8b9d
migration guide v1.5 to v2
riseandshaheen Mar 11, 2025
80a57e3
feat: docs v2 products restructuring, rollups and coprocessor in navbar
riseandshaheen Apr 28, 2025
83ea5fb
fix: visibility of version dropdown and table of contents on coproces…
riseandshaheen Apr 29, 2025
54479fc
doc: added quickstart(rollups) to Get-Started tab
riseandshaheen Apr 30, 2025
f8c55c8
refactor: removed troubleshooting, differences with rollups and nonod…
riseandshaheen May 1, 2025
ab559d1
revert: coprocessor content
riseandshaheen May 16, 2025
63bdba4
updated content for cartesi-machine and fraud-proofs
riseandshaheen May 16, 2025
925bf1e
changed table font size for better fit
jplgarcia May 20, 2025
5ddb22b
docs(api): graphql reference update
henriquemarlon Mar 31, 2025
0b74b3f
queries update
henriquemarlon Apr 3, 2025
72467c4
docs: more clear description and some broken links
henriquemarlon Apr 7, 2025
b03a169
docs: add delegate call voucher docs
henriquemarlon Apr 8, 2025
43b1fa3
docs: fix references for filters
henriquemarlon Apr 8, 2025
81b1c17
docs: update inspect request reference
henriquemarlon Apr 8, 2025
77681e6
docs:add reference for delegate call vouchers on vouchers section
henriquemarlon Apr 8, 2025
5ad497f
docs(api-reference): add exception and finish to backend
henriquemarlon Apr 8, 2025
a245f80
docs(api-reference): chnage query for enum
henriquemarlon Apr 8, 2025
edcfa28
docs(api-reference): add outputs on intro for backend apis
henriquemarlon Apr 9, 2025
0d73c73
docs(api-reference): update info for finish endpoint
henriquemarlon Apr 9, 2025
8aaf564
docs: improve delegate call voucher description
henriquemarlon May 2, 2025
6203787
docs: json-rpc api section
henriquemarlon May 2, 2025
cbff064
docs: improve description and references
henriquemarlon May 3, 2025
f91d0ec
docs: improve description and references
henriquemarlon May 3, 2025
a025f0e
docs: fix sidebar
henriquemarlon May 3, 2025
041d874
docs: update json-rpc api reference
henriquemarlon Jun 2, 2025
c96ff74
update contracts and json-rpc, consensus WIP
henriquemarlon Jun 26, 2025
b4c13ac
docs: modified development section images
Nonnyjoe Mar 16, 2025
5d64419
docs: modified assets-handling section
Nonnyjoe Mar 16, 2025
c8aa3a7
docs: modified building section in line with v2 updates
Nonnyjoe Mar 16, 2025
863be44
docs: partial update to the cli command section
Nonnyjoe Mar 16, 2025
260316f
docs: Modified graphQL queries and dapp reference in query section
Nonnyjoe Mar 16, 2025
75141c0
docs: updated send-inputs section in line with V2 updates
Nonnyjoe Mar 16, 2025
71d7546
docs: added page for managing devnet environment
Nonnyjoe Mar 18, 2025
3d30fdc
docs: modifying the deploying an app section
Nonnyjoe Mar 19, 2025
13141e8
docs: updated cli-commands section inline with cli2.0
Nonnyjoe Mar 20, 2025
2455687
docs: updated broken links in tutorial section referencing changes in…
Nonnyjoe Mar 20, 2025
6295c50
docs: modified page title for building and deploying an application
Nonnyjoe Mar 20, 2025
71b6826
docs: reflected first stage of reviews
Nonnyjoe Mar 21, 2025
8f80099
docs: updated cli commands in line with cli-aplha-9
Nonnyjoe Apr 21, 2025
60e222a
docs: updated api-reference
Nonnyjoe Jun 5, 2025
ca2f3ed
docs: restructured development section
Nonnyjoe Jun 5, 2025
af20760
docs: Implemented reviews across development section
Nonnyjoe Jun 9, 2025
134fb75
docs: Rebased on staging and fixed broken links
Nonnyjoe Jun 9, 2025
39384ef
fixup! docs: Implemented reviews across development section
Nonnyjoe Jun 11, 2025
c412355
fixup! docs: Implemented reviews across development section
Nonnyjoe Jun 11, 2025
02e967d
update delegatecall
henriquemarlon Aug 8, 2025
5ddc6cf
removed espresso, added react tutorials and app-chains page
riseandshaheen Jun 16, 2025
5085b4c
added diagrams and minor improvements
riseandshaheen Jul 3, 2025
4029832
added spacing on big square image
jplgarcia Jul 3, 2025
6baff6b
update application contract and add consensus section
henriquemarlon Aug 8, 2025
3ea1982
minor improvements and cosmetic changes
henriquemarlon Aug 10, 2025
12dfe3b
fix: id correspondence
henriquemarlon Aug 10, 2025
3229d40
fix: id correspondence
henriquemarlon Aug 10, 2025
5ccf396
revert golang version for delegate call voucher
henriquemarlon Aug 10, 2025
5207dd0
docs(development): Updated development section in line with updates o…
Nonnyjoe Aug 12, 2025
77ad8a0
feat: src files and deployment tutorial for local node deployment
henriquemarlon Aug 11, 2025
e3544db
feat: change link for compose file
henriquemarlon Aug 11, 2025
b69b6f8
minor improvements and snapshot section with gh actions example
henriquemarlon Aug 14, 2025
54d504d
docs: update snapshot workflow description and minor updates on self-…
henriquemarlon Aug 21, 2025
21ceb9b
Fraud Proofs Tab- Content
riseandshaheen Aug 25, 2025
800c3e0
cosmetic updates and review comments updated content
riseandshaheen Aug 27, 2025
c5a36df
cosmetic updates, dapp to app, sidebar collapse set to true
riseandshaheen Aug 28, 2025
14aa454
honeypot application logic corrections
riseandshaheen Sep 4, 2025
9cba477
updates with review comments from lyno
riseandshaheen Sep 5, 2025
91419e9
Rename Computation-Hash-Rollups.jpg to computation-hash-rollups.jpg
riseandshaheen Sep 5, 2025
c646f0b
minor updates
riseandshaheen Sep 8, 2025
278e04f
minor refinements
riseandshaheen Sep 8, 2025
3a4ab20
Default to 1.5, removed outdated commands from quickstart and removed…
riseandshaheen Sep 19, 2025
933bde6
add: implemented a sidebar file for V2
Nonnyjoe Oct 10, 2024
7b18b3e
update: Modified the Development folder for V2
Nonnyjoe Oct 10, 2024
5e969df
fix: Handled error relating to broken links
Nonnyjoe Oct 11, 2024
c920e8b
docs: restructuring the api reference
henriquemarlon Oct 15, 2024
94d55f9
modified: overview & quickstart merged in side-bar
riseandshaheen Oct 14, 2024
c232611
remapped pages
jplgarcia Nov 21, 2024
459ce3d
setting redirects
jplgarcia Nov 21, 2024
0a838e7
fix: Handled error relating to broken links
Nonnyjoe Oct 11, 2024
d9b1a4f
update: modified application factory contract in line with V2.0
Nonnyjoe Nov 18, 2024
3acd0c5
update: modified the different portals page in line with docs V2
Nonnyjoe Nov 18, 2024
c497ab0
mod: relayer page and also reference in sidebar
Nonnyjoe Nov 18, 2024
f444920
mod: updated querry outputs inline with V2
Nonnyjoe Nov 25, 2024
950dba5
merge: merged Joao's restructure with V2 updates
Nonnyjoe Nov 25, 2024
58c990e
update: modified asssets-handling inline with V2
Nonnyjoe Nov 25, 2024
3f5deaa
add: Added an external resource section
Nonnyjoe Nov 7, 2024
7c97ec2
update: restructured external resource position
Nonnyjoe Nov 7, 2024
3be2f4e
add: Added an external resource section
Nonnyjoe Nov 7, 2024
069b3f6
update: restructured external resource position
Nonnyjoe Nov 7, 2024
7124d1c
update: added shour descriptions for different integratins
Nonnyjoe Nov 18, 2024
d491822
add: added the integrations guide section
Nonnyjoe Nov 25, 2024
f1660b0
update on structure, spliting architecture concepts and installation …
jplgarcia Dec 9, 2024
e3b328a
updated tutorials for v2
jplgarcia Dec 23, 2024
30c5037
admonition
jorka Dec 2, 2024
a599180
announcement bar
jorka Dec 2, 2024
d950593
api item
jorka Dec 2, 2024
bff75b5
edit this page, custom icons
jorka Dec 9, 2024
bc768ec
footer
jorka Dec 10, 2024
90f7078
edit icon fix
jorka Dec 11, 2024
8c4480c
edit icon fix
jorka Dec 11, 2024
bd32d8c
remove console log
jorka Dec 12, 2024
c40a17e
sidebar version
jorka Dec 12, 2024
1bd129d
sidebar version
jorka Dec 12, 2024
f6847e3
config and deps
jorka Dec 12, 2024
47f5e8c
remove DocVersionBadge
jorka Dec 12, 2024
8a478ac
open api config - enable generation of previos versions
jorka Dec 13, 2024
90f354a
generate prev versions open api
jorka Dec 13, 2024
176d34c
yarn lock
jorka Dec 13, 2024
5f3a117
remove log
jorka Dec 13, 2024
f9b862e
add deps
jorka Dec 13, 2024
bdb3c86
fix mdx
jorka Dec 18, 2024
bfece53
add missing page to fix broken links
jorka Dec 18, 2024
1be31c3
fix api folder for v2, comment missing redirects, switch to v2
jorka Dec 18, 2024
a33faeb
docs: application section updated to v2
henriquemarlon Dec 2, 2024
6b755a6
docs: typos and solving requests for input-box and application consensus
henriquemarlon Mar 8, 2025
ce9321d
docs: update from json-rpc to contracts
henriquemarlon Mar 8, 2025
0ff0006
docs: update broken links
henriquemarlon Mar 8, 2025
94fae4f
docs: update broken links
henriquemarlon Mar 8, 2025
f8a3aaa
docs: update from json-rpc to contracts
henriquemarlon Mar 8, 2025
6c67e71
docs: solve broken links and wrong references
henriquemarlon Mar 8, 2025
7cd09c9
migration guide v1.5 to v2
riseandshaheen Mar 11, 2025
4796fd0
feat: docs v2 products restructuring, rollups and coprocessor in navbar
riseandshaheen Apr 28, 2025
d0debb2
fix: visibility of version dropdown and table of contents on coproces…
riseandshaheen Apr 29, 2025
b4e8c17
doc: added quickstart(rollups) to Get-Started tab
riseandshaheen Apr 30, 2025
3de0a49
refactor: removed troubleshooting, differences with rollups and nonod…
riseandshaheen May 1, 2025
3167a84
revert: coprocessor content
riseandshaheen May 16, 2025
7430577
updated content for cartesi-machine and fraud-proofs
riseandshaheen May 16, 2025
1ca1e1f
changed table font size for better fit
jplgarcia May 20, 2025
7a7de10
docs(api): graphql reference update
henriquemarlon Mar 31, 2025
d7ff997
queries update
henriquemarlon Apr 3, 2025
6f73877
docs: more clear description and some broken links
henriquemarlon Apr 7, 2025
9911a74
docs: add delegate call voucher docs
henriquemarlon Apr 8, 2025
459dfad
docs: fix references for filters
henriquemarlon Apr 8, 2025
ed3fccc
docs: update inspect request reference
henriquemarlon Apr 8, 2025
8ed7165
docs:add reference for delegate call vouchers on vouchers section
henriquemarlon Apr 8, 2025
c1c8534
docs(api-reference): add exception and finish to backend
henriquemarlon Apr 8, 2025
b1b4e0f
docs(api-reference): chnage query for enum
henriquemarlon Apr 8, 2025
6b3dd8d
docs(api-reference): add outputs on intro for backend apis
henriquemarlon Apr 9, 2025
58edce2
docs(api-reference): update info for finish endpoint
henriquemarlon Apr 9, 2025
acd798d
docs: improve delegate call voucher description
henriquemarlon May 2, 2025
9a3d40d
docs: json-rpc api section
henriquemarlon May 2, 2025
10dfe1e
docs: improve description and references
henriquemarlon May 3, 2025
f129dfc
docs: improve description and references
henriquemarlon May 3, 2025
762b002
docs: fix sidebar
henriquemarlon May 3, 2025
cf5d5e5
docs: update json-rpc api reference
henriquemarlon Jun 2, 2025
f0a7f98
update contracts and json-rpc, consensus WIP
henriquemarlon Jun 26, 2025
644f733
docs: modified development section images
Nonnyjoe Mar 16, 2025
3717dea
docs: modified assets-handling section
Nonnyjoe Mar 16, 2025
8fc6032
docs: modified building section in line with v2 updates
Nonnyjoe Mar 16, 2025
6361cd0
docs: partial update to the cli command section
Nonnyjoe Mar 16, 2025
197e559
docs: Modified graphQL queries and dapp reference in query section
Nonnyjoe Mar 16, 2025
c50cdbc
docs: updated send-inputs section in line with V2 updates
Nonnyjoe Mar 16, 2025
6469942
docs: added page for managing devnet environment
Nonnyjoe Mar 18, 2025
db575de
docs: modifying the deploying an app section
Nonnyjoe Mar 19, 2025
7f3258c
docs: updated cli-commands section inline with cli2.0
Nonnyjoe Mar 20, 2025
58fbb6b
docs: updated broken links in tutorial section referencing changes in…
Nonnyjoe Mar 20, 2025
82b0a34
docs: modified page title for building and deploying an application
Nonnyjoe Mar 20, 2025
9ba983f
docs: reflected first stage of reviews
Nonnyjoe Mar 21, 2025
4de1a58
docs: updated cli commands in line with cli-aplha-9
Nonnyjoe Apr 21, 2025
073a225
docs: updated api-reference
Nonnyjoe Jun 5, 2025
9d909be
docs: restructured development section
Nonnyjoe Jun 5, 2025
3357452
docs: Implemented reviews across development section
Nonnyjoe Jun 9, 2025
bac529a
docs: Rebased on staging and fixed broken links
Nonnyjoe Jun 9, 2025
0192d87
fixup! docs: Implemented reviews across development section
Nonnyjoe Jun 11, 2025
cfcec7a
fixup! docs: Implemented reviews across development section
Nonnyjoe Jun 11, 2025
636464b
update delegatecall
henriquemarlon Aug 8, 2025
b3ce8af
removed espresso, added react tutorials and app-chains page
riseandshaheen Jun 16, 2025
df866e6
added diagrams and minor improvements
riseandshaheen Jul 3, 2025
575187c
added spacing on big square image
jplgarcia Jul 3, 2025
d343841
update application contract and add consensus section
henriquemarlon Aug 8, 2025
511d3b5
minor improvements and cosmetic changes
henriquemarlon Aug 10, 2025
c520967
fix: id correspondence
henriquemarlon Aug 10, 2025
c284807
fix: id correspondence
henriquemarlon Aug 10, 2025
40a1188
revert golang version for delegate call voucher
henriquemarlon Aug 10, 2025
10c0fa7
docs(development): Updated development section in line with updates o…
Nonnyjoe Aug 12, 2025
a768257
feat: src files and deployment tutorial for local node deployment
henriquemarlon Aug 11, 2025
caf7e2b
feat: change link for compose file
henriquemarlon Aug 11, 2025
9896952
minor improvements and snapshot section with gh actions example
henriquemarlon Aug 14, 2025
a56fcb5
docs: update snapshot workflow description and minor updates on self-…
henriquemarlon Aug 21, 2025
7a53d22
Fraud Proofs Tab- Content
riseandshaheen Aug 25, 2025
e96bcdc
cosmetic updates and review comments updated content
riseandshaheen Aug 27, 2025
f0d30fe
cosmetic updates, dapp to app, sidebar collapse set to true
riseandshaheen Aug 28, 2025
8ab1f93
honeypot application logic corrections
riseandshaheen Sep 4, 2025
65bd883
updates with review comments from lyno
riseandshaheen Sep 5, 2025
82d6cc6
Rename Computation-Hash-Rollups.jpg to computation-hash-rollups.jpg
riseandshaheen Sep 5, 2025
a2f3aea
minor updates
riseandshaheen Sep 8, 2025
b28a4eb
minor refinements
riseandshaheen Sep 8, 2025
0739ecc
Default to 1.5, removed outdated commands from quickstart and removed…
riseandshaheen Sep 19, 2025
1882edd
Hide 2.0 docs from the dropdown version list
riseandshaheen Sep 24, 2025
9b98c29
Update vouchers.md
jplgarcia Sep 24, 2025
ce1a87d
Update yarn.lock
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