Skip to content

An open source Python CLI tool to create a snapshot of CAT holders

License

Notifications You must be signed in to change notification settings

dexie-space/snapcat

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SnapCAT

snapcat is a Python command-line tool that helps monitor CATs (Chia Asset Tokens) on Chia Blockchain. It retrieves the latest CAT holder data by communicating with your local Chia Full Node RPC. The tool also leverages code from chia-network's CAT-addresses.

❯ snapcat --help

 Usage: snapcat [OPTIONS] COMMAND [ARGS]...

╭─ Options ───────────────────────────────────────────────────────────────────────────────────╮
│ --version              Show the version and exit.                                           │
│ --file-name  -f  TEXT  The name of the database file (default: <tail_hash>.db)              │
│ --help                 Show this message and exit.                                          │
╰─────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ──────────────────────────────────────────────────────────────────────────────────╮
│ export      Export the CAT holder as csv or json.                                           │
│ show        Display the CAT db information.                                                 │
│ sync        Sync or create (if not exist) the CAT holder database.                          │
╰─────────────────────────────────────────────────────────────────────────────────────────────╯

Sync (i.e., generate CAT database)

❯ snapcat sync --help

 Usage: snapcat sync [OPTIONS]

 Sync or create (if not exist) the CAT holder database.

╭─ Options ───────────────────────────────────────────────────────────────────────────────────╮
│ *  --tail-hash  -t  BYTES32  The TAIL hash of CAT [required]                                │
│    --help                    Show this message and exit.                                    │
╰─────────────────────────────────────────────────────────────────────────────────────────────╯

❯ snapcat -f dbx.db sync -t db1a9020d48d9d4ad22631b66ab4b9ebd3637ef7758ad38881348c5d24c38f20
press Ctrl+C to exit.
tail hash: db1a9020d48d9d4ad22631b66ab4b9ebd3637ef7758ad38881348c5d24c38f20
database file name: dbx.db
Full Node is synced
Processed all blocks from 0 to 5320532

Export

❯ snapcat export --help

 Usage: snapcat export [OPTIONS]

 Export the CAT holder as csv or json.

╭─ Options ───────────────────────────────────────────────────────────────────────────────────╮
│ --output  -o  TEXT  The name of the output file (default: <tail_hash>-<block>.csv or .json) │
│ --coins   -c        Show individual coins in output rather than collapsing on puzzle hash   │
│ --json    -j        Export as JSON instead of CSV                                           │
│ --help              Show this message and exit.                                             │
╰─────────────────────────────────────────────────────────────────────────────────────────────╯

❯ snapcat -f dbx.db export --json -o dbx.json
Exporting CAT holders
Tail Hash: db1a9020d48d9d4ad22631b66ab4b9ebd3637ef7758ad38881348c5d24c38f20
Last Block Height: 5320532

Show

❯ snapcat show --help

 Usage: snapcat show [OPTIONS]

 Display the CAT db information.

╭─ Options ───────────────────────────────────────────────────────────────────────────────────╮
│ --puzzle-hash  -p  BYTES32  The (inner) puzzle hash to show the unspent coins and available │
│                             balance for                                                     │
│ --help                      Show this message and exit.                                     │
╰─────────────────────────────────────────────────────────────────────────────────────────────╯

❯ snapcat -f dbx.db show
Tail Hash: db1a9020d48d9d4ad22631b66ab4b9ebd3637ef7758ad38881348c5d24c38f20
Last Block Height: 5320532
# of Coins Spent: 152881
# of Coins Created: 158324

❯ snapcat -f dbx.db show -p 627d8cb88c51412d783bc2e6048b6bd9d48e68d790182d582d90395d860da680
Tail Hash: db1a9020d48d9d4ad22631b66ab4b9ebd3637ef7758ad38881348c5d24c38f20
Last Block Height: 5320532
Puzzle Hash: 627d8cb88c51412d783bc2e6048b6bd9d48e68d790182d582d90395d860da680
# of Unspent Coins: 2
Available Balance: 13,678.781

About

An open source Python CLI tool to create a snapshot of CAT holders

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages