Skip to main content

Abyss

Abyss Python SDK

Launch tokens, read pools, swap, and use lending with web3.py. Package 0.15.1, Python 3.10+, import black_market_sdk. The launch examples target Robinhood Chain mainnet (4663).

Install

Install the published package in your Python environment:

python -m pip install black-market-sdk==0.15.1

For the runnable examples, install an editable checkout:

git clone https://github.com/abysshopper/black-market-python-sdk.git
cd black-market-python-sdk
python -m venv .venv
. .venv/bin/activate
python -m pip install -e .

Discover without a wallet

python examples/quickstart.py
python examples/launch_matrix.py

These optional audits read profile IDs, venues, admission, and refusal reasons. Use list_known_lifecycle_profiles for the shipped zero-RPC offering catalog; new registrations appear there when the SDK release is updated.

Run your first launch

Start with launch_erc20_abyss.py: one ERC20, one canonical Abyss pool, one permanent position, and one opening buy, atomically.

cp -n examples/.env.example .env
chmod 600 .env

Set LAUNCH_API_URL=https://api.abyss.trading and exactly one key source: PRIVATE_KEY, or EXAMPLE_KEYSTORE_PATH with EXAMPLE_KEYSTORE_PASSWORD if needed. Fund that creator with ETH for the buy and gas. RPC_URL optionally overrides the official mainnet RPC. Process environment values override .env.

# Dry run: discovery, pricing and admission; no signatures or writes.
python examples/launch_erc20_abyss.py
# Authorizes spending and publication, without an interactive prompt.
python examples/launch_erc20_abyss.py --broadcast
# After partial execution, use the ORIGINAL broadcast run directory.
python examples/launch_erc20_abyss.py --resume "launch-results/<original-run>"

Even a dry run needs the creator key, sufficient funds, and live RPC/API access. Review the full supply, aligned starting valuation, fees, buy output/share, minimum output, and gas before broadcasting. --broadcast builds a fresh plan, not the dry-run plan. --resume retains the original identity, plan, receipts, and session. Keep recovery files private; never commit keys, capabilities, or signed bytes.

Understand the defaults

  • ERC20 supply: 1,000,000 tokens; ERC404 supply: 10,000, with 100-token NFT units.
  • EXAMPLE_TARGET_MARKET_CAP_USD=5000: full minted-supply valuation, not cash raised. At 1M tokens, that is $0.005/token before tick rounding. It is not a recommendation.
  • EXAMPLE_BUY_AMOUNT_WEI=10000000000000: 0.00001 ETH per buy, plus gas. WETH funding wraps ETH; USDG funding uses a Kyber conversion.
  • Abyss fee: 3000 pips (0.3%), spacing 60. Fixed V4 examples add a 1% hook fee to their 0.3% LP fee. Their config6 minimum does not select dynamic behavior.
  • Reward examples allocate 40% of distributed fees to rewards and 60% to the owner. The 275 bps collection reward is a fee-distribution share, not a trader tax.
  • Launch commands reserve the preset's 32M total gas on Robinhood, including poster gas. Profiles select mode, never signing-gas size. An atomic preference can select staged execution; review the returned launch.mode.
  • Approvals leave gas/fee preparation to the wallet. Held launch gas must match the native ceiling, and held prices below the pinned fee floor refuse without a bump.

Examples

All eleven cases use launch_examples.py and _launch_support.py. Counts below are markets / positions / ordered buys.

Script in examples/ Token / rewards Counts Mode
launch_erc20_abyss.py ERC20 1 / 1 / 1 atomic
launch_erc20_v4.py ERC20 1 / 1 / 1 atomic
launch_erc20_staking_v4.py ERC20 staking 1 / 2 / 2 staged
launch_erc20_dividends_abyss.py ERC20 dividends 1 / 3 / 1 staged
launch_erc20_burn_mixed.py ERC20 burn split 2 / 3 / 2 staged
launch_erc404_v4.py ERC404 1 / 1 / 1 staged
launch_erc404_abyss.py ERC404 1 / 1 / 1 atomic
launch_erc404_dividends_mixed.py ERC404 dividends 2 / 5 / 2 staged
launch_erc20_multi_quote.py ERC20, WETH + USDG 3 / 3 / 3 staged
launch_erc20_depth_v4.py ERC20, four bands 1 / 4 / 1 staged
launch_erc20_dividends_multiquote_mixed.py ERC20 dividends, WETH + USDG 3 / 7 / 3 staged

Planning never executes launch calldata, including conversion routes. Multi-market and conversion-funded plans use staged execution. Release-owned capacity budgets must fit the native ceiling; unavailable budgets refuse without a simulation fallback. See prepare and assess.

Choose an offering

Offering Use it for Guide
Canonical Abyss STANDARD / STANDARD_ORACLE / QUOTE / QUOTE_ORACLE pools Choose an offering
Fixed V4 Pool-bound hook with a fixed trading fee Build the plan
Dynamic V4 Fee minimum, maximum, and tick-velocity sensitivity Choose an offering
HMM V2 Fixed/dynamic V4 plus fee-funded auxiliary liquidity HMM launch configuration
UFG treasury ERC20 with quote-fee reserves and holder redemption UFG treasury launches
Auto-compounding Static/dynamic V4 with fee-funded, hook-owned full-range liquidity Auto-compounding launches

Auto-compounding presets and codecs are available, but planning currently refuses them with UNKNOWN_GAS_PROFILE because they lack a reviewed capacity budget.

Integrate and recover

Follow the launch guide for pricing, signing, publication, recovery, and claims. Check receipt confirmed → markets active → metadata published → API indexed separately; an API timeout does not undo an open token.

Release-owned openings use versioned capacity budgets and exact ordered local buy math. launch.assessment reports readiness and actionable refusals, not execution proof. build_next_transaction refreshes only the immediate command. The wallet assigns its transaction nonce; LaunchPlanV1.nonce remains launch identity.

See runner configuration, limits and codecs, release changes, and the MIT license.

Metadata

Release files for black-market-sdk 0.15.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for black-market-sdk 0.15.1
File Size Uploaded Provenance Actions
black_market_sdk-0.15.1.tar.gz 723.4 kB With provenance Details for black_market_sdk-0.15.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for black-market-sdk 0.15.1
File Interpreter ABI Platform Actions
black_market_sdk-0.15.1-py3-none-any.whl Python 3 none any Details for black_market_sdk-0.15.1-py3-none-any.whl

Total release size: 995.4 kB

Release files / black_market_sdk-0.15.1.tar.gz

Download URL black_market_sdk-0.15.1.tar.gz
Size 723.4 kB
Tags Source
SHA-256 checksum
How to use checksums
c3c26653d8c49de2c10473ff1cbaf13eb8c865ce1fe7a7e1a98a6ede81ce0de4
BLAKE2b-256 checksum
How to use checksums
6d4efb90363565f498a93356bad23d525d13f1cc4800d577be99cf9b8a93e61d
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 29, 2026.

Transparency log

Release files / black_market_sdk-0.15.1-py3-none-any.whl

Download URL black_market_sdk-0.15.1-py3-none-any.whl
Size 272.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f0d41c42ea8dfbf1afdb1c00e8b6de2fa03507efd7947feb8e296946d18c3d08
BLAKE2b-256 checksum
How to use checksums
9833bc5e7a30a445f84a0a5fc08732eb1d1e3a9c4bfedf48a09965cfe2b48757
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 29, 2026.

Transparency log

Security for black-market-sdk 0.15.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.

Select from 2 files

Attestation for black_market_sdk-0.15.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 29, 2026.

Transparency log

A 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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page