electrum-obelisk

Electrum server using libbitcoin as its backend
git clone https://git.parazyd.org/electrum-obelisk
Log | Files | Refs | README | LICENSE

README.md (2797B)

      1 electrum-obelisk
      2 ================
      3 
      4 ![electrum-obelisk](res/obelisk.png)
      5 
      6 A **work-in-progress** implementation of an Electrum server using
      7 [libbitcoin](https://libbitcoin.info) as a backend.
      8 
      9 TODO
     10 ----
     11 
     12 * Better (and more) error handling
     13 * More testing
     14 * git grep -E "TODO:|BUG:"
     15 
     16 
     17 Usage
     18 -----
     19 
     20 Install `bx` and `bs`
     21 
     22 * https://github.com/libbitcoin/libbitcoin-explorer/
     23 * https://github.com/libbitcoin/libbitcoin-server/
     24 
     25 Configure them per your needs and sync the node. Following this,
     26 configure `config.ini` to use with obelisk.
     27 
     28 Now you can run `./obelisk config.ini` to start the server.
     29 
     30 Connect Electrum with:
     31 
     32 ```
     33 electrum --oneserver --server 127.0.0.1:50002:s
     34 ```
     35 
     36 Talk
     37 ----
     38 
     39 `#libbitcoin` on freenode.
     40 
     41 
     42 License
     43 -------
     44 
     45 electrum-obelisk is licensed [AGPL-3](LICENSE.md).
     46 
     47 ```
     48 electrum-obelisk
     49 Copyright (C) 2020-2021 Ivan J. <parazyd@dyne.org>
     50 
     51 This program is free software: you can redistribute it and/or modify
     52 it under the terms of the GNU Affero General Public License as published by
     53 the Free Software Foundation, either version 3 of the License, or
     54 (at your option) any later version.
     55 
     56 This program is distributed in the hope that it will be useful,
     57 but WITHOUT ANY WARRANTY; without even the implied warranty of
     58 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     59 GNU Affero General Public License for more details.
     60 
     61 You should have received a copy of the GNU Affero General Public License
     62 along with this program.  If not, see <http://www.gnu.org/licenses/>.
     63 ```
     64 
     65 This software is heavily inspired by, and certain parts of the code
     66 are copied from Chris Belcher's implementation of
     67 [electrum-personal-server](https://github.com/chris-belcher/electrum-personal-server]
     68 and are copyrighted under the MIT license:
     69 
     70 ```
     71 The MIT License (MIT)
     72 
     73 Permission is hereby granted, free of charge, to any person obtaining
     74 a copy of this software and associated documentation files (the
     75 "Software"), to deal in the Software without restriction, including
     76 without limitation the rights to use, copy, modify, merge, publish,
     77 distribute, sublicense, and/or sell copies of the Software, and to
     78 permit persons to whom the Software is furnished to do so, subject to
     79 the following conditions:
     80 
     81 The above copyright notice and this permission notice shall be
     82 included in all copies or substantial portions of the Software.
     83 
     84 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
     85 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
     86 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
     87 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
     88 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
     89 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
     90 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
     91 ```