Best version yet

TrueBlocks · Jan 3, 2025 · 89ac112 · 89ac112
1 parent 0ce4a9b
commit 89ac112
Show file tree

Hide file tree

Showing 18 changed files with 717 additions and 552 deletions.
diff --git a/app/app.go b/app/app.go
@@ -21,7 +21,7 @@ func NewKhedraApp() *KhedraApp {
 	cli := initializeCli()
 
 	k := &KhedraApp{
-		config:     cfg,
+		config:     &cfg,
 		fileLogger: fileLogger,
 		progLogger: progLogger,
 		Cli:        cli,

diff --git a/book/src/about_the_name.md b/book/src/about_the_name.md
@@ -1,17 +1,17 @@
 # About the Name
 
-The name **khedra** (pronounced *key-drah*) is inspired by the Persian word <span style="font-size: 1.5em;"> خدمت </span> (*khedmat*), meaning "service."
+The name **khedra** (pronounced *kay-drah*) is inspired by the Persian word <span style="font-size: 1.5em;"> خدمت </span> (*khedmat*), meaning "service."
 
-In ancient Persian culture, service was considered a noble pursuit, emphasizing dedication, reliability, and humility in action. Drawing from this tradition, the name **khedra** embodies the essence of a system designed to serve—efficiently, continuously, and with purpose.
+In ancient Persian culture (my childrens' grandfather is Persian), service was considered a noble pursuit, emphasizing dedication, reliability, and humility in action. Drawing from this tradition, the name **khedra** embodies the essence of a system designed to serve--efficiently, continuously, and with purpose.
 
-Like its counterpart, [chifra](https://github.com/TrueBlocks/trueblocks-core) (derived from the Persian word for "cipher"), the name **khedra** connects deeply to our roots while adapting to a modern technological context. The streamlined spelling symbolizes long-running, dependable processes that tirelessly "serves" the needs of its users.
+Simliar to its counterpart, [chifra](https://github.com/TrueBlocks/trueblocks-core) (derived from the Persian word for "cipher"), the name **khedra** connects to our roots while adapting to a modern context. The name symbolizes a long-running, dependable processes that tirelessly "serves" the needs of its users.
 
-More technically, **khedra** literally is a collection of services including:
+More technically, **khedra** is a collection of persistant go routines that:
 
-- an address appearance indexer, 
-- a publisher (to both IPFS and a smart contract) of the index, 
-- an address monitoring and notification tool, 
-- a RESTful API exposing `chifra`'s command line options,
-- and an IPFS daemon.
+- creates the Unchained Index,
+- publishes the index to IPFS and a manifest of the resultant hashes to a smart contract,
+- monitors customized lists of addresses automating caching, notifications, and other ETL processes,
+- provides a RESTful API exposing `chifra`'s many data access commands,
+- allows for starting, stopping, pausing, and resuming these individual services.
 
 By choosing the name **khedra**, we honor a legacy of service while committing to building tools that are as resilient, adaptive, and reliable as the meaning behind its name.
diff --git a/book/src/index.md b/book/src/index.md
@@ -1,14 +1,12 @@
 # The Khedra Book
 
-**Khedra** (pronounced *key-drah*) is an all-in-one tool for indexing and monitoring EVM-compatible blockchains.
+**Khedra** (pronounced *kay-drah*) is an all-in-one tool for indexing, publishing, and sharing the Unchained Index and monitoring addresses any on EVM-compatible blockchains.
 
-It creates and shares the [Unchained Index](https://trueblocks.io/papers/2023/specification-for-the-unchained-index-v2.0.0-release.pdf)
-which is a permissionless index of "address appearances" shared via IPFS and published to a smart contract.
+The tool creates and shares the [Unchained Index](https://trueblocks.io/papers/2023/specification-for-the-unchained-index-v2.0.0-release.pdf)
+which is a permissionless index of "address appearances," including appearances in event logs, execution traces, smart contract state, staking or block rewards, prefund allocations and many other locations.
 
-Address appearances record every location in a blockchain's history including appearing in an event log, appearing in an execution trace, winning a staking or block reward, appearing as a prefund address or any other location.
+This detailed indexing allows for near-perfect monitoring and notifications of address activity, native and ERC-20 account balance histories, address auditing and accounting, and even custom indexing. It works for any address on any chain (as long as you have access to the chain's RPC).
 
-This detailed indexing allows for near-perfect monitoring and notifications of addresses, native and ERC-20 account balance auditing and accounting, and even your own custom indexing needs. It works for any address on any chain (if you have access to the chain's RPC).
+*Enjoy!*
 
-Enjoy.
-
-Please help us improve this software by providing any feedback or suggestions. Contact information is available [at our website](https://trueblocks.io).
+Please help us improve this software by providing any feedback or suggestions. Contact information and links to our socials are available [at our website](https://trueblocks.io).
diff --git a/book/src/user_man/README.md b/book/src/user_man/README.md
@@ -2,15 +2,15 @@
 
 ## Overview of Khedra
 
-**Khedra** is a blockchain indexing and monitoring application designed to provide users with an efficient way to interact with and manage transactional histories for EVM-compatible blockchains. It supports functionalities such as transaction monitoring, address appearance indexing, publishing and pinning the indexes to IPFS, and a RESTful API for accessing data.
+**Khedra** is a blockchain indexing and monitoring application designed to provide users with an efficient way to interact with and manage transactional histories for EVM-compatible blockchains. It supports functionalities such as transaction monitoring, address indexing, publishing and pinning the indexes to IPFS and a smart contract, and a RESTful API for accessing data.
 
 ## Purpose of this Document
 
-This User's Manual is designed to help users get started with **Khedra**, understand its features, and operate the application effectively for both basic and advanced use cases. For a more technical treatment of the application, refer to the [Technical Specification](../tech_spec/).
+This "User's Manual" is designed to help users get started with **Khedra**, understand its features, and operate the application effectively for both basic and advanced use cases. For a more technical treatment of the software, refer to the [Technical Specification](../tech_spec/).
 
 ## Intended Audience
 
-This manual is for:
+This manual is intended for:
 
 - End-users looking to index and monitor blockchain data.
 - Developers integrating blockchain data into their applications.