Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/exinone/mixin-sdk-php
Mixin-Network SDK for PHP
https://github.com/exinone/mixin-sdk-php
exinone mixin mixin-network mixin-network-sdk mixin-sdk-php php sdk
Last synced: about 1 month ago
JSON representation
Mixin-Network SDK for PHP
- Host: GitHub
- URL: https://github.com/exinone/mixin-sdk-php
- Owner: ExinOne
- License: mit
- Created: 2018-12-04T10:38:41.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-28T11:54:20.000Z (about 1 month ago)
- Last Synced: 2024-05-29T02:56:34.360Z (about 1 month ago)
- Topics: exinone, mixin, mixin-network, mixin-network-sdk, mixin-sdk-php, php, sdk
- Language: PHP
- Homepage:
- Size: 315 KB
- Stars: 24
- Watchers: 9
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: readme-cn.md
- License: LICENSE
Lists
- awesome-mixin - Mixin SDK PHP - A Mixin-Network SDK for PHP, provided by Exin.One, widely used in Exin's products. (SDK / 3rd-party SDK)
README
# Mixin-SDK-PHP
------
[](readme.md)
Mixin-Network SDK for PHP
## 要求
1. `Composer`
2. `PHP` >= 7.0
## Installation
```bash
$ composer require exinone/mixin-sdk-php -vvv
```
## 使用
### 例示
```php
// 配置文件格式示例
// 通过 Mixin 开发者后台的会话密钥部分来生成
$config0 = [
"app_id" => "d4155247-xxxx-xxxx-aa8a-775333b12406",
"session_id" => "7a633a3f-xxxx-xxxx-99b9-ae43c88be4be",
"server_public_key" => "556b82842exxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxa6d8ad8af3f2649474",
"session_private_key" => "154cd8dceaxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx24d070b1acc880a13b",
"spend_key" => "f86d9dd3faxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxc64e8bc7c5aef6a0a4", // 注册应用钱包时备份的spend key
"client_secret" => "fdbe66249axxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxcc4519a4ea20d48b7e" // 授权密钥
];
// 旧版配置文件格式
$config1 = [
'mixin_id' => '7000101633',
'client_id' => '982afd4e-92dd-4430-98cf-d308442ea04d',
'client_secret' => 'b0a9adf1b358501b1fb6065c6292b09dbc675d5734225f86e0ec14a71d0fd38a',
'pin' => '125334',
'pin_token' => 'RzgyepFhLbMx+zLw6ogYzZ5k+kmlo8gQ2f4+1uwGMi1HgvMexGdFdeny0ffuBl7gXgPqi1GpUDPWPNrgAIjwGIFu+rHSre1G7JA5ET6tgIYoC+OI2dF0PmNK0qtkjK+qpGpSCt8nFbTfgyHjFENAp4hLZEIhuhzSPPmkkhXGlAU=',
'session_id' => '8a70b414-bdef-46f3-9738-186c1095da61',
'private_key' => <<setConfig('myConfig-A',$config0);
$mixinSdk->setConfig('myConfig-B',$config1);
// 在之后的调用中你就可以
$mixinSdk->use('myConfig-A')->user()->readProfile();
//-------
// 或者更加简洁一些，直接使用 use 方法后，链式调用其他方法
$mixinSdk->use('myConfig-A',$config)->user()->readProfile();
// 在之后的调用中你就可以
$mixinSdk->use('myConfig-A')->user()->readProfile();
```
### 调用
| code | description | module | Mixin Network Docs |
| --------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------ |
| `MixinSDK::pin()->updatePin($oldPin, $pin)` | 更新 Pin 码 | Pin | [link](https://developers.mixin.one/docs/api/pin/pin-update) |
| `MixinSDK::pin()->verifyPin($pin)` | 验证 Pin 码 | Pin | [link](https://developers.mixin.one/docs/api/pin/pin-verify) |
| **---** | **--** | **--** | |
| **---** | **--** | **--** | |
| **---** | **--** | **--** | |
| `MixinSDK::user()->readProfile()` | 读取当前账号信息 | User | [link](https://developers.mixin.one/docs/api/users/profile) |
| `MixinSDK::user()->updateProfile(string $full_name, string $avatar_base64 = '')` | 更新账号信息 | User | [link](https://developers.mixin.one/docs/api/users/profile) |
| `MixinSDK::user()->updatePreferences(string $receive_message_source, string $accept_conversation_source)` | 更新隐私设置 | User | [link](https://developers.mixin.one/docs/api/users/profile) |
| `MixinSDK::user()->rotateQRCode()` | 更换 QRCode | User | [link](https://developers.mixin.one/docs/api/users/profile) |
| `MixinSDK::user()->readFriends()` | read friends | User | [link](https://developers.mixin.one/docs/api/users/contacts) |
| `MixinSDK::user()->addFavoriteApp(string $user_id)` | 增加 App 至喜欢列表 | User | [link](https://developers.mixin.one/docs/api/shared-bots) |
| `MixinSDK::user()->removeFavoriteApp(string $user_id)` | 从喜欢列表中删除 App | User | [link](https://developers.mixin.one/docs/api/shared-bots) |
| `MixinSDK::user()->readFavoriteApps(string $user_id = null)` | 读取喜欢列表 | User | [link](https://developers.mixin.one/docs/api/shared-bots) |
| **---** | **--** | **--** | |
| **---** | **--** | **--** | |
| **---** | **--** | **--** | |
| `MixinSDK::wallet()->createAddress(string $asset_id, string $destination, $pin, $label, $tag)` | 创建一个 address | Wallet | [link](https://developers.mixin.one/docs/api/withdrawal/address-add) |
| `MixinSDK::wallet()->readAddresses(string $assetId)` | 获取某个 asset 的全部地址 | Wallet | [link](https://developers.mixin.one/docs/api/withdrawal/addresses) |
| `MixinSDK::wallet()->readAddress(string $addressId)` | 获取某个 address 的信息 | Wallet | [link](https://developers.mixin.one/docs/api/withdrawal/address) |
| `MixinSDK::wallet()->deleteAddress(string $addressId, $pin = null)` | 删除一个 address | Wallet | [link](https://developers.mixin.one/docs/api/withdrawal/address-delete) |
| `MixinSDK::wallet()->readAssets()` | 获取当前用户全部的 assets 信息 | Wallet | [link](https://developers.mixin.one/docs/api/assets) |
| `MixinSDK::wallet()->readAsset(string $assetId)` | 获取当前用户某个 asset 的信息 | Wallet | [link](https://developers.mixin.one/docs/api/assets/asset) |
| `MixinSDK::wallet()->deposit(string $assetId)` | deposit (The api same as `wallet()->readAsset`) | Wallet | [link](https://developers.mixin.one/docs/api/assets/asset) |
| `MixinSDK::wallet()->withdrawal(string $addressId, $amount, $pin, $memo = '', $trace_id = null)` | 转账到某个 address | Wallet | [link](https://developers.mixin.one/docs/api/withdrawal) |
| `MixinSDK::wallet()->transfer(string $assetId, string $opponentId, $pin, $amount, $memo = '', $trace_id = null)` | 转账给某个用户 | Wallet | [link](https://developers.mixin.one/docs/api/transfer) |
| `MixinSDK::wallet()->verifyPayment(string $asset_id, string $opponent_id, $amount, string $trace_id)` | verify payment | Wallet | [link](https://developers.mixin.one/docs/api/transfer/payment) |
| `MixinSDK::wallet()->readTransfer(string $traceId)` | 获取转账详情 | Wallet | [link](https://developers.mixin.one/docs/api/transfer) |
| `MixinSDK::wallet()->readAssetFee(string $assetId)` | 获取资产提现费率 | Wallet | [link](https://developers.mixin.one/docs/api/assets/fee) |
| `MixinSDK::wallet()->readUserSnapshots($limit = null, string $offset = null, string $asset = '', string $order = 'DESC')` | 获取当前用户某个资产全部的 snapshots | Wallet | [link](https://developers.mixin.one/docs/api/network/snapshots) |
| `MixinSDK::wallet()->readUserSnapshot(string $snapshotId)` | 获取当前用户某个 snapshot 的信息 | Wallet | [link](https://developers.mixin.one/docs/api/network/snapshot) |
| `MixinSDK::wallet()->accessTokenGetUserSnapshots(string $access_token, $limit = null, string $offset = null, string $asset = '', string $order = 'DESC')` | 获取当前用户某个资产全部的 snapshots | Wallet | [link](https://developers.mixin.one/docs/api/network/snapshots) |
| `MixinSDK::wallet()->accessTokenGetUserSnapshot(string $access_token, string $snapshot_id)` | 获取当前用户某个 snapshot 的信息 | Wallet | [link](https://developers.mixin.one/docs/api/network/snapshot) |
| `MixinSDK::wallet()->accessTokenGetTransfer(string $access_token, string $trace_id)` | 获取转账详情 | Wallet | [link](https://developers.mixin.one/docs/api/transfer/snapshot) |
| `MixinSDK::wallet()->readRawMainNetAddress(string $client_id)` | 获取转账地址 | Wallet | |
| `MixinSDK::wallet()->accessTokenPostOutputs($access_token, $receivers, $index = 0)` | 获取转账地址 | Wallet | [link](https://developers.mixin.one/docs/api/outputs) |
| `MixinSDK::wallet()->multisigPayment(string $asset_id, array $receivers, int $threshold, $amount, $memo = '', $trace_id = null)` | 发起多签 | Wallet | [link](https://developers.mixin.one/docs/api/transfer/payment) |
| `MixinSDK::wallet()->checkCode($code_id)` | 查看支付详情 | Wallet | |
| `MixinSDK::wallet()->readMultisigs(string $offset = '', $limit = null)` | 查看所有多签 | Wallet | [link](https://developers.mixin.one/docs/api/multisigs/outputs) |
| `MixinSDK::wallet()->accessTokenPostMultisigs(string $access_token, string $raw, string $action = 'sign')` | 发起多签交易请求 | Wallet | [link](https://developers.mixin.one/docs/api/multisigs/outputs) |
| `MixinSDK::wallet()->externalProxy($params, $method = 'sendrawtransaction')` | 提取资产 | Wallet | [link](https://developers.mixin.one/docs/api/multisigs/request) |
| `MixinSDK::wallet()->postMultisigs(string $raw, string $action = 'sign')` | 发起多签交易请求 | Wallet | [link](https://developers.mixin.one/docs/api/multisigs/request) |
| `MixinSDK::wallet()->multisigsRequests(string $raw, string $action = 'sign')` | 发起多签交易请求 | Wallet | [link](https://developers.mixin.one/docs/api/multisigs/request) |
| `MixinSDK::wallet()->multisigsRequestsSign(string $request_id, String $pin)` | 签名 | Wallet | [link](https://developers.mixin.one/docs/api/multisigs/request) |
| `MixinSDK::wallet()->multisigsRequestsCancel(string $request_id, String $pin)` | 取消签名 | Wallet | [link](https://developers.mixin.one/docs/api/multisigs/request) |
| `MixinSDK::wallet()->multisigsRequestsUnlock(string $request_id, String $pin)` | 取消多签交易 | Wallet | [link](https://developers.mixin.one/docs/api/multisigs/request) |
| `MixinSDK::wallet()->multisigsSign(string $request_id, String $pin)` | 签名 | Wallet | [link](https://developers.mixin.one/docs/api/multisigs/request) |
| `MixinSDK::wallet()->multisigsCancel(string $request_id, String $pin)` | 取消签名 | Wallet | [link](https://developers.mixin.one/docs/api/multisigs/request) |
| `MixinSDK::wallet()->readFiats()` | 法币对应美元汇率 | Wallet | |
| **---** | **--** | **--** | |
| **---** | **--** | **--** | |
| **---** | **--** | **--** | |
| `MixinSDK::network()->readUser($userId)` | 获取某个用户的信息 | Network | [link](https://developers.mixin.one/docs/api/users/user) |
| `MixinSDK::network()->readUsers(array $userIds)` | 获取多个用户的信息 | Network | [link](https://developers.mixin.one/docs/api/users) |
| `MixinSDK::network()->searchUser($item)` | search user | Network | [link](https://developers.mixin.one/docs/api/users/search) |
| `MixinSDK::network()->readNetworkAsset(string $assetId)` | read network asset | Network | [link](https://developers.mixin.one/docs/api/network/assets) |
| `MixinSDK::network()->readNetworkSnapshots($limit = null, string $offset = null, string $asset = '', string $order = 'DESC')` | read network snapshots | Network | [link](https://developers.mixin.one/docs/api/network/snapshots) |
| `MixinSDK::network()->readNetworkSnapshot(string $snapshotId)` | read network snapshot | Network | [link](https://developers.mixin.one/docs/api/network/snapshot) |
| `MixinSDK::network()->createUser($fullName)` | 在 Mixin Network 上创建用户 | Network | [link](https://developers.mixin.one/docs/api/users/network-user) |
| `MixinSDK::network()->externalTransactions($asset, $destination, $limit, $offset, $tag, $transaction_hash, $source, $user)` | read external transactions | Network | [link](https://developers.mixin.one/docs/api/external/pending-deposits) |
| `MixinSDK::network()->createAttachments()` | create attachments | Network | [link](https://developers.mixin.one/docs/api/messages/attachment-upload) |
| `MixinSDK::network()->mixinNetworkChainsSyncStatus()` | 获取 Mixin Network 当前的区块同步状态 | Network | |
| `MixinSDK::network()->topAsset()` | top asset | Network | [link](https://developers.mixin.one/docs/api/network/assets) |
| `MixinSDK::network()->multisigAsset()` | multisig asset | Network | [link](https://developers.mixin.one/docs/api/network/assets) |
| `MixinSDK::network()->requestAccessToken(string $code)` | use code request access token | Network | [link](https://developers.mixin.one/docs/api-overview) |
| `MixinSDK::network()->accessTokenGetInfo(string $access_token)` | use access token get info | Network | [link](https://developers.mixin.one/docs/api-overview) |
| `MixinSDK::network()->accessTokenGetAssets(string $access_token)` | use access token get assets info | Network | [link](https://developers.mixin.one/docs/api-overview) |
| `MixinSDK::network()->accessTokenGetAddresses(string $access_token, string $assetId)` | use access token get addresses | Network | [link](https://developers.mixin.one/docs/api-overview) |
| `MixinSDK::network()->accessTokenGetAddress(string $access_token, string $addressId)` | use access token get an addresseses | Network | [link](https://developers.mixin.one/docs/api-overview) |
| `MixinSDK::network()->accessTokenGetContacts(string $access_token)` | use access token get contact info | Network | [link](https://developers.mixin.one/docs/api-overview) |
| `MixinSDK::network()->createConversations($category, $participants, $conversation_id, $name)` | 创建群聊 | Network | [link](https://developers.mixin.one/docs/api/conversations/create) |
| `MixinSDK::network()->readConversations($conversation_id)` | 获取群聊 | Network | [link](https://developers.mixin.one/docs/api/conversations/read) |
| `MixinSDK::network()->participantsActions(string $conversation_id, array $participants, string $action = "ADD")` | 管理群聊 | Network | [link](https://developers.mixin.one/docs/api/conversations/group) |
| `MixinSDK::network()->rotateConversation(string $conversation_id)` | 刷新群邀请链接 | Network | [link](https://developers.mixin.one/docs/api/conversations/create) |
| `MixinSDK::network()->searchAssets($q)` | 搜索资产 | Network | [link](https://developers.mixin.one/docs/api/assets/asset) |
| `MixinSDK::network()->readHistoricalPrices(string $asset, string $offset)` | 获取历史价格 | Network | [link](https://developers.mixin.one/docs/api/network/ticker) |
| **---** | **---** | **---** | |
| **---** | **--** | **--** | |
| `MixinSDK::message()->sendText($user_id, $data, $category, $conversation_id, $recipient_id)` | 发送文本消息 | Message | [link](https://developers.mixin.one/docs/api/messages/send) |
| `MixinSDK::message()->sendContact($user_id, $contact_id, $category, $conversation_id, $recipient_id)` | 发送用户名片 | Message | [link](https://developers.mixin.one/docs/api/messages/send) |
| `MixinSDK::message()->sendAppButtonGroup($user_id, $data, $category, $conversation_id, $recipient_id)` | 发送 App Button Group (最多三个) | Message | [link](https://developers.mixin.one/docs/api/messages/send) |
| `MixinSDK::message()->sendAppCard($user_id, $data, $category, $conversation_id, $recipient_id)` | 发送 App Card | Message | [link](https://developers.mixin.one/docs/api/messages/send) |
| `MixinSDK::message()->askMessageReceipt($message_id)` | 确认消息是否送达 | Message | [link](https://developers.mixin.one/docs/api/messages/send) |
| `MixinSDK::message()->sendBatchMessage($user_id, $data, $use_http, $type)` | 群发消息 | Message | [link](https://developers.mixin.one/docs/api/messages/send) |
| **---** | **--** | **--** | |
| **---** | **--** | **--** | |
| **---** | **--** | **--** | |
| `MixinSDK::getOauthUrl($user_id, $data, $category = 'CONTACT', $conversation_id = null)` | 获取 Oauth Url | other | [link](https://developers.mixin.one/docs/api-overview) |
| `MixinSDK::getPayUrl($asset_id, $amount, $trace_id, $memo, $client_id = null)` | 生成一个支付 Url | other | [link](https://developers.mixin.one/docs/api-overview) |
| `MixinSDK::getConfig($configGroupName='')` | 查看一个或者全部配置 | other | |
## 异常
在 MixinNetwork 的返回体中如果存在 error ，则会直接抛出一个 `ExinOne\MixinSDK\Exceptions\MixinNetworkRequestException` 异常。使用者需要对这个异常进行捕获并处理。
```php
try {
//如果这里转账失败将会抛出错误
$mixinSdk->wallet()->transfer($asset_id, $opponent_id, $pin, $amount, $memo);
} catch (MixinNetworkRequestException $e) {
// 此处的 errCode 和 errMessage 与 MixinNetwork 一致，可以参阅下方官方链接
$errCode = $e->getCode();
$errMessage = $e->getMessage();
...
} catch (\Throwable $e) {
...
}
```
[MixinNetwork Error Codes](https://developers.mixin.one/docs/api/error-codes)
### 其他的异常
| class | description |
| ---------------------------------------------------------- | --------------- |
| `ExinOne\MixinSDK\Exceptions\MixinNetworkRequestException` | Api 请求失败 |
| `ExinOne\MixinSDK\Exceptions\NotFoundConfigException` | 未找到指定的配置组 |
| `ExinOne\MixinSDK\Exceptions\LoadPrivateKeyException` | 私钥格式等错误 |
| `ExinOne\MixinSDK\Exceptions\ClassNotFoundException` | 寻找指定的 module 失败 |
## WARNING
1. 进行如下操作可以配置 `iterator`, 在加密 PIN 时会使用到这个变量。在大部分时候，这个变量基本不需要修改。如果需要修改这个变量，请务必知道你在做什么。[关于 iterator 更详细的说明](https://developers.mixin.one/docs/dapp/guide/pin#encrypting-pin)
```php
$mixinSdk->wallet()->setIterator($iterator)->transfer($asset_id, $opponent_id, $pin, $amount, $memo);
// 默认使用 ( microtime(true) . 随机数 ) * 1000000000 作为 iterator
```
2. 设定 Http Request 超时时间
```php
$iterator = [time()];
// 如果是在 $mixinSdk->pin()->updatePin($oldPin,$pin) 中使用,
// $iterator 需要是有两个元素的数组, 即 count($iterator) == 2
$mixinSdk->wallet()->setTimeout(10)->transfer($asset_id, $opponent_id, $pin, $amount, $memo);
// 默认超时时间为 20s
```
3. 获取原始结果
```php
$mixinSdk->wallet()->setRaw(true)->transfer($asset_id, $opponent_id, $pin, $amount, $memo);
// 返回 MixinNetwork 原始 Response 内容
```
## Alternatives
[[exinone/laravel-mixin-sdk](https://github.com/ExinOne/laravel-mixin-sdk)]
[[zamseam/mixin](https://github.com/zamseam/mixin)]
## LICENSE
**MIT**