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
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
Start the node in indexer mode
Usage: neoprism-node indexer [OPTIONS] --db-url <DB_URL>
Options:
--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=]
--db-url <DB_URL>
Database URL (e.g. postgres://user:pass@host:5432/db) [env: NPRISM_DB_URL=]
--skip-migration
Skip database migration on node startup [env: NPRISM_SKIP_MIGRATION=]
--cardano-network <CARDANO_NETWORK>
The Cardano network the node is syncing from [env: NPRISM_CARDANO_NETWORK=] [default: mainnet] [possible values: mainnet, preprod, preview]
--cardano-relay-addr <CARDANO_RELAY_ADDR>
Address of the Cardano relay node to sync from. If provided, the node will sync events from the Cardano relay node. (e.g. backbone.mainnet.cardanofoundation.org:3001) [env: NPRISM_CARDANO_RELAY_ADDR=]
--cardano-dbsync-url <CARDANO_DBSYNC_URL>
DB-Sync url. If provided, the node will sync events from DB Sync. (e.g. postgres://user:pass@host:5432/db) [env: NPRISM_CARDANO_DBSYNC_URL=]
--cardano-dbsync-poll-interval <CARDANO_DBSYNC_POLL_INTERVAL>
Number of seconds to wait before polling DB Sync for the next update [env: NPRISM_CARDANO_DBSYNC_POLL_INTERVAL=] [default: 10]
--index-interval <INDEX_INTERVAL>
Number of seconds to wait before checking for unindexed operations [env: NPRISM_INDEX_INTERVAL=] [default: 10]
--confirmation-blocks <CONFIRMATION_BLOCKS>
Number of confirmation blocks to wait before considering the block valid [env: NPRISM_CONFIRMATION_BLOCKS=] [default: 112]
-h, --help
Print help
Start the node in standalone mode
Usage: neoprism-node standalone [OPTIONS] --db-url <DB_URL> --cardano-wallet-base-url <CARDANO_WALLET_BASE_URL> --cardano-wallet-wallet-id <CARDANO_WALLET_WALLET_ID> --cardano-wallet-passphrase <CARDANO_WALLET_PASSPHRASE> --cardano-wallet-payment-addr <CARDANO_WALLET_PAYMENT_ADDR>
Options:
--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=]
--db-url <DB_URL>
Database URL (e.g. postgres://user:pass@host:5432/db) [env: NPRISM_DB_URL=]
--skip-migration
Skip database migration on node startup [env: NPRISM_SKIP_MIGRATION=]
--cardano-network <CARDANO_NETWORK>
The Cardano network the node is syncing from [env: NPRISM_CARDANO_NETWORK=] [default: mainnet] [possible values: mainnet, preprod, preview]
--cardano-relay-addr <CARDANO_RELAY_ADDR>
Address of the Cardano relay node to sync from. If provided, the node will sync events from the Cardano relay node. (e.g. backbone.mainnet.cardanofoundation.org:3001) [env: NPRISM_CARDANO_RELAY_ADDR=]
--cardano-dbsync-url <CARDANO_DBSYNC_URL>
DB-Sync url. If provided, the node will sync events from DB Sync. (e.g. postgres://user:pass@host:5432/db) [env: NPRISM_CARDANO_DBSYNC_URL=]
--cardano-dbsync-poll-interval <CARDANO_DBSYNC_POLL_INTERVAL>
Number of seconds to wait before polling DB Sync for the next update [env: NPRISM_CARDANO_DBSYNC_POLL_INTERVAL=] [default: 10]
--index-interval <INDEX_INTERVAL>
Number of seconds to wait before checking for unindexed operations [env: NPRISM_INDEX_INTERVAL=] [default: 10]
--confirmation-blocks <CONFIRMATION_BLOCKS>
Number of confirmation blocks to wait before considering the block valid [env: NPRISM_CONFIRMATION_BLOCKS=] [default: 112]
--cardano-wallet-base-url <CARDANO_WALLET_BASE_URL>
Base url of cardano wallet [env: NPRISM_CARDANO_WALLET_BASE_URL=]
--cardano-wallet-wallet-id <CARDANO_WALLET_WALLET_ID>
Wallet ID to use for making transactions [env: NPRISM_CARDANO_WALLET_WALLET_ID=]
--cardano-wallet-passphrase <CARDANO_WALLET_PASSPHRASE>
Passphrase for the wallet [env: NPRISM_CARDANO_WALLET_PASSPHRASE=]
--cardano-wallet-payment-addr <CARDANO_WALLET_PAYMENT_ADDR>
Payment address for making transactions [env: NPRISM_CARDANO_WALLET_PAYMENT_ADDR=]
-h, --help
Print help
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