{"id":31044845,"url":"https://github.com/ixian-platform/quixi","last_synced_at":"2025-09-14T16:52:11.410Z","repository":{"id":310635821,"uuid":"1029364779","full_name":"ixian-platform/QuIXI","owner":"ixian-platform","description":"Quick integration toolkit for Ixian. Connects apps, IoT devices, and services to the Ixian Platform via REST APIs and message queues (MQTT/RabbitMQ). Provides developers with a simple bridge into secure Ixian communication.","archived":false,"fork":false,"pushed_at":"2025-08-19T09:05:45.000Z","size":49,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-09-06T10:34:36.839Z","etag":null,"topics":["api","encryption","integration","iot","message-queue","messaging","mqtt","p2p","post-quantum","post-quantum-cryptography","rabbitmq"],"latest_commit_sha":null,"homepage":"https://www.ixian.io","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ixian-platform.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-07-31T00:02:42.000Z","updated_at":"2025-08-26T13:31:07.000Z","dependencies_parsed_at":"2025-08-19T11:21:41.781Z","dependency_job_id":"8a37fada-5bce-4f1d-897b-d0b55a4b6a7c","html_url":"https://github.com/ixian-platform/QuIXI","commit_stats":null,"previous_names":["ixian-platform/quixi"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ixian-platform/QuIXI","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ixian-platform%2FQuIXI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ixian-platform%2FQuIXI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ixian-platform%2FQuIXI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ixian-platform%2FQuIXI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ixian-platform","download_url":"https://codeload.github.com/ixian-platform/QuIXI/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ixian-platform%2FQuIXI/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":275136700,"owners_count":25411709,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-14T02:00:10.474Z","response_time":75,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","encryption","integration","iot","message-queue","messaging","mqtt","p2p","post-quantum","post-quantum-cryptography","rabbitmq"],"created_at":"2025-09-14T16:52:08.513Z","updated_at":"2025-09-14T16:52:11.396Z","avatar_url":"https://github.com/ixian-platform.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# QuIXI\n\n**QuIXI** is the quick integration gateway for the [Ixian Platform](https://www.ixian.io).\n\nIts name is a play on words:\n\n* **Quick + IXI** - fast integration into Ixian\n* **Qu (Quantum)** - future-ready with post-quantum cryptography\n* **qu (Queue)** - message queue support (MQTT / RabbitMQ)\n\nQuIXI lets you connect **anything** - devices, applications, or services - into Ixian's **secure, decentralized, and\npresence-based network**.\n\nIt provides:\n\n* 📨 **Message Queue Bridges** - Subscribe to Ixian P2P streams via **MQTT** or **RabbitMQ**\n* 🌐 **REST API** - Send messages, app data, or service commands into Ixian\n* 🔒 **Encryption by Default** - All communication is protected by Ixian Core's cryptography\n* 📦 **Lightweight \u0026 Portable** - Runs anywhere .NET 8 is supported, from servers to Raspberry Pi\n\n---\n\n## 🚀 Quick Start\n\n### 1. Install .NET 8\n\nQuIXI requires [.NET 8 SDK \u0026 Runtime](https://dotnet.microsoft.com/en-us/download/dotnet/8.0).\n\n### 2. Clone \u0026 Build\n\n```bash\ngit clone https://github.com/ixian-platform/Ixian-Core.git\ngit clone https://github.com/ixian-platform/QuIXI.git\ncd QuIXI\ndotnet build\n```\n\n### 3. Configure\n\nCreate a file 'ixian.cfg' in the working directory. Example:\n\n```ini\napiPort = 8001\nmqDriver = mqtt\nmqHost = localhost\nmqPort = 1883\n```\n\n### 4. Run\n\n```bash\ndotnet run --project QuIXI\n```\n\n### 5. Try the REST API\n\nAdd a contact:\n\n```bash\ncurl --get \\\n  --data-urlencode \"address=RECIPIENT_IXI_ADDRESS\" \\\n  \"http://localhost:8001/addContact\"\n```\n\nSend a chat message:\n\n```bash\ncurl --get \\\n  --data-urlencode \"channel=0\" \\\n  --data-urlencode \"message=Hello Ixian!\" \\\n  --data-urlencode \"address=RECIPIENT_IXI_ADDRESS\" \\\n  \"http://localhost:8001/sendChatMessage\"\n```\n\n---\n\n## ⚙️ Configuration\n\nQuIXI uses a simple `parameterName = parameterValue` format.\nEach option is on its own line in `ixian.cfg` file.\n\n### General\n\n* `apiPort` - HTTP/API port (default 8001)\n* `apiAllowIp` - Allow API connections from specific IPs (can repeat)\n* `apiBind` - Bind to specific address (can repeat)\n* `testnetApiPort` - API port in testnet mode\n* `addApiUser` - Add 'user:password' credentials (can repeat)\n* `externalIp` - External IP address\n* `addPeer` - Specify Ixian seed node (can repeat)\n* `addTestnetPeer` - Seed node in testnet mode (can repeat)\n\n### Logging\n\n* `maxLogSize` - Max log file size (MB)\n* `maxLogCount` - Max number of rotated logs\n* `logVerbosity` - Logging level\n\n### Messaging\n\n* `mqDriver` - `mqtt` or `rabbitmq`\n* `mqHost` - Queue host\n* `mqPort` - Queue port\n* `streamCapabilities` - Supported stream types (Incoming, Outgoing, IPN, Apps, AppProtocols)\n\n### Notifications\n\n* `walletNotify` - Execute command when wallet changes\n\n---\n\n## 🌐 REST API Reference\n\nAll APIs are `GET` endpoints.\n\n### Contacts\n\n* `/contacts` - List current contacts\n* `/addContact?address=` - Request contact with given Ixian address\n* `/acceptContact?address=` - Accept contact request\n* `/removeContact?address=` - Remove a contact\n\n### Messaging\n\n* `/sendChatMessage?address=\u0026message=\u0026channel=`\n\n  * `address` - Ixian cryptographic address of recipient\n  * `message` - Text to send\n  * `channel` - Chat channel (usually `0`)\n\n* `/sendSpixiMessage?address=\u0026type=\u0026data=\u0026channel=`\n\n  * `address` - Recipient address\n  * `type` - Message type (Spixi-specific)\n  * `data` - Payload\n  * `channel` - Channel ID\n\n* `/sendAppData?address=\u0026appId=\u0026data=`\n\n  * Send app-specific data identified by `appId`\n\n* `/sendAppData?address=\u0026protocolId=\u0026data=`\n\n  * Send protocol-specific data identified by `protocolId`\n\n* `/getLastMessages?address=\u0026count=\u0026channel=`\n\n  * Fetch recent messages with a given contact\n  * `address` - Contact address\n  * `count` - Number of messages to retrieve\n  * `channel` - Channel ID\n\n---\n\n## 📡 Message Queue Topics\n\nQuIXI publishes Ixian events and messages into **MQTT** or **RabbitMQ topics**.\nApplications can subscribe to these topics to react to events in real time (IoT triggers, service automation, analytics, etc.).\n\n### Core Chat \u0026 Messaging\n\n* `Chat` - Standard chat messages\n* `MsgTyping` - Typing indicator from a contact\n* `MsgReceived` - Confirmation a message was received\n* `MsgRead` - Confirmation a message was read\n* `MsgDelete` - Message was deleted\n* `MsgReaction` - Reaction to a message (emoji, like, etc.)\n\n### Contacts \u0026 Presence\n\n* `RequestAdd2` - Incoming contact request\n* `AcceptAdd2` - Contact request accepted\n* `AcceptAddBot` - Bot contact accepted\n* `BotAction` - Bot-initiated action\n* `LeaveConfirmed` - Bot confirmed contact has left\n* `Nick` - Nickname update\n\n### File Transfers\n\n* `FileHeader` - Metadata for an incoming file\n* `AcceptFile` - File transfer accepted\n* `RequestFileData` - Request for file chunks\n* `FileData` - A piece of file content\n* `FileFullyReceived` - Entire file transfer complete\n* `Avatar` - Profile picture / avatar update\n\n### Funds \u0026 Transactions\n\n* `RequestFunds` - Contact is requesting funds\n* `RequestFundsResponse` - Response to a funds request\n* `SentFunds` - Outgoing funds sent\n\n### Applications \u0026 Protocols\n\n* `AppData` - Spixi Mini App Data\n* `AppProtocolData` - Spixi Mini App Protocol Data\n* `AppRequest` - App session request\n* `AppRequestAccept` - App session accepted\n* `AppRequestReject` - App session rejected\n* `AppEndSession` - App session terminated\n* `AppRequestError` - App session error\n* `GetAppProtocols` - Request for supported app protocols\n* `AppProtocols` - List of supported app protocols\n\n---\n\n## 💡 Example: Decentralized LED on Raspberry Pi \n\nThe repo includes `/Examples/RasPi/LED`, which contains two bash scripts that turn a Raspberry Pi into a\n**decentralized LED device**.\n\nIt:\n\n1. Automatically accepts any user that adds it.\n2. Subscribes to MQTT messages from Ixian.\n3. Accepts commands ('on', 'off', 'temp', 'help').\n4. Controls GPIO pins or replies via Ixian chat messages.\n\nExample command flow:\n\n* Send **\"on\"** → LED turns on.\n* Send **\"temp\"** → Device replies with its CPU temperature.\n\nThis demonstrates how **any IoT device** can securely integrate into Ixian via QuIXI.\n\n---\n\n## 🌱 Development Branches\n\n* **master** - Stable, production-ready releases\n* **development** - Active development, may contain unfinished features\n\nFor reproducible builds, always use the latest **release tag** on `master`.\n\n---\n\n## 🤝 Contributing\n\nWe welcome contributions and new integration examples.\n\n1. Fork this repo\n2. Create a feature branch ('feature/my-change')\n3. Commit with clear messages\n4. Open a Pull Request\n\n---\n\n## 🌍 Community \u0026 Links\n\n* **Website**: [www.ixian.io](https://www.ixian.io)\n* **Docs**: [docs.ixian.io](https://docs.ixian.io)\n* **Discord**: [discord.gg/pdJNVhv](https://discord.gg/pdJNVhv)\n* **Telegram**: [t.me/ixian\\_official\\_ENG](https://t.me/ixian_official_ENG)\n* **Bitcointalk**: [Forum Thread](https://bitcointalk.org/index.php?topic=4631942.0)\n* **GitHub**: [ixian-platform](https://www.github.com/ixian-platform)\n\n---\n\n## 📜 License\n\nLicensed under the [MIT License](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fixian-platform%2Fquixi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fixian-platform%2Fquixi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fixian-platform%2Fquixi/lists"}