Commit graph

39 commits

Author SHA1 Message Date
DataHoarder b6ca970f30
Change project name 2022-10-05 09:40:23 +02:00
Ciro S. Costa 74a9dfbdca cmd: add address generation
here a new subcommand is added: `address`.

the idea here is to provide an example of how address-related
funcionality from `pkg/monero` can be used.

at the moment, the only available action is "generate", which
instantiates a new seed based on `crypto/rand` and then displaying on
stdout the result

	WARNING: DO NOT USE THIS FOR ANYTHING MEANINGFUL.
	you've been advised.

example:

	$ monero address generate

	Mnemonic:  dawn      repent   towel    taxi
		   cucumber  muzzle   romance  awesome
		   losing    yeti     dogs     biplane
		   foyer     hotel    tattoo   dilute
		   gearbox   later    afloat   purged
		   software  ashtray  cell     dangerous
		   biplane

	Primary Address:        49MYaXwy8K177bw9i1bBDvPuM...
	Private Spend Key:      455f1c286ff8db620e61ca6c6...
	Private View Key:       b5d26a403c6cec29c3ecc8d2f...
	Public Spend Key:       cc06a0f6e6c6b0248d5e2c3fd...
	Public View Key:        bcb8d3dc372efb9071c120b72...

	(output truncated to fit the commit message).

Signed-off-by: Ciro S. Costa <utxobr@protonmail.com>
2021-08-26 07:46:52 -04:00
Ciro S. Costa 88e6ce099f readme: add docker instructions
Signed-off-by: Ciro S. Costa <utxobr@protonmail.com>
2021-08-03 18:23:13 -04:00
Ciro S. Costa dcbefcada8 readme: wording
Signed-off-by: Ciro S. Costa <utxobr@protonmail.com>
2021-07-28 07:54:14 -04:00
Ciro S. Costa ac58bd1fd1 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-28 07:37:23 -04:00
Ciro S. Costa 4539099b20 add install guide
Signed-off-by: Ciro S. Costa <utxobr@protonmail.com>
2021-07-19 19:48:06 -04:00
Ciro S. Costa ec284c589c readme: rephrase tor support
Signed-off-by: Ciro S. Costa <utxobr@protonmail.com>
2021-07-18 17:15:08 -04:00
Ciro S. Costa 75198b6d18 readme: shorten outputs; add tor instructions
Signed-off-by: Ciro S. Costa <utxobr@protonmail.com>
2021-07-18 17:12:24 -04:00
Ciro S. Costa e78b200d02 add support for rpc auth
example:

	monerod --rpc-login foo:foo  (...)
	monero daemon -u foo -p foo get-version

new flags
	  -p, --password string    password to supply for rpc auth
	  -u, --username string    name of the user to use during rpc auth

Signed-off-by: Ciro S. Costa <utxobr@protonmail.com>
2021-07-18 08:27:44 -04:00
Ciro S. Costa 28184b21bd readme: add example
Signed-off-by: Ciro S. Costa <utxobr@protonmail.com>
2021-07-17 09:23:37 -04:00
Ciro S. Costa 249ec31a71 pretty print + readme update
Signed-off-by: Ciro S. Costa <utxobr@protonmail.com>
2021-07-17 09:21:40 -04:00
Ciro S. Costa 27d22281e1 readme: re-order, mention releases page
moving on, we'll have tagged commits that represent a point-in-time
release for the `cli` and the library, so, it's good to mention that one
can just fetch the binary for their dist if they'd like to consume the
cli (which, at least for me, has proven to be quite handy).

Signed-off-by: Ciro S. Costa <utxobr@protonmail.com>
2021-07-10 22:52:20 -04:00
Ciro S. Costa edb7e1b79f improve documentation
- update readme so that it's up to date when it comes to package
structure

- add a badge that points at godoc so that one can quickly recognize
where docs can be found

- add an example that can be referenced via godoc (using `_test.go`
example)

- update sync-info to include a little description

Signed-off-by: Ciro S. Costa <utxobr@protonmail.com>
2021-07-10 21:32:09 -04:00
Ciro S. Costa a67bbd5e11 readme: fix quotation
Signed-off-by: Ciro S. Costa <utxobr@protonmail.com>
2021-07-03 15:49:51 -04:00
Ciro S. Costa 207bd1f632 readme: update command help
Signed-off-by: Ciro S. Costa <utxobr@protonmail.com>
2021-06-13 18:04:51 -04:00
Ciro S. Costa bef12c7374 readme: contact info
Signed-off-by: Ciro S. Costa <utxobr@protonmail.com>
2021-06-12 11:55:24 -04:00
Ciro S. Costa c7f0a16c32 readme: add link to pkg.go.dev; minor updates
Signed-off-by: Ciro S. Costa <utxobr@protonmail.com>
2021-06-12 11:54:02 -04:00
Ciro S. Costa abdd05f886 remove crawler; add donate
well, that's not really what the library should be about, so, no reason
to have it here.

see https://github.com/cirocosta/monero-p2p-crawler

Signed-off-by: Ciro S. Costa <utxobr@protonmail.com>
2021-06-12 09:07:14 -04:00
Ciro S. Costa 0d7d31ee77 daemonrpc -> rpc
Signed-off-by: Ciro S. Costa <utxobr@protonmail.com>
2021-06-12 08:17:46 -04:00
Ciro S. Costa f3f749572a readme: update list of cmds
Signed-off-by: Ciro S. Costa <ciroscosta@vmware.com>
2021-05-31 14:51:15 -04:00
Ciro S. Costa edae598aa2 readme: remove TODO
whelp, that should go elsewhere.

Signed-off-by: Ciro S. Costa <utxobr@protonmail.com>
2021-04-25 17:03:20 -04:00
Ciro S. Costa 1ab846b4f2 readme: add comments to levin's example
Signed-off-by: Ciro S. Costa <utxobr@protonmail.com>
2021-04-25 17:00:19 -04:00
Ciro S. Costa 6d95777fd8 readme: go get
Signed-off-by: Ciro S. Costa <utxobr@protonmail.com>
2021-04-25 16:58:38 -04:00
Ciro S. Costa 9a112b2681 readme: update help copy
Signed-off-by: Ciro S. Costa <utxobr@protonmail.com>
2021-04-25 16:57:50 -04:00
Ciro S. Costa 13594f863c readme: kickstart a proper readme
Signed-off-by: Ciro S. Costa <utxobr@protonmail.com>
2021-04-25 16:57:16 -04:00
Ciro S. Costa 67c0d9ebc1 readme: update last items worked on
Signed-off-by: Ciro S. Costa <utxobr@protonmail.com>
2021-04-20 21:58:10 -04:00
Ciro S. Costa 0075d63f87 readme: update levin status
Signed-off-by: Ciro S. Costa <utxobr@protonmail.com>
2021-04-20 19:13:30 -04:00
Ciro S. Costa 4e0e4c6c3b readme: add levin status
Signed-off-by: Ciro S. Costa <utxobr@protonmail.com>
2021-04-18 11:16:21 -04:00
Ciro S. Costa 2cbc2287e6 readme: thanks
Signed-off-by: Ciro S. Costa <utxobr@protonmail.com>
2021-04-18 10:11:24 -04:00
Ciro S. Costa c6bac23042 levin: add header packet parsing
Signed-off-by: Ciro S. Costa <utxobr@protonmail.com>
2021-04-18 09:55:29 -04:00
Ciro S. Costa 067473c5e3 readme: add description
Signed-off-by: Ciro S. Costa <utxobr@protonmail.com>
2021-04-17 14:53:12 -04:00
Ciro S. Costa 6449ca0a26 add get-transaction-pool
Signed-off-by: Ciro S. Costa <utxobr@protonmail.com>
2021-04-17 14:50:55 -04:00
Ciro S. Costa 2250ecdc6d add sync-info
Signed-off-by: Ciro S. Costa <utxobr@protonmail.com>
2021-04-17 12:23:21 -04:00
Ciro S. Costa 071f2db944 add get-fee-estimate
Signed-off-by: Ciro S. Costa <utxobr@protonmail.com>
2021-04-17 12:13:31 -04:00
Ciro S. Costa ede6b0f563 add get-coinbase-tx-sum
Signed-off-by: Ciro S. Costa <utxobr@protonmail.com>
2021-04-17 11:57:23 -04:00
Ciro S. Costa 643d4ec210 reamde: sort todo
Signed-off-by: Ciro S. Costa <utxobr@protonmail.com>
2021-04-17 11:46:44 -04:00
Ciro S. Costa b61379fb9c add get-info
Signed-off-by: Ciro S. Costa <utxobr@protonmail.com>
2021-04-17 11:45:43 -04:00
Ciro S. Costa a4fa8fcd49 add get_connections
Signed-off-by: Ciro S. Costa <utxobr@protonmail.com>
2021-04-16 18:11:28 -04:00
Ciro S. Costa e679267237 add readme
Signed-off-by: Ciro S. Costa <utxobr@protonmail.com>
2021-04-16 17:26:10 -04:00