gary23w/uplandcli

UPLANDCLI is a Go application that simplifies the collection and analysis of Upland blockchain data. With UPLANDCLI, users can create a local database, run analytics systems, and analyze long-term trends of the Upland ecosystem.

UPLANDCLI

UPLANDCLI is a compact, highly capable Go application that streamlines the collection and visualization of Upland blockchain information and raw data. The tool facilitates the creation of a local database to store the collected data and employs graphing and analytics systems to offer insights into the long-term trends of the Upland ecosystem.

Prerequisites

To leverage the full functionality of UPLANDCLI, users must ensure the following versions of Go, Node.js, and npm are installed:

• Go: Go > v1.16.x
• Node.js: Node.js v14.17.6
• NPM: npm > v6.14.x

Basic Commands

upland The upland command initiates a pipeline to collect data related to Upland properties. The collected data is then used to populate the CLI based user interface.

Usage:

uplandcli upland [flags]


upldcli upland --collect
upldcli upland --live
upldcli upland --live -a  // run API in async mode
upldcli upland --live -a -b  // run API in async mode and bypass database connections

Flags:

-a, --api: Run API in async mode.
-b, --bypass: Bypass database connections and inserts.
-d, --collect: Retrieve all recently listed properties for sale.
-h, --help: Display help for the upland command.
-q, --live: Display live mode data in the shell.

---

The database command is used to set up and initialize a PostgreSQL database on Heroku.

Usage:

uplandcli database [flags]

-q, --check: Check if a database is already active.
-d, --deploy: Set up a PostgreSQL database on Heroku.
-u, --destroy: Attempt to destroy the database.
-h, --help: Display help for the database command.

---

The api command deploys a CRUD API to interact with the database.

Usage:

uplandcli api [flags]
Flags:

-d, --deploy: Initialize a CRUD API to interact with the database.
-h, --help: Display help for the api command.

Configuration

UPLANDCLI relies on a PostgreSQL database to collect data. To configure the collection system, a database.json file must be available within the conf/ directory. Here's an example:

{
    "Url": "null",
    "PSQLurl": "null",
    "User": "<DB NAME>",
    "Password": "<DB PASSWORD>",
    "Host": "<DB HOST>",
    "Port": "<PORT>",
    "Database": "<DATABASE>"
}

UPLANDCLI also uses a .conf file to configure the API. This file should be available within the conf/ directory. Here's an example:

    appname = MYAPPNAME
    httpport = 1337
    runmode = dev
    autorender = false
    copyrequestbody = true
    EnableDocs = true
    sqlconn = postgres://<username>:<password>@<ip>:<port>/<database>?sslmode=require

Example Logging Configuration

An example logging.json file can be found within the conf/ directory. This file provides a basic configuration for logging system information. Below is an example of what this file might look like:

{
  "level": "info",
  "encoding": "console",
  "outputPaths": ["stdout", "tmp/logs"],
  "errorOutputPaths": ["tmp/errorlogs"],
  "initialFields": { "initFieldKey": "fieldValue" },
  "encoderConfig": {
    "messageKey": "message",
    "levelKey": "level",
    "nameKey": "logger",
    "timeKey": "time",
    "callerKey": "logger",
    "stacktraceKey": "stacktrace",
    "callstackKey": "callstack",
    "errorKey": "error",
    "timeEncoder": "iso8601",
    "fileKey": "file",
    "levelEncoder": "capitalColor",
    "durationEncoder": "second",
    "callerEncoder": "full",
    "nameEncoder": "full",
    "sampling": {
      "initial": "3",
      "thereafter": "10"
    }
  }
}

CLI Goals

The Upland CLI has several goals:

• Load all blockchain information related to upland.me
• Collect data from eos.hyperion.eosrio.io
• Transform data to selected outputs
• Create a local database for collected data
• Implement graphing and various analytics systems
• Analyze long-term data to predict possible trends

API Documentation

The Upland CLI also includes a small beego/swagger CRUD API. The following endpoint is currently available:

GET /upland/properties       | Get properties from database.

You can also view the collected data from your web browser by starting the API and visiting:

http://127.0.0.1:1337/upland/properties/analysis

Data is displayed in descending order, with the most recently collected data at the top of the list.

Built With:

The Upland CLI was built using the following technologies:

• Golang

• chromedp

• TermUI

• Cobra

• ZAP

• BEEGO

Acknowledgements

We would like to give a special shoutout to Upland.me for providing an amazing metaverse experience. We would also like to thank EOS Hyperion for providing their services at https://eos.hyperion.eosrio.io.