Skip to content
You are reading Codefi Orchestrate development version documentation and some displayed features may not be available in the stable release. You can switch to stable version using the version box at screen bottom.

Transaction Scheduler

The Transaction Scheduler acts as an orchestrator between other transaction workers to create and send transactions.

Transaction Scheduler options

Usage:
  orchestrate transaction-scheduler run [flags]

Flags:
      --chain-registry-url string           URL of the Chain Registry HTTP endpoint. 
                                            Environment variable: "CHAIN_REGISTRY_URL" (default "localhost:8081")
      --contract-registry-url string        URL (GRPC target) of the Contract Registry (See https://github.com/grpc/grpc/blob/master/doc/naming.md)
                                            Environment variable: "CONTRACT_REGISTRY_URL" (default "localhost:8080")
      --db-database string                  Target Database name
                                            Environment variable: "DB_DATABASE" (default "postgres")
      --db-host string                      Database host
                                            Environment variable: "DB_HOST" (default "127.0.0.1")
      --db-password string                  Database User password
                                            Environment variable: "DB_PASSWORD" (default "postgres")
      --db-poolsize int                     Maximum number of connections on database
                                            Environment variable: "DB_POOLSIZE"
      --db-port int                         Database port
                                            Environment variable: "DB_PORT" (default 5432)
      --db-sslmode string                   TLS SSL mode to connect to database (one of "DB_TLS_SSLMODE")
                                            Environment variable: ["require" "disable" "verify-ca" "verify-full"] (default "disable")
      --db-tls-ca string                    Trusted Certificate Authority
                                            Environment variable: "DB_TLS_CA"
      --db-tls-cert string                  TLS Certificate to connect to database
                                            Environment variable: "DB_TLS_CERT"
      --db-tls-key string                   TLS Private Key to connect to database
                                            Environment variable: "DB_TLS_KEY"
      --db-user string                      Database User.
                                            Environment variable: "DB_USER" (default "postgres")
  -h, --help                                help for run
      --kafka-consumer-max-wait-time int    Kafka consumer max wait time.
                                            Environment variable: "KAFKA_CONSUMER_MAX_WAIT_TIME" in ms (default 20)
      --kafka-group string                  Address of Kafka server to connect to.
                                            Environment variable: "KAFKA_GROUP" (default "group-e2e")
      --kafka-sasl-enabled                  Whether or not to use SASL authentication when connecting to the broker
                                            Environment variable: "KAFKA_SASL_ENABLED"
      --kafka-sasl-handshake                Whether or not to send the Kafka SASL handshake first if enabled (defaults to true). You should only set this to false if you're using a non-Kafka SASL proxy.
                                            Environment variable: "KAFKA_SASL_HANDSHAKE" (default true)
      --kafka-sasl-mechanism string         SASLMechanism is the name of the enabled SASL mechanism. Possible values: OAUTHBEARER, PLAIN (defaults to PLAIN).
                                            Environment variable: "KAFKA_SASL_MECHANISM"
      --kafka-sasl-password string          Password for SASL/PLAIN or SASL/SCRAM auth.
                                            Environment variable: "KAFKA_SASL_PASSWORD"
      --kafka-sasl-scramauthzid string      Authz id used for SASL/SCRAM authentication
                                            Environment variable: "KAFKA_SASL_SCRAMAUTHZID"
      --kafka-sasl-user string              Username for SASL/PLAIN or SASL/SCRAM auth.
                                            Environment variable: "KAFKA_SASL_USER"
      --kafka-tls-ca-cert-file string       CA cert file Path.
                                            Environment variable: "KAFKA_TLS_CA_CERT_FILE"
      --kafka-tls-client-cert-file string   Client Cert File Path.
                                            Environment variable: "KAFKA_TLS_CLIENT_CERT_FILE"
      --kafka-tls-client-key-file string    Client key file Path.
                                            Environment variable: "KAFKA_TLS_CLIENT_KEY_FILE"
      --kafka-tls-enabled                   Whether or not to use TLS when connecting to the broker (defaults to false).
                                            Environment variable: "KAFKA_TLS_ENABLED"
      --kafka-tls-insecure-skip-verify      Controls whether a client verifies the server's certificate chain and host name. If InsecureSkipVerify is true, TLS accepts any certificate presented by the server and any host name in that certificate. In this mode, TLS is susceptible to man-in-the-middle attacks. This should be used only for testing.
                                            Environment variable: "KAFKA_TLS_INSECURE_SKIP_VERIFY"
      --kafka-url strings                   URL (addresses) of Kafka server(s) to connect to.
                                            Environment variable: "KAFKA_URL" (default [localhost:9092])
      --rest-hostname string                Hostname to expose REST services
                                            Environment variable: "REST_HOSTNAME"
      --rest-port uint                      Port to expose REST services
                                            Environment variable: "REST_PORT" (default 8081)
      --transaction-scheduler-type string   Type of Transaction scheduler Store (one of ["postgres"])
                                            Environment variable: "TRANSACTION_SCHEDULER_TYPE" (default "postgres")
      --topic-tx-crafter string             Kafka topic for envelopes waiting for their transaction payload crafted
                                            Environment variable: "TOPIC_TX_CRAFTER" (default "topic-tx-crafter")
      --topic-tx-sender string              Kafka topic for envelopes waiting for their transaction sent
                                            Environment variable: "TOPIC_TX_SENDER" (default "topic-tx-sender")

Migration options

Usage:
  orchestrate transaction-scheduler migrate [flags]
  orchestrate transaction-scheduler migrate [command]

Available Commands:
  down        Reverts last migration
  init        Initialize database
  reset       Reverts all migrations
  set-version Set database version
  up          Upgrade database
  version     Print current database version

Flags:
      --db-database string   Target Database name
                             Environment variable: "DB_DATABASE" (default "postgres")
      --db-host string       Database host
                             Environment variable: "DB_HOST" (default "127.0.0.1")
      --db-password string   Database User password
                             Environment variable: "DB_PASSWORD" (default "postgres")
      --db-poolsize int      Maximum number of connections on database
                             Environment variable: "DB_POOLSIZE"
      --db-port int          Database port
                             Environment variable: "DB_PORT" (default 5432)
      --db-sslmode string    TLS SSL mode to connect to database (one of "DB_TLS_SSLMODE")
                             Environment variable: ["require" "disable" "verify-ca" "verify-full"] (default "disable")
      --db-tls-ca string     Trusted Certificate Authority
                             Environment variable: "DB_TLS_CA"
      --db-tls-cert string   TLS Certificate to connect to database
                             Environment variable: "DB_TLS_CERT"
      --db-tls-key string    TLS Private Key to connect to database
                             Environment variable: "DB_TLS_KEY"
      --db-user string       Database User.
                             Environment variable: "DB_USER" (default "postgres")
  -h, --help                 help for migrat
ConsenSys has acquired Quorum from J.P. Morgan. Please read the FAQ.
Questions or feedback? You can obtain paid professional support by Consensys at orchestrate@consensys.net