@wemix3/wallet-sdk v0.8.2

Wemix Wallet JavaScript SDK

Requirements

• In NPM environment : Node 10 or above recommended

Settings

It is possible to operate in an environment where HTTP(s) communication is basically possible without a separate subscription procedure.

In NPM environment

Install SDK with NPM or YARN

npm install @wemix3/wallet-sdk

or

yarn add @wemix3/wallet-sdk

Import ES module

import wemixSDK from "@wemix3/wallet-sdk";

If you download and use the file

• Download SDK file and move to the repository
• Add script to the HTML file as shown below

<script src="./lib/wemixSDK.js"></script>

Setup Network

Can change the network if necessary. The default network is Mainnet, but it is not currently available.

Be sure to set it as testnet.

• Testnet : https://a2a.test.wemix.com/api/v1/a2a

wemixSDK.setBaseURL("https://a2a.test.wemix.com/api/v1/a2a");

Run Example codes

To run Example codes, either NPM environment or Parcel installation is required.

Setup Parcel

npm install -g parcel-bundler

Run Example code

npm run example

API

Overview

Request for App-to-App in Javascript SDK happens in the order of Proposal, Request, Result.

• Proposal: A stage that requests a task to be performed by a dApp There are 5 different types of requests.
• Request: Runs the WEMIX Wallet on the QR Code to continue the signing process.
• Result: Receive and check the result value by calling the function.

Proposal

Use wemixSDK.proposal (metaData, transaction) function to serve 5 requests depending on the transaction.

• null : Request wallet address
• SendWemix : Request WEMIX transfer
• SendToken : Request Token transfer
• SendNFT : Request NFT transfer
• ContractExecute : Request ContractExecute

MetaData

In order to request a Proposal, information about the dApp is required. The information about the dApp must be provided through the METADATA interface.

METADATA

const metaData = {
  name: "WEMIX test dApp",
  description: "Test Proposal",
  url: "https://test-dApp.wemix.com",
  icon: "https://test-dApp.wemix.com/logo.png",
};

Auth

This function requests an authentication of the user’s wallet, and the address of the user wallet can be confirmed when the authentication is completed.

Example

wemixSDK.proposal(metaData).then((res) => {
  if (res.error) {
    // Handling errors
  } else if (res.requestId) {
    // requestId Storage and processing
  }
});

SendWemix

This is a request to send the user’s WEMIX to a specific address. After the approval of the request, the user can check the transactionHash of the request.

SendWemix(from, to, value)

Example

// send 1 WEMIX to 0xFb0... from 0x9a...
const transaction = new SendWemix("0x9a...", "0xFb0...", "1000000000000000000");
wemixSDK.proposal(metaData, transaction).then((res) => {
  if (res.error) {
    // Handling errors
  } else if (res.requestId) {
    // requestId Storage and processing
  }
});

SendToken

This is a request to send the user’s Token to a specific address. After the approval of the request, the user can check the transactionHash of the request.

SendNFT(from, to, contract, tokenId)

Example

// 1 token is sent from 0x9a... to 0xFb0... in the 0xa8b.. contract. (if decimal is 0)
const transaction = new SendToken("0x9a...", "0xFb0...", "1", "0xa8b...");
wemixSDK.proposal(metaData, transaction).then((res) => {
  if (res.error) {
    // Handling errors
  } else if (res.requestId) {
    // requestId Storage and processing
  }
});

SendNFT

This is a request to send the user’s NFT to a specific address. After the approval of the request, the user can check the transactionHash of the request.

SendNFT(from, to, contract, tokenId)

Example

// In the 0xa8b.. contract, tokenId 12 is sent from 0x9a... to 0xFb0....
const transaction = new SendNFT("0x9a...", "0xFb0...", "0xa8b...", "12");
wemixSDK.proposal(metaData, transaction).then((res) => {
  if (res.error) {
    // Handling errors
  } else if (res.requestId) {
    // requestId Storage and processing
  }
});

ContractExcute

This is a request to execute a specific contract. After the approval of the request, the user can check the transactionHash of the request.

ContractExecute(from, contract, abi, params)

Example

// 0xa8b.. Execute transfer function in contract.
const transaction = new ContractExecute(
  "0x9a...",
  "0xa8b...",
  JSON.stringify({
    constant: false,
    inputs: [
      { name: "_to", type: "address" },
      { name: "_value", type: "uint256" },
    ],
    name: "transfer",
    outputs: [{ name: "success", type: "bool" }],
    payable: false,
    type: "function",
  }),
  JSON.stringify([
    "0xcad9042cf49684939a2f42c2d916d1b6526635c2",
    5000000000000000000,
  ])
);
wemixSDK.proposal(metaData, transaction).then((res) => {
  if (res.error) {
    // Handling errors
  } else if (res.requestId) {
    // requestId Storage and processing
  }
});

Request

A user can create a Scheme that calls the app with the request ID received from Proposal and make a request to the WEMIX Wallet app with a QRCode or scheme call.

Scheme

wemix://wallet?requestId={request_id}

Example

wemix://wallet?requestId=569308f1-5d21-4ffc-abc5-1c3f4fcd12b7

Result

A user can confirm the reaction of requestId after the approval.

wemixSDK.getResult(requestId)

Request

Response

Example

wemixSDK.getResult(requestId).then((res) => {
  if (res.error) {
    // Handling errors
  } else if (res.status && res.status === "completed") {
    // res.address <= Only Auth
    // res.tx_hash
  }
});

License

MIT