https://github.com/blinklabs-io/txtop

mempool display tool for a Cardano Node
https://github.com/blinklabs-io/txtop

blockchain cardano cardano-node go golang mempool terminal-app tui

Last synced: about 1 month ago
JSON representation

mempool display tool for a Cardano Node

• Host: GitHub
• URL: https://github.com/blinklabs-io/txtop
• Owner: blinklabs-io
• License: apache-2.0
• Created: 2023-10-03T14:34:26.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-07T21:48:35.000Z (about 1 month ago)
• Last Synced: 2024-11-07T22:22:05.635Z (about 1 month ago)
• Topics: blockchain, cardano, cardano-node, go, golang, mempool, terminal-app, tui
• Language: Go
• Homepage:
• Size: 224 KB
• Stars: 22
• Watchers: 1
• Forks: 3
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# txtop

Mempool inspector for Cardano Node software.

# Usage

There's no configuration file. Everything is handled by environment variables.

This tool can connect to a cardano-node using either UNIX socket or TCP, such

as an exposed socat.

## Global variables

- `NETWORK` - Sets network and forces container defaults for `NETWORK` mode

- `REFRESH` - Sets how fast we refresh data (in seconds), defaults to 10

- `RETRIES` - Sets how many retries before aborting (currently unused)

## Cardano variables

- `CARDANO_NETWORK` - Sets network to connect to node unless NETWORK is set,

    defaults to mainnet

- `CARDANO_NODE_NETWORK_MAGIC` - (optional) Manually configure network magic

- `CARDANO_NODE_SOCKET_PATH` - Sets path to UNIX socket of node, defaults to

    /opt/cardano/ipc/socket unless NETWORK is set, then uses /ipc/node.socket

- `CARDANO_NODE_SOCKET_TCP_HOST` - Sets the TCP host for NtC communication

    (socat), defaults to empty

- `CARDANO_NODE_SOCKET_TCP_PORT` - Sets the TCP port for NtC communication

    (socat), defaults to 30001

# Development / Building

This requires Go 1.20 or better is installed. You also need `make`.

```bash

# Build

make

# Run

./txtop

```

You can also run the code without building a binary, first

```bash

go run .

```