luk3yx
/
lurkcoin-core
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
29 Commits
1 Branch
0 Tags
156 KiB
Go 100%
 
Go to file
luk3yx d0e433e209 Decrease max spend to 10,000 and check this when getting exchange rate 2021-07-25 14:59:27 +12:00
cmd/lurkcoin-restore-backup Move restore-backup.go temporarily 2021-02-22 19:26:15 +13:00
lurkcoin Decrease max spend to 10,000 and check this when getting exchange rate 2021-07-25 14:59:27 +12:00
.gitignore Initial commit. 2020-04-21 22:24:16 +12:00
HTTPS API.md Update HTTPS API.md 2020-10-07 09:55:45 +13:00
LICENSE.md Initial commit. 2020-04-21 22:24:16 +12:00
README.md Update README.md 2021-02-22 19:43:53 +13:00
TODO.md Improve lurkcoin.ConstantTimeCompare(). 2020-05-01 15:48:55 +12:00
config.yaml Fix UNIX socket support. 2020-06-15 17:55:43 +12:00
go.mod Start using go mod 2021-02-22 19:19:35 +13:00
go.sum Start using go mod 2021-02-22 19:19:35 +13:00
main.go Start using go mod 2021-02-22 19:19:35 +13:00

README.md

lurkcoin

This is the core code of the current release of lurkcoin.

Installation

Make sure you have Go 1.13 or later installed.

To run lurkcoin, you can compile the lurkcoin-core binary:

$ go get github.com/luk3yx/lurkcoin-core
$ lurkcoin-core /path/to/config.yaml

If you get a command not found error, you may have to run ~/go/bin/lurkcoin-core instead.

I advise against importing github.com/luk3yx/lurkcoin-core in your own Go code, any functions or types can and will change in future releases.

Restoring the database from a backup

$ go get github.com/luk3yx/lurkcoin-core/cmd/...
$ lurkcoin-restore-backup /path/to/config.yaml /path/to/backup.json

Configuration

See config.yaml for a list of configuration options.

Compilation flags

The following compilation flags are supported:

  • lurkcoin.disablebbolt: Disables the bbolt database. If this flag is used, bbolt does not need to be installed.
  • lurkcoin.disableplaintextdb: Disables the plaintext database.
  • lurkcoin.disablev2api: Disables version 2 of the API. This can also be done at runtime in config.yaml.

License

Copyright © 2020 by luk3yx

This program 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.

This program 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 this program. If not, see https://www.gnu.org/licenses/.