Mixin-Network SDK for PHP
Composer-
PHP>= 7.0
$ composer require exinone/mixin-sdk-php -vvv// config format
$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",
"client_secret" => "fdbe66249axxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxcc4519a4ea20d48b7e"
];
// old format is also supported
$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' => <<<EOF
-----BEGIN RSA PRIVATE KEY-----
MIICXQIBAAKBgQCZAkpYA7eH38GbzIX653dxBAEanrSSdYbzQYIV/kKbULYSB43X
5hWfCFpNJ6FoIUjHAzrNyqJMvSS6LwAA+R4w5GYv8en1Ga1blKbziCMvZsRJ65bP
F2cPbPQUYNWZpZRsyFlMZCjVVytA1a+HWba5FzGBXiEEzd5BVo9truxGKQIDAQAB
AoGBAJHpVj4ipUWEgtvxKR9A1m1G9UqOaAJ2409cfBI/GwOD72y4GXL2rk2vKHYF
Qe3MN9vY353aC/YENV77bRSAfGF+lAuw3hQOFfMvKfRUmVaB5V4kEaF1+z9jPHwh
QcSpqyAsMClEnyMxbNrFih4tQGlGUydHI3xv1wK+53MjncwBAkEA98GvzldsLW7E
dhwXLba3KN/GvLZLcljLyHjctUxCU8EywD73UM1lJuayWvYdLfzFe0p9cDjvS8Gx
sbYg3eE2qQJBAJ4ZkqVbdCAyUBpjaIO9QzxsL77zCgayrQTvWv0QQgJputO7S2rs
i/iCmt1bZ3IAnfVnDUJfAaxSL6VU1T6Fw4ECQQCtUvrCx7YOMqeOWSh9+o04MxS9
gGpXnHcz0BnXW3orTcVLaMFr7cUN6eZsbDENswAUuI/4qlv+C4tcX6Wuk5fBAkA+
EggzB37GDTrJwXGNF0dId6kfLMgo7QlkwJxWcoWX8O66pfPsHMavYIdwlKw+Y+Og
Lz9TaX18rB+sp2u5SkcBAkBIsC/AJNhf1xILLAkkpycJ7rc864Y1JbmKk+I5fXid
vA4vKPqu2ZnD0O4YbGmciuTRPgeJqAt8bbHq/xOfL0lE
-----END RSA PRIVATE KEY-----
EOF
, //import your private_key
];
$mixinSdk = new \ExinOne\MixinSDK\MixinSDK();
// use setConfig method to save config
$mixinSdk->setConfig('myConfig-A',$config0);
$mixinSdk->setConfig('myConfig-B',$config1);
// then you can
$mixinSdk->use('myConfig-A')->user()->readProfile();
//-------
// Or more simple way, using the 'use' method , chained with other methods
$mixinSdk->use('myConfig-A',$config)->user()->readProfile();
// then you can
$mixinSdk->use('myConfig-A')->user()->readProfile();| code | description | module | Mixin Network Docs |
|---|---|---|---|
MixinSDK::pin()->updatePin($oldPin, $pin) |
Update Pin code | Pin | link |
MixinSDK::pin()->verifyPin($pin) |
Verify Pin code | Pin | link |
| --- | -- | -- | |
| --- | -- | -- | |
| --- | -- | -- | |
MixinSDK::user()->readProfile() |
Read self profile | User | link |
MixinSDK::user()->updateProfile(string $full_name, string $avatar_base64 = '') |
Update user’s profile. | User | link |
MixinSDK::user()->updatePreferences(string $receive_message_source, string $accept_conversation_source) |
Update user’s preferences. | User | link |
MixinSDK::user()->rotateQRCode() |
Rotate user’s code_id. | User | link |
MixinSDK::user()->readFriends() |
Get user’s friends. | User | link |
MixinSDK::user()->addFavoriteApp(string $user_id) |
Add app to favorite app list. | User | link |
MixinSDK::user()->removeFavoriteApp(string $user_id) |
Remove app from favorite app list. | User | link |
MixinSDK::user()->readFavoriteApps(string $user_id = null) |
Returns the favorite apps are recommended by the user. | User | link |
| --- | -- | -- | |
| --- | -- | -- | |
| --- | -- | -- | |
MixinSDK::wallet()->createAddress(string $asset_id, string $destination, $pin, $label, $tag) |
Create an address for withdrawal | Wallet | link |
MixinSDK::wallet()->readAddresses(string $assetId) |
Read addresses by asset ID. | Wallet | link |
MixinSDK::wallet()->readAddress(string $addressId) |
Read an address by ID. | Wallet | link |
MixinSDK::wallet()->deleteAddress(string $addressId, $pin = null) |
Delete an address by ID. | Wallet | link |
MixinSDK::wallet()->readAssets() |
Read user’s all assets in old mainnet. | Wallet | link |
MixinSDK::wallet()->safeReadAssets() |
Read user’s all assets in Safe mainnet. | Wallet | link |
MixinSDK::wallet()->readAsset(string $assetId) |
Read asset by ID in old mainnet. | Wallet | link |
MixinSDK::wallet()->safeReadAsset(string $assetId) |
Read asset by ID in Safe mainnet. | Wallet | link |
MixinSDK::wallet()->deposit(string $assetId) |
Gant an asset’s deposit address (The api same as wallet()->readAsset) |
Wallet | link |
MixinSDK::wallet()->withdrawal(string $addressId, $amount, $pin, $memo = '', $trace_id = null) |
Get assets out of Mixin Network | Wallet | link |
MixinSDK::wallet()->transfer(string $assetId, string $opponentId, $pin, $amount, $memo = '', $trace_id = null) |
Transfer of assets between Mixin Network users. | Wallet | link |
MixinSDK::wallet()->verifyPayment(string $asset_id, string $opponent_id, $amount, string $trace_id) |
Verify a transfer | Wallet | link |
MixinSDK::wallet()->readTransfer(string $traceId) |
Read transfer by trace ID. | Wallet | link |
MixinSDK::wallet()->readAssetFee(string $assetId) |
Read transfer fee | Wallet | link |
MixinSDK::wallet()->readUserSnapshots($limit = null, string $offset = null, string $asset = '', string $order = 'DESC') |
Get user's all snapshots. | Wallet | link |
MixinSDK::wallet()->readUserSnapshot(string $snapshotId) |
Get user's a snapshots by ID. | Wallet | link |
MixinSDK::wallet()->accessTokenGetUserSnapshots(string $access_token, $limit = null, string $offset = null, string $asset = '', string $order = 'DESC') |
Get user's all snapshots. | Wallet | link |
MixinSDK::wallet()->accessTokenGetUserSnapshot(string $access_token, string $snapshot_id) |
Get user's a snapshots by ID. | Wallet | link |
MixinSDK::wallet()->accessTokenGetTransfer(string $access_token, string $trace_id) |
Get Transfer | Wallet | link |
MixinSDK::wallet()->readRawMainNetAddress(string $client_id) |
Get Transfer Address | Wallet | |
MixinSDK::wallet()->accessTokenPostOutputs($access_token, $receivers, $index = 0) |
Get Transfer Address | Wallet | link |
MixinSDK::wallet()->multisigPayment(string $asset_id, array $receivers, int $threshold, $amount, $memo = '', $trace_id = null) |
Post Multisig Payment | Wallet | link |
MixinSDK::wallet()->checkCode($code_id) |
Get payment details | Wallet | |
MixinSDK::wallet()->readMultisigs(string $offset = '', $limit = null) |
Get Multisigs | Wallet | link |
MixinSDK::wallet()->accessTokenPostMultisigs(string $access_token, string $raw, string $action = 'sign') |
Initiate a multi-signature transaction request | Wallet | link |
MixinSDK::wallet()->postMultisigs(string $raw, string $action = 'sign') |
Initiate a multi-signature transaction request | Wallet | link |
MixinSDK::wallet()->multisigsRequests(string $raw, string $action = 'sign') |
Initiate a multi-signature transaction request | Wallet | link |
MixinSDK::wallet()->multisigsRequestsSign(string $request_id, String $pin) |
Sign multisig request | Wallet | link |
MixinSDK::wallet()->multisigsRequestsCancel(string $request_id, String $pin) |
Send multisig cancelling request | Wallet | link |
MixinSDK::wallet()->multisigsRequestsUnlock(string $request_id, String $pin) |
Send multisig unlocking request | Wallet | link |
MixinSDK::wallet()->externalProxy($params, $method = 'sendrawtransaction') |
Draw assets | Wallet | link |
MixinSDK::wallet()->multisigsSign(string $request_id, String $pin) |
Sign | Wallet | link |
MixinSDK::wallet()->multisigsCancel(string $request_id, String $pin) |
Cancel Sign | Wallet | link |
MixinSDK::wallet()->readFiats() |
Fiat currency to USD exchange rate | Wallet | |
| --- | -- | -- | |
| --- | -- | -- | |
| --- | -- | -- | |
MixinSDK::network()->readUser( $userId) |
Get user’s information by ID. | Network | link |
MixinSDK::network()->readUsers(array $userIds) |
Get users information by IDs. | Network | link |
MixinSDK::network()->searchUser($item) |
Search user by ID. | Network | link |
MixinSDK::network()->readNetworkAsset(string $assetId) |
Read public asset information by ID from Mixin Network. | Network | link |
MixinSDK::network()->readNetworkSnapshots($limit = null, string $offset = null, string $asset = '', string $order = 'DESC') |
Read public snapshots of Mixin Network. | Network | link |
MixinSDK::network()->readNetworkSnapshot(string $snapshotId) |
Read public snapshots of Mixin Network by ID. | Network | link |
MixinSDK::network()->createUser($fullName) |
Create a new Mixin Network user | Network | link |
MixinSDK::network()->externalTransactions($asset, $destination, $limit, $offset, $tag, $transaction_hash, $source, $user) |
Read external transactions | Network | link |
MixinSDK::network()->createAttachments() |
Create an attachment upload address. | Network | link |
MixinSDK::network()->mixinNetworkChainsSyncStatus() |
Get Mixin Network Chains Synchronize status | Network | |
MixinSDK::network()->topAsset() |
top asset | Network | link |
MixinSDK::network()->multisigAsset() |
multisig asset | Network | link |
MixinSDK::network()->requestAccessToken(string $code) |
use code request access token | Network | link |
MixinSDK::network()->accessTokenGetInfo(string $access_token) |
use access token get info | Network | link |
MixinSDK::network()->accessTokenGetAssets(string $access_token) |
use access token get assets info | Network | link |
MixinSDK::network()->accessTokenGetContacts(string $access_token) |
use access token get contact info | Network | link |
MixinSDK::network()->accessTokenGetAddresses(string $access_token, string $assetId) |
use access token get addresses | Network | link |
MixinSDK::network()->accessTokenGetAddress(string $access_token, string $addressId) |
use access token get an addresseses | Network | link |
MixinSDK::network()->createConversations($category, $participants, $conversation_id, $name) |
Create groups | Network | link |
MixinSDK::network()->readConversations($conversation_id) |
Read groups | Network | link |
MixinSDK::network()->participantsActions(string $conversation_id, array $participants, string $action = "ADD") |
Manage groups | Network | link |
MixinSDK::network()->rotateConversation(string $conversation_id) |
Rotate Conversation | Network | link |
MixinSDK::network()->searchAssets(string $snapshotId) |
search assets | Network | link |
MixinSDK::network()->readHistoricalPrices(string $asset, string $offset) |
get the historical price of a given asset_id | Network | link |
| --- | -- | -- | |
| --- | -- | -- | |
| --- | -- | -- | |
MixinSDK::message()->sendText($user_id, $data, $category , $conversation_id) |
send text | Message | link |
MixinSDK::message()->sendContact($user_id, $contact_id, $category, $conversation_id) |
send user card | Message | link |
MixinSDK::message()->sendAppButtonGroup($user_id, $data, $category, $conversation_id) |
send App Button Group (max three) | Message | link |
MixinSDK::message()->sendAppCard($user_id, $data, $category, $conversation_id) |
send App Card | Message | link |
MixinSDK::message()->askMessageReceipt($message_id) |
ask Message Receipt | Message | link |
MixinSDK::message()->sendBatchMessage($user_id, $data, $use_http, $type) |
send batch message | Message | link |
| --- | -- | -- | |
| --- | -- | -- | |
| --- | -- | -- | |
MixinSDK::getOauthUrl($client_id, string $scope) |
Get Oauth Url | other | link |
MixinSDK::getPayUrl($asset_id, $amount, $trace_id, $memo, $client_id = null) |
generate a pay Url | other | link |
MixinSDK::getConfig($configGroupName='') |
read config | other |
If MixinNetwork response with an error，An Exception ExinOne\MixinSDK\Exceptions\MixinNetworkRequestException will be
thrown. Developers need to capture and handle this exception.
try {
// If the transfer fails here, an error will be thrown.
$mixinSdk->wallet()->transfer($asset_id, $opponent_id, $pin, $amount, $memo);
} catch (MixinNetworkRequestException $e) {
// Here errCode and errMessage are the same as MixinNetwork, refer to the following link.
$errCode = $e->getCode();
$errMessage = $e->getMessage();
...
} catch (\Throwable $e) {
...
}| class | description |
|---|---|
ExinOne\MixinSDK\Exceptions\MixinNetworkRequestException |
Api request fail |
ExinOne\MixinSDK\Exceptions\NotFoundConfigException |
not found config set |
ExinOne\MixinSDK\Exceptions\LoadPrivateKeyException |
private Key error |
ExinOne\MixinSDK\Exceptions\ClassNotFoundException |
class not found |
-
You can config
iteratorin the following way. Theiteratoris used when a PIN is encrypted. Generally,iteratorshould not be modified. If you want ot modify this variable, be sure to know what you are doing. More details on iterator$iterator = [time()]; // if use it by $mixinSdk->pin()->updatePin($oldPin,$pin), // $iterator need have two element (count($iterator) == 2) $mixinSdk->wallet()->setIterator($iterator)->transfer($asset_id, $opponent_id, $pin, $amount, $memo); // By default, ( microtime(true) . RANDOM NUMBERS ) * 1000000000 is used as iterator
-
Setting Http Request timeout
$mixinSdk->wallet()->setTimeout(10)->transfer($asset_id, $opponent_id, $pin, $amount, $memo); // The default timeout is 20 s
-
Get raw Recponse content
$mixinSdk->wallet()->setRaw(true)->transfer($asset_id, $opponent_id, $pin, $amount, $memo); // Return MixinNetwork raw Response content
MIT
