forked from darioteixeira/ocaml-bitcoin
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README
64 lines (44 loc) · 2 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
=========================================================================
| README for OCaml-bitcoin |
| |
| http://ocaml-bitcoin.forge.ocamlcore.org/ |
| |
| Dario Teixeira <[email protected]> |
=========================================================================
1. Overview
===========
OCaml-bitcoin is a library offering an OCaml interface to the official
Bitcoin client API [1]. It works by making JSON-RPC calls over the
network to a running Bitcoin daemon offering the client API.
2. Dependencies
===============
The core library depends solely on Yojson and Cryptokit [2,3].
The optional auxiliary engines each have their own set of dependencies:
* Bitcoin_ocamlnet: Ocamlnet's Netclient [4].
* Bitcoin_ocsigen: Lwt and the Ocsigen server libraries [5,6].
* Bitcoin_cohttp: Lwt and Cohttp [5,7].
* Bitcoin_ocurl: OCurl [8].
3. Building and installing
==========================
The build system is generated with OASIS [9]. Run 'configure' if
you wish to modify the defaults. Enter 'make' and 'make install'
to build and install the libraries. Enter 'make doc' to generate
the API documentation.
4. License
==========
OCaml-bitcoin is distributed under the terms of the GNU LGPL version 2.1
(with OCaml linking exception). See LICENSE file for full license text.
5. Contributors
===============
Vincent Bernardoff contributed the engines based on OCurl and Cohttp.
References
==========
[1] http://bitcoin.org/en/developer-reference
[2] http://mjambon.com/yojson.html
[3] http://forge.ocamlcore.org/projects/cryptokit/
[4] http://projects.camlcity.org/projects/ocamlnet.html
[5] http://ocsigen.org/lwt/
[6] http://ocsigen.org/ocsigenserver/
[7] http://github.com/mirage/ocaml-cohttp
[8] http://ocurl.forge.ocamlcore.org/
[9] http://oasis.forge.ocamlcore.org/