Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
296 commits
Select commit Hold shift + click to select a range
c70b06d
dic item
jorka Dec 9, 2024
94d95ff
edit this page, custom icons
jorka Dec 9, 2024
24b07cd
footer
jorka Dec 10, 2024
3f3a86b
heading
jorka Dec 10, 2024
ed14b68
edit meta row
jorka Dec 10, 2024
83697ab
last updated
jorka Dec 10, 2024
7261534
tag
jorka Dec 10, 2024
e996dad
edit icon fix
jorka Dec 11, 2024
c654de9
edit icon fix
jorka Dec 11, 2024
9244d62
remove console log
jorka Dec 12, 2024
7484fa2
sidebar version
jorka Dec 12, 2024
e82461e
sidebar version
jorka Dec 12, 2024
6be24cc
toc
jorka Dec 12, 2024
f6cf354
tabs
jorka Dec 12, 2024
43794d0
mdx components tooltip
jorka Dec 12, 2024
2bdbf22
config and deps
jorka Dec 12, 2024
4d481fc
remove DocVersionBadge
jorka Dec 12, 2024
bb01984
announcement bar - fix useEffect
jorka Dec 13, 2024
b1bae59
fix docs/earn-ctsi/staking-faq.md mdx
jorka Dec 13, 2024
9a1cf5e
open api config - enable generation of previos versions
jorka Dec 13, 2024
b104ac8
generate prev versions open api
jorka Dec 13, 2024
0c43fff
yarn lock
jorka Dec 13, 2024
ea7c794
remove log
jorka Dec 13, 2024
6599c99
fix mdx
jorka Dec 13, 2024
2612ff2
add deps
jorka Dec 13, 2024
8bfbb3d
fix tabs inside openapi - remove border:
jorka Dec 13, 2024
7e01244
fix mdx
jorka Dec 18, 2024
2dc01b8
add missing page to fix broken links
jorka Dec 18, 2024
f203c53
fix api folder for v2, comment missing redirects, switch to v2
jorka Dec 18, 2024
0ca6005
docs: application section updated to v2
henriquemarlon Dec 2, 2024
da639b8
docs: typos and solving requests for input-box and application consensus
henriquemarlon Mar 8, 2025
477e983
Infobar update
dimitarangelkov Dec 23, 2024
5f989a8
docs: update from json-rpc to contracts
henriquemarlon Mar 8, 2025
6032e62
docs: update broken links
henriquemarlon Mar 8, 2025
6a3970e
docs: update broken links
henriquemarlon Mar 8, 2025
23eaf1e
docs: update from json-rpc to contracts
henriquemarlon Mar 8, 2025
a208940
docs: solve broken links and wrong references
henriquemarlon Mar 8, 2025
4f268ee
migration guide v1.5 to v2
riseandshaheen Mar 11, 2025
f18bba3
feat: docs v2 products restructuring, rollups and coprocessor in navbar
riseandshaheen Apr 28, 2025
5a990cc
fix: visibility of version dropdown and table of contents on coproces…
riseandshaheen Apr 29, 2025
28a04ca
doc: added quickstart(rollups) to Get-Started tab
riseandshaheen Apr 30, 2025
261cbc8
refactor: removed troubleshooting, differences with rollups and nonod…
riseandshaheen May 1, 2025
04b382a
revert: coprocessor content
riseandshaheen May 16, 2025
004619b
updated content for cartesi-machine and fraud-proofs
riseandshaheen May 16, 2025
7c3538a
changed table font size for better fit
jplgarcia May 20, 2025
1fa202a
docs(api): graphql reference update
henriquemarlon Mar 31, 2025
c400a36
queries update
henriquemarlon Apr 3, 2025
d81d37a
docs: more clear description and some broken links
henriquemarlon Apr 7, 2025
5cd815b
docs: add delegate call voucher docs
henriquemarlon Apr 8, 2025
65af208
docs: fix references for filters
henriquemarlon Apr 8, 2025
04daae7
docs: update inspect request reference
henriquemarlon Apr 8, 2025
1ab2849
docs:add reference for delegate call vouchers on vouchers section
henriquemarlon Apr 8, 2025
40605b2
docs(api-reference): add exception and finish to backend
henriquemarlon Apr 8, 2025
d2ddfa9
docs(api-reference): chnage query for enum
henriquemarlon Apr 8, 2025
5d2e8dd
docs(api-reference): add outputs on intro for backend apis
henriquemarlon Apr 9, 2025
d198283
docs(api-reference): update info for finish endpoint
henriquemarlon Apr 9, 2025
5b7177e
docs: improve delegate call voucher description
henriquemarlon May 2, 2025
fc197a7
docs: json-rpc api section
henriquemarlon May 2, 2025
743a335
docs: improve description and references
henriquemarlon May 3, 2025
2a7bdc9
docs: improve description and references
henriquemarlon May 3, 2025
336d41d
docs: fix sidebar
henriquemarlon May 3, 2025
032f45c
docs: update json-rpc api reference
henriquemarlon Jun 2, 2025
07b4b3f
docs: modified development section images
Nonnyjoe Mar 16, 2025
aadf2d1
docs: modified assets-handling section
Nonnyjoe Mar 16, 2025
b7b1db2
docs: modified building section in line with v2 updates
Nonnyjoe Mar 16, 2025
df89abc
docs: partial update to the cli command section
Nonnyjoe Mar 16, 2025
e426ed0
docs: update reference of dapp to application in installation section
Nonnyjoe Mar 16, 2025
2cdf164
docs: Modified graphQL queries and dapp reference in query section
Nonnyjoe Mar 16, 2025
687d133
docs: updated send-inputs section in line with V2 updates
Nonnyjoe Mar 16, 2025
b590630
docs: added page for managing devnet environment
Nonnyjoe Mar 18, 2025
d9644e2
docs: modifying the deploying an app section
Nonnyjoe Mar 19, 2025
dbb5e6b
docs: updated cli-commands section inline with cli2.0
Nonnyjoe Mar 20, 2025
eafde1b
docs: updated broken links in tutorial section referencing changes in…
Nonnyjoe Mar 20, 2025
3236801
docs: modified page title for building and deploying an application
Nonnyjoe Mar 20, 2025
301c464
docs: reflected first stage of reviews
Nonnyjoe Mar 21, 2025
eef0177
docs: updated cli commands in line with cli-aplha-9
Nonnyjoe Apr 21, 2025
778488b
docs: updated api-reference
Nonnyjoe Jun 5, 2025
dcc4a9b
docs: restructured development section
Nonnyjoe Jun 5, 2025
628515f
docs: Implemented reviews across development section
Nonnyjoe Jun 9, 2025
9b6fe05
docs: Rebased on staging and fixed broken links
Nonnyjoe Jun 9, 2025
0a20fb6
fixup! docs: Implemented reviews across development section
Nonnyjoe Jun 11, 2025
a396188
fixup! docs: Implemented reviews across development section
Nonnyjoe Jun 11, 2025
19d3c9d
update contracts and json-rpc, consensus WIP
henriquemarlon Jun 26, 2025
ec57a1e
Merge branch 'Staging' of https://github.com/cartesi/docs into docs/a…
henriquemarlon Jun 26, 2025
6e7125e
removed espresso, added react tutorials and app-chains page
riseandshaheen Jun 16, 2025
a6c821d
added diagrams and minor improvements
riseandshaheen Jul 3, 2025
17f11f2
added spacing on big square image
jplgarcia Jul 3, 2025
03556b0
update delegatecall
henriquemarlon Aug 8, 2025
30a1c4d
merge Staging into docs(api-reference
henriquemarlon Aug 8, 2025
b4bd503
update application contract and add consensus section
henriquemarlon Aug 8, 2025
15f348b
Merge branch 'henriquemarlon-docs/api-reference' into Staging
henriquemarlon Aug 8, 2025
1bad6d9
minor improvements and cosmetic changes
henriquemarlon Aug 10, 2025
dd1260f
fix: id correspondence
henriquemarlon Aug 10, 2025
fccabe1
fix: id correspondence
henriquemarlon Aug 10, 2025
d0736b6
revert golang version for delegate call voucher
henriquemarlon Aug 10, 2025
1722b02
docs(development): Updated development section in line with updates o…
Nonnyjoe Aug 12, 2025
175c69f
feat: src files and deployment tutorial for local node deployment
henriquemarlon Aug 11, 2025
ae73aa3
feat: change link for compose file
henriquemarlon Aug 11, 2025
af9b4b4
minor improvements and snapshot section with gh actions example
henriquemarlon Aug 14, 2025
5da8d2e
docs: update snapshot workflow description and minor updates on self-…
henriquemarlon Aug 21, 2025
147a216
Fraud Proofs Tab- Content
riseandshaheen Aug 25, 2025
bb7737b
cosmetic updates and review comments updated content
riseandshaheen Aug 27, 2025
90cd4c2
cosmetic updates, dapp to app, sidebar collapse set to true
riseandshaheen Aug 28, 2025
bf45629
honeypot application logic corrections
riseandshaheen Sep 4, 2025
9a4a380
updates with review comments from lyno
riseandshaheen Sep 5, 2025
caa1c35
Rename Computation-Hash-Rollups.jpg to computation-hash-rollups.jpg
riseandshaheen Sep 5, 2025
59c7087
minor updates
riseandshaheen Sep 8, 2025
f977417
minor refinements
riseandshaheen Sep 8, 2025
eac0d3f
Default to 1.5, removed outdated commands from quickstart and removed…
riseandshaheen Sep 19, 2025
bc0fda2
Merge branch 'main' into Staging
riseandshaheen Sep 19, 2025
6bf7342
add: implemented a sidebar file for V2
Nonnyjoe Oct 10, 2024
b40351d
add: Added the Account abstraction tutorial to V2
Nonnyjoe Oct 10, 2024
111847f
update: Modified the Development folder for V2
Nonnyjoe Oct 10, 2024
f416864
fix: Handled error relating to broken links
Nonnyjoe Oct 11, 2024
6e2b752
docs: restructuring the api reference
henriquemarlon Oct 15, 2024
4fa64b7
modified: overview & quickstart merged in side-bar
riseandshaheen Oct 14, 2024
2ea9a01
remapped pages
jplgarcia Nov 21, 2024
980c3e5
setting redirects
jplgarcia Nov 21, 2024
8692944
fix: Handled error relating to broken links
Nonnyjoe Oct 11, 2024
6cb3c88
update: modified application factory contract in line with V2.0
Nonnyjoe Nov 18, 2024
f0c33b3
update: modified the different portals page in line with docs V2
Nonnyjoe Nov 18, 2024
2f21584
mod: relayer page and also reference in sidebar
Nonnyjoe Nov 18, 2024
3c570fd
mod: updated querry outputs inline with V2
Nonnyjoe Nov 25, 2024
9ecd473
merge: merged Joao's restructure with V2 updates
Nonnyjoe Nov 25, 2024
0a4e2d3
update: modified asssets-handling inline with V2
Nonnyjoe Nov 25, 2024
55f181d
add: Added an external resource section
Nonnyjoe Nov 7, 2024
badd54d
update: restructured external resource position
Nonnyjoe Nov 7, 2024
6483947
add: Added an external resource section
Nonnyjoe Nov 7, 2024
15eb664
update: restructured external resource position
Nonnyjoe Nov 7, 2024
42b8db5
update: added shour descriptions for different integratins
Nonnyjoe Nov 18, 2024
3a3fbce
add: added the integrations guide section
Nonnyjoe Nov 25, 2024
9b7582d
update on structure, spliting architecture concepts and installation …
jplgarcia Dec 9, 2024
0b55da9
updated tutorials for v2
jplgarcia Dec 23, 2024
b8cff4d
admonition
jorka Dec 2, 2024
907ee98
announcement bar
jorka Dec 2, 2024
4ee1ec7
api item
jorka Dec 2, 2024
c43501d
api tabs
jorka Dec 2, 2024
8f94498
code block
jorka Dec 2, 2024
41a0d3b
doc breadcrumbs
jorka Dec 2, 2024
f9526d2
doc card
jorka Dec 2, 2024
dbf58d6
doc generated index
jorka Dec 2, 2024
53090ad
dic item
jorka Dec 9, 2024
8b02983
edit this page, custom icons
jorka Dec 9, 2024
93991c1
footer
jorka Dec 10, 2024
f45e1e8
heading
jorka Dec 10, 2024
dd708ee
edit meta row
jorka Dec 10, 2024
2a0ff9f
last updated
jorka Dec 10, 2024
33507f6
tag
jorka Dec 10, 2024
b95b202
edit icon fix
jorka Dec 11, 2024
d4ff61c
edit icon fix
jorka Dec 11, 2024
bc95488
remove console log
jorka Dec 12, 2024
ea3ce21
sidebar version
jorka Dec 12, 2024
77a4deb
sidebar version
jorka Dec 12, 2024
808ac17
toc
jorka Dec 12, 2024
2b08db6
tabs
jorka Dec 12, 2024
08a48aa
mdx components tooltip
jorka Dec 12, 2024
b068bbd
config and deps
jorka Dec 12, 2024
46328b9
remove DocVersionBadge
jorka Dec 12, 2024
935ec8a
announcement bar - fix useEffect
jorka Dec 13, 2024
a81bb5c
fix docs/earn-ctsi/staking-faq.md mdx
jorka Dec 13, 2024
1255e38
open api config - enable generation of previos versions
jorka Dec 13, 2024
6217d03
generate prev versions open api
jorka Dec 13, 2024
1501c8f
yarn lock
jorka Dec 13, 2024
ebd0490
remove log
jorka Dec 13, 2024
ddeee26
fix mdx
jorka Dec 13, 2024
edb3ece
add deps
jorka Dec 13, 2024
1c0e46d
fix tabs inside openapi - remove border:
jorka Dec 13, 2024
28c8d3d
fix mdx
jorka Dec 18, 2024
680ef41
add missing page to fix broken links
jorka Dec 18, 2024
b1cb252
fix api folder for v2, comment missing redirects, switch to v2
jorka Dec 18, 2024
8e9434a
docs: application section updated to v2
henriquemarlon Dec 2, 2024
3574476
docs: typos and solving requests for input-box and application consensus
henriquemarlon Mar 8, 2025
3bf2de5
docs: update from json-rpc to contracts
henriquemarlon Mar 8, 2025
79a01bc
docs: update broken links
henriquemarlon Mar 8, 2025
a5a2b2d
docs: update broken links
henriquemarlon Mar 8, 2025
0e96d5b
docs: update from json-rpc to contracts
henriquemarlon Mar 8, 2025
b832463
docs: solve broken links and wrong references
henriquemarlon Mar 8, 2025
8ba5e56
migration guide v1.5 to v2
riseandshaheen Mar 11, 2025
0017089
feat: docs v2 products restructuring, rollups and coprocessor in navbar
riseandshaheen Apr 28, 2025
9ea35b8
fix: visibility of version dropdown and table of contents on coproces…
riseandshaheen Apr 29, 2025
ea638e9
doc: added quickstart(rollups) to Get-Started tab
riseandshaheen Apr 30, 2025
005f12c
refactor: removed troubleshooting, differences with rollups and nonod…
riseandshaheen May 1, 2025
031555c
revert: coprocessor content
riseandshaheen May 16, 2025
1d34b86
updated content for cartesi-machine and fraud-proofs
riseandshaheen May 16, 2025
98672bc
changed table font size for better fit
jplgarcia May 20, 2025
e60ef7e
docs(api): graphql reference update
henriquemarlon Mar 31, 2025
5fa283d
queries update
henriquemarlon Apr 3, 2025
069dbd3
docs: more clear description and some broken links
henriquemarlon Apr 7, 2025
6074b85
docs: add delegate call voucher docs
henriquemarlon Apr 8, 2025
e241dd8
docs: fix references for filters
henriquemarlon Apr 8, 2025
c678600
docs: update inspect request reference
henriquemarlon Apr 8, 2025
91b7329
docs:add reference for delegate call vouchers on vouchers section
henriquemarlon Apr 8, 2025
78a99c6
docs(api-reference): add exception and finish to backend
henriquemarlon Apr 8, 2025
d87c0f0
docs(api-reference): chnage query for enum
henriquemarlon Apr 8, 2025
ec719ca
docs(api-reference): add outputs on intro for backend apis
henriquemarlon Apr 9, 2025
5d59b08
docs(api-reference): update info for finish endpoint
henriquemarlon Apr 9, 2025
1a3aed5
docs: improve delegate call voucher description
henriquemarlon May 2, 2025
80dd026
docs: json-rpc api section
henriquemarlon May 2, 2025
1697d5b
docs: improve description and references
henriquemarlon May 3, 2025
2ad2ec8
docs: improve description and references
henriquemarlon May 3, 2025
7d0b865
docs: fix sidebar
henriquemarlon May 3, 2025
43aff68
docs: update json-rpc api reference
henriquemarlon Jun 2, 2025
1afe255
update contracts and json-rpc, consensus WIP
henriquemarlon Jun 26, 2025
f7c0a7d
docs: modified development section images
Nonnyjoe Mar 16, 2025
f794886
docs: modified assets-handling section
Nonnyjoe Mar 16, 2025
eafe7a6
docs: modified building section in line with v2 updates
Nonnyjoe Mar 16, 2025
4af194d
docs: partial update to the cli command section
Nonnyjoe Mar 16, 2025
4f67d25
docs: update reference of dapp to application in installation section
Nonnyjoe Mar 16, 2025
5b1e050
docs: Modified graphQL queries and dapp reference in query section
Nonnyjoe Mar 16, 2025
5fadf12
docs: updated send-inputs section in line with V2 updates
Nonnyjoe Mar 16, 2025
1d29f8b
docs: added page for managing devnet environment
Nonnyjoe Mar 18, 2025
ae85c7b
docs: modifying the deploying an app section
Nonnyjoe Mar 19, 2025
31c289c
docs: updated cli-commands section inline with cli2.0
Nonnyjoe Mar 20, 2025
b4cea38
docs: updated broken links in tutorial section referencing changes in…
Nonnyjoe Mar 20, 2025
b324ef1
docs: modified page title for building and deploying an application
Nonnyjoe Mar 20, 2025
b08d544
docs: reflected first stage of reviews
Nonnyjoe Mar 21, 2025
2287eb4
docs: updated cli commands in line with cli-aplha-9
Nonnyjoe Apr 21, 2025
2d0f86f
docs: updated api-reference
Nonnyjoe Jun 5, 2025
af598d8
docs: restructured development section
Nonnyjoe Jun 5, 2025
a1de72a
docs: Implemented reviews across development section
Nonnyjoe Jun 9, 2025
018d8d9
docs: Rebased on staging and fixed broken links
Nonnyjoe Jun 9, 2025
9636821
fixup! docs: Implemented reviews across development section
Nonnyjoe Jun 11, 2025
4de3c2f
fixup! docs: Implemented reviews across development section
Nonnyjoe Jun 11, 2025
ecdd4c1
update delegatecall
henriquemarlon Aug 8, 2025
511b2bf
removed espresso, added react tutorials and app-chains page
riseandshaheen Jun 16, 2025
d99d75a
added diagrams and minor improvements
riseandshaheen Jul 3, 2025
5f09368
added spacing on big square image
jplgarcia Jul 3, 2025
194b887
update application contract and add consensus section
henriquemarlon Aug 8, 2025
1935f33
minor improvements and cosmetic changes
henriquemarlon Aug 10, 2025
d078a80
fix: id correspondence
henriquemarlon Aug 10, 2025
a84a94b
fix: id correspondence
henriquemarlon Aug 10, 2025
120c5bb
revert golang version for delegate call voucher
henriquemarlon Aug 10, 2025
c0ba2d8
docs(development): Updated development section in line with updates o…
Nonnyjoe Aug 12, 2025
127807f
feat: src files and deployment tutorial for local node deployment
henriquemarlon Aug 11, 2025
cf3297a
feat: change link for compose file
henriquemarlon Aug 11, 2025
a9fc484
minor improvements and snapshot section with gh actions example
henriquemarlon Aug 14, 2025
f6e9437
docs: update snapshot workflow description and minor updates on self-…
henriquemarlon Aug 21, 2025
fafcdcd
Fraud Proofs Tab- Content
riseandshaheen Aug 25, 2025
0bd7b8f
cosmetic updates and review comments updated content
riseandshaheen Aug 27, 2025
bae26cf
cosmetic updates, dapp to app, sidebar collapse set to true
riseandshaheen Aug 28, 2025
b790bcd
honeypot application logic corrections
riseandshaheen Sep 4, 2025
4ef1cfd
updates with review comments from lyno
riseandshaheen Sep 5, 2025
e5e881a
Rename Computation-Hash-Rollups.jpg to computation-hash-rollups.jpg
riseandshaheen Sep 5, 2025
d100540
minor updates
riseandshaheen Sep 8, 2025
25a1ca5
minor refinements
riseandshaheen Sep 8, 2025
14ec7d1
Default to 1.5, removed outdated commands from quickstart and removed…
riseandshaheen Sep 19, 2025
7d9ba6e
Hide 2.0 docs from the dropdown version list
riseandshaheen Sep 24, 2025
c4cbb94
Merge branch 'Staging' of https://github.com/cartesi/docs into Staging
jplgarcia Sep 24, 2025
fed70fc
Update vouchers.md
jplgarcia Sep 24, 2025
226bbe2
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