File Coverage

blib/lib/Zcash/RPC/Client.pm

Criterion	Covered	Total	%
statement	14	73	19.1
branch	0	30	0.0
condition	0	3	0.0
subroutine	5	10	50.0
pod	0	1	0.0
total	19	117	16.2

package Zcash::RPC::Client;

use 5.008;

use strict;
use warnings;

use Moo;
use JSON::RPC::Legacy::Client;

our $VERSION  = '1.01';

has jsonrpc  => (is => "lazy", default => sub { "JSON::RPC::Legacy::Client"->new });
has user     => (is => 'ro');
has password => (is => 'ro');
has cookie   => (is => 'ro', isa => \&isa_cookie);
has host     => (is => "lazy", default => '127.0.0.1');
has wallet   => (is => 'ro');
has port     => (is => "lazy", default => 8232);
has timeout  => (is => "lazy", default => 20);
has debug    => (is => "lazy", default => 0);

# SSL constructor options
#  OpenSSL support has been removed from Bitcoin Core as of v0.12.0 and Zcash
#  but should work with older versions and connections via a proxy.
has ssl             => (is => 'ro', default => 0);
has verify_hostname => (is => 'ro', default => 1);

my $DEBUG_DUMPED = 0;

sub AUTOLOAD {
   my $self   = shift;
   my $method = $Zcash::RPC::Client::AUTOLOAD;

   $method =~ s/.*:://;

   return if ($method eq 'DESTROY');

   # Build request URL
   my $url = "";

   # Are we using SSL?
   my $uri = "http://";
   if ($self->ssl eq 1) {
      $uri = "https://";
   }

   # Cookie will take precedence over user/password
   if ($self->cookie) {
      # If cookie is defined its contents become user:password
      $url = $uri . $self->cookie . "\@" . $self->host . ":" . $self->port;
   } elsif ($self->user) {
      $url = $uri . $self->user . ":" . $self->password . "\@" . $self->host . ":" . $self->port;
   } else {
      die "An RPC user or RPC cookie file must be defined";
   }

   # Tack on a specific wallet name if given
   if ($self->wallet) {
      $url .= "/wallet/" . $self->wallet;
   }

   my $client = $self->jsonrpc;

   # Set timeout because bitcoin is slow
   $client->ua->timeout($self->timeout);

   # Set Agent, let them know who we be
   $client->ua->agent("Zcash::RPC::Client/" . $VERSION);

   # Turn on debugging for LWP::UserAgent
   if ($self->debug) {
      if (!$DEBUG_DUMPED) { # We only want to set this up once
         $client->ua->add_handler("request_send",  sub { shift->dump; return });
         $client->ua->add_handler("response_done", sub { shift->dump; return });
         $DEBUG_DUMPED = 1;
      }
   } else {# Don't print error message when debug is on.
      # We want to handle broken responses ourself
      $client->ua->add_handler("response_data",
         sub {
            my ($response, $ua, $h, $data) = @_;

            if ($response->is_error) {
               my $content = JSON->new->utf8->decode($data);
               print STDERR "error code: ";
               print STDERR $content->{error}->{code};
               print STDERR ", error message: ";
               print STDERR $content->{error}->{message} . " ($method)\n";
               exit(1);
            } else {
               # If no error then ditch the handler
               # otherwise things that did not error will get handled too
               $ua->remove_handler();
            }

            return;
         }
      );
   }

   # For self signed certs
   if ($self->verify_hostname eq 0) {
      $client->ua->ssl_opts( verify_hostname => 0,
                             SSL_verify_mode => 'SSL_VERIFY_NONE' );
   }

   my $obj = {
      method => $method,
      params => (ref $_[0] ? $_[0] : [@_]),
   };

   my $res = $client->call( $url, $obj );
   if($res) {
      if ($res->is_error) {
         return $res->error_message;
      }

      return $res->result;
   }

   return;
}

# function to setup cookie attrib
sub isa_cookie {

   my $failed = 0;

   # We only want to read this once (limit io).
   open COOKIE, $_[0] or $failed = 1;

   if ($failed) {
      print STDERR "Could not open RPC cookie file: " . $_[0];
      print STDERR "\n";
      exit(1);
   }

   my $cookie = ;
   close COOKIE;
   if (!defined($cookie) or $cookie !~ /:/) {
      print STDERR "Invalid RPC cookie file format\n";
      exit(1);
   }
   $cookie =~ s/\s+//g;
   $_[0] = $cookie;

}

1;

=pod

=head1 NAME

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

=head1 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

=head1 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:
L

=head1 CONSTRUCTOR

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

This method creates a new C 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

B - Address listens for JSON-RPC connections

B and B - User and Password for JSON-RPC api commands

B - 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.

B - TCP port for JSON-RPC connections

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

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

B - 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.

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

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

=head1 AVAILABILITY

The latest branch is avaiable from GitHub:
L

=head1 CAVEATS

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

=head1 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 C.

C is developed by Wesley Hinds. This Zcash fork is
mantained by Nils Knieling.

=head1 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:

L

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.


=cut