From 8068d4398405a7db817b4efa3dc880a11fc65d02 Mon Sep 17 00:00:00 2001 From: Peter Harpending Date: Thu, 20 Mar 2025 13:51:59 -0700 Subject: [PATCH] building out wiki --- API-Encoding.md | 8 ++++---- Home.md | 9 +++++---- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/API-Encoding.md b/API-Encoding.md index 47fffa5..dee52b5 100644 --- a/API-Encoding.md +++ b/API-Encoding.md @@ -12,8 +12,8 @@ These are called "API strings" or "API encoding" in official lingo. Suppose you have a string `xy_ABCD` - The `xy` prefix (`cb`, `th`, etc) indicates what sort of data is contained - in the rest of the string, and whether it is Base64 or Base58. (See [[ - BaseN ]]). + in the rest of the string, and whether it is Base64 or Base58. (See + [[BaseN]]). Generally, anything that is both fixed-length and likely to be input manually (e.g. public keys) is going to be Base58, else it will be Base64. @@ -72,7 +72,7 @@ checksum: passed If it's compound data (i.e. it has fields), then the binary data you get out of the decode process is going to be encoded in RLP. (See -[[ RLP ]]) +[[RLP]]) RLP-decode is going to give you a list-of-lists-of-\dots-of-binaries. @@ -87,7 +87,7 @@ integers. The tag and version tell you what the format of the fields are going to be. -These formats are documented in [[ Serialization ]]. +These formats are documented in [[Serialization]]. ## The Representation Problem diff --git a/Home.md b/Home.md index 7913092..ee06353 100644 --- a/Home.md +++ b/Home.md @@ -2,7 +2,8 @@ ## Quick Reference -1. [[ API Encoding ]] (`ak_...` garbage) -2. [[ BaseN ]] -3. [[ RLP ]] -4. [[ Serializations ]] +1. [[API Encoding]]: `ak_...` etc garbage explained +2. [[BaseN]]: Given `xy_ABCD`, what is the `ABCD` +3. [[RLP]]: If the binary `ABCD` is some data with fields (e.g. a transaction), + how to destructure the binary data to fields +4. [[Serializations]]: Conventions for field order in Gajumaru data structures