Wallet App

The Wallet App is an application which:

• Creates a new wallet (generating private and public key on behalf of the user)
• Loads an existing wallet (by data + password)
• Creates, signs and sends transactions
• Provides access to balance

Launching

In order to launch the Wallet App server you would need to execute the following command in the command line:

npm start

Environment could be specified when launching the server as well:

NODE_ENV=<ENVIRONMENT_NAME> npm start 

where <ENVIRONMENT_NAME> should be the value of the corresponding environment on which the server would be ran, e.g. development.

API

Create Wallet

Example

Request

POST /wallets

Response

The payload would be look in the following way:

201 - successful call
{
    "privateKey": "d4533c6141d72c7ad542ea64d25f8ed820195adc09537fc74dacbb283354c64f",
    "publicKey": "b51eccb98ce565474ef06d4145b96e4a397f929190c007dc703eeeb42ce71a701",
    "address": "a838fdabe6c9ddd8b01c4dfdb736d3d9e7240d0d"
}

Load Existing Wallet

Example

Request

PUT /wallets
{
  "privateKey": "7e4670ae70c98d24f3662c172dc510a085578b9ccc717e6c2f4e547edd960a34"
}

Response

On successful call the status would be either:

• 201, i.e. a new wallet was created on the server or
• 200, i.e. the resource does already exist.

The payload would be look in the following way:

{
    "privateKey": "7e4670ae70c98d24f3662c172dc510a085578b9ccc717e6c2f4e547edd960a34",
    "publicKey": "c74a8458cd7a7e48f4b7ae6f4ae9f56c5c88c0f03e7c59cb4132b9d9d1600bba1",
    "address": "c3293572dbe6ebc60de4a20ed0e21446cae66b17"
}

Retrieve Wallet Info

Please note that this endpoint is NOT available on production environment.

Example

Request

GET /wallets/c3293572dbe6ebc60de4a20ed0e21446cae66b17

Response

200 - successful call
{
    "privateKey": "7e4670ae70c98d24f3662c172dc510a085578b9ccc717e6c2f4e547edd960a34",
    "publicKey": [
        "c74a8458cd7a7e48f4b7ae6f4ae9f56c5c88c0f03e7c59cb4132b9d9d1600bba",
        "a54aa7835a34e10dc6c8e386dc32e98bb18583f7c7259be3e444fe2876b9aaef"
    ],
    "compressedPublicKey": "c74a8458cd7a7e48f4b7ae6f4ae9f56c5c88c0f03e7c59cb4132b9d9d1600bba1",
    "address": "c3293572dbe6ebc60de4a20ed0e21446cae66b17"
}

Create Transaction

Example

Request

POST /wallets/:address/transactions
{
  "from": "c3293572dbe6ebc60de4a20ed0e21446cae66b17",
  "to": "f51362b7351ef62253a227a77751ad9b2302f911",
  "senderPubKey": "c74a8458cd7a7e48f4b7ae6f4ae9f56c5c88c0f03e7c59cb4132b9d9d1600bba1",
  "value": 25000, 
  "fee": 10
}

At the moment :address should have the value of the from field.

Response

200 - successful call
{
    "from": "c3293572dbe6ebc60de4a20ed0e21446cae66b17",
    "to": "f51362b7351ef62253a227a77751ad9b2302f911",
    "senderPubKey": "c74a8458cd7a7e48f4b7ae6f4ae9f56c5c88c0f03e7c59cb4132b9d9d1600bba1",
    "value": 25000,
    "fee": 10,
    "dateCreated": "2018-02-10T17:53:48.972Z",
    "senderSignature": [
        "1aaf55dcb11060749b391d547f37b4727222dcb90e793d9bdb945c64fe4968b0",
        "87250a2841f7a56910b0f7ebdd067589632ccf19d352c15f16cfdba9b7687960"
    ]
}

Send Transaction

Creates a transaction and sends it to a node for mining and further propagation.

Note: At the moment the Wallet expects to be running on the same host along with a Node (which respectively could be found at http://127.0.0.1:5555).

Example

Request

POST /wallets/:address/transactions/send
{
  "from": "c3293572dbe6ebc60de4a20ed0e21446cae66b17",
  "to": "f51362b7351ef62253a227a77751ad9b2302f911",
  "senderPubKey": "c74a8458cd7a7e48f4b7ae6f4ae9f56c5c88c0f03e7c59cb4132b9d9d1600bba1",
  "value": 25000, 
  "fee": 10
}

At the moment :address should have the value of the from field.

Response

200 - successful call
{
    "transactionHash": "b2e0d16602bf0a8e5a78b1d0133e535afe85638112b45cc511bbafc2a8279f34"
}

Retrieve a Wallet's Balance

Retrieves the balance (confirmed, pending and just mined) for a given wallet.

Note: At the moment the Wallet expects to be running on the same host along with a Node (which respectively could be found at http://127.0.0.1:5555).

Example

Request

GET /wallets/0a37ccb342861218ea8331fdf6e4a4a6521e3e55/balance

Response

200 - successful call
{
    "address": "ac51700449340e5400e13772741c94cc9c457799",
    "confirmedBalance": {
        "confirmations": 6,
        "balance": 15
    },
    "lastMinedBalance": {
        "confirmations": 1,
        "balance": 25
    },
    "pendingBalance": {
        "confirmations": 0,
        "balance": 20
    }
}

Wallet UI

The wallet UI could be accessed at the host where the wallet is deployed, e.g. http://http://194.129.62.10:5556, assuming that the wallet app is listening at port 5556.

Some screeshots of the UI are available below.

Home Page

Create a New Wallet

Load an Existing Wallet

Check Wallet's Balance

Sign and Send a Transaction

Future Work

• The Wallet App might be based on the HD wallet standards (BIP-39 / BIP-32)