Hardware Wallet Daemon API

API default service port is 9510.

The API currently supports skywallet and its emulator.

The skywallet endpoints start with /api/v1 and emulator endpoints with /api/v1/emulator.

Usage
- Main Endpoints
- Intermediates
  - Pincode
  - Passphrase
  - Word
  - Button

Main Endpoints

Generate Addresses

Generate addresses for the hardware wallet seed.

URI: /api/v1/generate_addresses
Method: POST
Content-Type: application/json
Args: {"address_n": "<address_n>", "start_index": "<start_index>", "confirm_address": "<confirm_address>"}

Parameters

address_n: Number of addresses to generate. Assume 1 if not set.
start_index: Index where deterministic key generation will start from. Assume 0 if not set.
confirm_address: If requesting one address it will be sent only if user confirms operation by pressing device's button.

Example:

$ curl http://127.0.0.1:9510/api/v1/generate_addresses \
  -H 'Content-Type: application/json' \
  -d '{"address_n": 2, "start_index": 0}'

Response:

{
    "data": [
        "GHqzSmFBBZqjNWZhFuSmgjES5WTWkNiKqK",
        "LVhMmHSWvsZ9iu66MMLVY4wih7gp9YwwWK"
    ]
}

Apply Settings

Apply hardware wallet settings.

URI: /api/v1/apply_settings
Method: POST
Content-Type: application/json
Args: {"label": "<label for hardware wallet>", "use_passphrase": "<ask for passphrase before starting operation>"}

Example:

$ curl -X POST http://127.0.0.1:9510/api/v1/apply_settings \
   -H 'Content-Type: application/json' \
   -d '{"label": "skywallet", "use_passphrase": false}'

Response Flow:

Intermediate button press response is returned multiple times

{
    "data": [
        "ButtonRequest"
    ]
}

Send Button request to start button handling process which returns the final response

{
    "data": [
        "Settings applied"
    ]
}

Backup Seed

Start seed backup procedure

URI: /api/v1/backup
Method: POST

Example:

$ curl -X POST http://127.0.0.1:9510/api/v1/backup

Response Flow:

Intermediate button press response is returned for each seed

{
    "data": [
        "ButtonRequest"
    ]
}

Send Button request to start button handling process which returns the final response

{
    "data": "Device backed up!"
}

Note: If device has no seed then following response is returned

{
    "error": {
        "message": "Device not initialized",
        "code": 409
    }
}

Cancel

Cancels the current operation.

This function can be called safely even if no operation is active. The Response will be the same.

URI: /api/v1/cancel
Method: PUT

Example:

$ curl -X PUT http://127.0.0.1:9510/api/v1/cancel

Response:

{
    "data": [
        "Action cancelled by user"
    ]
}

Check Message Signature

Check a message signature matches the given address.

URI: /api/v1/check_message_signature
Method: POST
Content-Type: application/json
Args: {"message": "<message>", "signature": "<signature>", "address": "<address>"}

Parameters

message: The message that the signature claims to be signing.
signature: Signature of the message.
address: Address that issued the signature.

Example:

curl -X POST http://127.0.0.1:9510/api/v1/check_message_signature \
-H 'Content-Type: application/json' \
-d '{"message": "Hello World", "signature": "6ebd63dd5e57cad07b6d229e96b5d2ac7d1bec1466d2a95bd200c21be6a0bf194b5ad5123f6e37c6393ee3635b38b938fcd91bbf1327fc957849a9e5736f6e4300", "address": "2EU3JbveHdkxW6z5tdhbbB2kRAWvXC2pLzw"}'

Response: The signing address is returned if the signature is correct

{
    "data": [
        "2EU3JbveHdkxW6z5tdhbbB2kRAWvXC2pLzw"
    ]
}

Get Features

Returns device information.

URI: /api/v1/features
Method: GET

Example:

$ curl http://127.0.0.1:9510/api/v1/features

Response:

{
    "data": {
        "vendor": "Skycoin Foundation",
        "device_id": "617F30E0E10C9C9E93B5EE37",
        "pin_protection": false,
        "passphrase_protection": false,
        "label": "617F30E0E10C9C9E93B5EE37",
        "initialized": false,
        "bootloader_hash": "k3jy1kG+JbHZxi2cTSScekQK007/YkbZzyXWI6dVJns=",
        "pin_cached": false,
        "passphrase_cached": false,
        "needs_backup": false,
        "model": "1",
        "fw_major": 1,
        "fw_minor": 7,
        "fw_patch": 0,
        "firmware_features": 4
    }
}

Firmware Update

Update device firmware

URI: /api/v1/firmware_update
Method: PUT
Args:
    file: firmware file

Example:

$ curl  -i -X PUT -H "Content-Type: multipart/form-data"  -F "file=@/Users/therealssj/go/src/github.com/skycoin/hardware-wallet/tiny-firmware/skyfirmware.bin" http://127.0.0.1:9510/api/v1/firmware_update

Recover Wallet

Recover existing wallet using seed.

The device needs to be wiped if already initialized.

URI: /api/v1/recovery
Method: POST
Content-Type: application/json
Args: {
        "word_count": "<mnemonic seed length>", 
        "use_passphrase": "<ask for passphrase before starting operation>", 
        "dry_run": "<perform dry-run recovery workflow (for safe mnemonic validation)>"
      }

Example:

$ curl -X POST http://127.0.0.1:9510/api/v1/recovery \
  -H 'Content-Type: application/json' \
  -d '{"word_count": 12, "use_passphrase": false, "dry_run": true}'

Response Flow:

The user is asked for confirmation on hardware wallet screen to start the recovery process.
The daemon then returns intermediate word request type in Response.
The frontend needs to send intermediate word request till the hardware wallet keeps showing instructions on screen.
Success Response:

{
    "data": ["Device recovered"]
}

Generate Mnemonic

Generate mnemonic can be used to initialize the device with a random seed.

URI: /api/v1/generate_mnemonic
Method: POST
Content-Type: application/json
Args: {"word_count": "<mnemonic seed length>", "use_passphrase": "<ask for passphrase before starting operation>"}

Example:

$ curl http://127.0.0.1:9510/api/v1/generate_mnemonic \
  -H 'Content-Type: application/json' \
  -d '{"word_count": 12, "use_passphrase": false}'

Response:

{
    "data": [
        "Mnemonic successfully configured"
    ]
}

Set Mnemonic

Set mnemonic can be used to initialize the device with your own seed.

The seed needs to be a valid bip39 seed.

URI: /api/v1/set_mnemonic
Method: POST
Content-Type: application/json
Args: {"mnemonic": "<bip39 mnemonic seed>"}

Example:

$ curl -X POST http://127.0.0.1:9510/api/v1/set_mnemonic \
  -H 'Content-Type: application/json' \
  -d '{"mnemonic": "cloud flower upset remain green metal below cup stem infant art thank"}'

Response Flow:

Intermediate button press response is returned

{
    "data": [
        "ButtonRequest"
    ]
}

Send Button request to start button handling process which returns the final response

Valid mnemonic

{
    "data": [
        "cloud flower upset remain green metal below cup stem infant art thank"
    ]
}

Invalid mnemonic

{
    "error": {
        "message": "Mnemonic with wrong checksum provided",
        "code": 409
    }
}

Configure Pin Code

Configure a pin code on the device.

URI: /api/v1/configure_pin_code
Method: POST
Args: {
    "remove_pin": <bool>, 
}

Example:

$ curl -X POST http://127.0.0.1:9510/api/v1/configure_pin_code \
  -H 'Content-Type: application/json' \
  -d '{"remove_pin": false}'

Response Flow:

Intermediate button press response is returned

{
    "data": [
        "ButtonRequest"
    ]
}

Send Button request to start button handling process. The daemon then returns intermediate pinmatrix request.

{
    "data": [
        "PinMatrixRequest"
    ]
}

Send Pincode request to handle pincode process. Pincode is requested two times.

Response on success

{
    "data": [
        "PIN changed"
    ]
}

Response on failure

{
    "error": {
        "message": "PIN mismatch",
        "code": 409
    }
}

Example(Remove Pin):

$  curl -X POST http://127.0.0.1:9510/api/v1/configure_pin_code \
  -H 'Content-Type: application/json' \
  -d '{"remove_pin": true}'

Response Flow: Response Flow:

Intermediate button press response is returned

{
    "data": [
        "ButtonRequest"
    ]
}

Send Button request to start button handling process. The daemon then returns intermediate pinmatrix request.

{
    "data": [
        "PinMatrixRequest"
    ]
}

Send Pincode request to handle pincode process.

Response on success

{
    "data": [
        "PIN removed"
    ]
}

Response on failure

{
    "error": {
        "message": "PIN invalid",
        "code": 409
    }
}

Sign Message

Sign a message using the secret key at given index.

URI: /api/v1/sign_message
Method: POST
Args: {
    "address_n": <address_n>, 
    "message": "<message>"
}

Parameters

address_n: Index of the address that will issue the signature.
message: The message that the signature claims to be signing.

Example:

$ curl -X POST http://127.0.0.1:9510/api/v1/sign_message \
  -H 'Content-Type: application/json' \
  -d '{"address_n": 0, "message": "hello world"}'

Intermediate button press response is returned

{
    "data": [
        "ButtonRequest"
    ]
}

Send Button request to start button handling process which returns the final response

{
    "data": [
        "060a690b7ad8abc4d4db2a47e6fa2f0a5e33f877c1d0beceac126daf248651c11148065fb03e992248432a6935ff1f5b36c0a36f595e50fcc9f327d84389e14000"
    ]
}

Transaction Sign

Sign a transaction with the hardware wallet.

URI: /api/v1/transaction_sign
Method: POST
Args: {
    "transaction_inputs": [{"index": <index<, "hash":"<hash>"}],
    "transaction_outputs": [{"address_index": <address_index>,"address":"<address>","coins":"<coins>","hours":"<hours>"}],
   }

Parameters

transaction_inputs: List of objects with the following fields:
- index: Index of the address, in the hardware wallet, to which the input belongs.
- hash: Input hash.
transaction_outputs: List of objects with the following fields:
- address_index: If the output is used for returning coins/hours to one of the addresses of the hardware
- address: Skycoin address in Base58 format. wallet, this parameter must contain the index of the address in the hardware wallet, so that the user is not asked for confirmation for this specific output. If this is not the case, this parameter is not necessary.
- coins: Output coins.
- hours: Output hours.

Example:

$ curl http://127.0.0.1:9510/api/v1/transaction_sign \
  -H 'Content-Type: application/json' \
  -d '{"transaction_inputs":[{"index":0,"hash":"c2244e4912330d201d979f80db4df42118e49704e500e2e00a52a61954e8c663"},{"index":1,"hash":"4f7250b0b1f588c4dedd5a4be984fab7215a773773480d8698e8f5ff04ef2611"}],"transaction_outputs":[{"address_index":null,"address":"2M9hQ4LqEsBF5JZ3uBatnkaMgg9pN965JvG","coins":"2","hours":"2"},{"address_index":null,"address":"2iNNt6fm9LszSWe51693BeyNUKX34pPaLx8","coins":"3","hours":"3"}]}'

Wipe

Wipe deletes all data from the hardware wallet.

URI: /api/v1/wipe
Method: DELETE

Example:

$ curl -X DELETE http://127.0.0.1:9510/api/v1/wipe

Response Flow:

Intermediate button press response is returned

{
    "data": [
        "ButtonRequest"
    ]
}

Send Button request to start button handling process which returns the final response

{
    "data": [
        "Device wiped"
    ]
}

Available

Available tells whether a device is currently connected to the machine or not.

URI: /api/v1/available
Method: GET

Example:

$ curl -X GET http://127.0.0.1:9510/api/v1/available

Response:

{
    "data": [
        true
    ]
}

Version

Version returns daemon version information

URI: /api/v1/version
Method: GET

Example:

$ curl -X GET http://127.0.0.1:9510/api/v1/version

Response:

{
    "data": {
        "version": "0.1.0",
        "commit": "d495cb596255dcca3c9e8f487c369b4b08a046d7",
        "branch": "master"
    }
}

Intermediates

Intermediate requests are those which require user input like pincode, passphrase or word.

Pincode

URI: /api/v1/intermediate/pin_matrix
Method: POST
Args: {"pin": "<pin>"}

Example:

$ curl -X POST http://127.0.0.1:9510/api/v1/intermediate/pin_matrix \
  -H 'Content-Type: application/json' \
  -d '{"pin": "234"}'

Note: The pincode should be a string not a number.

Passphrase

URI: /api/v1/intermediate/passphrase
Method: POST
Args: {"passphrase": "<passphrase>"}

Example:

$ curl -X POST http://127.0.0.1:9510/api/v1/intermediate/passphrase \
  -H 'Content-Type: application/json' \
  -d '{"passphrase": "foobar"}'

Word

URI: /api/v1/intermediate/word
Method: POST
Args: {"word": "<word>"}

Example:

$ curl -X POST http://127.0.0.1:9510/api/v1/intermediate/word \
  -H 'Content-Type: application/json' \
  -d '{"word": "cloud"}'

Button

URI: /api/v1/intermediate/button
Method: POST

Example:

$ curl -X POST http://127.0.0.1:9510/api/v1/intermediate/button

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

Hardware Wallet Daemon API

Main Endpoints

Generate Addresses

Apply Settings

Backup Seed

Cancel

Check Message Signature

Get Features

Firmware Update

Recover Wallet

Generate Mnemonic

Set Mnemonic

Configure Pin Code

Sign Message

Transaction Sign

Wipe

Available

Version

Intermediates

Pincode

Passphrase

Word

Button

Files

README.md

Latest commit

History

README.md

File metadata and controls

Hardware Wallet Daemon API

Main Endpoints

Generate Addresses

Apply Settings

Backup Seed

Cancel

Check Message Signature

Get Features

Firmware Update

Recover Wallet

Generate Mnemonic

Set Mnemonic

Configure Pin Code

Sign Message

Transaction Sign

Wipe

Available

Version

Intermediates

Pincode

Passphrase

Word

Button