Merge pull request #78 from arik-so/conservative-announcements

[rapid-gossip-sync-server] / README.md

diff --git a/README.md b/README.md
index 1df2902dbac91c2174657b5df2eb34651aad005b..12104909aac1cea00e7a769a51ae2bc4c5a02412 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,54 +1,43 @@
-# rust-ln-sync
+# rapid-gossip-sync-server
 
 This is a server that connects to peers on the Lightning network and calculates compact rapid sync
 gossip data.
 
 These are the components it's comprised of.
 
-## config
+## Modules
+
+### config
 
 A config file where the Postgres credentials and Lightning peers can be adjusted. Most adjustments
 can be made by setting environment variables, whose usage is as follows:
 
-| Name                     | Default       | Description                                                                                                |
-|:-------------------------|:--------------|:-----------------------------------------------------------------------------------------------------------|
-| RUST_LN_SYNC_DB_HOST     | localhost     | Domain of the Postgres database                                                                            |
-| RUST_LN_SYNC_DB_USER     | alice         | Username to access Postgres                                                                                |
-| RUST_LN_SYNC_DB_PASSWORD | _None_        | Password to access Postgres                                                                                |
-| RUST_LN_SYNC_DB_NAME     | ln_graph_sync | Name of the database to be used for gossip storage                                                         |
-| BITCOIN_REST_DOMAIN      | 127.0.0.1     | Domain of the [bitcoind REST server](https://github.com/bitcoin/bitcoin/blob/master/doc/REST-interface.md) |
-| BITCOIN_REST_PORT        | 80            | HTTP port of the bitcoind REST server                                                                      |
-| BITCOIN_REST_PATH        | /rest/        | Path infix to access the bitcoind REST endpoints                                                           |
-
-Notably, one property needs to be modified in code, namely the `ln_peers()` method. It specifies how
-many and which peers to use for retrieving gossip.
-
-## download
+| Name                                       | Default             | Description                                                                                                |
+|:-------------------------------------------|:--------------------|:-----------------------------------------------------------------------------------------------------------|
+| RAPID_GOSSIP_SYNC_SERVER_DB_HOST           | localhost           | Domain of the Postgres database                                                                            |
+| RAPID_GOSSIP_SYNC_SERVER_DB_USER           | alice               | Username to access Postgres                                                                                |
+| RAPID_GOSSIP_SYNC_SERVER_DB_PASSWORD       | _None_              | Password to access Postgres                                                                                |
+| RAPID_GOSSIP_SYNC_SERVER_DB_NAME           | ln_graph_sync       | Name of the database to be used for gossip storage                                                         |
+| RAPID_GOSSIP_SYNC_SERVER_NETWORK           | mainnet             | Network to operate in. Possible values are mainnet, testnet, signet, regtest                               |
+| RAPID_GOSSIP_SYNC_SERVER_SNAPSHOT_INTERVAL | 10800               | The interval in seconds between snapshots                                                                  |
+| BITCOIN_REST_DOMAIN                        | 127.0.0.1           | Domain of the [bitcoind REST server](https://github.com/bitcoin/bitcoin/blob/master/doc/REST-interface.md) |
+| BITCOIN_REST_PORT                          | 8332                | HTTP port of the bitcoind REST server                                                                      |
+| BITCOIN_REST_PATH                          | /rest/              | Path infix to access the bitcoind REST endpoints                                                           |
+| LN_PEERS                                   | _Wallet of Satoshi_ | Comma separated list of LN peers to use for retrieving gossip                                              |
+
+### downloader
 
 The module responsible for initiating the scraping of the network graph from its peers.
 
-## persistence
+### persistence
 
 The module responsible for persisting all the downloaded graph data to Postgres.
 
-## server
-
-The server is responsible for returning dynamic and snapshotted rapid sync data.
-
-Dynamic sync data is fed a timestamp of the last sync, and it dynamically calculates a delta
-such that a minimal change set is returned based on changes which are assumed to have been seen
-by the client (ignoring any intermediate changes). Dynamic sync is only available after the first
-full graph sync completes on startup.
-
-Snapshot sync data is also based on a timestamp, but unlike dynamic sync, its responses are
-precalculated, which is done in a way that considers the possibility that the client may have
-intermittently seen later updates.
-
 ### snapshot
 
 The snapshotting module is responsible for calculating and storing snapshots. It's started up
 as soon as the first full graph sync completes, and then keeps updating the snapshots at a
-24-hour-interval.
+configurable interval with a 3-hour-default.
 
 ### lookup
 
@@ -67,22 +56,6 @@ announcement.
 Finally, all channel update transitions are evaluated and collected into either a full or an
 incremental update.
 
-## Making a call
-
-### Dynamic
-
-Make a call to
-
-`http://localhost:3030/dynamic/1652644698`
-
-Where `1652644698` is the last sync timestamp.
-
-### Snapshotted
-
-Same as above, but sub `dynamic` for `snapshot`:
-
-`http://localhost:3030/snapshot/1652644698`
-
 ## License
 
-MIT
+[Apache 2.0](LICENSE-APACHE.md) or [MIT](LICENSE-MIT.md), [at your option](LICENSE.md).