tribulnation-catalogue
Python client for the Tribulnation Catalogue — a typed, open catalogue of crypto assets, trading platforms, and instrument mappings.
Install
pip install tribulnation-catalogue
Usage
from tribulnation.catalogue import Catalogue
catalogue = Catalogue.load()
btc = catalogue.assets["bitcoin"]
binance = catalogue.platforms["binance"]
load() keeps the published data.zip in ~/.cache/tribulnation and loads it from there. Once a day (max_age) it asks the site whether the archive changed with one conditional request (ETag / Last-Modified), and downloads it again only when it did. A download replaces the cached copy only once it loads; if the site is unreachable, the last good copy is used and a warning is logged. Only a first run without any cached copy fails.
Command line
pip install 'tribulnation-catalogue[cli]'
tn catalogue download data # extract the catalogue into ./data, or update it
tn catalogue download # only refresh the cache used by Catalogue.load()
download works like load(): it asks the site whether data.zip changed and only re-extracts the folder when it did. --refresh downloads unconditionally, --url uses a mirror. A folder is only replaced if it is empty or holds an earlier download.
Loading options
# Cached archive, checked at most once a day (default)
catalogue = Catalogue.load()
# Check more or less often
catalogue = Catalogue.load(max_age=timedelta(hours=6))
# Force a fresh download
catalogue = Catalogue.load(refresh=True)
# Load from an explicit local folder (never touches the network once it exists)
catalogue = Catalogue.load("data")
# Custom source URL or cache directory
catalogue = Catalogue.load(
url="https://my-mirror.example.com/data.zip",
cache_dir=".cache/catalogue",
)
# Suppress the download message
catalogue = Catalogue.load(silent=True)
Long-running processes
catalogue = Catalogue.load()
catalogue.digest # sha256 of the loaded data.zip (None for a folder)
catalogue.loaded_at # when it was loaded
# Call as often as you like (e.g. daily): returns the same object until max_age
# elapsed and the published archive actually changed, then a freshly loaded one.
catalogue = catalogue.maybe_refresh()
# Check now, regardless of max_age
catalogue = catalogue.refresh()
Network errors never raise from maybe_refresh() / refresh(); the last good copy stays.
Lookups
catalogue.asset_for('hyperliquid', 150) # 'hyperliquid' (spot token index)
catalogue.asset_for('arbitrum', '0xaf88d065e77c8cc2239327c5edb3a432268e5831') # 'usd-coin' (any casing)
catalogue.asset_for('ethereum', 'native') # 'ethereum'
catalogue.asset_for('bitget', 'rSPY') # symbols are case-sensitive
catalogue.asset_for('mexc', 'UNKNOWN') # None
catalogue.perpetual_for('hyperliquid', 'kPEPE')
# PerpetualInstrument(platform='hyperliquid', id='kPEPE', base='pepe', quote='tether',
# settlement='usd-coin', multiplier=Decimal('1000'), delisted=False)
catalogue.debt_for('ethereum', '0x72e95b8931767c79ba4eee721354d6e99a61d004')
# DebtInstrument(platform='ethereum', id='0x72E95b89…', asset='usd-coin', name='Aave USDC Debt')
catalogue.network_for('bybit', 'BSC (BEP20)') # 'bnb-chain'
catalogue.canonical_id('old-id') # follows `replaced_by` aliases
Every lookup follows replaced_by: asset ids are never deleted, and a merged asset keeps its file as an alias of the surviving one.
Correlation keys
A correlation key is a string both sides of one cross-chain movement can compute
independently, e.g. a CCTP burn and its mint. Each key's namespace is a protocol in
data/protocols/, which defines the key template and its typed fields, so two writers
that never import each other produce the same string.
catalogue.format_correlation('cctp', source_domain=4, nonce=12345) # 'cctp:4:12345'
catalogue.parse_correlation('ibc:dydx:channel-0:42')
# ('ibc', {'sending_chain': 'dydx', 'channel': 'channel-0', 'sequence': 42})
catalogue.network_for_domain('cctp', 3) # 'arbitrum'
catalogue.domain_for_network('cctp', 'noble') # 4
catalogue.protocol('hlbridge') # Protocol record, or None
Both raise CorrelationError (a ValueError) for an unknown namespace, missing or
extra fields, or a value of the wrong type. Field types fix the canonical form:
int/uint in base 10, hex as lower-case 0x… (bytes accepted), string as-is
without : or whitespace, and network as an existing catalogue platform id.
| Protocol | Key |
|---|---|
cctp |
cctp:{source_domain}:{nonce} (CCTP V1; V2 burns have no nonce on the source chain) |
ibc |
ibc:{sending_chain}:{channel}:{sequence} |
hlbridge |
hlbridge:{user}:{nonce} (Hyperliquid Bridge2 withdrawals) |
gofast |
gofast:{order_id} (Skip Go Fast) |
relay |
relay:{request_id} (Relay depository deposits and their fills) |
lighter |
lighter:{serial_id} (Lighter L1 priority requests, e.g. deposits) |
What's available
catalogue.assets # dict[str, Asset]
catalogue.platforms # dict[str, Platform]
catalogue.blockchains # filtered view: kind == 'blockchain'
catalogue.cexs # filtered view: kind == 'cex'
catalogue.dexs # filtered view: kind == 'dex'
catalogue.spot_instruments # dict[platform, dict[id, Spot]]
catalogue.perpetual_instruments # dict[platform, dict[id, Perpetual]]
catalogue.debt_instruments # dict[platform, dict[id, Debt]]
catalogue.pools # dict[platform, dict[id, Pool]]
catalogue.asset_translations # dict[platform, dict[exchange_id, asset_id]]
catalogue.network_translations # dict[platform, dict[exchange_id, network_id]]
catalogue.spam # dict[platform, dict[address, SpamAddress]]
catalogue.protocols # dict[protocol, Protocol]
Types
All types are available from the package root:
from tribulnation.catalogue import (
Asset, AssetPeg, ExternalIds,
Platform, Blockchain, CexPlatform, DexPlatform,
Spot, Perpetual, PerpetualInstrument, DebtInstrument, Debt, Pool,
SpamAddress, Protocol, Correlation, CorrelationFieldType, CorrelationError,
)
Links
1 maintainer
Metadata
1 maintainer
Release files for tribulnation-catalogue 0.4.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| tribulnation_catalogue-0.4.1.tar.gz | 60.3 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| tribulnation_catalogue-0.4.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 117.4 kB
Release files / tribulnation_catalogue-0.4.1.tar.gz
| Download URL | tribulnation_catalogue-0.4.1.tar.gz |
|---|---|
| Size | 60.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1d333dc70eb5edb74a8b6434951e02ccdee6e812b00f7ed2584ea5796c7fed05
|
|
BLAKE2b-256 checksum How to use checksums |
ccea2cc949074d6e8bd6f8c75c1146eef908485cae46318cbb42c9c37e70f65a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 24, 2026.
Transparency logRelease files / tribulnation_catalogue-0.4.1-py3-none-any.whl
| Download URL | tribulnation_catalogue-0.4.1-py3-none-any.whl |
|---|---|
| Size | 57.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7b428f17cadfde0f9092ac4e4d44478606fcb5803a42938e7bf4eb7c92d40d33
|
|
BLAKE2b-256 checksum How to use checksums |
81ef0bb9381456e5b2e55ff75bd80f5c5f8aa5d1791525d4b7bd76f08b240777
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 24, 2026.
Transparency logSecurity for tribulnation-catalogue 0.4.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for tribulnation_catalogue-0.4.1.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 24, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
