Initial Commit

Author: CryptAPI

.gitignore

@@ -0,0 +1,65 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.cache
+nosetests.xml
+coverage.xml
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+README.rst
+venv
+
+
+# IDE stuff
+
+.idea
+
+# Test DB
+
+*.sqlite3

LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 CryptAPI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

MANIFEST.in

@@ -0,0 +1,3 @@
+include README.md
+recursive-include cryptapi *.html
+

README.md

@@ -0,0 +1,109 @@
+# CryptAPI's PHP Library
+Official PHP library of CryptAPI
+
+## Requirements:
+
+```
+PHP >= 5.5
+PHP Curl
+```
+
+
+
+## Install
+
+
+```
+git clone https://github.com/cryptapi/php-cryptapi
+```
+
+[on GitHub](https://github.com/cryptapi/php-cryptapi)
+
+## Usage
+
+### Generating a new address
+
+```php
+<?php
+require ('cryptapi.php');
+
+$ca = new Cryptapi($coin, $my_address, $callback_url, $parameters, $pending);
+$payment_address = $ca->get_address();
+```
+
+Where:
+
+``$coin`` is the coin you wish to use, can be one of: ``['btc', 'eth', 'bch', 'ltc', 'iota', 'xmr']``  
+
+``$my_address`` is your own crypto address, where your funds will be sent to  
+
+``$callback_url`` is the URL that will be called upon payment
+
+``$parameters`` is any parameter you wish to send to identify the payment, such as ``['order_id' => 1234]``
+
+``$pending`` if you want to be notified of pending transactions.
+
+``$payment_address`` is the newly generated address, that you will show your users
+
+
+### Getting notified when the user pays
+
+The URL you provided earlier will be called when a user pays, for easier processing of the request we've added the ``process_callback`` helper
+
+```php
+<?php
+require ('cryptapi.php');
+
+$payment_data = Cryptapi::process_callback($_GET, $convert);
+```
+
+Where:
+
+`$convert` is a boolean to whether to convert to the main coin denomination.
+
+&nbsp;
+
+The `$payment_data` will be an array with the following keys:
+
+`address_in` - the address generated by our service, where the funds were received
+
+`address_out` - your address, where funds were sent
+
+`txid_in` - the received TXID
+
+`txid_out` - the sent TXID or null, in the case of a pending TX
+
+`confirmations` - number of confirmations, or 0 in case of pending TX
+
+`value` - the value that your customer paid
+
+`value_forwarded` - the value we forwarded to you, after our fee
+
+`coin` - the coin the payment was made in, one of: ``['btc', 'eth', 'bch', 'ltc', 'iota', 'xmr']``
+
+`pending` - whether the transaction is pending, if `false` means it's confirmed
+
+plus, any values set on `$params` when requesting the address, like the order ID.
+
+&nbsp;
+
+From here you just need to check if the value matches your order's value.
+
+
+### Checking the logs of a request
+
+```php
+<?php
+require ('cryptapi.php');
+
+$ca = new Cryptapi($coin, $my_address, $callback_url, $parameters);
+$data = $ca->check_logs();
+```
+
+Same parameters as before, the `$data` returned can be checked here: https://cryptapi.io/docs/#/Bitcoin/btclogs
+
+
+## Help
+
+Need help?  
+Contact us @ https://cryptapi.io/contact/

cryptapi.php

@@ -0,0 +1,110 @@
+<?php
+
+class Cryptapi {
+    private $base_url = "https://cryptapi.io/api";
+    private $valid_coins = ['btc', 'bch', 'eth', 'ltc', 'xmr', 'iota'];
+    private $own_address = null;
+    private $callback_url = null;
+    private $coin = null;
+    private $pending = false;
+    private $parameters = [];
+
+    public static $COIN_MULTIPLIERS = [
+        'btc' => 100000000,
+        'bch' => 100000000,
+        'ltc' => 100000000,
+        'eth' => 1000000000000000000,
+        'iota' => 1000000,
+        'xmr' => 1000000000000,
+    ];
+
+    public function __construct($coin, $own_address, $callback_url, $parameters=[], $pending=false) {
+
+        if (!in_array($coin, $this->valid_coins)) {
+            $vc = print_r($this->valid_coins, true);
+            throw new Exception("Unsupported Coin: {$coin}, Valid options are: {$vc}");
+        }
+
+        $this->own_address = $own_address;
+        $this->callback_url = $callback_url;
+        $this->coin = $coin;
+        $this->pending = $pending ? 1 : 0;
+        $this->parameters = $parameters;
+
+    }
+
+    public function get_address() {
+
+        if (empty($this->own_address) || empty($this->coin) || empty($this->callback_url)) return null;
+
+        $ca_params = [
+            'callback' => $this->callback_url,
+            'address' => $this->own_address,
+            'pending' => $this->pending,
+        ];
+
+        $response = $this->_request('create', array_merge($ca_params, $this->parameters));
+
+        if ($response->status == 'success') {
+            return $response->address_in;
+        }
+
+        return null;
+    }
+
+    public function check_logs() {
+
+        if (empty($this->coin) || empty($this->callback_url)) return null;
+
+        $params = [
+            'callback' => $this->callback_url,
+        ];
+
+        $response = $this->_request('logs', $params);
+
+        if ($response->status == 'success') {
+            return $response;
+        }
+
+        return null;
+    }
+
+    public static function process_callback($_get, $convert=false) {
+        $params = [
+            'address_in' => $_get['address_in'],
+            'address_out' => $_get['address_out'],
+            'txid_in' => $_get['txid_in'],
+            'txid_out' => isset($_get['txid_out']) ? $_get['txid_out'] : null,
+            'confirmations' => $_get['confirmations'],
+            'value' => $convert ? Cryptapi::convert($_get['value'], $_get['coin']) : $_get['value'],
+            'value_forwarded' => isset($_get['value_forwarded']) ? ($convert ? Cryptapi::convert($_get['value_forwarded'], $_get['coin']) : $_get['value_forwarded']) : null,
+            'coin' => $_get['coin'],
+            'pending' => isset($_get['pending']) ? $_get['pending'] : false,
+        ];
+        
+        foreach ($_get as $k => $v) {
+            if (isset($params[$k])) continue;
+            $params[$k] = $_get[$k];
+        }
+
+        return $params;
+    }
+
+    public static function convert($val, $coin) {
+        return $val / Cryptapi::$COIN_MULTIPLIERS[$coin];
+    }
+
+    private function _request($endpoint, $params) {
+
+        $data = http_build_query($params);
+        $url = "{$this->base_url}/{$this->coin}/{$endpoint}/?{$data}";
+
+        $ch = curl_init();
+        curl_setopt($ch, CURLOPT_URL, $url);
+        curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
+        $response = curl_exec($ch);
+        curl_close($ch);
+
+        return json_decode($response);
+    }
+}