ic-basilisk-toolkit 0.1.0

Basilisk OS — Operating system services, shell, and SFTP for IC Python canisters

ic-basilisk-toolkit

Basilisk OS — Operating system services, interactive shell, and SFTP for Basilisk IC Python canisters.

Overview

ic-basilisk-toolkit provides POSIX-like abstractions on top of the Basilisk CDK:

• Task/Process Management — Task, TaskStep, TaskSchedule, TaskManager
• Wallet — ICRC-1 token registry, transfers, balance tracking, transaction sync
• Encryption — vetKeys + per-principal envelopes + groups (CryptoService)
• FX — Exchange rate queries via the IC XRC canister (FXService)
• Entities — Persistent ORM entities via ic-python-db
• Logging — Structured logging via ic-python-logging
• Interactive Shell — REPL for live canister interaction (basilisk-toolkit shell)
• SFTP — Browse and edit canister filesystem over SSH (basilisk-toolkit sshd)

Installation

pip install ic-basilisk-toolkit

For shell/SFTP support (requires asyncssh):

pip install ic-basilisk-toolkit[shell]

CLI Usage

basilisk-toolkit exec 'print("hello")'                    # Execute code on canister
basilisk-toolkit shell --canister my_app --network ic      # Interactive shell
basilisk-toolkit sshd --canister my_app --network ic       # SSH/SFTP server

Canister-Side Usage

Inside your canister code:

from ic_basilisk_toolkit import Task, TaskStep, Wallet, CryptoService

# Create and schedule a task
task = Task(name="sync_balances")
TaskStep(task=task, name="fetch", code="wallet.refresh_all()")

Dependencies

• ic-basilisk — CDK (types, decorators, ic.* API)
• ic-python-db — Persistent entity ORM
• ic-python-logging — Structured logging

Development

git clone https://github.com/smart-social-contracts/ic-basilisk-toolkit.git
cd ic-basilisk-toolkit
pip install -r requirements.txt
pip install -r requirements-dev.txt
pip install -e .
pytest tests/ -v

License

MIT — see LICENSE.