crypto-markets/common

Common components for cryptocurrency exchange markets.

Common

, _(*1)

Introduction

We are accepting new adapters., _(*2)

Documentation

The "Common" package is without a function in its own right. The package keep and manage the common functionality for other market libraries., _(*3)

Let's pick a random market package to figure out how to use it. I choose the Binance package for this. You are feel free to use what you want., _(*4)

composer require crypto-markets/binance

All market packages contains the same request and response to maintain consistency. Only the configuration and some parameter values may be different., _(*5)

Let's start by creating a new instance:, _(*6)

use CryptoMarkets\Exchange;

$market = Exchange::create('Binance', [
    'api_key' => 'YOUR-APIKEY',
    'secret'  => 'YOUR-SECRET',
]);

In the above example, the Binance instance was created by configuring., _(*7)

Supported Common Methods

In this section, we will explain the supported methods that the market instance:, _(*8)

Testing

You will need an install of Composer before continuing., _(*9)

First, install the dependencies:, _(*10)

$ composer install

Then run PHPUnit:, _(*11)

$ vendor/bin/phpunit

If the test suite passes on your local machine you should be good to go., _(*12)

When you make a pull request, the tests will automatically be run again by Travis CI., _(*13)

We also have StyleCI setup to automatically fix any code style issues., _(*14)

Changelog

Please see CHANGELOG for more information what has changed recently., _(*15)

Contributing

Please see CONTRIBUTING for details., _(*16)

Security Vulnerabilities

If you discover any security related issues, please create a new issue with using the "Bug" label. All security vulnerabilities will be promptly addressed., _(*17)

License

The MIT License (MIT). Please see License File for more information., _(*18)