Skip to content
Permalink
Browse files

chore: fix docs

  • Loading branch information
gakonst committed Nov 29, 2019
1 parent 888783b commit 08a9d190fc9b07c945f49b504667b6bd2be8077a
Showing with 18 additions and 14 deletions.
  1. +3 −0 crates/ilp-node/src/node.rs
  2. +1 −1 docker/run-testnet-bundle.js
  3. +14 −13 docs/configuration.md
@@ -222,7 +222,10 @@ pub struct InterledgerNode {
/// information to other nodes using CCP. Defaults to 30000ms (30 seconds).
pub route_broadcast_interval: Option<u64>,
#[serde(default)]
/// Configuration for calculating exchange rates between various pairs.
pub exchange_rate: ExchangeRateConfig,
/// Configuration for [Prometheus](https://prometheus.io) metrics collection.
/// If this configuration is not provided, the node will not collect metrics.
#[serde(default)]
pub prometheus: Option<PrometheusConfig>,
#[cfg(feature = "google-pubsub")]
@@ -134,7 +134,7 @@ function runNode({ httpBindAddress, adminAuthToken, secretSeed, nodeName }) {
],
{
env: {
'ILP_EXCHANGE_RATE_PROVIDER': 'CoinCap',
'ILP_EXCHANGE_RATE__PROVIDER': 'CoinCap',
'RUST_LOG': process.env.RUST_LOG || 'interledger=debug',
'RUST_BACKTRACE': process.env.RUST_BACKTRACE || '1'
},
@@ -95,18 +95,19 @@ The configuration parameters are explained in the following format.
- Non-negative Integer (in milliseconds)
- `30000`
- Interval, defined in milliseconds, on which the node will broadcast routing information to other nodes using CCP. Defaults to 30000ms (30 seconds).
- exchange_rate_provider
- String (should be one of `CoinCap`, `CryptoCompare`)
- `CoinCap`
- Exchange rate API to poll for exchange rates. If this is not set, the node will not poll for rates and will instead use the rates set via the HTTP API. Note that [CryptoCompare](#using-cryptocompare) can also be used **when the node is configured via a config file or stdin**, because an API key must be provided to use that service.
- exchange_rate_poll_interval
- Non-negative Integer (in milliseconds)
- `60000`
- Interval, defined in milliseconds, on which the node will poll the `exchange_rate_provider` (if specified) for exchange rates.
- exchange_rate_spread
- Float
- `0.01`
- Spread, as a fraction, to add on top of the exchange rate. This amount is kept as the node operator's profit, or may cover fluctuations in exchange rates. For example, take an incoming packet with an amount of 100. If the exchange rate is 1:0.5 and the spread is 0.01, the amount on the outgoing packet would be 198 (instead of 200 without the spread).
- exchange_rate
- provider
- String (should be one of `CoinCap`, `CryptoCompare`)
- `CoinCap`
- Exchange rate API to poll for exchange rates. If this is not set, the node will not poll for rates and will instead use the rates set via the HTTP API. Note that [CryptoCompare](#using-cryptocompare) can also be used **when the node is configured via a config file or stdin**, because an API key must be provided to use that service.
- poll_interval
- Non-negative Integer (in milliseconds)
- `60000`
- Interval, defined in milliseconds, on which the node will poll the `provider` (if specified) for exchange rates.
- spread
- Float
- `0.01`
- Spread, as a fraction, to add on top of the exchange rate. This amount is kept as the node operator's profit, or may cover fluctuations in exchange rates. For example, take an incoming packet with an amount of 100. If the exchange rate is 1:0.5 and the spread is 0.01, the amount on the outgoing packet would be 198 (instead of 200 without the spread).
- [prometheus](https://prometheus.io/)
- bind_address
- Socket Address (`address:port`)
@@ -133,7 +134,7 @@ some-command | ilp-node
Then `some-command` should output a config like:

```yaml
exchange_rate_provider:
exchange_rate.provider:
CryptoCompare: insert_api_key_here
```

0 comments on commit 08a9d19

Please sign in to comment.
You can’t perform that action at this time.