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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
Arching Kaos Tools
==================
> Warning: The tools and the whole project is in an experimental state.
> Everything is subject to change.
Introduction
------------
Tools that help you to create a blockchain called `zchain` by preparing small
JSON objects that are pointing one to another in the following way:
```
ZBLOCK = BLOCK + SIGNATURE
BLOCK = ACTION + DATA + DATA_SIGNATURE + TIMESTAMP + GPG + PREVIOUS_ZBLOCK
DATA = IPFS_CID + SIGNATURE ( + key-pair values that are based on ACTION )
```
Most of the times, IPFS_CID in DATA is expected to be a file. And the module
is responsible for handling it properly.
For the zchain to be valid, all the signatures must be verifiable against the
provided GPG key that is included in the BLOCK.
Previous developments
---------------------
1. A proof of work blockchain is introduced to synchronize the zchains among
them.
2. A miner prototype is introduced as well.
3. From a directory full of blocks, find the latest block of the longest chain
4. API for calling some of the bash scripts
Description
-----------
This is an installable repository which provides various tools for running
Arching Kaos and using it.
Generic tools:
`ak-enter` - Can be used to crawl zchains.
`ak-zchain-rebase` - Can be used to rebase your zchain to a previous zblock.
`ak-zchain-reset` - Can be used to reset your zchain to zgenesis.
ACTION tools (modules):
`ak-mixtapes` and `news` - Can be used to add content to your zchain.
`ak-profile` - Can be used to build up a profile of the contributor.
Based on your GPG, zchain and other values provided by `profile`, you can create
with `akconfig` a pointer to some basic information that you can share with
others in order for them to crawl your zchain or view your "profile".
There are more tools available under the `bin` folder. Make sure you deeply
understand what they are doing before using them.
Changes are mentioned in `git log` of the repo, as well as in CHANGELOG file.
Requirements
------------
Some Linux machine will propably work. It's tested under Fedora Linux. External
programs used are:
- bash (v5.1.8)
- gpg (v2.3.4)
- wget (v1.21.2)
- curl (v7.79.1)
- git (v2.34.1)
- which (v2.21)
- jq (v1.6)
- nodejs (v18.14)
- npm (v9.5.0)
- npx (v9.5.0)
How to install the repository
-----------------------------
Write on your terminal:
```
git clone https://github.com/arching-kaos/arching-kaos-tools
cd arching-kaos-tools
./install.sh
```
If you encounter any errors, please open an issue.
Update
------
Navigate to your cloned repository and execute the following commands:
```
git pull
./update.sh
```
Uninstall
---------
Navigate to your cloned repository and execute the following command:
```
./uninstall.sh
```
This will output an archive with your aknet-gpg-keyring to your $HOME folder.
It will NOT remove your IPFS repository, neither is going to clean it.
Examples
--------
### Add a news article ( `ak-news add` )
You could use ZCHAIN with NEWS model. Or MIXTAPE model, or make your own.
``` bash
$ ak-news create
```
This would pop up a vim editor for you to write a news article or whatever is
text or markdown format with a title.
Saving the file, will save it locally, add it to IPFS, sign it, pack detached
signature with metadata on a JSON object. Then a block will be created packing
your GPG public key, the news/add action with the JSON object and a detached
signature of this, timestamp and finally an entry for the previous *zblock*.
After that, we finally write this as a JSON object, add it to IPFS, sign it
and pack a *ZBLOCK*. The ZBLOCK is then published over our IPNS zchain key.
Other options... let's try help!
``` console
$ ak-news help
ak-news
-------
#TODO
All you need to know is that there are two options available:
help Prints this help message
index Prints an indexed table of your news files
import <file> #TODO
add <file> Creates a data file from the news file you point to
create Vim is going to pop up, you will write and save your
newsletter and it's going to be saved
```
Clearly there is a TODO item. Import is not working so avoid it, or fix it.
Add is nice, you can add an already existing file directly. `news` is the second
module after `mixtape`. Both modules need refactoring but they work at a level
that someone can be productive with these tools.
### Explore chains ( `ak-enter` )
You can view your zchain as a JSON object using `enter`. There are some flags
in order to either view other zchains or change the depth of view ( includes or
ignores data object and action ).
``` console
$ ak-enter -h
ak-enter - Crawl an arching kaos chain
-----------------------------------
Usage:
--help, -h Print this help and exit
--chain <ipns-link>, -n <ipns-link> Crawl specified chain
--show-zblocks-only, -z Show only zblocks
--no-verify, -nV Don't verify signatures
<ipfs-link> Specify IPFS CID for entrance
Note that combined flags don't work for now
Running with no flags crawls your chain
```
Podman (or Docker)
------------------
There is a ContainerFile that you can use to build an image which you can then
deploy in a container.
Use:
```
podman build -f ContainerFile -t arching-kaos-tools .
```
TODO
----
Next things to come are:
- [ ] - zblock manipulator to fix wrong previous block references and repack
zblocks.
- [X] - zchain rebase-like procedure to move the zblocks to another seed or set
another previous block (e.g. join chains)
- [ ] - Clean up installation and filesystem usage
- [ ] - Log rotate to gzip archives
- [ ] - Filters for log searching for IPFS hashes or names
- [ ] - Use of IPFS file system to store/pin sub chains, previous chains or
other chains
Concepts under thought
----------------------
- Base chain, derived from personal ones.
- Daemon to monitor chains' states, update and sign new zblocks.
- Find a minimum agreement of what is valid or not. (important)
- Spam defence (e.g. how to protect the network from abuse cases) (important)
- Reduce size of all parts of chain (stringify JSON) (improvement)
|
