aboutsummaryrefslogtreecommitdiffstats
path: root/TODO
blob: 0ed08df92d578d6734509696e2bfb66918f66ec2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

next:
- basic network handshake
    /home/bnewbold/src/hypercore-protocol
- fix append bug
- non-sparse 'has'/'has_all' implementations
x appending to register (sans bitfield)
- verifying register (sans bitfield)
- reading/writing secret key for register
- bitfield stuff (un-indexed)
    https://docs.rs/bit_field/0.8.0/bit_field/trait.BitArray
- protobuf infra
- basic drive trait
- 'drive log' command (shows actions)
- network infra
- 'geniza clone' command
- 'geniza checkout' command
- 'geniza init', 'geniza commit' commands
- 'geniza broadcast' command
- API to link and run from, eg, python

meta:
- license
- rustfmt
- github
- travis tests (linux, osx)

specific tests:
- sleep info a variety of bad sleep files, should error
- sleep create a known file, should be same as empty (also a "Rot13" algo file)
- create a register, binary compare against known-good

APIs:
- trait: register
- trait: drive
- SLEEP file
- SLEEP register
- SLEEP drive
- peer (multiple transit types)
- synchronizer (register, peers, discovery)

Old API:
sleep: SLEEP file I/O
register: hypercore registers/journal streams, signing
drive: hyperdrive
sync: dat network protocol, discover
geniza: command line, swarm



Backburner:
- SLEEP API: should just be empty string for algo-name, not Option<>
- I have the SLEEP/register naming wrong... sleep refers to the directory?
- refactor to something pwrite based for file I/O
    https://doc.rust-lang.org/std/os/unix/fs/trait.FileExt.html
    https://github.com/vasi/positioned-io
- mmap
    https://docs.rs/scroll/0.7.0/scroll/
- switch to byteorder for endian reads/writes
- --json args to most CLI commands
- simplify APIs
- SleepFile from existing File
- refactor key generation into generic/re-usable function
- turn magic numbers in tree nodes into declared (public?) constants
- root_nodes as an iterator? (vs returning a Vec)