Skip to content

Latest commit

 

History

History
151 lines (119 loc) · 5.56 KB

README.md

File metadata and controls

151 lines (119 loc) · 5.56 KB
Raw

Cardano JS SDK | Cardano GraphQL Services

Libraries and program entrypoints for services to facilitate remote data and submit access using Provider interfaces over HTTP, with optional queue-based transaction submission; The TxSubmitHttpService can be configured to submit directly via Ogmios, or via a RabbitMQ broker, with one or more workers handling submission and response job creation. Data is sourced from Cardano DB Sync, the local Cardano Node via Ogmios Local State Queries, genesis files, and remote sources.

Features

  • CLI with configuration via command line arguments or environment variables and optional loading of secrets from disk.
  • Service port discovery via DNS resolution, or static configuration.
  • Fault-tolerant transaction submission via persistent queue, or direct submission.
  • Optional Prometheus metrics available at /metrics
  • Data sourced from Cardano DB Sync PostgreSQL, Local State Queries, genesis files, and remote sources.

Services

The services require instances of Cardano Node and Ogmios as a minimum, with Cardano DB Sync and RabbitMQ dependent on the run command. Please refer to docker-compose.json for the current supported version of each service dependency.

HTTP Server

The HTTP server can be started with one or more provider modules by name, segmented by URL path. Run the CLI with start-server --help to see the full list of options.

Worker

A worker must be started when opting for queue-based transaction submission. Run the CLI with start-worker --help to see the full list of options.

Examples

The following examples require the install and build steps to be completed.

All Providers | Static Service Config | Direct Tx Submission

  • The server will expose all Provider HTTP services
  • Transactions will be submitted directly via Ogmios, running at ws://localhost:1338.
  • Connects to PostgreSQL service running at localhost:5432
  • HTTP API exposed using a custom API URL

start-server using CLI options:

./dist/cjs/cli.js \
  start-server \
    --api-url http://localhost:6000 \
    --cardano-node-config-path ./config/network/preprod/cardano-node/config.json \
    --postgres-connection-string postgresql://somePgUser:somePassword@localhost:5432/someDbName \
    --ogmios-url  ws://localhost:1338 \
    asset chain-history stake-pool tx-submit network-info utxo rewards

start-server using env variables:

SERVICE_NAMES=asset,chain-history,stake-pool,tx-submit,network-info,utxo,rewards \
API_URL=http://localhost:6000 \
CARDANO_NODE_CONFIG_PATH=./config/network/preprod/cardano-node/config.json \
POSTGRES_CONNECTION_STRING=postgresql://somePgUser:somePassword@localhost:5432/someDbName \
OGMIOS_URL=ws://localhost:1338 \
./dist/cjs/cli.js start-server

All Providers | Service Discovery | Queued Tx Submission | Metrics

  • The server will expose all Provider HTTP services
  • Transactions will be queued by the HTTP service, with the worker completing the submission. The HTTP service receives the submission result via a dedicated channel to complete the HTTP request.
  • Ports for Ogmios, PostgreSQL, and RabbitMQ, discovered using DNS resolution.
  • HTTP API exposed using a custom API URL
  • Prometheus metrics exporter enabled at http://localhost:6000/metrics

start-server using CLI options:

./dist/cjs/cli.js \
  start-server \
    --api-url http://localhost:6000 \
    --enable-metrics \
    --cardano-node-config-path ./config/network/preprod/cardano-node/config.json \
    --postgres-srv-service-name \
    --postgres-db someDbName \
    --postgres-user somePgUser \
    --postgres-password somePassword \
    --ogmios-srv-service-name  some-domain-for-ogmios \
    --rabbitmq-srv-service-name some-domain-for-rabbitmq \
    --use-queue \
    asset chain-history stake-pool tx-submit network-info utxo rewards

start-server using env variables:

SERVICE_NAMES=asset,chain-history,stake-pool,tx-submit,network-info,utxo,rewards \
API_URL=http://localhost:6000 \
ENABLE_METRICS=true \
CARDANO_NODE_CONFIG_PATH=./config/network/preprod/cardano-node/config.json \
POSTGRES_SRV_SERVICE_NAME=some-domain-for-postgres-db
POSTGRES_DB=someDbName \
POSTGRES_USER=someUser \
POSTGRES_PASSWORD=somePassword \
OGMIOS_SRV_SERVICE_NAME=some-domain-for-ogmios \
RABBITMQ_SRV_SERVICE_NAME=some-domain-for-rabbitmq \
USE_QUEUE=true \
./dist/cjs/cli.js start-server

start-worker using CLI options:

./dist/cjs/cli.js \
  start-worker \
    --ogmios-srv-service-name  some-domain-for-ogmios \
    --rabbitmq-srv-service-name some-domain-for-rabbitmq

start-worker using env variables:

OGMIOS_SRV_SERVICE_NAME=some-domain-for-ogmios \
RABBITMQ_SRV_SERVICE_NAME=some-domain-for-rabbitmq \
./dist/cjs/cli.js start-worker

Development

See the development documentation

Tests

See code coverage report