Skip to content
This repository has been archived by the owner on May 6, 2021. It is now read-only.

Latest commit

 

History

History
115 lines (86 loc) · 4.92 KB

README.md

File metadata and controls

115 lines (86 loc) · 4.92 KB

laravel-exincore-sdk


Requirement

  1. Laravel >= 5.1
  2. Composer
  3. PHP >= 7.0

Installation

$ composer require kurisu/laravel-exincore-sdk -vvv

配置

  1. 如果你的 Laravel >= 5.5,可跳过第一步,从第二步开始即可。否则需要在 config/app.php 中注册 ServiceProvider 和 Facade。
'providers' => [
    ...
    Kurisu\ExinCore\ExinCoreServiceProvider::class,
],
'aliases' => [
    ...
    'MixinSDK' => Kurisu\ExinCore\Facades\ExinCore::class,
]
  1. 创建配置文件
$ php artisan vendor:publish --provider="Kurisu\ExinCore\ExinCoreServiceProvider"
  1. 填写配置,你可以选择如下几种方法中的一种来配置
    1. 填写 config/exincore.php.env 配置

      // 账号配置信息
         'mixin_id'      => env('MIXIN_SDK_MIXIN_ID'),       //
         'client_id'     => env('MIXIN_SDK_CLIENT_ID'),      //
         'client_secret' => env('MIXIN_SDK_CLIENT_SECRET'),  //
         'pin'           => env('MIXIN_SDK_PIN'),            //
         'pin_token'     => env('MIXIN_SDK_PIN_TOKEN'),      //
         'session_id'    => env('MIXIN_SDK_SESSION_ID'),     //
         'private_key'   => '',                              //import your private_key

      此后,调用时就自动载入以上配置。

      如果不想私钥被记录到 VCS 中,可以参考此处进行配置

    2. 你也可以不在 config/exincore.php 中进行任何配置,以如下方式调用即可

      // 使用 setConfig 方法,保存配置
      ExinCore::getMixinSDK()->setConfig('default',$config);
    3. 你也可以在项目中封装自己的方法来更加方便的切换配置。

使用

例示

// 1. 查询指定交易对的行情
$baseAsset     = 'c94ac88f-4671-3976-b60a-09064f1811e8';   // uuid
$exchangeAsset = '815b0b1a-2764-3736-8faa-42d694fa620a';   // uuid

ExinCore::readExchangeList();                              // 查询全部交易对的行情
ExinCore::readExchangeList($baseAsset);                    // 查询 baseAsset 为 $baseAsset 的交易对的行情
ExinCore::readExchangeList($baseAsset, $exchangeAsset);    // 查询 baseAsset 为 $baseAsset , exchangeAsset 为 $exchangeAsset 的交易对的行情


// 2. 创建订单
ExinCore::createOrder($baseAsset, $exchangeAsset, 1);

调用

code description
ExinCore::readExchangeList($baseAsset = null, $exchangeAsset = null) 查询指定交易对的行情
ExinCore::createOrder($baseAsset, $exchangeAsset, $amount) 创建订单

WARNING

有三个不太重要的可配置项

  1. 是否需要返回原始响应体

    ExinCore::setRaw(true);    // or false , 默认为 false
  2. 如果 Mixin Network Api 返回错误码,是否抛出异常

    ExinCore::setBoom(false);  // or true , 默认为 true
  3. 设置网络请求超时时间

    ExinCore::setTimeout(6);   // 默认为 10

Alternatives

[kurisu/exincore-php-sdk]

LICENSE

MIT