mixin-node-client

Node.js SDK for Mixin Network, heavily inspired by mixin-node, but is much more developer friendly

Table of Contents

• Install
• Usage
• Contributors
• License

Install

1yarn add mixin-node-client
2# OR npm install mixin-node-client -S

Usage

1. Generate Config

Steps to use generate config for dapp:

1. Create a dapp on developers.mixin.one, get clientId and clientSecret(the result when Click to generate a new secret)
2. Generate config from a new session info of your dapp (the result when Click to generate a new session) using mixin-cli (a command line tool by me).

Config file format, remember to replace clientId and clientSecret with yours:

1// Generated with awesome https://github.com/wangshijun/mixin-cli
2module.exports = {
3  clientId: '<PUT YOUR DAPP CLIENT_ID HERE>',
4  clientSecret: '<PUT YOUR DAPP CLIENT_SECRET HERE>',
5  assetPin: '310012',
6  sessionId: '621c905b-1739-45e7-b668-b5531dd83646',
7  aesKey: '56GcGs2EFHBPV2Xsb/OiwLdgjGt3q53JcFeLmbUutEk=',
8  privateKey: `-----BEGIN RSA PRIVATE KEY-----
9MIICXAIBAAKBgQCsNaGbDx1UeKrTux01nC6R7/bu2GUELe6Q2mBSPymkZW2fpiaO
10FjkTI1MkEE8Eq1kGm/+6vAP84LMXG/W49UqZTBkKkrQ=
11-----END RSA PRIVATE KEY-----`,
12};

2. HttpClient

HttpClient provides wrapper for all API supported by mixin network and mixin messenger, such as pin/user/asset/snapshot:

1const { HttpClient } = require('mixin-node-client');
2const config = require('./config');
3
4const client = new HttpClient(config);
5
6const recipientId = 'ca630936-5af6-427e-ac4a-864a4c64f372'; // UserId
7const senderId = '7701e7bf-2a86-4655-982e-023564fa8945'; // UserID
8const assetId = '965e5c6e-434c-3fa9-b780-c50f43cd955c'; // CNB
9
10(async () => {
11  const assets = await client.getAssets();
12  const verifyPin = await client.verifyPin(config.assetPin);
13  const user = await client.getUser(senderId);
14  console.log({ assets, verifyPin, user });
15})();

Full API list supported by HttpClient:

• getUserAssets, get asset list owned by user
• getUserAsset, get asset detail owned by user
• getNetworkAssets, get top asset list by mixin network
• getNetworkAsset, get top asset detail by mixin network
• getWithdrawAddress, get withdraw address
• createWithdrawAddress, create withdraw address
• deleteWithdrawAddress, delete withdraw address
• withdraw, request withdraw from mixin network
• deposit, get deposit address for asset
• getSnapshots, get network snapshot list
• getSnapshot, get network snapshot detail
• verifyPin, verify asset pin
• updatePin, update/create asset pin
• createTransfer, create transfer with an asset
• getTransfer, read transfer detail
• verifyPayment, verify transfer state
• getProfile, get user profile
• updatePreference, update user preference
• updateProfile, update user profile
• createUser, create user
• getUser, get user by id
• getUsers, get multiple users by id
• getFriends, get friend list
• getContacts, get contact list
• createConversation, create new conversation
• readConversation, read conversation detail
• sendMessage, send raw message to specific conversation, see next section for message sender util.

Working example for HttpClient can be found HERE

Message Sender Util

Because we can send messages to a conversation, HttpClient provide neat methods to send all kinds of message to Mixin Messenger:

1console.log(client.getMessageSenders());
2// [ 'sendText',
3//   'sendImage',
4//   'sendVideo',
5//   'sendData',
6//   'sendSticker',
7//   'sendContact',
8//   'sendButton',
9//   'sendButtons',
10//   'sendApp' ]
11const text = await client.sendText({
12  conversationId: conversation.conversation_id,
13  data: 'Hello from node.js new client sdk',
14});
15const button = await client.sendButton({
16  conversationId: conversation.conversation_id,
17  data: { label: 'Open Mixin', color: '#FF0000', action: 'https://mixin.one' },
18});

For syntax of sending messages, see working example HERE.

3. SocketClient

SocketClient provide basic wrapper for Mixin Messenger WebSocket Messages, you can use it to listen and react to socket messages.

1const { SocketClient } = require('mixin-node-client');
2const config = require('./config');
3
4const client = new SocketClient(config);
5
6socket.on(
7  'message',
8  socket.getMessageHandler(message => {
9    console.log('Message Received', message);
10    if (message.data && message.data.category === 'PLAIN_TEXT' && message.data.data.toLowerCase() === 'hi') {
11      // We support `sendText`, `sendButton`, `sendImage` here
12      return socket.sendText('Hi there!', message);
13    }
14
15    return Promise.resolve(message);
16  })
17);

Working example for SocketClient can be found HERE

Same set of message sender utils are also supported by SocketClient (Note: parameters are different for message sender utils of HttpClient and SocketClient, because we have the conversationId from the onMessage callback):

1socket.sendText('Hi there!', message);
2socket.sendButton({ label: 'Open Mixin', color: '#FF0000', action: 'https://mixin.one' }, message);

Debugging

If you are curious what happened during each API call, try run example code with following command:

1DEBUG=mixin-node-client:* node examples/http.js
2DEBUG=mixin-node-client:* node examples/socket.js
3DEBUG=mixin-node-client:* node examples/message.js

The mixin dapp included in the examples folder can be found with the following qrcode:

Contributors

Name
wangshijun

License

MIT © wangshijun