Skip to main content

Configurations

Developers can develop wallet application using our cli sdk. Install the dcent-cli-connector from npm repository.

npm install dcent-cli-connector

Developer can access api through DcentCLIConnector object.

import DcentCLIConnector from 'dcent-cli-connector'

Requirement​

  • Must have a DCENT Biometric wallet.
    You can get it at DCENT website : https://dcentwallet.com/Shop
  • DCENT Biometric will be connected with your PC or Laptop using USB Cable(Micro USB 5-pin type).

Basic structure​

Functions​

All API functions return a Promise.
When function processing is completed, it is resolved. If an error occurs, it is rejected.
In either case, respond with a JSON object.

Returned JSON object type​

{
    "header": {
        "version": "1.0",
        "request_from": "",
        "status": ""
    },
    "body": {
        "command" : "",
        "parameter" : {}
    }
}

Common Errors​

If DCENT wallet isn't connected via USB, you'll get the following error:

{
    "header": {
        "version": "1.0",
        "request_from": "wam",
        "status": "error"
    },
    "body": {
        "error": {
            "code": "no_device",
            "message": "DCENT Biometric Wallet is not connected"
        }
    }
}

When executing a function that requires user authentication, an error occurs if the user cancels the authentication. The following shows the user cancel error in the Ethereum signed Transaction.

{
    "header": {
        "version": "1.0",
        "request_from": "ethereum",
        "status": "error"
    },
    "body": {
        "command": "transaction",
        "error": {
            "code": "user_cancel",
            "message": "user cancel"
        }
    }
}

Basic functions​

DcentCLIConnector initialize​

dcent-cli-connector provides functions for using DCENT Biometric Wallet.

var result
try{
    result = await DcentCLIConnector.info()
}catch(e){
    result = e
}

info() returns :

{
    "header": {
        "version": "1.0",
        "request_from": "",
        "status": ""
    },
    "body": {
        "command" : "",
        "parameter" : {
            "version": "1.0.0",
            "isUsbAttached": "true | false"
        }
    }    
}

Set TimeOut Time​

Sets the maximum time the function will run. Once the timeout time is set, it is valid until the value is set again. The default value is 60 seconds.

You can set the timeout time by calling setTimeOutMs () as shown below.


  try {
    await DcentCLIConnector.setTimeOutMs(60000) // 60 sec, The default value is 60 seconds.
  } catch (e) {
    console.log(e)    
  }

All functions except setTimeOutMs function are called and then respond with JSON Object as below when timeout occurs.

  {
    "header": {
      "version": "1.0",
      "response_from": "dcent-cli",
      "status": "error"
    },
    "body": {
      "error": {
        "code": "time_out",
        "message": "The function execution time has expired"
      }
    }
  }