From 3cbb06015e88892e65ceccbcfd5c2808c5f5d34c Mon Sep 17 00:00:00 2001
From: Ethan Buchman <ethan@coinculture.info>
Date: Wed, 13 Jun 2018 15:17:18 -0700
Subject: [PATCH] add gaiadebug readme

---
 cmd/gaia/cmd/gaiadebug/README.md | 35 ++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 cmd/gaia/cmd/gaiadebug/README.md

diff --git a/cmd/gaia/cmd/gaiadebug/README.md b/cmd/gaia/cmd/gaiadebug/README.md
new file mode 100644
index 000000000..c2f0b8bc0
--- /dev/null
+++ b/cmd/gaia/cmd/gaiadebug/README.md
@@ -0,0 +1,35 @@
+# Gaiadebug
+
+Simple tool for simple debugging.
+
+We try to accept both hex and base64 formats and provide a useful response.
+
+Note we often encode bytes as hex in the logs, but as base64 in the JSON.
+
+## Pubkeys
+
+The following give the same result:
+
+```
+gaiadebug pubkey TZTQnfqOsi89SeoXVnIw+tnFJnr4X8qVC0U8AsEmFk4=
+gaiadebug pubkey 4D94D09DFA8EB22F3D49EA17567230FAD9C5267AF85FCA950B453C02C126164E
+```
+
+## Txs
+
+Pass in a hex/base64 tx and get back the full JSON
+
+```
+gaiadebug tx <hex or base64 transaction>
+```
+
+## Hack
+
+This is a command with boilerplate for using Go as a scripting language to hack
+on an existing Gaia state.
+
+Currently we have an example for the state of gaia-6001 after it
+[crashed](https://github.com/cosmos/cosmos-sdk/blob/master/cmd/gaia/testnets/STATUS.md#june-13-2018-230-est---published-postmortem-of-gaia-6001-failure). 
+If you run `gaiadebug hack $HOME/.gaiad` on that 
+state, it will do a binary search on the state history to find when the state
+invariant was violated.