ui

README

UI server

The user interface (UI) server lets to have a graphical user interface to easily communicate with a Ruthenium host node. Any other implementation of this UI server can communicate with a node using its API. In this repository, the UI is described in a simple index.html. Any other implementation of this UI can communicate with the UI server using its API.

Prerequisites

A Ruthenium node must be running.

Launch

At root level (ruthenium folder), run the ui using the command go run src/ui/main.go with the add of some program arguments. For example:

go run src/ui/main.go -host-ip=0.0.0.0 -private-key=0x48913790c2bebc48417491f96a7e07ec94c76ccd0fe1562dc1749479d9715afd

Program arguments:

-mnemonic: The mnemonic (required if the private key is not provided)
-derivation-path: The derivation path (unused if the mnemonic is omitted, default: "m/44'/60'/0'/0/0")
-password: The mnemonic password (unused if the mnemonic is omitted)
-private-key: The private key (required if the mnemonic is not provided, unused if the mnemonic is provided)
-port: The TCP port number for the UI server (default: 8080)
-host-ip: The node host IP address
-host-port: The TCP port number of the host node (default: 8106)
-templates-path: The UI templates path (default: "src/ui/templates")
-log-level: The log level (default: "info")  

Using a web browser, go to http://localhost:8080 (If needed, replace localhost by the UI server IP address and 8080 by the TCP port number for the UI server)

API

Base url: <UI server IP>:<UI server port> (example: localhost:8080)

Transactions pool

Add transaction

Description: Add a transaction to the transactions pool.

• parameters: none

• request body: Transaction request

• responses:

  Code	Description
  200	Transaction added
  400	Bad request
  500	Internal server error

Get transactions

Description: Get all the transactions of the current transactions pool.

• parameters: none

• request body: none

• responses:

  Code	Description
  200	Array of transaction responses
  500	Internal server error

Validation

Start validation

Description: Start validating one block per minute.

• parameters: none

• request body: none

• responses:

  Code	Description
  200	Validation started
  500	Internal server error

Stop validation

Description: Stop validating one block per minute.

• parameters: none

• request body: none

• responses:

  Code	Description
  200	Validation stopped
  500	Internal server error

Validate

Description: Validate the next block.

• parameters: none

• request body: none

• responses:

  Code	Description
  200	The next block will be validated
  500	Internal server error

Wallet

Create wallet

Description: Create a new wallet instance with the provided program arguments.

• parameters: none

• request body: none

• responses:

  Code	Description
  200	Wallet response
  500	Internal server error

Get wallet amount

Description: Get the amount for the given wallet address.

• parameters:

  Name	Description	Example
  address	42 characters hexadecimal wallet address	0xf14DB86A3292ABaB1D4B912dbF55e8abc112593a

• request body: none

• responses:

  Code	Description
  200	Amount response
  400	Bad request
  500	Internal server error

Schemas

Amount response

Schema	Description	Example
AmountResponse { Amount float64 }	The amount data structure for response The amount	{ "Amount": 100000000 }

Transaction request

Schema	Description	Example
TransactionRequest { SenderPrivateKey string SenderAddress string RecipientAddress string SenderPublicKey string Value string }	The transaction data structure for request The sender wallet private key The sender wallet address The recipient wallet address The sender wallet public key The value	{ "SenderPrivateKey": 0x48913790c2bebc48417491f96a7e07ec94c76ccd0fe1562dc1749479d9715afd "SenderAddress": 0x9C69443c3Ec0D660e257934ffc1754EB9aD039CB "RecipientAddress": 0xf14DB86A3292ABaB1D4B912dbF55e8abc112593a "SenderPublicKey": 0x046bd857ce80ff5238d6561f3a775802453c570b6ea2cbf93a35a8a6542b2edbe5f625f9e3fbd2a5df62adebc27391332a265fb94340fb11b69cf569605a5df782 "Value": 100000000 }

Transaction response

Schema	Description	Example
TransactionResponse { RecipientAddress string SenderAddress string SenderPublicKey string Signature string Timestamp int64 Value uint64 Fee uint64 }	The transaction data structure for response The recipient wallet address The sender wallet address The sender wallet public key The signature generated by both the private and public keys The timestamp The value The fee	{ "RecipientAddress": 0xf14DB86A3292ABaB1D4B912dbF55e8abc112593a "SenderAddress": 0x9C69443c3Ec0D660e257934ffc1754EB9aD039CB "SenderPublicKey": 0x046bd857ce80ff5238d6561f3a775802453c570b6ea2cbf93a35a8a6542b2edbe5f625f9e3fbd2a5df62adebc27391332a265fb94340fb11b69cf569605a5df782 "Signature": 4f3b24cbb4d2c13aaf60518fce70409fd29e1668db1c2109c0eac58427c203df59788bade6d5f3eb9df161b4ed3de451bac64f4c54e74578d69caf8cd401a38f "Timestamp": 1667768884780639700 "Value": 100000000 "Fee": 1000 }

Wallet response

Schema	Description	Example
Wallet { PrivateKey string PublicKey string Address string }	The wallet data structure The wallet private key The wallet public key The wallet address	{ "PrivateKey": 0x48913790c2bebc48417491f96a7e07ec94c76ccd0fe1562dc1749479d9715afd "PublicKey": 0x046bd857ce80ff5238d6561f3a775802453c570b6ea2cbf93a35a8a6542b2edbe5f625f9e3fbd2a5df62adebc27391332a265fb94340fb11b69cf569605a5df782 "Address": 0x9C69443c3Ec0D660e257934ffc1754EB9aD039CB }