go-monero/README.md

# go-monero


A multi-platform [Go] library (and command line interface) for interacting with
[Monero] servers either on clearnet or not (see [Tor support]), supporting
daemon and wallet RPC, p2p commands and ZeroMQ.

## License

See [LICENSE](./LICENSE).
add readme Signed-off-by: Ciro S. Costa <utxobr@protonmail.com> 2021-04-16 21:26:10 +00:00			`# go-monero`

readme: add link to pkg.go.dev; minor updates Signed-off-by: Ciro S. Costa <utxobr@protonmail.com> 2021-06-12 15:54:02 +00:00
add zmq support here i add `pkg/zmq`, a package aimed at providing one with the ability of subscribing to zmq topics that the monero daemon published messages to. as exaplined under [1], there are four topics that one can subscribe to: - json-minimal-txpool_add - json-full-txpool_add - json-minimal-chain_main - json-full-chain_main in the implementation provided here, one goes about listening to these by: 1. creating a client aiming at a topic 2. telling the client to listen 3. consuming typed objects from a "stream" object e.g.: client := zmq.NewClient(endpoint, zmq.TopicMinimalTxPoolAdd) defer client.Close() stream, _ := client.Listen(ctx) for { select { case err := <-stream.ErrC: panic(err) case tx := <-stream.MinimalTxPoolAddC: fmt.Println(tx) } } CLI users can also make use of it via `monero daemon zmq`: $ monero daemon zmq \ --topic json-minimal-chain_main \ --endpoint tcp://127.0.0.1:18085 [1]: https://github.com/monero-project/monero/blob/master/docs/ZMQ.md Signed-off-by: Ciro S. Costa <utxobr@protonmail.com> 2021-07-27 11:10:25 +00:00			`A multi-platform [Go] library (and command line interface) for interacting with`
readme: wording Signed-off-by: Ciro S. Costa <utxobr@protonmail.com> 2021-07-28 11:54:14 +00:00			`[Monero] servers either on clearnet or not (see [Tor support]), supporting`
add zmq support here i add `pkg/zmq`, a package aimed at providing one with the ability of subscribing to zmq topics that the monero daemon published messages to. as exaplined under [1], there are four topics that one can subscribe to: - json-minimal-txpool_add - json-full-txpool_add - json-minimal-chain_main - json-full-chain_main in the implementation provided here, one goes about listening to these by: 1. creating a client aiming at a topic 2. telling the client to listen 3. consuming typed objects from a "stream" object e.g.: client := zmq.NewClient(endpoint, zmq.TopicMinimalTxPoolAdd) defer client.Close() stream, _ := client.Listen(ctx) for { select { case err := <-stream.ErrC: panic(err) case tx := <-stream.MinimalTxPoolAddC: fmt.Println(tx) } } CLI users can also make use of it via `monero daemon zmq`: $ monero daemon zmq \ --topic json-minimal-chain_main \ --endpoint tcp://127.0.0.1:18085 [1]: https://github.com/monero-project/monero/blob/master/docs/ZMQ.md Signed-off-by: Ciro S. Costa <utxobr@protonmail.com> 2021-07-27 11:10:25 +00:00			`daemon and wallet RPC, p2p commands and ZeroMQ.`
readme: contact info Signed-off-by: Ciro S. Costa <utxobr@protonmail.com> 2021-06-12 15:55:24 +00:00
readme: remove TODO whelp, that should go elsewhere. Signed-off-by: Ciro S. Costa <utxobr@protonmail.com> 2021-04-25 21:03:20 +00:00			`## License`

			`See [LICENSE](./LICENSE).`