Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

CLI Options

Commands

Usage: neoprism-node <COMMAND>

Commands:
  indexer           Start the node in indexer mode
  submitter         Start the node in submitter mode
  standalone        Start the node in standalone mode
  dev               Start the node in standalone mode with an in-memory blockchain for development
  generate-openapi  Generate OpenAPI specification for the API
  help              Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

Indexer options

Start the node in indexer mode

Usage: neoprism-node indexer [OPTIONS] --dlt-source-type <DLT_SOURCE_TYPE>

Options:
  -h, --help  Print help

Server:
      --address <ADDRESS>            Node HTTP server binding address [env: NPRISM_ADDRESS=] [default: 0.0.0.0]
  -p, --port <PORT>                  Node HTTP server listening port [env: NPRISM_PORT=] [default: 8080]
      --assets-path <ASSETS_PATH>    The directory containing the web UI assets (CSS, JavaScript files) [env: NPRISM_ASSETS_PATH=] [default: ./bin/neoprism-node/assets]
      --cors-enabled                 Enable permissive CORS (https://docs.rs/tower-http/latest/tower_http/cors/struct.CorsLayer.html#method.permissive) [env: NPRISM_CORS_ENABLED=]
      --external-url <EXTERNAL_URL>  External URL for Swagger server list (e.g. https://example.com) [env: NPRISM_EXTERNAL_URL=]

Database:
      --db-url <DB_URL>  Database URL (e.g. postgres://user:pass@host:5432/db or sqlite:///path/to/db). Defaults to an embedded SQLite file when omitted [env: NPRISM_DB_URL=]
      --skip-migration   Skip database migration on node startup [env: NPRISM_SKIP_MIGRATION=]

DLT Source:
      --dlt-source-type <DLT_SOURCE_TYPE>
          Type of DLT source to use for event synchronization [env: NPRISM_DLT_SOURCE_TYPE=] [possible values: oura, dbsync, blockfrost]
      --index-interval <INDEX_INTERVAL>
          Duration to wait before checking for unindexed operations [env: NPRISM_INDEX_INTERVAL=] [default: 10s]
      --confirmation-blocks <CONFIRMATION_BLOCKS>
          Number of confirmation blocks to wait before considering the block valid [env: NPRISM_CONFIRMATION_BLOCKS=] [default: 112]

Network:
      --cardano-network <CARDANO_NETWORK>
          The Cardano network (mainnet, preprod, preview, or custom) [env: NPRISM_CARDANO_NETWORK=] [default: mainnet] [possible values: mainnet, preprod, preview, custom]

Oura:
      --cardano-relay-addr <CARDANO_RELAY_ADDR>
          Address of the Cardano relay node (e.g. backbone.mainnet.cardanofoundation.org:3001) [env: NPRISM_CARDANO_RELAY_ADDR=]

DB-Sync:
      --cardano-dbsync-url <CARDANO_DBSYNC_URL>
          DB-Sync URL (e.g. postgres://user:pass@host:5432/db) [env: NPRISM_CARDANO_DBSYNC_URL=]
      --cardano-dbsync-poll-interval <CARDANO_DBSYNC_POLL_INTERVAL>
          Duration to wait before polling DB Sync for the next update [env: NPRISM_CARDANO_DBSYNC_POLL_INTERVAL=] [default: 10s]

Blockfrost:
      --blockfrost-api-key <BLOCKFROST_API_KEY>
          Blockfrost API key [env: NPRISM_BLOCKFROST_API_KEY=]
      --blockfrost-base-url <BLOCKFROST_BASE_URL>
          Blockfrost base URL [env: NPRISM_BLOCKFROST_BASE_URL=] [default: https://cardano-mainnet.blockfrost.io/api/v0]
      --blockfrost-poll-interval <BLOCKFROST_POLL_INTERVAL>
          Duration to wait before polling Blockfrost for the next update [env: NPRISM_BLOCKFROST_POLL_INTERVAL=] [default: 10s]
      --blockfrost-api-delay <BLOCKFROST_API_DELAY>
          Delay between Blockfrost API calls. Set this to throttle requests and stay within Blockfrost API limits [env: NPRISM_BLOCKFROST_API_DELAY=] [default: 100ms]
      --blockfrost-concurrency-limit <BLOCKFROST_CONCURRENCY_LIMIT>
          Blockfrost API calls concurrency limit [env: NPRISM_BLOCKFROST_CONCURRENCY_LIMIT=] [default: 4]

Submitter options

Start the node in submitter mode

Usage: neoprism-node submitter [OPTIONS] --dlt-sink-type <DLT_SINK_TYPE>

Options:
  -h, --help  Print help

Server:
      --address <ADDRESS>            Node HTTP server binding address [env: NPRISM_ADDRESS=] [default: 0.0.0.0]
  -p, --port <PORT>                  Node HTTP server listening port [env: NPRISM_PORT=] [default: 8080]
      --assets-path <ASSETS_PATH>    The directory containing the web UI assets (CSS, JavaScript files) [env: NPRISM_ASSETS_PATH=] [default: ./bin/neoprism-node/assets]
      --cors-enabled                 Enable permissive CORS (https://docs.rs/tower-http/latest/tower_http/cors/struct.CorsLayer.html#method.permissive) [env: NPRISM_CORS_ENABLED=]
      --external-url <EXTERNAL_URL>  External URL for Swagger server list (e.g. https://example.com) [env: NPRISM_EXTERNAL_URL=]

Network:
      --cardano-network <CARDANO_NETWORK>
          The Cardano network (mainnet, preprod, preview, or custom) [env: NPRISM_CARDANO_NETWORK=] [default: mainnet] [possible values: mainnet, preprod, preview, custom]

DLT Sink:
      --dlt-sink-type <DLT_SINK_TYPE>  Type of DLT sink to use for transaction submission [env: NPRISM_DLT_SINK_TYPE=] [possible values: cardano-wallet, embedded-wallet]

Cardano Wallet:
      --cardano-wallet-base-url <CARDANO_WALLET_BASE_URL>
          Base URL of the Cardano wallet. Required when --dlt-sink-type=cardano-wallet [env: NPRISM_CARDANO_WALLET_BASE_URL=]
      --cardano-wallet-wallet-id <CARDANO_WALLET_WALLET_ID>
          Wallet ID to use for making transactions. Required when --dlt-sink-type=cardano-wallet [env: NPRISM_CARDANO_WALLET_WALLET_ID=]
      --cardano-wallet-passphrase <CARDANO_WALLET_PASSPHRASE>
          Passphrase for the wallet. Required when --dlt-sink-type=cardano-wallet [env: NPRISM_CARDANO_WALLET_PASSPHRASE=]
      --cardano-wallet-payment-addr <CARDANO_WALLET_PAYMENT_ADDR>
          Payment address for making transactions. Required when --dlt-sink-type=cardano-wallet [env: NPRISM_CARDANO_WALLET_PAYMENT_ADDR=]

Embedded Wallet:
      --embedded-wallet-bin <EMBEDDED_WALLET_BIN>
          Path to the embedded wallet binary. Required when --dlt-sink-type=embedded-wallet [env: NPRISM_EMBEDDED_WALLET_BIN=]
      --embedded-wallet-submit-api-url <EMBEDDED_WALLET_SUBMIT_API_URL>
          Base URL of the Cardano submit API. When omitted, transactions are submitted via Blockfrost [env: NPRISM_EMBEDDED_WALLET_SUBMIT_API_URL=]
      --embedded-wallet-blockfrost-url <EMBEDDED_WALLET_BLOCKFROST_URL>
          Blockfrost API URL. Defaults to mainnet Blockfrost [env: NPRISM_EMBEDDED_WALLET_BLOCKFROST_URL=] [default: https://cardano-mainnet.blockfrost.io/api/v0]
      --embedded-wallet-blockfrost-api-key <EMBEDDED_WALLET_BLOCKFROST_API_KEY>
          Blockfrost API key for public Blockfrost. Takes precedence over --embedded-wallet-blockfrost-url when set [env: NPRISM_EMBEDDED_WALLET_BLOCKFROST_API_KEY=]
      --embedded-wallet-mnemonic <EMBEDDED_WALLET_MNEMONIC>
          Mnemonic phrase for the embedded wallet. Required when --dlt-sink-type=embedded-wallet. Mutually exclusive with --embedded-wallet-mnemonic-file [env: NPRISM_EMBEDDED_WALLET_MNEMONIC=]
      --embedded-wallet-mnemonic-file <EMBEDDED_WALLET_MNEMONIC_FILE>
          Path to a file containing the mnemonic phrase for the embedded wallet. A safer alternative to --embedded-wallet-mnemonic for production deployments. The file contents are trimmed of leading/trailing whitespace. Mutually exclusive with --embedded-wallet-mnemonic [env: NPRISM_EMBEDDED_WALLET_MNEMONIC_FILE=]

Standalone options

Start the node in standalone mode

Usage: neoprism-node standalone [OPTIONS] --dlt-source-type <DLT_SOURCE_TYPE> --dlt-sink-type <DLT_SINK_TYPE>

Options:
  -h, --help  Print help

Server:
      --address <ADDRESS>            Node HTTP server binding address [env: NPRISM_ADDRESS=] [default: 0.0.0.0]
  -p, --port <PORT>                  Node HTTP server listening port [env: NPRISM_PORT=] [default: 8080]
      --assets-path <ASSETS_PATH>    The directory containing the web UI assets (CSS, JavaScript files) [env: NPRISM_ASSETS_PATH=] [default: ./bin/neoprism-node/assets]
      --cors-enabled                 Enable permissive CORS (https://docs.rs/tower-http/latest/tower_http/cors/struct.CorsLayer.html#method.permissive) [env: NPRISM_CORS_ENABLED=]
      --external-url <EXTERNAL_URL>  External URL for Swagger server list (e.g. https://example.com) [env: NPRISM_EXTERNAL_URL=]

Database:
      --db-url <DB_URL>  Database URL (e.g. postgres://user:pass@host:5432/db or sqlite:///path/to/db). Defaults to an embedded SQLite file when omitted [env: NPRISM_DB_URL=]
      --skip-migration   Skip database migration on node startup [env: NPRISM_SKIP_MIGRATION=]

DLT Source:
      --dlt-source-type <DLT_SOURCE_TYPE>
          Type of DLT source to use for event synchronization [env: NPRISM_DLT_SOURCE_TYPE=] [possible values: oura, dbsync, blockfrost]
      --index-interval <INDEX_INTERVAL>
          Duration to wait before checking for unindexed operations [env: NPRISM_INDEX_INTERVAL=] [default: 10s]
      --confirmation-blocks <CONFIRMATION_BLOCKS>
          Number of confirmation blocks to wait before considering the block valid [env: NPRISM_CONFIRMATION_BLOCKS=] [default: 112]

Network:
      --cardano-network <CARDANO_NETWORK>
          The Cardano network (mainnet, preprod, preview, or custom) [env: NPRISM_CARDANO_NETWORK=] [default: mainnet] [possible values: mainnet, preprod, preview, custom]

Oura:
      --cardano-relay-addr <CARDANO_RELAY_ADDR>
          Address of the Cardano relay node (e.g. backbone.mainnet.cardanofoundation.org:3001) [env: NPRISM_CARDANO_RELAY_ADDR=]

DB-Sync:
      --cardano-dbsync-url <CARDANO_DBSYNC_URL>
          DB-Sync URL (e.g. postgres://user:pass@host:5432/db) [env: NPRISM_CARDANO_DBSYNC_URL=]
      --cardano-dbsync-poll-interval <CARDANO_DBSYNC_POLL_INTERVAL>
          Duration to wait before polling DB Sync for the next update [env: NPRISM_CARDANO_DBSYNC_POLL_INTERVAL=] [default: 10s]

Blockfrost:
      --blockfrost-api-key <BLOCKFROST_API_KEY>
          Blockfrost API key [env: NPRISM_BLOCKFROST_API_KEY=]
      --blockfrost-base-url <BLOCKFROST_BASE_URL>
          Blockfrost base URL [env: NPRISM_BLOCKFROST_BASE_URL=] [default: https://cardano-mainnet.blockfrost.io/api/v0]
      --blockfrost-poll-interval <BLOCKFROST_POLL_INTERVAL>
          Duration to wait before polling Blockfrost for the next update [env: NPRISM_BLOCKFROST_POLL_INTERVAL=] [default: 10s]
      --blockfrost-api-delay <BLOCKFROST_API_DELAY>
          Delay between Blockfrost API calls. Set this to throttle requests and stay within Blockfrost API limits [env: NPRISM_BLOCKFROST_API_DELAY=] [default: 100ms]
      --blockfrost-concurrency-limit <BLOCKFROST_CONCURRENCY_LIMIT>
          Blockfrost API calls concurrency limit [env: NPRISM_BLOCKFROST_CONCURRENCY_LIMIT=] [default: 4]

DLT Sink:
      --dlt-sink-type <DLT_SINK_TYPE>  Type of DLT sink to use for transaction submission [env: NPRISM_DLT_SINK_TYPE=] [possible values: cardano-wallet, embedded-wallet]

Cardano Wallet:
      --cardano-wallet-base-url <CARDANO_WALLET_BASE_URL>
          Base URL of the Cardano wallet. Required when --dlt-sink-type=cardano-wallet [env: NPRISM_CARDANO_WALLET_BASE_URL=]
      --cardano-wallet-wallet-id <CARDANO_WALLET_WALLET_ID>
          Wallet ID to use for making transactions. Required when --dlt-sink-type=cardano-wallet [env: NPRISM_CARDANO_WALLET_WALLET_ID=]
      --cardano-wallet-passphrase <CARDANO_WALLET_PASSPHRASE>
          Passphrase for the wallet. Required when --dlt-sink-type=cardano-wallet [env: NPRISM_CARDANO_WALLET_PASSPHRASE=]
      --cardano-wallet-payment-addr <CARDANO_WALLET_PAYMENT_ADDR>
          Payment address for making transactions. Required when --dlt-sink-type=cardano-wallet [env: NPRISM_CARDANO_WALLET_PAYMENT_ADDR=]

Embedded Wallet:
      --embedded-wallet-bin <EMBEDDED_WALLET_BIN>
          Path to the embedded wallet binary. Required when --dlt-sink-type=embedded-wallet [env: NPRISM_EMBEDDED_WALLET_BIN=]
      --embedded-wallet-submit-api-url <EMBEDDED_WALLET_SUBMIT_API_URL>
          Base URL of the Cardano submit API. When omitted, transactions are submitted via Blockfrost [env: NPRISM_EMBEDDED_WALLET_SUBMIT_API_URL=]
      --embedded-wallet-blockfrost-url <EMBEDDED_WALLET_BLOCKFROST_URL>
          Blockfrost API URL. Defaults to mainnet Blockfrost [env: NPRISM_EMBEDDED_WALLET_BLOCKFROST_URL=] [default: https://cardano-mainnet.blockfrost.io/api/v0]
      --embedded-wallet-blockfrost-api-key <EMBEDDED_WALLET_BLOCKFROST_API_KEY>
          Blockfrost API key for public Blockfrost. Takes precedence over --embedded-wallet-blockfrost-url when set [env: NPRISM_EMBEDDED_WALLET_BLOCKFROST_API_KEY=]
      --embedded-wallet-mnemonic <EMBEDDED_WALLET_MNEMONIC>
          Mnemonic phrase for the embedded wallet. Required when --dlt-sink-type=embedded-wallet. Mutually exclusive with --embedded-wallet-mnemonic-file [env: NPRISM_EMBEDDED_WALLET_MNEMONIC=]
      --embedded-wallet-mnemonic-file <EMBEDDED_WALLET_MNEMONIC_FILE>
          Path to a file containing the mnemonic phrase for the embedded wallet. A safer alternative to --embedded-wallet-mnemonic for production deployments. The file contents are trimmed of leading/trailing whitespace. Mutually exclusive with --embedded-wallet-mnemonic [env: NPRISM_EMBEDDED_WALLET_MNEMONIC_FILE=]

Dev options

Start the node in standalone mode with an in-memory blockchain for development

Usage: neoprism-node dev [OPTIONS]

Options:
  -h, --help  Print help

Server:
      --address <ADDRESS>            Node HTTP server binding address [env: NPRISM_ADDRESS=] [default: 0.0.0.0]
  -p, --port <PORT>                  Node HTTP server listening port [env: NPRISM_PORT=] [default: 8080]
      --assets-path <ASSETS_PATH>    The directory containing the web UI assets (CSS, JavaScript files) [env: NPRISM_ASSETS_PATH=] [default: ./bin/neoprism-node/assets]
      --cors-enabled                 Enable permissive CORS (https://docs.rs/tower-http/latest/tower_http/cors/struct.CorsLayer.html#method.permissive) [env: NPRISM_CORS_ENABLED=]
      --external-url <EXTERNAL_URL>  External URL for Swagger server list (e.g. https://example.com) [env: NPRISM_EXTERNAL_URL=]

Database:
      --db-url <DB_URL>  Database URL (e.g. postgres://user:pass@host:5432/db or sqlite:///path/to/db). Defaults to an embedded SQLite file when omitted [env: NPRISM_DB_URL=]
      --skip-migration   Skip database migration on node startup [env: NPRISM_SKIP_MIGRATION=]

Generate OpenAPI options

Generate OpenAPI specification for the API

Usage: neoprism-node generate-openapi [OPTIONS]

Options:
      --output <OUTPUT>  Output file for the OpenAPI spec (stdout if not provided)
  -h, --help             Print help