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 [--monitor]

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

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

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

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

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

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

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]
# See README-security.md for details
verify_certificates = false
cache_sessions = true

[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

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.5.0.tar.gz (60.4 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.5.0-py3-none-any.whl (46.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: odin_bots-0.5.0.tar.gz
  • Upload date:
  • Size: 60.4 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.5.0.tar.gz
Algorithm Hash digest
SHA256 b8b34ea81aa9b005433ea788a223e6177c11c15c0b11bca2654cf0bd60ecf089
MD5 0732763528bb1af0d5cb99be862cf127
BLAKE2b-256 9a1a208eeed8014976440f60e0ae37c95943d3363dff094e18b0439848b43e42

See more details on using hashes here.

File details

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

File metadata

  • Download URL: odin_bots-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 46.4 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.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0849bd4c478667bfdde0b274a836a0e5557d533d49433fd2d69e63bce810ab9b
MD5 e90e078aa043b9e137bbab40fa529523
BLAKE2b-256 3dee5410ab0e247de191e351a7cbfa37cc3508db2bb374cb98e6672a8d56ca1f

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