NAME

Zcash::RPC::Client - Zcash Payment API Client

SYNOPSIS

   use Zcash::RPC::Client;

   # Create Zcash::RPC::Client object
   $zec = Zcash::RPC::Client->new(
      user     => "username",
      password => "p4ssword",
   );

   # Zcash supports all commands in the Bitcoin Core API
   # Check the block height of our Zcash node
   #     https://bitcoin.org/en/developer-reference#getblockchaininfo
   $getinfo = $zec->getinfo;
   $blocks = $getinfo->{blocks};

   # Return the total value of funds stored in the node's wallet
   #     https://github.com/zcash/zcash/blob/master/doc/payment-api.md
   $z_gettotalbalance = $zec->z_gettotalbalance;
   # Output:
   #{
   #  "transparent" : 1.23,
   #  "private" : 4.56,
   #  "total" : 5.79
   #}
   print $z_gettotalbalance->{total};
   # 5.79

   # See ex/example.pl for more in depth JSON handling:
   #     https://github.com/Cyclenerd/Zcash-RPC-Client/tree/master/ex

DESCRIPTION

This module is a pure Perl implementation of the methods that are currently part of the Zcash Payment API client calls. The method names and parameters are identical between the Zcash Payment API reference and this module. This is done for consistency so that a developer only has to reference one manual: https://github.com/zcash/zcash/blob/master/doc/payment-api.md

CONSTRUCTOR

$zec = Zcash::RPC::Client->new( %options )

This method creates a new Zcash::RPC::Client and returns it.

   Key                 Default
   -----------         -----------
   host                127.0.0.1
   user                undef (Required)
   password            undef (Required)
   cookie              undef
   port                8232
   wallet              undef
   timeout             20
   ssl                 0
   verify_hostname     1
   debug               0

host - Address listens for JSON-RPC connections

user and password - User and Password for JSON-RPC api commands

cookie - Absolute path to your RPC cookie file (.cookie). When cookie is defined user and password will be ignored and the contents of cookie will be used instead.

port - TCP port for JSON-RPC connections

wallet - Work against specific wallet.dat file when Multi-wallet support is enabled

timeout - Set the timeout in seconds for individual RPC requests. Increase this for slow zcashd instances.

ssl - OpenSSL support has been removed from the Bitcoin Core and Zcash project. However Zcash::RPC::Client will work over SSL with earlier versions or with a reverse web proxy such as nginx.

verify_hostname - Disable SSL certificate verification. Needed when bitcoind is fronted by a proxy or when using a self-signed certificate.

debug - Turns on raw HTTP request/response output from LWP::UserAgent.

AVAILABILITY

The latest branch is avaiable from GitHub: https://github.com/Cyclenerd/Zcash-RPC-Client

CAVEATS

Boolean parameters must be passed as JSON::Boolean objects E.g. JSON::true

AUTHOR

Zcash is based on Bitcoin. Zcash supports all commands in the Bitcoin Core API (as of version 0.11.2).

This module is a fork of Bitcoin::RPC::Client.

Bitcoin::RPC::Client is developed by Wesley Hinds. This Zcash fork is mantained by Nils Knieling.

LICENSE AND COPYRIGHT

 Copyright (c) 2018 Nils Knieling
 Copyright (c) 2016-2018 Wesley Hinds

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

cpanm Zcash::RPC::Client

perl -MCPAN -e shell
install Zcash::RPC::Client