Console

Synopsis

Uplink provides a console interface (in addition to the RPC interface) that can be used to issue transactions and inspect the state of the ledger. The console runs as a separate process, so an Uplink node must (currently) be running on the same machine as the console program.

Running the Console

After booting an Uplink node as described here. run the following command to start an interactive console to the ledger:

$ uplink console

Console Commands

discover:
    force discovery of new peers

listPeers:
    list peers

reconnect:
    reconnect

ping:
    ping all peers

pingPeer <node>:
    ping a specific peer eg. pingPeer 127.0.1.1

addPeer <node>:
    discover a peer eg. addPeer 143.245.35.1

listAccounts:
    print all acccounts

listAssets:
    print all assets

listContracts:
    print all contracts

createAccount <private key path>:
    create account eg. createAccount key.priv

createAsset <name> <supply>:
    create an asset eg. createAsset "USD" 1000

createContract <FCL source path>:
    create contract eg. createContract contracts/escrow.s

transferAsset:
    transfer asset

callContract:
    call contract

transaction <path of json transaction header>:
    submit a transaction eg. transaction tests/testTxHeader.json

help:
    display this message

setAccount <optional path to account dir to use>:
    set active account transactions are submitted from eg setAccount or setAccount alice

quit:
    exit the console

Console CLI

Usage: uplink console [-h|--hostname HOST] [-p|--port PORT]
  Connect to a node and issue transactions.

  Available options:
    -h,--help                Show this help text
    -h,--hostname HOST       Specify hostname
    -p,--port PORT           Override the port on which the node should
                             listen for P2P. Default 8001