Skip to main content

Bitcoin rune trading CLI & SDK

Project description

cicd

ODIN-BOTS


pip install odin-bots

Note: On macOS Apple Silicon, install automake and libtool before running pip install:

brew install automake libtool

Setup (one time):

odin-bots init             Configures your project with 3 bots
                           Stored in odin-bots.toml

odin-bots wallet create    Generate wallet identity
                           Stored in .wallet/identity-private.pem

How to use your bots:

Step 1. Fund your odin-bots wallet:
        odin-bots wallet receive
        Send ckBTC or BTC to the address shown.
        BTC deposits require min 10,000 sats and ~6 confirmations.

Step 2. Check your wallet balance:
        odin-bots wallet balance

Step 3. Fund your bots (deposits ckBTC into Odin.Fun):
        odin-bots --bot <name> fund <amount>      # in sats
        odin-bots --all-bots fund <amount>

Step 4. Buy Runes on Odin.Fun:
        odin-bots --bot <name> trade buy <token-id> <amount>
        odin-bots --all-bots trade buy <token-id> <amount>

Step 5. Check your balances (wallet + bots):
        odin-bots --all-bots balance

Step 6. Sell Runes on Odin.Fun:
        odin-bots --bot <name> trade sell <token-id> <amount>
        odin-bots --all-bots trade sell <token-id> <amount>
        # to sell all holdings of a token
        odin-bots --bot <name> trade sell <token-id> all
        odin-bots --all-bots trade sell <token-id> all
        # to sell all holdings of all tokens
        odin-bots --bot <name> trade sell all-tokens all
        odin-bots --all-bots trade sell all-tokens all

Step 7. Withdraw ckBTC from Odin.Fun back to wallet:
        odin-bots --bot <name> withdraw <amount>
        odin-bots --all-bots withdraw <amount>
        # to sweep all ckBTC back into the wallet
        odin-bots --all-bots withdraw all

Or use sweep to sell all tokens + withdraw in one command:
        odin-bots --bot <name> sweep
        odin-bots --all-bots sweep

Step 8. Send ckBTC from wallet to an external ckBTC or BTC account:
        odin-bots wallet send <amount> <address>
        (supports both ICRC-1 and BTC addresses)

Configuration

odin-bots.toml (created by odin-bots init):

[settings]

[bots.bot-1]
description = "Bot 1"

[bots.bot-2]
description = "Bot 2"

[bots.bot-3]
description = "Bot 3"

Each bot gets its own trading identity on Odin.Fun. Add or remove [bots.*] sections as needed.

Project Layout

my-bots/
├── .gitignore             # ignores .wallet/, .cache/
├── odin-bots.toml         # bot config
├── .wallet/               # identity key (BACK UP!)
│   └── identity-private.pem
└── .cache/                # delegated identities (auto-created)
    ├── session_bot-1.json # no backup needed — regenerated
    ├── session_bot-2.json # when expired (24h lifetime)
    └── session_bot-3.json

Open Source & Verifiable

odin-bots is powered by the onicai ckSigner canister: g7qkb-iiaaa-aaaar-qb3za-cai

The canister code is fully open source with a reproducible build, available at github.com/onicai/PoAIW -> ckSigner branch.

How It Works

See README-how-it-works.md for technical details.

Security

See README-security.md for security considerations and best practices.

Contribute

To contribute, see README-contribute.md.

Status & Disclaimer

This project is in alpha. APIs may change without notice.

The software and hosted services are provided "as is", without warranty of any kind. Use at your own risk. The authors and onicai are not liable for any losses — including but not limited to loss of funds, keys, or data — incurred through use of this software or the hosted canister services. No guarantee of availability, correctness, or security is made. You are solely responsible for evaluating the suitability of these services for your use case and for complying with all applicable laws and regulations in your jurisdiction.

Reference

The Bitcoin rune trading platform is Odin Fun

Supported Platforms

Platform Python 3.11 Python 3.12 Python 3.13
Ubuntu (x86-64) yes yes yes
macOS Apple Silicon yes yes yes
macOS Intel yes yes yes
Windows (x86-64) yes yes yes

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

odin_bots-0.4.0.tar.gz (53.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

odin_bots-0.4.0-py3-none-any.whl (43.5 kB view details)

Uploaded Python 3

File details

Details for the file odin_bots-0.4.0.tar.gz.

File metadata

  • Download URL: odin_bots-0.4.0.tar.gz
  • Upload date:
  • Size: 53.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.11

File hashes

Hashes for odin_bots-0.4.0.tar.gz
Algorithm Hash digest
SHA256 620529d550d0380eb736ab8511282c54eb7de22904dcc879cfd7188d2132d5ba
MD5 4db304dce0fd82d2adadc2a2f22fa997
BLAKE2b-256 9c453912fb9bd6077898dfb928d1b074905ee5c82358c8f1efd09fff1a1a2422

See more details on using hashes here.

File details

Details for the file odin_bots-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: odin_bots-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 43.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.11

File hashes

Hashes for odin_bots-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ff90d75f198541561828c1a71886daf2599c3f209f7f23224ebe8356bc0c1ac9
MD5 01e219cfdc03e1349dc69b4e12a97edf
BLAKE2b-256 4f1959b0b257ceaad294923ef202eefd4a65a24e3fbe4062147b7f32f1a4a6a3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page