cartesi-rollups-graphql

command module
v0.0.0-...-4db6afb Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 2, 2025 License: Apache-2.0 Imports: 17 Imported by: 0

README

Cartesi's GraphQL

CI Go Report Card

Technical Vision Forum Discussion

Internal docs

Description

Exposes the GraphQL reader API in the endpoint http://127.0.0.1:8080/graphql. You may access this address to use the GraphQL interactive playground in your web browser. You can also make POST requests directly to the GraphQL API. For instance, the command below gets the number of inputs.

QUERY='query { inputs { totalCount } }'; \
curl \
    -X POST \
    -H 'Content-Type: application/json' \
    -d "{\"query\": \"$QUERY\"}" \
    http://127.0.0.1:8080/graphql

Connecting to Postgres locally

Start a Postgres instance locally using docker compose.

make up-db-raw
export POSTGRES_GRAPHQL_DB_URL="postgres://postgres:password@localhost:5432/rlgraphql?sslmode=disable"
export POSTGRES_NODE_DB_URL="postgres://postgres:password@localhost:5432/rollupsdb?sslmode=disable"
./cartesi-rollups-graphql

Environment Variables

The following environment variables are used for PostgreSQL configuration:

  • POSTGRES_GRAPHQL_DB_URL: URL for the PostgreSQL database used by GraphQL.
  • POSTGRES_NODE_DB_URL: URL for the PostgreSQL database used by the node.
  • DB_MAX_OPEN_CONNS: Maximum number of open connections to the database (default: 25).
  • DB_MAX_IDLE_CONNS: Maximum number of idle connections in the pool (default: 10).
  • DB_CONN_MAX_LIFETIME: Maximum amount of time a connection may be reused (default: 1800 seconds).
  • DB_CONN_MAX_IDLE_TIME: Maximum amount of time a connection may be idle (default: 300 seconds).

Contributors

Contributors

Made with contributors-img.

Documentation

Overview

This package contains the main function that executes the cartesi-rollups-graphql command.

Directories

Path Synopsis
pkg
bootstrap
This package contains the nonodo run function.
This package contains the nonodo run function.
contracts
This package contains the contract bindings for Cartesi Rollups.
This package contains the contract bindings for Cartesi Rollups.
contracts/generate
This binary generates the Go bindings for the Cartesi Rollups contracts.
This binary generates the Go bindings for the Cartesi Rollups contracts.
model
The nonodo model uses a shared-memory paradigm to synchronize between threads.
The nonodo model uses a shared-memory paradigm to synchronize between threads.
reader
This package is responsible for serving the GraphQL reader API.
This package is responsible for serving the GraphQL reader API.
reader/model
This module is a wrapper for the nonodo model that converts the internal types to GraphQL-compatible types.
This module is a wrapper for the nonodo model that converts the internal types to GraphQL-compatible types.
readerclient
This package contains a client for the GraphQL reader API for testing purposes.
This package contains a client for the GraphQL reader API for testing purposes.
supervisor
This package contains a simple supervisor for goroutine workers.
This package contains a simple supervisor for goroutine workers.
postgres
raw

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL