NAME

Sah::Schema::cryptoexchange::currency_pair - Currency pair, e.g. LTC/USD

VERSION

This document describes version 0.015 of Sah::Schema::cryptoexchange::currency_pair (from Perl distribution Sah-Schemas-CryptoCurrency), released on 2020-03-08.

SYNOPSIS

Using with Data::Sah:

use Data::Sah qw(gen_validator);
my $vdr = gen_validator("cryptoexchange::currency_pair*");
say $vdr->($data) ? "valid" : "INVALID!";

# Data::Sah can also create a validator to return error message, coerced value,
# even validators in other languages like JavaScript, from the same schema.
# See its documentation for more details.

Using in Rinci function metadata (to be used with Perinci::CmdLine, etc):

package MyApp;
our %SPEC;
$SPEC{myfunc} = {
    v => 1.1,
    summary => 'Routine to do blah ...',
    args => {
        arg1 => {
            summary => 'The blah blah argument',
            schema => ['cryptoexchange::currency_pair*'],
        },
        ...
    },
};
sub myfunc {
    my %args = @_;
    ...
}

DESCRIPTION

Currency pair is string in the form of currency1/currency2, where currency1 is called the base currency and must be a known cryptocurrency code (e.g. LTC) while currency2 is the quote (or price) currency and must be a known fiat currency or a known cryptocurrency code (e.g. USD, or BTC).

Cryptocurrency code is checked against catalog in CryptoCurrency::Catalog, while fiat currency code is checked against Locale::Codes::Currency_Codes.

Will be normalized to uppercase.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Sah-Schemas-CryptoCurrency.

SOURCE

Source repository is at https://github.com/perlancar/perl-Sah-Schemas-CryptoCurrency.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Sah-Schemas-CryptoCurrency

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2020, 2019, 2018 by perlancar@cpan.org.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.