File Coverage

blib/lib/REFECO/Blockchain/Contract/Solidity/ABI/Decoder.pm

Criterion	Covered	Total	%
statement	37	39	94.8
branch	1	2	50.0
condition	2	4	50.0
subroutine	11	12	91.6
pod	2	6	33.3
total	53	63	84.1

use strict;
use warnings;
no indirect;

=head1 NAME

REFECO::Blockchain::Contract::Solidity::ABI::Decoder - Contract Application Binary Interface argument decoder

=head1 VERSION

Version 0.001

=cut

our $VERSION = '0.001';

=head1 SYNOPSIS

The Contract Application Binary Interface (ABI) is the standard way to interact
with contracts (Ethereum), this module aims to be an utility to encode the given
data according ABI type specification.

    my $decoder = REFECO::Blockchain::Contract::Solidity::ABI::Decoder->new();
    $decoder
        ->append('uint256')
        ->append('bytes[]')
        ->decode('0x...');
    ...

=head1 AUTHOR

Reginaldo Costa, C<< <refeco at cpan.org> >>

=head1 BUGS

Please report any bugs or feature requests to C<bug-refeco-blockchain-smartcontracts-solidity-abi-encoder at rt.cpan.org>, or through
the web interface at L<https://rt.cpan.org/NoAuth/ReportBug.html?Queue=REFECO-Blockchain-Contract-Solidity-ABI-Encoder>.  I will be notified, and then you'll
automatically be notified of progress on your bug as I make changes.

=head1 SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc REFECO::Blockchain::Contract::Solidity::ABI::Decoder


You can also look for information at:

=over 4

=item * RT: CPAN's request tracker (report bugs here)

L<https://rt.cpan.org/NoAuth/Bugs.html?Dist=REFECO-Blockchain-Contract-Solidity-ABI-Encoder>

=item * CPAN Ratings

L<https://cpanratings.perl.org/d/REFECO-Blockchain-Contract-Solidity-ABI-Encoder>

=item * Search CPAN

L<https://metacpan.org/release/REFECO-Blockchain-Contract-Solidity-ABI-Encoder>

=back


=head1 ACKNOWLEDGEMENTS


=head1 LICENSE AND COPYRIGHT

This software is Copyright (c) 2022 by Reginaldo Costa.

This is free software, licensed under:

  The Artistic License 2.0 (GPL Compatible)

=cut

use Carp;
use REFECO::Blockchain::Contract::Solidity::ABI::Type;
use REFECO::Blockchain::Contract::Solidity::ABI::Type::Tuple;

    my ($class, %params) = @_;

    my $self = {};
    bless $self, $class;
    return $self;
}

    my $self = shift;
    return $self->{instances} //= [];
}

    my $self = shift;
    return $self->{data};
}

=head2 append

Appends type signature

=over 4

=item * C<%param> type signature

=back

return same L<REFECO::Blockchain::Contract::Solidity::ABI::Decoder> instance

=cut

    my ($self, $param) = @_;

    push $self->instances->@*, REFECO::Blockchain::Contract::Solidity::ABI::Type::new_type(signature => $param);
    return $self;
}

=head2 encode

Decodes all appended type signatures

=over 4

=back

Array ref containing all decoded values

=cut

    my ($self, $hex_data) = @_;

    croak 'Invalid hexadecimal value ' . $hex_data // 'undef'
        unless $hex_data =~ /^(?:0x|0X)?([a-fA-F0-9]+)$/;

    my $hex  = $1;
    my @data = unpack("(A64)*", $hex);

    my $tuple = REFECO::Blockchain::Contract::Solidity::ABI::Type::Tuple->new;
    $tuple->{instances} = $self->instances;
    $tuple->{data}      = \@data;
    return $tuple->decode;
}

=head2 clean

Clean all the appended type signatures

=over 4

=back

undef

=cut

    my $self = shift;
    delete $self->{instances};
}

1;