docs: Add guide on connecting to custom networks (txpipe#306)

kodemill · Jun 24, 2022 · f99d346 · f99d346
1 parent f9d29e8
commit f99d346
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 0 deletions.
diff --git a/book/src/SUMMARY.md b/book/src/SUMMARY.md
@@ -36,3 +36,4 @@
     - [Intersect Options](./advanced/intersect_options.md)
 - [Guides](./guides/README.md)
     - [Cardano => Kafka](./guides/cardano_2_kafka.md)
+    - [Custom networks](./guides/connecting_to_custom_networks.md)
diff --git a/book/src/guides/connecting_to_custom_networks.md b/book/src/guides/connecting_to_custom_networks.md
@@ -0,0 +1,43 @@
+# Connecting to custom networks
+
+This guide shows you how to configure Oura to connect to a custom (not mainnet or testnet) network.
+
+
+## Instructions
+
+### 1. Add Network specific configurations
+
+Add the following data on the network to config TOML file.
+
+```TOML
+[chain]
+byron_epoch_length  = u32
+byron_slot_length = u32
+byron_known_slot = u64
+byron_known_hash = String
+byron_known_time = u64
+shelley_epoch_length = u32
+shelley_slot_length = u32
+shelley_known_slot = u64
+shelley_known_hash = String
+shelley_known_time = u64
+address_hrp = String
+adahandle_policy = String
+```
+
+Some details on the cofigurataion:
+
+| Name                 | DataType | Description              |
+| :---                 | :---     | :---                     |
+| byron_epoch_length   | u32      | ....                     |
+| byron_slot_length    | u32      | ....                     |
+| byron_known_slot     | u32      | ....                     |
+| byron_known_hash     | String   | ....                     |
+| byron_known_time     | u64      | ....                     |
+| shelley_epoch_length | u32      | ....                     |
+| shelley_slot_length  | u32      | ....                     |
+| shelley_known_slot   | u32      | ....                     |
+| shelley_known_hash   | String   | ....                     |
+| shelley_known_time   | u64      | ....                     |
+| address_hrp          | String   | ....                     |
+| adahandle_policy     | String   | Minting policy of AdaHandle on the network. |