add doc comment on "P"/"PS" struct
This commit is contained in:
parent
ece60632ac
commit
33032a4fbf
1 changed files with 21 additions and 6 deletions
|
|
@ -1,10 +1,26 @@
|
|||
(* https://docs.taler.net/core/api-common.html#binary-formats
|
||||
|
||||
- numeric values are in network byte order (big endian) *)
|
||||
(* TODO: ?
|
||||
- some struct have a 'P' suffix, but are not defined in doc
|
||||
we assume they are = to the un-suffixed ones
|
||||
- some purpose (`TALER_SIGNATURE_XXX`) are missing or outdated(?) *)
|
||||
|
||||
(* structs that are ‘packed’ and do not contain pointers and are
|
||||
thus suitable for hashing or similar operations are distinguished
|
||||
by adding a “P” at the end of the name. (NEW) Note that this convention
|
||||
does not hold for the GNUnet-structs (yet).
|
||||
|
||||
structs that are used with a purpose for signatures,
|
||||
additionally get an “S” at the end of the name.
|
||||
|
||||
(from https://docs.taler.net/taler-developer-manual.html) *)
|
||||
|
||||
(* TODO
|
||||
- check that our struct are well packed
|
||||
- it looks like Bin only define packed structs
|
||||
- we don't need to worry about struct having "P" suffix
|
||||
remove them
|
||||
- test them
|
||||
- some purpose (`TALER_SIGNATURE_XXX`) are missing
|
||||
exchange and gana master branch are not in sync
|
||||
and we should use a specific git tag instead *)
|
||||
|
||||
open Include
|
||||
|
||||
|
|
@ -271,8 +287,7 @@ module AgeMask = struct
|
|||
end
|
||||
|
||||
(* TODO
|
||||
- why is the non-NBO version only used in TALER_WithdrawRequestPS?
|
||||
- GNUNET_PACKED? *)
|
||||
- why is the non-NBO version only used in TALER_WithdrawRequestPS? *)
|
||||
(* Number of characters (plus 1 for 0-termination) for currency names.
|
||||
typically an ISO 4217 currency code when an alphanumeric 3-digit code is used.
|
||||
For regional currencies, the first character should be a "*" followed
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue