Skip to content

Commit 0af9b9e

Browse files
committed
v0.5
1 parent e737826 commit 0af9b9e

File tree

6 files changed

+142
-1
lines changed

6 files changed

+142
-1
lines changed

README.md

Lines changed: 67 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,67 @@
1-
# algostreamer
1+
# AlgoNode algostreamer utility
2+
3+
## About algostreamer
4+
5+
Small utility to stream past and/or current Algorand node JSON blocks to Redis or stdout.
6+
7+
## About AlgoNode
8+
9+
We are here to help your Algorand node shine!
10+
Go to https://algonode.cloud for more.
11+
12+
## Install
13+
14+
```Shell
15+
go get https://github.com/algonode/algostreamer
16+
```
17+
18+
## Config
19+
20+
config.json
21+
```json
22+
{
23+
"algod" : {
24+
"address" : "http://localhost:8080",
25+
"token" : "...",
26+
"queue" : 100
27+
},
28+
"redis": {
29+
"addr": "localhost",
30+
"user": "",
31+
"pass": "",
32+
"db": 10
33+
}
34+
}
35+
```
36+
37+
* You can find your token in node/data/algo.token
38+
* You can find your address in node/data/alogo.net
39+
40+
## Run
41+
42+
Start streaming from the current block
43+
```Shell
44+
./algostreamer -f config.json -s 2>>stream.log
45+
```
46+
47+
Start streming from the block no 18000000 and then continue with current blocks
48+
```Shell
49+
./algostreamer -r 18000000 -f config.json -s 2>>stream.log
50+
```
51+
52+
WARN: Redis is not yet implemented
53+
54+
## License
55+
56+
Copyright (C) 2022 AlgoNode Org.
57+
58+
algostreamer is free software: you can redistribute it and/or modify
59+
it under the terms of the GNU Affero General Public License as
60+
published by the Free Software Foundation, either version 3 of the
61+
License, or (at your option) any later version.
62+
63+
## Support AlgoNode
64+
65+
if you like what we do feel free to support us by sending some microAlgos to
66+
67+
**AlgoNode wallet**: `S322JRT4RZ4L2CLEQ5HXQBU2CNH3DLLO6JJEMWGPQHAOG2ALCH7ZAHXOPE`

cmd/algostream/alogd.go

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1+
// Copyright (C) 2022 AlgoNode Org.
2+
//
3+
// algostreamer is free software: you can redistribute it and/or modify
4+
// it under the terms of the GNU Affero General Public License as
5+
// published by the Free Software Foundation, either version 3 of the
6+
// License, or (at your option) any later version.
7+
//
8+
// algostreamer is distributed in the hope that it will be useful,
9+
// but WITHOUT ANY WARRANTY; without even the implied warranty of
10+
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11+
// GNU Affero General Public License for more details.
12+
//
13+
// You should have received a copy of the GNU Affero General Public License
14+
// along with algostreamer. If not, see <https://www.gnu.org/licenses/>.
15+
116
package main
217

318
import (

cmd/algostream/cfg.go

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1+
// Copyright (C) 2022 AlgoNode Org.
2+
//
3+
// algostreamer is free software: you can redistribute it and/or modify
4+
// it under the terms of the GNU Affero General Public License as
5+
// published by the Free Software Foundation, either version 3 of the
6+
// License, or (at your option) any later version.
7+
//
8+
// algostreamer is distributed in the hope that it will be useful,
9+
// but WITHOUT ANY WARRANTY; without even the implied warranty of
10+
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11+
// GNU Affero General Public License for more details.
12+
//
13+
// You should have received a copy of the GNU Affero General Public License
14+
// along with algostreamer. If not, see <https://www.gnu.org/licenses/>.
15+
116
package main
217

318
import (

cmd/algostream/main.go

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1+
// Copyright (C) 2022 AlgoNode Org.
2+
//
3+
// algostreamer is free software: you can redistribute it and/or modify
4+
// it under the terms of the GNU Affero General Public License as
5+
// published by the Free Software Foundation, either version 3 of the
6+
// License, or (at your option) any later version.
7+
//
8+
// algostreamer is distributed in the hope that it will be useful,
9+
// but WITHOUT ANY WARRANTY; without even the implied warranty of
10+
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11+
// GNU Affero General Public License for more details.
12+
//
13+
// You should have received a copy of the GNU Affero General Public License
14+
// along with algostreamer. If not, see <https://www.gnu.org/licenses/>.
15+
116
package main
217

318
import (

cmd/algostream/redis.go

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1+
// Copyright (C) 2022 AlgoNode Org.
2+
//
3+
// algostreamer is free software: you can redistribute it and/or modify
4+
// it under the terms of the GNU Affero General Public License as
5+
// published by the Free Software Foundation, either version 3 of the
6+
// License, or (at your option) any later version.
7+
//
8+
// algostreamer is distributed in the hope that it will be useful,
9+
// but WITHOUT ANY WARRANTY; without even the implied warranty of
10+
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11+
// GNU Affero General Public License for more details.
12+
//
13+
// You should have received a copy of the GNU Affero General Public License
14+
// along with algostreamer. If not, see <https://www.gnu.org/licenses/>.
15+
116
package main
217

318
import (

cmd/algostream/utils.go

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1+
// Copyright (C) 2022 AlgoNode Org.
2+
//
3+
// algostreamer is free software: you can redistribute it and/or modify
4+
// it under the terms of the GNU Affero General Public License as
5+
// published by the Free Software Foundation, either version 3 of the
6+
// License, or (at your option) any later version.
7+
//
8+
// algostreamer is distributed in the hope that it will be useful,
9+
// but WITHOUT ANY WARRANTY; without even the implied warranty of
10+
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11+
// GNU Affero General Public License for more details.
12+
//
13+
// You should have received a copy of the GNU Affero General Public License
14+
// along with algostreamer. If not, see <https://www.gnu.org/licenses/>.
15+
116
package main
217

318
import (

0 commit comments

Comments
 (0)