doanha86 / tezos-ocaml-api

Tezos API

This OCaml API provides functions to interact with a Tezos node. It uses the Tezos libraries released on opam and wraps them inside a more simplified and easy-to-use interface. The API heavily utilizes the tezos-client library with its built-in input verification and prevalidation of operations in order to provide instant feedback and thus avoiding injections of invalid operations.
The source code of the Tezos libraries can be found on Gitlab.

Using Tezos_Api

To install the Tezos libraries with opam:
opam install tezos

Once you have the Tezos libraries installed, you can easily build the Tezos_Api into your project using dune. Your project structure should look like this:

.  
+-- dune  
+-- dune-project
+-- your_main.ml
+-- ...
+-- lib
|   +-- dune
|   +-- SyncAPIV1.mli
|   +-- SyncAPIV1.ml
|   +-- Api.mli
|   +-- Api.ml
|   +-- Api_context.mli
|   +-- Api_context.ml
|   +-- Api_error.mli
|   +-- Api_error.ml
|   +-- test/

Inside your projects root dune file, include the Tezos_api and the following dependencies:

(executables
 (names my_exe)
 (libraries SyncAPIV1
 	    lwt
	    lwt.unix
	    unix
            ... )

  (flags (:standard -open Lwt
                     ...
  	 	     -linkall)))

Your dune-projects file should contain the following line: (lang dune 1.11)

Build your project with
dune build my_exe.exe

Code examples

Example 1: Query the balance of an implicit account

  SyncAPIV1.get_contract "MickeyMouse"
  >>=? fun c->
  SyncAPIV1.get_balance c
  >>=? fun balance ->
  ....

Example 2: Transfer tokens from one account to another

SyncAPIV1.get_pukh_from_alias "MickeyMouse"
>>=? fun pukh_mickey ->
SyncAPIV1.get_contract "MinnieMouse"
>>=? fun c_minnie ->
let amount = SyncAPIV1.Tez_t.tez 1.0 in
let fee = SyncAPIV1.Tez_t.tez 0.02 in
SyncAPIV1.transfer amount pukh_mickey c_minnie fee
>>=? fun oph ->
....

Example 3: Calling a contract

SyncAPIV1.get_pukh_from_alias "MickeyMouse"
>>=? fun pukh_mickey ->
SyncAPIV1.get_contract "KT1VZGyuHDLpUaL67VkZ8gzhmXdn1yXxSwqi"
>>=? fun c ->
let amount = SyncAPIV1.Tez_t.tez 1.0 in
let fee = SyncAPIV1.Tez_t.tez 0.02 in
let entrypoint = "someEntrypoint" in
let arg = "Some arguments" in
SyncAPIV1.call_contract amount pukh_mickey c ~entrypoint ~arg fee
>>=? fun oph ->
....

Example 4: Query an operation status

...
>>=? fun oph ->
SyncAPIV1.query oph
>>=? function
| Accepted result -> print_endline ("Consumed gas: " ^ string_of_int res.consumed_gas) ; ...
| Still_pending -> ...
| Rejected (Reason Insufficient_fee) -> ...
| ....

Example 5: Error handling

begin
  SyncAPIV1.get_pukh_from_alias "MickeyMouse"
  >>=? fun pukh_mickey ->
  SyncAPIV1.get_contract "KT1VZGyuHDLpUaL67VkZ8gzhmXdn1yXxSwqi"
  >>=? fun c ->
  SyncAPIV1.call_contract amount pukh_mickey c ~entrypoint ~arg fee
end
>>= function
| Ok oph -> ...
| Error Node_connection_failed -> ...
| Error (Rejection Insufficient_fee) -> ...
| ....