81 lines
2.1 KiB
Markdown
81 lines
2.1 KiB
Markdown
# Fcoin (Bcoin ported to Lcoin ported to Flo)
|
|
|
|
## Differences between this repo and [bcoin-org/bcoin](https://github.com/bcoin-org/bcoin)
|
|
|
|
* Based on latest bcoin repo, pick flo related commits from bcoin-org/fcoin, applied some modifications and fixed more tests.
|
|
* **May rebase and `push --force` frequently, to catch up with bcoin and make repo easy to maintain.**
|
|
|
|
## TODO
|
|
|
|
* [ ] Fix tests:
|
|
* [ ] block-test
|
|
* [ ] tx-test
|
|
|
|
## Fcoin
|
|
|
|
__NOTE__: The latest release of fcoin contains a non-backward compatible change
|
|
to the rest API. Please read the [changelog]'s "migrating" section for more
|
|
details.
|
|
|
|
---
|
|
|
|
**Fcoin** is an alternative implementation of the flo protocol, written in
|
|
node.js.
|
|
|
|
## Uses
|
|
|
|
- Full Node
|
|
- SPV Node
|
|
- Wallet Backend (bip44 derivation)
|
|
- Mining Backend (getblocktemplate support)
|
|
- Layer 2 Backend (lightning)
|
|
- General Purpose Bitcoin Library
|
|
|
|
Try it in the browser: http://bcoin.io/browser.html
|
|
|
|
## Install
|
|
|
|
```
|
|
$ git clone git://github.com/oipwg/fcoin.git
|
|
$ cd fcoin
|
|
$ npm install
|
|
$ ./bin/fcoin
|
|
```
|
|
|
|
See the [Beginner's Guide][guide] for more in-depth installation instructions.
|
|
|
|
## Documentation
|
|
|
|
- API Docs: http://bcoin.io/docs/
|
|
- REST Docs: http://bcoin.io/api-docs/index.html
|
|
- Docs: [docs/](docs/README.md)
|
|
|
|
## Support
|
|
|
|
Join us on [freenode][freenode] in the [#bcoin][irc] channel.
|
|
|
|
## Disclaimer
|
|
|
|
Fcoin does not guarantee you against theft or lost funds due to bugs, mishaps,
|
|
or your own incompetence. You and you alone are responsible for securing your
|
|
money.
|
|
|
|
## Contribution and License Agreement
|
|
|
|
If you contribute code to this project, you are implicitly allowing your code
|
|
to be distributed under the MIT license. You are also implicitly verifying that
|
|
all code is your original work. `</legalese>`
|
|
|
|
## License
|
|
|
|
- Copyright (c) 2014-2015, Fedor Indutny (MIT License).
|
|
- Copyright (c) 2014-2017, Christopher Jeffrey (MIT License).
|
|
|
|
See LICENSE for more info.
|
|
|
|
[purse]: https://purse.io
|
|
[guide]: https://github.com/bcoin-org/bcoin/blob/master/docs/Beginner's-Guide.md
|
|
[freenode]: https://freenode.net/
|
|
[irc]: irc://irc.freenode.net/bcoin
|
|
[changelog]: https://github.com/bcoin-org/bcoin/blob/master/CHANGELOG.md
|