v0.5

README.md

@@ -1 +1,67 @@
-# algostreamer
+# AlgoNode algostreamer utility
+
+## About algostreamer
+
+Small utility to stream past and/or current Algorand node JSON blocks to Redis or stdout.
+
+## About AlgoNode
+
+We are here to help your Algorand node shine!
+Go to https://algonode.cloud for more.
+
+## Install 
+
+```Shell
+go get https://github.com/algonode/algostreamer
+```
+
+## Config
+
+config.json
+```json
+{
+ "algod" : {
+ "address" : "http://localhost:8080",
+ "token" : "...",
+ "queue" : 100
+ },
+ "redis": {
+ "addr": "localhost",
+ "user": "",
+ "pass": "",
+ "db": 10
+ }
+}
+```
+
+* You can find your token in node/data/algo.token
+* You can find your address in node/data/alogo.net
+
+## Run
+
+Start streaming from the current block
+```Shell
+./algostreamer -f config.json -s 2>>stream.log
+```
+
+Start streming from the block no 18000000 and then continue with current blocks
+```Shell
+./algostreamer -r 18000000 -f config.json -s 2>>stream.log
+```
+
+WARN: Redis is not yet implemented
+
+## License
+
+Copyright (C) 2022 AlgoNode Org.
+
+algostreamer is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+## Support AlgoNode
+
+if you like what we do feel free to support us by sending some microAlgos to
+
+**AlgoNode wallet**: `S322JRT4RZ4L2CLEQ5HXQBU2CNH3DLLO6JJEMWGPQHAOG2ALCH7ZAHXOPE`

cmd/algostream/alogd.go

@@ -1,3 +1,18 @@
+// Copyright (C) 2022 AlgoNode Org.
+//
+// algostreamer is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as
+// published by the Free Software Foundation, either version 3 of the
+// License, or (at your option) any later version.
+//
+// algostreamer is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with algostreamer. If not, see <https://www.gnu.org/licenses/>.
+
 package main
 
 import (

cmd/algostream/cfg.go

@@ -1,3 +1,18 @@
+// Copyright (C) 2022 AlgoNode Org.
+//
+// algostreamer is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as
+// published by the Free Software Foundation, either version 3 of the
+// License, or (at your option) any later version.
+//
+// algostreamer is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with algostreamer. If not, see <https://www.gnu.org/licenses/>.
+
 package main
 
 import (

cmd/algostream/main.go

@@ -1,3 +1,18 @@
+// Copyright (C) 2022 AlgoNode Org.
+//
+// algostreamer is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as
+// published by the Free Software Foundation, either version 3 of the
+// License, or (at your option) any later version.
+//
+// algostreamer is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with algostreamer. If not, see <https://www.gnu.org/licenses/>.
+
 package main
 
 import (

cmd/algostream/redis.go

@@ -1,3 +1,18 @@
+// Copyright (C) 2022 AlgoNode Org.
+//
+// algostreamer is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as
+// published by the Free Software Foundation, either version 3 of the
+// License, or (at your option) any later version.
+//
+// algostreamer is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with algostreamer. If not, see <https://www.gnu.org/licenses/>.
+
 package main
 
 import (

cmd/algostream/utils.go

@@ -1,3 +1,18 @@
+// Copyright (C) 2022 AlgoNode Org.
+//
+// algostreamer is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as
+// published by the Free Software Foundation, either version 3 of the
+// License, or (at your option) any later version.
+//
+// algostreamer is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with algostreamer. If not, see <https://www.gnu.org/licenses/>.
+
 package main
 
 import (