Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
507 commits
Select commit Hold shift + click to select a range
00768a3
Default to 1.5, removed outdated commands from quickstart and removed…
riseandshaheen Sep 19, 2025
09ad080
Hide 2.0 docs from the dropdown version list
riseandshaheen Sep 24, 2025
deda5fc
Update vouchers.md
jplgarcia Sep 24, 2025
6c6a0d6
Update yarn.lock
jplgarcia Sep 24, 2025
445929e
add: implemented a sidebar file for V2
Nonnyjoe Oct 10, 2024
68c4406
update: Modified the Development folder for V2
Nonnyjoe Oct 10, 2024
91e3cd7
fix: Handled error relating to broken links
Nonnyjoe Oct 11, 2024
b8115a4
docs: restructuring the api reference
henriquemarlon Oct 15, 2024
8b4a8e7
modified: overview & quickstart merged in side-bar
riseandshaheen Oct 14, 2024
a5b688b
docs: fix the reference for api-reference inside of getting-started
henriquemarlon Oct 15, 2024
dcc21aa
remapped pages
jplgarcia Nov 21, 2024
6778d6a
setting redirects
jplgarcia Nov 21, 2024
b330dde
remapped pages
jplgarcia Nov 21, 2024
671bbb4
setting redirects
jplgarcia Nov 21, 2024
3c35606
add: implemented a sidebar file for V2
Nonnyjoe Oct 10, 2024
2d79905
update: Modified the Development folder for V2
Nonnyjoe Oct 10, 2024
c2ce82a
fix: Handled error relating to broken links
Nonnyjoe Oct 11, 2024
027d678
update: modified application factory contract in line with V2.0
Nonnyjoe Nov 18, 2024
1164ee7
update: modified the different portals page in line with docs V2
Nonnyjoe Nov 18, 2024
dfb1053
mod: relayer page and also reference in sidebar
Nonnyjoe Nov 18, 2024
c11eb7b
mod: updated querry outputs inline with V2
Nonnyjoe Nov 25, 2024
b47f353
merge: merged Joao's restructure with V2 updates
Nonnyjoe Nov 25, 2024
ed84815
update: modified asssets-handling inline with V2
Nonnyjoe Nov 25, 2024
50c09b3
add: Added an external resource section
Nonnyjoe Nov 7, 2024
04ba0d8
update: restructured external resource position
Nonnyjoe Nov 7, 2024
d95e6aa
add: Added an external resource section
Nonnyjoe Nov 7, 2024
3f6d64b
update: restructured external resource position
Nonnyjoe Nov 7, 2024
88e89de
update: added shour descriptions for different integratins
Nonnyjoe Nov 18, 2024
4a9f817
add: added the integrations guide section
Nonnyjoe Nov 25, 2024
d6f4f06
add: added the integrations guide section
Nonnyjoe Nov 25, 2024
b552900
update on structure, spliting architecture concepts and installation …
jplgarcia Dec 9, 2024
6d8dd58
updated tutorials for v2
jplgarcia Dec 23, 2024
cad3615
admonition
jorka Dec 2, 2024
daf7171
announcement bar
jorka Dec 2, 2024
8adfa9c
api item
jorka Dec 2, 2024
910f104
edit this page, custom icons
jorka Dec 9, 2024
1093834
footer
jorka Dec 10, 2024
3bfe5ab
edit icon fix
jorka Dec 11, 2024
02b92e8
edit icon fix
jorka Dec 11, 2024
5c0fd16
remove console log
jorka Dec 12, 2024
85ac12d
sidebar version
jorka Dec 12, 2024
2a6fe98
sidebar version
jorka Dec 12, 2024
70d741a
config and deps
jorka Dec 12, 2024
36969b9
remove DocVersionBadge
jorka Dec 12, 2024
828d59c
open api config - enable generation of previos versions
jorka Dec 13, 2024
f333fff
generate prev versions open api
jorka Dec 13, 2024
f4d3f06
yarn lock
jorka Dec 13, 2024
47c3a2b
remove log
jorka Dec 13, 2024
4e46df0
add deps
jorka Dec 13, 2024
64efe0c
fix mdx
jorka Dec 18, 2024
00e7450
add missing page to fix broken links
jorka Dec 18, 2024
fa4a7af
fix api folder for v2, comment missing redirects, switch to v2
jorka Dec 18, 2024
bd316ab
docs: application section updated to v2
henriquemarlon Dec 2, 2024
d3faaa5
docs: typos and solving requests for input-box and application consensus
henriquemarlon Mar 8, 2025
e303254
docs: update from json-rpc to contracts
henriquemarlon Mar 8, 2025
ab3e28c
docs: update broken links
henriquemarlon Mar 8, 2025
8ea12ba
docs: update broken links
henriquemarlon Mar 8, 2025
5fbdb64
docs: update from json-rpc to contracts
henriquemarlon Mar 8, 2025
09d9deb
docs: solve broken links and wrong references
henriquemarlon Mar 8, 2025
0299e0f
migration guide v1.5 to v2
riseandshaheen Mar 11, 2025
2e16fbd
feat: docs v2 products restructuring, rollups and coprocessor in navbar
riseandshaheen Apr 28, 2025
b2f5866
fix: visibility of version dropdown and table of contents on coproces…
riseandshaheen Apr 29, 2025
91fb105
doc: added quickstart(rollups) to Get-Started tab
riseandshaheen Apr 30, 2025
ef47875
refactor: removed troubleshooting, differences with rollups and nonod…
riseandshaheen May 1, 2025
717b843
revert: coprocessor content
riseandshaheen May 16, 2025
0cf6157
updated content for cartesi-machine and fraud-proofs
riseandshaheen May 16, 2025
6f99a37
changed table font size for better fit
jplgarcia May 20, 2025
65c244b
docs(api): graphql reference update
henriquemarlon Mar 31, 2025
8ce9373
queries update
henriquemarlon Apr 3, 2025
1878f78
docs: more clear description and some broken links
henriquemarlon Apr 7, 2025
feabfe3
docs: add delegate call voucher docs
henriquemarlon Apr 8, 2025
7b0c11f
docs: fix references for filters
henriquemarlon Apr 8, 2025
8f90927
docs: update inspect request reference
henriquemarlon Apr 8, 2025
3cf2271
docs:add reference for delegate call vouchers on vouchers section
henriquemarlon Apr 8, 2025
928a511
docs(api-reference): add exception and finish to backend
henriquemarlon Apr 8, 2025
fd8cdcd
docs(api-reference): chnage query for enum
henriquemarlon Apr 8, 2025
6540029
docs(api-reference): add outputs on intro for backend apis
henriquemarlon Apr 9, 2025
33bf560
docs(api-reference): update info for finish endpoint
henriquemarlon Apr 9, 2025
c686f92
docs: improve delegate call voucher description
henriquemarlon May 2, 2025
5dc10b0
docs: json-rpc api section
henriquemarlon May 2, 2025
1c8a8a8
docs: improve description and references
henriquemarlon May 3, 2025
61625ec
docs: improve description and references
henriquemarlon May 3, 2025
7df999c
docs: fix sidebar
henriquemarlon May 3, 2025
ba36c7c
docs: update json-rpc api reference
henriquemarlon Jun 2, 2025
a77edd7
update contracts and json-rpc, consensus WIP
henriquemarlon Jun 26, 2025
f1c1407
docs: modified development section images
Nonnyjoe Mar 16, 2025
70576dd
docs: modified assets-handling section
Nonnyjoe Mar 16, 2025
e91bd4f
docs: modified building section in line with v2 updates
Nonnyjoe Mar 16, 2025
1cc2b1e
docs: partial update to the cli command section
Nonnyjoe Mar 16, 2025
1010523
docs: Modified graphQL queries and dapp reference in query section
Nonnyjoe Mar 16, 2025
1ebe381
docs: updated send-inputs section in line with V2 updates
Nonnyjoe Mar 16, 2025
59777b4
docs: added page for managing devnet environment
Nonnyjoe Mar 18, 2025
0d11280
docs: modifying the deploying an app section
Nonnyjoe Mar 19, 2025
fdb42e0
docs: updated cli-commands section inline with cli2.0
Nonnyjoe Mar 20, 2025
a44fa90
docs: updated broken links in tutorial section referencing changes in…
Nonnyjoe Mar 20, 2025
f9bd47a
docs: modified page title for building and deploying an application
Nonnyjoe Mar 20, 2025
6745a46
docs: reflected first stage of reviews
Nonnyjoe Mar 21, 2025
3ddc645
docs: updated cli commands in line with cli-aplha-9
Nonnyjoe Apr 21, 2025
d9e658d
docs: updated api-reference
Nonnyjoe Jun 5, 2025
4ca5ebf
docs: restructured development section
Nonnyjoe Jun 5, 2025
246a5e8
docs: Implemented reviews across development section
Nonnyjoe Jun 9, 2025
f1b7496
docs: Rebased on staging and fixed broken links
Nonnyjoe Jun 9, 2025
8ca2d16
fixup! docs: Implemented reviews across development section
Nonnyjoe Jun 11, 2025
71c46e1
fixup! docs: Implemented reviews across development section
Nonnyjoe Jun 11, 2025
bd15187
update delegatecall
henriquemarlon Aug 8, 2025
056aacf
removed espresso, added react tutorials and app-chains page
riseandshaheen Jun 16, 2025
bc5f391
added diagrams and minor improvements
riseandshaheen Jul 3, 2025
0ef00a5
added spacing on big square image
jplgarcia Jul 3, 2025
8410aae
update application contract and add consensus section
henriquemarlon Aug 8, 2025
52d0611
minor improvements and cosmetic changes
henriquemarlon Aug 10, 2025
a3eccca
fix: id correspondence
henriquemarlon Aug 10, 2025
d193d72
fix: id correspondence
henriquemarlon Aug 10, 2025
1da1a44
revert golang version for delegate call voucher
henriquemarlon Aug 10, 2025
4304a89
docs(development): Updated development section in line with updates o…
Nonnyjoe Aug 12, 2025
b24275b
feat: src files and deployment tutorial for local node deployment
henriquemarlon Aug 11, 2025
d7d78e0
feat: change link for compose file
henriquemarlon Aug 11, 2025
0d6f12c
minor improvements and snapshot section with gh actions example
henriquemarlon Aug 14, 2025
9387296
docs: update snapshot workflow description and minor updates on self-…
henriquemarlon Aug 21, 2025
77fdad7
Fraud Proofs Tab- Content
riseandshaheen Aug 25, 2025
82bdd33
cosmetic updates and review comments updated content
riseandshaheen Aug 27, 2025
8fd0dcf
cosmetic updates, dapp to app, sidebar collapse set to true
riseandshaheen Aug 28, 2025
fd5030a
honeypot application logic corrections
riseandshaheen Sep 4, 2025
0c65ed3
updates with review comments from lyno
riseandshaheen Sep 5, 2025
c88225d
Rename Computation-Hash-Rollups.jpg to computation-hash-rollups.jpg
riseandshaheen Sep 5, 2025
175ab9f
minor updates
riseandshaheen Sep 8, 2025
d6a5d45
minor refinements
riseandshaheen Sep 8, 2025
8ff2bd1
Default to 1.5, removed outdated commands from quickstart and removed…
riseandshaheen Sep 19, 2025
32c1b5c
add: implemented a sidebar file for V2
Nonnyjoe Oct 10, 2024
6a3c0f8
update: Modified the Development folder for V2
Nonnyjoe Oct 10, 2024
28457ed
fix: Handled error relating to broken links
Nonnyjoe Oct 11, 2024
7910ab0
docs: restructuring the api reference
henriquemarlon Oct 15, 2024
ac0bfdf
modified: overview & quickstart merged in side-bar
riseandshaheen Oct 14, 2024
8af8161
remapped pages
jplgarcia Nov 21, 2024
5160c73
setting redirects
jplgarcia Nov 21, 2024
a278116
fix: Handled error relating to broken links
Nonnyjoe Oct 11, 2024
0157b76
update: modified application factory contract in line with V2.0
Nonnyjoe Nov 18, 2024
793aa66
update: modified the different portals page in line with docs V2
Nonnyjoe Nov 18, 2024
5cfd871
mod: relayer page and also reference in sidebar
Nonnyjoe Nov 18, 2024
de0e590
mod: updated querry outputs inline with V2
Nonnyjoe Nov 25, 2024
ac7c2b1
merge: merged Joao's restructure with V2 updates
Nonnyjoe Nov 25, 2024
7b96428
update: modified asssets-handling inline with V2
Nonnyjoe Nov 25, 2024
d1decfd
add: Added an external resource section
Nonnyjoe Nov 7, 2024
aad753d
update: restructured external resource position
Nonnyjoe Nov 7, 2024
c895204
add: Added an external resource section
Nonnyjoe Nov 7, 2024
7f1c722
update: restructured external resource position
Nonnyjoe Nov 7, 2024
21ce7a5
update: added shour descriptions for different integratins
Nonnyjoe Nov 18, 2024
a4b9f36
add: added the integrations guide section
Nonnyjoe Nov 25, 2024
4d9f528
update on structure, spliting architecture concepts and installation …
jplgarcia Dec 9, 2024
bf3a955
updated tutorials for v2
jplgarcia Dec 23, 2024
6b75438
admonition
jorka Dec 2, 2024
e9b3b16
announcement bar
jorka Dec 2, 2024
3abc72b
api item
jorka Dec 2, 2024
141d391
edit this page, custom icons
jorka Dec 9, 2024
85faab4
footer
jorka Dec 10, 2024
3f66c24
edit icon fix
jorka Dec 11, 2024
1559310
edit icon fix
jorka Dec 11, 2024
49d5f51
remove console log
jorka Dec 12, 2024
cabf07f
sidebar version
jorka Dec 12, 2024
0599f43
sidebar version
jorka Dec 12, 2024
6fd9eb3
config and deps
jorka Dec 12, 2024
3fba883
remove DocVersionBadge
jorka Dec 12, 2024
a7d1e0c
open api config - enable generation of previos versions
jorka Dec 13, 2024
69e1beb
generate prev versions open api
jorka Dec 13, 2024
7e8f824
yarn lock
jorka Dec 13, 2024
a39a56d
remove log
jorka Dec 13, 2024
ccdb1b9
add deps
jorka Dec 13, 2024
0056063
fix mdx
jorka Dec 18, 2024
7282d04
add missing page to fix broken links
jorka Dec 18, 2024
bc6c948
fix api folder for v2, comment missing redirects, switch to v2
jorka Dec 18, 2024
994f874
docs: application section updated to v2
henriquemarlon Dec 2, 2024
af30438
docs: typos and solving requests for input-box and application consensus
henriquemarlon Mar 8, 2025
d2ece26
docs: update from json-rpc to contracts
henriquemarlon Mar 8, 2025
9d64104
docs: update broken links
henriquemarlon Mar 8, 2025
11a62e7
docs: update broken links
henriquemarlon Mar 8, 2025
cd35844
docs: update from json-rpc to contracts
henriquemarlon Mar 8, 2025
7fd84cd
docs: solve broken links and wrong references
henriquemarlon Mar 8, 2025
de46ea5
migration guide v1.5 to v2
riseandshaheen Mar 11, 2025
7a8e748
feat: docs v2 products restructuring, rollups and coprocessor in navbar
riseandshaheen Apr 28, 2025
8a289f9
fix: visibility of version dropdown and table of contents on coproces…
riseandshaheen Apr 29, 2025
d35dd11
doc: added quickstart(rollups) to Get-Started tab
riseandshaheen Apr 30, 2025
ac9d252
refactor: removed troubleshooting, differences with rollups and nonod…
riseandshaheen May 1, 2025
ec97017
revert: coprocessor content
riseandshaheen May 16, 2025
881dd4b
updated content for cartesi-machine and fraud-proofs
riseandshaheen May 16, 2025
3e284b3
changed table font size for better fit
jplgarcia May 20, 2025
e42b2c0
docs(api): graphql reference update
henriquemarlon Mar 31, 2025
ae9f185
queries update
henriquemarlon Apr 3, 2025
32787a4
docs: more clear description and some broken links
henriquemarlon Apr 7, 2025
dceddce
docs: add delegate call voucher docs
henriquemarlon Apr 8, 2025
a302458
docs: fix references for filters
henriquemarlon Apr 8, 2025
9bcbbfc
docs: update inspect request reference
henriquemarlon Apr 8, 2025
1f2a968
docs:add reference for delegate call vouchers on vouchers section
henriquemarlon Apr 8, 2025
67d5aec
docs(api-reference): add exception and finish to backend
henriquemarlon Apr 8, 2025
17c3f29
docs(api-reference): chnage query for enum
henriquemarlon Apr 8, 2025
b2d040a
docs(api-reference): add outputs on intro for backend apis
henriquemarlon Apr 9, 2025
91a6f48
docs(api-reference): update info for finish endpoint
henriquemarlon Apr 9, 2025
952a686
docs: improve delegate call voucher description
henriquemarlon May 2, 2025
1e2945f
docs: json-rpc api section
henriquemarlon May 2, 2025
422cce8
docs: improve description and references
henriquemarlon May 3, 2025
6855b30
docs: improve description and references
henriquemarlon May 3, 2025
534868a
docs: fix sidebar
henriquemarlon May 3, 2025
58e1cb4
docs: update json-rpc api reference
henriquemarlon Jun 2, 2025
56699cc
update contracts and json-rpc, consensus WIP
henriquemarlon Jun 26, 2025
3062320
docs: modified development section images
Nonnyjoe Mar 16, 2025
a14046d
docs: modified assets-handling section
Nonnyjoe Mar 16, 2025
637d6e3
docs: modified building section in line with v2 updates
Nonnyjoe Mar 16, 2025
267d441
docs: partial update to the cli command section
Nonnyjoe Mar 16, 2025
e8e0562
docs: Modified graphQL queries and dapp reference in query section
Nonnyjoe Mar 16, 2025
4763445
docs: updated send-inputs section in line with V2 updates
Nonnyjoe Mar 16, 2025
92f3e9b
docs: added page for managing devnet environment
Nonnyjoe Mar 18, 2025
022386d
docs: modifying the deploying an app section
Nonnyjoe Mar 19, 2025
3bc1b06
docs: updated cli-commands section inline with cli2.0
Nonnyjoe Mar 20, 2025
12adc85
docs: updated broken links in tutorial section referencing changes in…
Nonnyjoe Mar 20, 2025
935a330
docs: modified page title for building and deploying an application
Nonnyjoe Mar 20, 2025
0937fa9
docs: reflected first stage of reviews
Nonnyjoe Mar 21, 2025
c9605cb
docs: updated cli commands in line with cli-aplha-9
Nonnyjoe Apr 21, 2025
832b814
docs: updated api-reference
Nonnyjoe Jun 5, 2025
20a91bd
docs: restructured development section
Nonnyjoe Jun 5, 2025
27bd991
docs: Implemented reviews across development section
Nonnyjoe Jun 9, 2025
47394a0
docs: Rebased on staging and fixed broken links
Nonnyjoe Jun 9, 2025
25c18f2
fixup! docs: Implemented reviews across development section
Nonnyjoe Jun 11, 2025
7a4d38f
fixup! docs: Implemented reviews across development section
Nonnyjoe Jun 11, 2025
3ecadfd
update delegatecall
henriquemarlon Aug 8, 2025
78e09b7
removed espresso, added react tutorials and app-chains page
riseandshaheen Jun 16, 2025
e52d645
added diagrams and minor improvements
riseandshaheen Jul 3, 2025
621552b
added spacing on big square image
jplgarcia Jul 3, 2025
c936625
update application contract and add consensus section
henriquemarlon Aug 8, 2025
5f8c736
minor improvements and cosmetic changes
henriquemarlon Aug 10, 2025
d37d784
fix: id correspondence
henriquemarlon Aug 10, 2025
c789d05
fix: id correspondence
henriquemarlon Aug 10, 2025
2a63943
revert golang version for delegate call voucher
henriquemarlon Aug 10, 2025
2d00611
docs(development): Updated development section in line with updates o…
Nonnyjoe Aug 12, 2025
aa8e47c
feat: src files and deployment tutorial for local node deployment
henriquemarlon Aug 11, 2025
025378b
feat: change link for compose file
henriquemarlon Aug 11, 2025
6329e2d
minor improvements and snapshot section with gh actions example
henriquemarlon Aug 14, 2025
0fe1815
docs: update snapshot workflow description and minor updates on self-…
henriquemarlon Aug 21, 2025
a3550ae
Fraud Proofs Tab- Content
riseandshaheen Aug 25, 2025
795d271
cosmetic updates and review comments updated content
riseandshaheen Aug 27, 2025
5f2ea82
cosmetic updates, dapp to app, sidebar collapse set to true
riseandshaheen Aug 28, 2025
85024db
honeypot application logic corrections
riseandshaheen Sep 4, 2025
1cbe7a9
updates with review comments from lyno
riseandshaheen Sep 5, 2025
66ff24e
Rename Computation-Hash-Rollups.jpg to computation-hash-rollups.jpg
riseandshaheen Sep 5, 2025
bd32e4a
minor updates
riseandshaheen Sep 8, 2025
abc8dfd
minor refinements
riseandshaheen Sep 8, 2025
143bdc6
Default to 1.5, removed outdated commands from quickstart and removed…
riseandshaheen Sep 19, 2025
af81f83
Hide 2.0 docs from the dropdown version list
riseandshaheen Sep 24, 2025
f052d25
Update vouchers.md
jplgarcia Sep 24, 2025
7af5ed0
Update yarn.lock
jplgarcia Sep 24, 2025
5fa2f1d
Update compute.md
jplgarcia Sep 24, 2025
29b6379
add: implemented a sidebar file for V2
Nonnyjoe Oct 10, 2024
ff967fe
add: Added the Account abstraction tutorial to V2
Nonnyjoe Oct 10, 2024
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