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.

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

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

Step 4. 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 5. 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 6. 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.3.0.tar.gz (53.0 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.3.0-py3-none-any.whl (43.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: odin_bots-0.3.0.tar.gz
  • Upload date:
  • Size: 53.0 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.3.0.tar.gz
Algorithm Hash digest
SHA256 33cfa69725ba95b4b0fb93525d4655992b4de7e2153a18fb63b58fd0c42d9961
MD5 f8c162b90c0d46d0eadb6d30d6f99249
BLAKE2b-256 b62bdf4e41d96d26cd05c2b9b5f7b1731c6bdc8baa1f71e25a9852148cfdfd34

See more details on using hashes here.

File details

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

File metadata

  • Download URL: odin_bots-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 43.1 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.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 15515a9230111b50393882a5a7f102cabc4b349f434b56e379fec8cde66d049b
MD5 6a252a0d538009c5a99883afa0a42c1f
BLAKE2b-256 fe5a68a3f0b41c35ec1d0560f6e6c337f1d12051b3725ed2198053d22bfcecc7

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