hashhavoc / teller

A sophisticated Command Line Interface (CLI) tool designed to empower developers with swift and seamless access to crypto chain data

Teller

Teller is a sophisticated Command Line Interface (CLI) tool designed to facilitate developers' interactions with STX contracts. It streamlines the process of exploring source code and leveraging various analytics tools, thereby significantly enhancing the developer experience within the STX ecosystem. With its intuitive design, Teller ensures that integrating STX contracts into projects is both straightforward and efficient.

Installing

Homebrew is the recommended way to install Teller:

brew install hashhavoc/tap/teller

Upgrade

brew upgrade hashhavoc/tap/teller

Configuration

There is a configuration file that contains various configuration values. You can find an example at config/config.yaml.example.

teller conf init

This will create a new configuration file at ~/.teller.yaml with the default values. You can then edit this file to your liking. There is not currently a way to specify the configuration file location. Not all of the endpoints are avaliable publicly, so you may need to specify your own endpoints.

Source

Building

To use Teller, follow these simple steps:

1. Clone the repository:

   git clone https://github.com/hashhavoc/teller.git

2. Navigate to the project directory:

   cd teller

3. Build the executable:

   go build -o teller cmd/teller/main.go

4. Run Teller:

   ./teller

Command Line Interface

Upon running Teller, you'll encounter the following command line interface:

➜  teller
NAME:
   teller - interact with the stx blockchain

USAGE:
   teller [global options] command [command options]

VERSION:
   v0.0.1

COMMANDS:
   config         Commands to manage the configuration file
   bob            Provides interactions with bob chain
   contracts      Provides interactions with contracts
   token          Provides interactions with tokens
   wallet         Provides interactions with wallets
   dex            Provides interactions with multiple dex
   transactions   Provides interactions with transactions
   ordinals, ord  Provides interactions with ordinals
   help, h        Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --help, -h     show help
   --version, -v  print the version

Commands

Teller offers the following commands:

• contracts: Provides interactions with contracts.
• token: Provides interactions with tokens.
• wallet: Provides interactions with wallets.
• dex: Provides interactions with multiple decentralized exchanges.
• transactions: Provides interactions with transactions.
• ordinals: Provides interactions with ordinals on bitcoin.
• help: Shows a list of commands or help for one command.

Support

If you encounter any issues or have suggestions for improvement, please feel free to open an issue on GitHub. Your feedback is highly appreciated!

License

This project is licensed under the GNU General Public License v3.0 License - see the LICENSE file for details.

teller's Issues

Feature request: Follow the money

A simple table view of transaction where the user can select a transaction and then see the transactions of the recipient later than the initially selected transaction.

Well know addresses like exchanges should be replaced with names. Maybe defined in the config.

All Features Allow Lookup by BNS Names

• transactions
• wallet balances
• holders

Linux build issues

Something small but documenting for others, initially was unable to build the executable on Linux after a fresh clone:

$ go version
go version go1.22.1 linux/amd64
$ go build -o teller
no Go files in /home/whoabuddy/Dev/hashhavoc/teller
$ ls
cmd  config  Dockerfile  go.mod  go.sum  internal  LICENSE  pkg  README.md

One suggestion on the internet was to run go build ./... but then I get an error about the clipboard:

$ go build ./...
# golang.design/x/clipboard
clipboard_linux.c:15:10: fatal error: X11/Xlib.h: No such file or directory
   15 | #include <X11/Xlib.h>
      |          ^~~~~~~~~~~~
compilation terminated.

The answer in my case was to install the dependency libx11-dev first, then run the build from a subfolder:

sudo apt-get install libx11-dev
cd hashhavoc/teller/cmd/teller
go build -o teller

Redirect Failed Lookup BNS

Sync Commands CSV Support

Support having the ability to select CSV or JSON for file output in sync commands