QPQ-AG/public-wiki
10
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

building out wiki

Peter Harpending 2025-03-20 13:51:59 -07:00
parent c162caabc4
commit 8068d43984
2 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
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` have a string `xy_ABCD`
- The `xy` prefix (`cb`, `th`, etc) indicates what sort of data is contained - 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 [[ in the rest of the string, and whether it is Base64 or Base58. (See
BaseN ]]). [[BaseN]]).
Generally, anything that is both fixed-length and likely to be input 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. 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 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 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. 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. 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 ## The Representation Problem

9
Home.md

@ -2,7 +2,8 @@
## Quick Reference ## Quick Reference
1. [[ API Encoding ]] (`ak_...` garbage) 1. [[API Encoding]]: `ak_...` etc garbage explained
2. [[ BaseN ]] 2. [[BaseN]]: Given `xy_ABCD`, what is the `ABCD`
3. [[ RLP ]] 3. [[RLP]]: If the binary `ABCD` is some data with fields (e.g. a transaction),
4. [[ Serializations ]] how to destructure the binary data to fields
4. [[Serializations]]: Conventions for field order in Gajumaru data structures