Skip to content
github-actions[bot] edited this page Oct 20, 2026 · 21 revisions

Overview

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; and MVM helpers 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.

Requirements

Ruby >= 4.0, Bundler 2.6+, and — only for the native encoder fallbacks — the mixin CLI.

Component map

flowchart LR
  CLI["mixinbot CLI"] --> API
  Rails["Rails layer (opt-in)"] --> API
  API --> Utils
  API --> Client
  Client --> Mixin["Mixin Network REST"]
Loading

Quick links

Source

Clone this wiki locally