From ab2c3b45c0ec98b0ad7afd863689887694f2c562 Mon Sep 17 00:00:00 2001 From: Daniel Onyesoh Date: Mon, 23 May 2022 13:40:40 +0100 Subject: [PATCH 1/2] Finished initial docs --- book/src/SUMMARY.md | 1 + .../guides/connecting_to_custom_networks.md | 43 +++++++++++++++++++ 2 files changed, 44 insertions(+) create mode 100644 book/src/guides/connecting_to_custom_networks.md diff --git a/book/src/SUMMARY.md b/book/src/SUMMARY.md index f50f732c..a5e545f3 100644 --- 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) + - [Connecting to custom networks](./guides/connecting_to_custom_networks.md) \ No newline at end of file diff --git a/book/src/guides/connecting_to_custom_networks.md b/book/src/guides/connecting_to_custom_networks.md new file mode 100644 index 00000000..55061371 --- /dev/null +++ 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. | \ No newline at end of file From 0f83581b119a4d6fa3487e0a8696695a1a1d8396 Mon Sep 17 00:00:00 2001 From: Daniel Onyesoh Date: Tue, 24 May 2022 16:45:45 +0100 Subject: [PATCH 2/2] docs: Added guide for connecting to custom networks --- book/src/SUMMARY.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/src/SUMMARY.md b/book/src/SUMMARY.md index a5e545f3..ad78cba9 100644 --- a/book/src/SUMMARY.md +++ b/book/src/SUMMARY.md @@ -36,4 +36,4 @@ - [Intersect Options](./advanced/intersect_options.md) - [Guides](./guides/README.md) - [Cardano => Kafka](./guides/cardano_2_kafka.md) - - [Connecting to custom networks](./guides/connecting_to_custom_networks.md) \ No newline at end of file + - [Custom networks](./guides/connecting_to_custom_networks.md) \ No newline at end of file