-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
24 changed files
with
7,249 additions
and
313 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| "@deroll/rpc": minor | ||
| --- | ||
|
|
||
| draft of RPC server and client |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| src/__generated__ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| # Cartesi JSON-RPC API | ||
|
|
||
| JSON-RPC API to query Cartesi application inputs and outputs. | ||
|
|
||
| The implementation is written in TypeScript and uses a GraphQL connection to the node to serve its requests. | ||
|
|
||
| ## Spec | ||
|
|
||
| The API specification is written in [OpenRPC](https://open-rpc.org) format and can be found in the [openrpc.json](openrpc.json) file. The specification is also available in the [OpenRPC Playground](https://playground.open-rpc.org/?schemaUrl=https://raw.githubusercontent.com/tuler/deroll/main/packages/rpc/openrpc.json). | ||
|
|
||
| ## Running | ||
|
|
||
| To run the RPC server, execute the command below, where `<graphqlUri>` is the URL of the GraphQL endpoint of the Cartesi node: | ||
|
|
||
| ```shell | ||
| npx @deroll/rpc <graphqlUri> | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| import { CodegenConfig } from "@graphql-codegen/cli"; | ||
|
|
||
| const config: CodegenConfig = { | ||
| schema: "https://github.com/cartesi/rollups-node/releases/download/v1.4.0/schema.graphql", | ||
| // this assumes that all your source files are in a top-level `src/` directory - you might need to adjust this to your file structure | ||
| documents: ["src/**/*.{graphql,ts,tsx}"], | ||
| generates: { | ||
| "./src/__generated__/": { | ||
| preset: "client", | ||
| plugins: [], | ||
| presetConfig: { | ||
| fragmentMasking: false, | ||
| gqlTagName: "gql", | ||
| }, | ||
| }, | ||
| }, | ||
| ignoreNoDocuments: true, | ||
| }; | ||
|
|
||
| export default config; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,306 @@ | ||
| { | ||
| "openrpc": "1.2.4", | ||
| "info": { | ||
| "version": "1.0.0", | ||
| "title": "Cartesi", | ||
| "license": { | ||
| "name": "Apache-2.0" | ||
| } | ||
| }, | ||
| "servers": [ | ||
| { | ||
| "url": "http://localhost:8080/node/rpc" | ||
| } | ||
| ], | ||
| "methods": [ | ||
| { | ||
| "name": "cartesi_inputNumber", | ||
| "summary": "Returns the number of the most recent input", | ||
| "params": [], | ||
| "result": { | ||
| "name": "inputNumber", | ||
| "summary": "The number of the most recent input", | ||
| "description": "The number of the most recent input receive by the node. Returns -1 if there were no inputs. The most recent input number is returned regardless its status, which can also be UNPROCESSED.", | ||
| "schema": { | ||
| "type": "number" | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "name": "cartesi_getInput", | ||
| "summary": "Returns the input with the given number", | ||
| "params": [ | ||
| { | ||
| "$ref": "#/components/contentDescriptors/InputNumber" | ||
| } | ||
| ], | ||
| "result": { | ||
| "name": "input", | ||
| "description": "The input with the given number", | ||
| "schema": { | ||
| "$ref": "#/components/schemas/Input" | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "name": "cartesi_getNoticeCount", | ||
| "summary": "Returns the number of notices produced by an input", | ||
| "params": [ | ||
| { | ||
| "$ref": "#/components/contentDescriptors/InputNumber" | ||
| } | ||
| ], | ||
| "result": { | ||
| "name": "noticeCount", | ||
| "description": "The number of notices produced by the input", | ||
| "schema": { | ||
| "type": "number" | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "name": "cartesi_getReportCount", | ||
| "summary": "Returns the number of reports produced by an input", | ||
| "params": [ | ||
| { | ||
| "$ref": "#/components/contentDescriptors/InputNumber" | ||
| } | ||
| ], | ||
| "result": { | ||
| "name": "reportCount", | ||
| "description": "The number of reports produced by the input", | ||
| "schema": { | ||
| "type": "number" | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "name": "cartesi_getVoucherCount", | ||
| "summary": "Returns the number of vouchers produced by an input", | ||
| "params": [ | ||
| { | ||
| "$ref": "#/components/contentDescriptors/InputNumber" | ||
| } | ||
| ], | ||
| "result": { | ||
| "name": "voucherCount", | ||
| "description": "The number of vouchers produced by the input", | ||
| "schema": { | ||
| "type": "number" | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "name": "cartesi_getNotice", | ||
| "summary": "Returns a notice produced by an input", | ||
| "params": [ | ||
| { | ||
| "$ref": "#/components/contentDescriptors/InputNumber" | ||
| }, | ||
| { | ||
| "$ref": "#/components/contentDescriptors/NoticeNumber" | ||
| } | ||
| ], | ||
| "result": { | ||
| "name": "notice", | ||
| "description": "The notice produced by the input", | ||
| "schema": { | ||
| "type": "number" | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "name": "cartesi_getReport", | ||
| "summary": "Returns a report produced by an input", | ||
| "params": [ | ||
| { | ||
| "$ref": "#/components/contentDescriptors/InputNumber" | ||
| }, | ||
| { | ||
| "$ref": "#/components/contentDescriptors/ReportNumber" | ||
| } | ||
| ], | ||
| "result": { | ||
| "name": "report", | ||
| "description": "Report produced by an input", | ||
| "schema": { | ||
| "$ref": "#/components/schemas/Report" | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "name": "cartesi_getVoucher", | ||
| "summary": "Returns a voucher produced by an input", | ||
| "params": [ | ||
| { | ||
| "$ref": "#/components/contentDescriptors/InputNumber" | ||
| }, | ||
| { | ||
| "$ref": "#/components/contentDescriptors/VoucherNumber" | ||
| } | ||
| ], | ||
| "result": { | ||
| "name": "voucher", | ||
| "description": "Voucher produced by an input", | ||
| "schema": { | ||
| "$ref": "#/components/schemas/Voucher" | ||
| } | ||
| } | ||
| } | ||
| ], | ||
| "components": { | ||
| "contentDescriptors": { | ||
| "InputNumber": { | ||
| "name": "inputNumber", | ||
| "required": true, | ||
| "description": "The index of the input", | ||
| "schema": { | ||
| "type": "number" | ||
| } | ||
| }, | ||
| "NoticeNumber": { | ||
| "name": "noticeNumber", | ||
| "required": true, | ||
| "description": "The index of the notice", | ||
| "schema": { | ||
| "type": "number" | ||
| } | ||
| }, | ||
| "ReportNumber": { | ||
| "name": "reportNumber", | ||
| "required": true, | ||
| "description": "The index of the report", | ||
| "schema": { | ||
| "type": "number" | ||
| } | ||
| }, | ||
| "VoucherNumber": { | ||
| "name": "voucherNumber", | ||
| "required": true, | ||
| "description": "The index of the voucher", | ||
| "schema": { | ||
| "type": "number" | ||
| } | ||
| } | ||
| }, | ||
| "schemas": { | ||
| "Input": { | ||
| "type": "object", | ||
| "required": [ | ||
| "blockNumber", | ||
| "msgSender", | ||
| "payload", | ||
| "status", | ||
| "timestamp" | ||
| ], | ||
| "properties": { | ||
| "blockNumber": { | ||
| "type": "string" | ||
| }, | ||
| "msgSender": { | ||
| "type": "string" | ||
| }, | ||
| "payload": { | ||
| "type": "string" | ||
| }, | ||
| "status": { | ||
| "type": "string" | ||
| }, | ||
| "timestamp": { | ||
| "type": "string" | ||
| } | ||
| } | ||
| }, | ||
| "Report": { | ||
| "type": "object", | ||
| "required": ["payload"], | ||
| "properties": { | ||
| "payload": { | ||
| "type": "string" | ||
| } | ||
| } | ||
| }, | ||
| "Proof": { | ||
| "type": "object", | ||
| "required": ["context", "validity"], | ||
| "properties": { | ||
| "context": { | ||
| "type": "string" | ||
| }, | ||
| "validity": { | ||
| "type": "object", | ||
| "required": [ | ||
| "inputIndexWithinEpoch", | ||
| "outputIndexWithinInput", | ||
| "outputHashesRootHash", | ||
| "vouchersEpochRootHash", | ||
| "noticesEpochRootHash", | ||
| "machineStateHash", | ||
| "outputHashInOutputHashesSiblings", | ||
| "outputHashesInEpochSiblings" | ||
| ], | ||
| "properties": { | ||
| "inputIndexWithinEpoch": { | ||
| "type": "number" | ||
| }, | ||
| "outputIndexWithinInput": { | ||
| "type": "number" | ||
| }, | ||
| "outputHashesRootHash": { | ||
| "type": "string" | ||
| }, | ||
| "vouchersEpochRootHash": { | ||
| "type": "string" | ||
| }, | ||
| "noticesEpochRootHash": { | ||
| "type": "string" | ||
| }, | ||
| "machineStateHash": { | ||
| "type": "string" | ||
| }, | ||
| "outputHashInOutputHashesSiblings": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "string" | ||
| } | ||
| }, | ||
| "outputHashesInEpochSiblings": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "string" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "Notice": { | ||
| "type": "object", | ||
| "required": ["payload"], | ||
| "properties": { | ||
| "payload": { | ||
| "type": "string" | ||
| }, | ||
| "proof": { | ||
| "$ref": "#/components/schemas/Proof" | ||
| } | ||
| } | ||
| }, | ||
| "Voucher": { | ||
| "type": "object", | ||
| "required": ["destination", "payload"], | ||
| "properties": { | ||
| "destination": { | ||
| "type": "string" | ||
| }, | ||
| "payload": { | ||
| "type": "string" | ||
| }, | ||
| "proof": { | ||
| "$ref": "#/components/schemas/Proof" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.