dev.env

### Environment vars for the core image

# The log level. 0 = INFO, 1 = DEBUG, 2 = TRACE. Defaults to zero
GLOG_V=0

# The syntax of the argument is a comma-separated list of pattern=N
# where pattern is a literal file name (minus the ".go" suffix) or "glob"
# pattern and N is a V level. For instance, -vmodule=gopher*=3 sets the V
# level to 3 in all Go files whose names begin "gopher".
GLOG_VMODULE=

# Whether or not to use the BitClout testnet. Mainnet is used by default.
BITCLOUT_TESTNET=false

# A comma-separated list of ip:port addresses that we should listen on.
# These will take priority over addresses discovered by network
# interfaces.
EXTERNAL_IPS=

# A comma-separated list of ip:port addresses that we should connect to on startup.
# If this argument is specified, we don't connect to any other peers.
CONNECT_IPS=

# A miner is started if and only if this field is set. Indicates where to send
# block rewards from mining blocks. Public keys must be
# comma-separated compressed ECDSA public keys formatted as base58 strings.
MINER_PUBLIC_KEYS=

# How many threads to run for mining. Only has an effect when --miner_public_keys
# is set. If set to zero, which is the default, then the number of
# threads available to the system will be used.
NUM_MINING_THREADS=0

# A comma-separated list of ip:port addresses that we should connect to on startup.
# If this argument is specified, we will still fetch addresses from DNS seeds and
# potentially connect to them.
ADD_IPS=

# A comma-separated list of DNS seeds to be used in addition to the
# pre-configured seeds.
ADD_SEEDS=

# passwords_file is a path to a file that contains a newline-separated 
# list of passwords which give the user access
# to the frontend UI. This is just a short-term thing to restrict access to the
# community nodes until we're ready. When no passwords are set, the node will
# serve the frontend to anybody. Note this is different from shared_secret--
# password allows someone to use the stateless UI whereas shared_secret allows
# someone to make changes to the node (think read vs write).
PASSWORDS_FILE=

# admin_public_keys is list of public keys delimited by commas or new-lines
# which gives users access to the admin panel. If no keys are specified 
# anyone can access the admin panel. You can add a space and a comment after 
# every public key and leave a note about who the public key belongs to.
ADMIN_PUBLIC_KEYS=

# When set, determines the port on which this node will listen for protocol-related
# messages. If unset, the port will default to what is present in the BitCloutParams set.
# Note also that even though the node will listen on this port, its outbound
# connections will not be determined by this flag (17000).
PROTOCOL_LISTEN_PORT=0

# When set, determines the port on which this node will listen for json
# requests. If unset, the port will default to what is present in the
# BitCloutParams set (17001).
JSON_API_PORT=0

# When set, determines the port on which this node will listen for connections
# from the user's web client. If unset, the port will default to what is present
# in the BitCloutParams set (17002).
WEB_CLIENT_PORT=0

# The directory containing the SSL certificates.
SSL_CERT_DIR=

# The domain we're serving https on.
SSL_DOMAIN=

# Transactions below this feerate will be rate-limited rather than flat-out
# rejected. This is in contrast to min_feerate, which will flat-out reject
# transactions with feerates below what is specified. As such, this value will have no
# effect if it is set below min_feerate. This, along with min_feerate, should
# be the first line of defense against attacks that involve flooding the
# network with low-fee transactions in an attempt to overflow the mempool
RATE_LIMIT_FEERATE=0

# The minimum feerate this node will accept when processing transactions
# relayed by peers. Increasing this number, along with increasing
# rate_limit_feerate, should be the first line of
# defense against attacks that involve flooding the network with low-fee
# transactions in an attempt to overflow the mempool
MIN_FEERATE=1000

# The target number of outbound peers. The node will continue attempting to connect to
# random addresses until it has this many outbound connections. During testing it's
# useful to turn this number down and test a small number of nodes in a controlled
# environment.
TARGET_OUTBOUND_PEERS=8

# The maximum number of inbound peers a node can have.
MAX_PEERS=125

# The location where all of the protocol-related data like blocks is stored.
# Useful for testing situations where multiple clients need to run on the
# same machine without trampling over each other.
# When unset, defaults to the system's configuration directory.
DATA_DIR_PATH=/db


# When set, the node will not allow more than one connection to/from a particular
# IP. This prevents forms of attack whereby one node tries to monopolize all of
# our connections and potentially make onerous requests as well. Useful to
# disable this flag when testing locally to allow multiple inbound connections
# from test servers
LIMIT_ONE_INBOUND_CONNECTION_PER_IP=true

# How long the node will wait for a peer to reply to certain types of requests.
# We make this gratuitous just in case the node we're connecting to is backed up.
STALL_TIMEOUT_SECONDS=900

# When set to true, the node does not look up addresses from DNS seeds.
PRIVATE_MODE=false

# When set to true, the node will generate an index mapping transaction
# ids to transaction information. This enables the use of certain API calls
# like ones that allow the lookup of particular transactions by their ID.
# Defaults to false because the index can be large.
TXINDEX=true

# The amount of BitClout given to new accounts to get them started. Only
# active if --starter_bitclout_seed is set and funded.
# 1 milli (~$0.10 at $100 coin price).
STARTER_BITCLOUT_AMOUNT_NANOS=1000000

# A comma-separated list of 'prefix=nanos' mappings, where prefix is a phone
# number prefix such as \"+1\". These mappings allow the
# node operator to specify custom amounts of BitClout to users verifying their phone
# numbers based on the country they're in. This is useful as it is more expensive
# for attackers to get phone numbers from certain countries. An example string would
# be '+1=2000000,+2=2000000', which would double the default nanos for users with
# with those prefixes.
PHONE_VERIFICATION_PREFIX_NANOS_MAP=

# When proviced, this seed is used to send a 'starter' amount of BitClout to
# newly-created accounts.
STARTER_BITCLOUT_SEED=


# The IP:PORT or DOMAIN:PORT corresponding to a node that can be used to
# set/get global state. When this is not provided, global state is set/fetched
# from a local DB. Global state is used to manage things like user data, e.g.
# emails, that should not be duplicated across multiple nodes.
GLOBAL_STATE_REMOTE_NODE=

# When a remote node is being used to set/fetch global state, a shared_secret
# is also required to restrict access.
GLOBAL_STATE_REMOTE_NODE_SHARED_SECRET=

# Accepts a comma-separated lists of origin domains that will be allowed as the
# Access-Control-Allow-Origin HTTP header. Defaults to * if not set.
#
# TODO: We should show some kind of warning or something if this option is set to *
ACCESS_CONTROL_ALLOW_ORIGINS=*

# If set, runs our secure header middleware in development mode, which disables some
# of the options. The default is true to make it easy to run a node locally.
# See https://github.com/unrolled/secure for more info. Note that
#
# TODO: We should show some kind of warning if we're in development mode, which
# is the default right now.
SECURE_HEADER_MIDDLEWARE_IS_DEVELOPMENT=true

# This is the domain that our secure middleware will accept requests from. We
# also set the HTTP Access-Control-Allow-Origin
SECURE_HEADER_MIDDLEWARE_ALLOWED_HOSTS=


# When set to false, the node does not open a browser pointed to the web
# app on start.
OPEN_WEB_APP_ON_NODE_START=false

# Access token for Rollbar (third-party error logging service).
ROLLBAR_ACCESS_TOKEN=

# Valid values are 'development' or 'production', among others. See rollbar 
# docs for more info.
ROLLBAR_ENVIRONMENT=

# A URI corresponding to a DB that we will dump all key/value entries
# into for debugging purposes. For example: mongodb://localhost:27017.
# When unset, no syncing is performed.
SYNC_DB_URI=

# A mongo database name used for storing all dumped key/value entires
# for debugging purposes. For example: bitclout.
# When unset, defaults to bitclout.
MONGO_DATABASE_NAME=

# A mongo collection name within a mongo database used for storing all
# dumped key/value entries for debugging purposes.
# For example: data. When unset, defaults to data.
MONGO_COLLECTION_NAME=

# Optional. Client-side amplitude key for instrumenting user behavior.
AMPLITUDE_KEY=

# Optional. Client-side amplitude API Endpoint.
AMPLITUDE_DOMAIN=api.amplitude.com

# Optional. Twilio account SID (string id). Twilio is used for sending 
# verification texts. See twilio documentation for more info.
TWILIO_ACCOUNT_SID=

# Optional. Twilio authentication token. See twilio documentation for more info.
TWILIO_AUTH_TOKEN=

# Optional. ID for a verify service configured within Twilio (used for
# verification texts)
TWILIO_VERIFY_SERVICE_ID=

# Users won't be able to create a profile unless they buy this
# amount of satoshis or provide a phone number.
# TODO: This field is deprecated by ParamUpdater transaction
MIN_SATOSHIS_BURNED_FOR_PROFILE_CREATION=50000

# Optional. Forces SSL redirect and 'Secure' cookies without an ssl_cert_dir.
# Useful if serving from behind an HTTPS load balancer or proxy.
FORCE_SSL=false


# Optional. Show a support email to users of this node.
SUPPORT_EMAIL=node.admin@protonmail.com

## Arguments for the block producer
#
# When set to a non-zero value, the node will generate block
# templates, and cache the number of templates specified by this flag. When set
# to zero, the node will not produce block templates.
MAX_BLOCK_TEMPLATES_TO_CACHE=0

# When set to a non-zero value, the node will wait at least this many seconds
# before producing another block template
MIN_BLOCK_UPDATE_INTERVAL_SECONDS=10

# When specified, this key is used to power the BitcoinExchange flow
# and to check for double-spends in the mempool
#
# Note: It is currently a bit dangerous to serve user traffic without a
# BLOCK_CYPHER_API_KEY because the validation of transactions using
# alternative mechanisms is not 100%.
BLOCK_CYPHER_API_KEY=

# When set, the mempool is initialized using a db in the directory specified, and
# subsequent dumps are also written to this dir
MEMPOOL_DUMP_DIR=

## Emergency flags that can help in reducing noise from peers when trying to debug.

# When set to true, the node will not make any outgoing connections or accept
# any incoming connections.
DISABLE_NETWORKING=false

# When set to true, the node will ignore all INV messages unless they come
# from an outbound peer. This is useful when setting up a node that you want to
# have a direct and 1:1 relationship with another node, as is common when
# setting up read sharding.
IGNORE_INBOUND_PEER_INV_MESSAGES=false

# When set to true, the node will ignore all transactions created on this node.
READ_ONLY_MODE=true

# When set to an IP:PORT, the BitcoinManager will use this peer to source Bitcoin
# headers and won't talk to anyone else. When unset, a random Bitcoin peer is chosen.
BITCOIN_CONNECT_PEER=

# When set to true, the node will log a snapshot of all DB keys every 30s.
LOG_DB_SUMMARY_SNAPSHOTS=false

# When set to true, the UI will show processing spinners for unmined posts / BitClout
# / creator coins.
SHOW_PROCESSING_SPINNERS=true

# When set to true, unmined BitcoinExchange transactions from peers are 
# disregarded. This is OK because we will eventually reprocess this transaction once
# it gets mined into a block, although anything that is built on top of it may not
# be considered. It's set to false by default because most nodes connect to trusted
# peers right now via --connectips and --ignore_inbound_peer_inv_messages.
#
# TODO: It is currently insecure to serve user write traffic without setting this
# flag to true because soneone could theoretically submit garbage entries to the
# mempool.
IGNORE_UNMINED_BITCOIN_TXNS_FROM_PEERS=false

# Google credentials to upload images to bucket. This is needed in order for image
# uploads to work.
GOOGLE_APPLICATION_CREDENTIALS_PATH=

# Name of bucket to store images
GOOGLE_IMAGE_BUCKET_NAME=images.bitclout.com

### Environment vars for the frontend image

# Override the Caddyfile with the one in this directory
CADDY_FILE=/app/Caddyfile.dev