cerc-io/lighthouse
10
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

Update readme syntax; Add explicit table for checks to be performed

Browse Source
This commit is contained in:
NatoliChris 2018-09-18 17:32:51 +10:00
parent 15ec33e790
commit 04b02854bc
No known key found for this signature in database
GPG Key ID: D3EA7DBA19945306
1 changed files with 16 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
ssz/README.md
View File

@ -69,14 +69,14 @@ serialization.
Syntax: Syntax:
| Shorthand | Meaning | | Shorthand | Meaning |
|:-------------|:---------------------------------------------------| |:-------------|:----------------------------------------------------|
| `big` | ``big endian`` | | `big` | ``big endian`` |
| `little` | ``little endian`` | | `to_bytes` | convert to bytes. Params: ``(size, byte order)`` |
| `to_bytes` | convert to bytes params ``(size, byte order)`` | | `from_bytes` | convert from bytes. Params: ``(bytes, byte order)`` |
| `from_bytes` | convert from bytes params ``(bytes, byte order)`` | | `value` | the value to serialize |
| `value` | the value to serialize | | `rawbytes` | raw encoded/serialized bytes |
| `len(value)` | get the length of the value. (number of bytes etc) | | `len(value)` | get the length of the value. (number of bytes etc) |
### Serialize/Encode ### Serialize/Encode
@ -100,6 +100,10 @@ return value.to_bytes(buffer_size, 'big')
The address should already come as a hash/byte format. Ensure that length is The address should already come as a hash/byte format. Ensure that length is
**20**. **20**.
| Check to perform | Code |
|:-----------------------|:---------------------|
| Length is correct (20) | ``len(value) == 20`` |
``` ```
assert( len(value) == 20 ) assert( len(value) == 20 )
return value return value
@ -110,6 +114,10 @@ return value
The hash32 should already be a 32 byte length serialized data format. The safety The hash32 should already be a 32 byte length serialized data format. The safety
check ensures the 32 byte length is satisfied. check ensures the 32 byte length is satisfied.
| Check to perform | Code |
|:-----------------------|:---------------------|
| Length is correct (32) | ``len(value) == 32`` |
``` ```
assert( len(value) == 32 ) assert( len(value) == 32 )
return value return value