Repository navigation
Home
github-actions[bot] edited this page Oct 20, 2026
·
21 revisions
MixinBot is a Ruby gem (v3.0.2) that wraps the [Mixin Network]((developers.mixin.one/redacted) REST API. It ships four things:
-
MixinBot::API— a REST SDK composed of ~40 domain modules: profiles, users, assets, network catalogs, Safe UTXO transfers, transactions, multisig, messaging (Blaze and encrypted), conversations, circles, snapshots, outputs, inscriptions, withdrawals, payments, apps, pins, OAuth, and an RPC proxy. -
mixinbot— a Thor-based CLI for exploring and invoking the API without writing Ruby. -
MixinBot::Utils/MixinBot::Transaction— cryptographic primitives (JWT signing, Ed25519, ghost keys), address building/parsing, amount conversion, and raw transaction encoding/decoding. -
Optional integrations — a Rails layer (
require 'mixin_bot/rails') with a multi-bot registry, Blaze message router, outputs poller, transfer ledger and Noticed channel; andMVMhelpers for the Mixin Virtual Machine.
The API surface mirrors the official bot-api-go-client and bot-api-nodejs-client SDKs. rake mixin_bot:api_coverage compares the endpoint catalog against the Go SDK.
Ruby >= 4.0, Bundler 2.6+, and — only for the native encoder fallbacks — the mixin CLI.
flowchart LR
CLI["mixinbot CLI"] --> API
Rails["Rails layer (opt-in)"] --> API
API --> Utils
API --> Client
Client --> Mixin["Mixin Network REST"]
- Getting Started — install, configure, first call
- Configuration — credentials, key conversion, keystores
- Architecture — module composition and request lifecycle
- API Reference — every public method, grouped by domain
- Safe Pipeline — UTXO select → build → verify → sign → submit
-
CLI —
mixinbot call,list,schema - Rails Integration — router, poller, transfers, notifications, generators